RESPONSE:
response | mode
set the mode in which the tubeplayer operates
not used = position and dimension is set by the container | selector
auto fullscreen = position and dimension is set to full window viewport - scaled
stacking order is positioned in back
autohide controls/show | controls property is set to true
tubeplayer is positioned fixed
auto fullwidth = top position and height is set by the container | selector
the width is set to full window viewport - scaled
stacking order is positioned in back
autohide controls/show | controls property is set to true
tubeplayer is positioned absolute
response | mode
set the mode in which the tubeplayer operates
not used = position and dimension is set by the container | selector
auto fullscreen = position and dimension is set to full window viewport - scaled
stacking order is positioned in back
autohide controls/show | controls property is set to true
tubeplayer is positioned fixed
auto fullwidth = top position and height is set by the container | selector
the width is set to full window viewport - scaled
stacking order is positioned in back
autohide controls/show | controls property is set to true
tubeplayer is positioned absolute
identifier
1. identifier is used to write down notes of animations, actions and anything we find important to make note of
identifier is a visual reference
2. identifier also provides a quick overview of the function structure flow
STRUCTURE: function (e) { javascript before - init - callback/event - javascript after }
container | selector
set the container/holder of the tubeplayer by a WB object
the object sets the position of the tubeplayer
if the property response | mode is set to not used the object will also set the tubeplayer dimension
for an in depth on selectors simplified see here
•••• var: string
SETTINGS:
url
set the url of the the youtube movie to play ie. http://www.youtube.com/v/x-40jgwazk0
•••• var: string
autoplay
enable autoplay
•••• var: non-string
quality
set quality of the movie
the full list of quality levels is:
default, small, medium, large, hd720
•••• var: string
start | volume
set start volume of the youtube movie (0=off to 100)
•••• var: non-string
start | play position
set start position of the youtube movie in seconds (ie. 120=2min)
•••• var: non-string
theme | overall
set the overall theme of the tubeplayer, either dark or light
•••• var: string
theme | progressbar
set the progressbar color of the tubeplayer, either red or white
•••• var: string
autohide controls
enable controls auto hide when the player starts playing
NOTE: if response | mode is auto fullscreen or auto fullwidth this property is surpassed (=always true)
•••• var: non-string
show | controls
disable the player controls
NOTE: if response | mode is auto fullscreen or auto fullwidth this property is surpassed (=always 1=true)
NOTE: 0 = false | 1 = true
•••• var: non-string
show | info
enable player displaying movie info, is top bar info display
•••• var: non-string
show | related
enable player displays related movies at the end of the movie
NOTE: 0 = false | 1 = true
•••• var: non-string
show | annotation
enable annotation, youtube notes
NOTE: internally adds &iv_load_policy=3 to the video url - (this property may not work in all browsers)
•••• var: non-string
show | allow fullscreen
enable allow fullscreen display
•••• var: non-string
EXTERNAL CONTROL:
control | play
set the selector of an object to act as a play button
•••• var: string
control | stop
set the selector of an object to act as a stop button
•••• var: string
control | pause
set the selector of an object to act as a pause button
•••• var: string
control | mute toggle
set the selector of an object to act as a volume mute-unmute button
NOTE: the object toggles between mute - unmute state
•••• var: string
EVENT:
event | on play - stop - pause - seek - mute - unmute
add a function on external control - more info see here
just as the callback function is beyond the scope of this manual, so is this property
for an in depth on callback and run on call see here
• fn: onPlay: function (id) { }
id = returns current video id/youtube url - NOTE: not initialVideo but dynamic set video!
• fn: onSeek: function (time) { }
time = returns current movie position
1. identifier is used to write down notes of animations, actions and anything we find important to make note of
identifier is a visual reference
2. identifier also provides a quick overview of the function structure flow
STRUCTURE: function (e) { javascript before - init - callback/event - javascript after }
container | selector
set the container/holder of the tubeplayer by a WB object
the object sets the position of the tubeplayer
if the property response | mode is set to not used the object will also set the tubeplayer dimension
for an in depth on selectors simplified see here
•••• var: string
SETTINGS:
url
set the url of the the youtube movie to play ie. http://www.youtube.com/v/x-40jgwazk0
•••• var: string
autoplay
enable autoplay
•••• var: non-string
quality
set quality of the movie
the full list of quality levels is:
default, small, medium, large, hd720
•••• var: string
start | volume
set start volume of the youtube movie (0=off to 100)
•••• var: non-string
start | play position
set start position of the youtube movie in seconds (ie. 120=2min)
•••• var: non-string
theme | overall
set the overall theme of the tubeplayer, either dark or light
•••• var: string
theme | progressbar
set the progressbar color of the tubeplayer, either red or white
•••• var: string
autohide controls
enable controls auto hide when the player starts playing
NOTE: if response | mode is auto fullscreen or auto fullwidth this property is surpassed (=always true)
•••• var: non-string
show | controls
disable the player controls
NOTE: if response | mode is auto fullscreen or auto fullwidth this property is surpassed (=always 1=true)
NOTE: 0 = false | 1 = true
•••• var: non-string
show | info
enable player displaying movie info, is top bar info display
•••• var: non-string
show | related
enable player displays related movies at the end of the movie
NOTE: 0 = false | 1 = true
•••• var: non-string
show | annotation
enable annotation, youtube notes
NOTE: internally adds &iv_load_policy=3 to the video url - (this property may not work in all browsers)
•••• var: non-string
show | allow fullscreen
enable allow fullscreen display
•••• var: non-string
EXTERNAL CONTROL:
control | play
set the selector of an object to act as a play button
•••• var: string
control | stop
set the selector of an object to act as a stop button
•••• var: string
control | pause
set the selector of an object to act as a pause button
•••• var: string
control | mute toggle
set the selector of an object to act as a volume mute-unmute button
NOTE: the object toggles between mute - unmute state
•••• var: string
EVENT:
event | on play - stop - pause - seek - mute - unmute
add a function on external control - more info see here
just as the callback function is beyond the scope of this manual, so is this property
for an in depth on callback and run on call see here
• fn: onPlay: function (id) { }
id = returns current video id/youtube url - NOTE: not initialVideo but dynamic set video!
• fn: onSeek: function (time) { }
time = returns current movie position
-----
run on load
run on load enables or disables this module to run on page load
run on call
run on call is the function name we can give this current function
we can call this function to occur ie. by using a callback | function
for an in depth on callback and run on call see here
code modification | variable
add function variables ie. Call_Disable_1(myVariable)
this function is beyond the scope of this manual see here
code modification | javascript | after
add javascript, further enhancing this function by adding custom code
this function is beyond the scope of this manual see here
code modification | javascript | before
add javascript, further enhancing this function by adding custom code
this function is beyond the scope of this manual see here
run on load
run on load enables or disables this module to run on page load
run on call
run on call is the function name we can give this current function
we can call this function to occur ie. by using a callback | function
for an in depth on callback and run on call see here
code modification | variable
add function variables ie. Call_Disable_1(myVariable)
this function is beyond the scope of this manual see here
code modification | javascript | after
add javascript, further enhancing this function by adding custom code
this function is beyond the scope of this manual see here
code modification | javascript | before
add javascript, further enhancing this function by adding custom code
this function is beyond the scope of this manual see here
__________________________________________________________________________
more info on module | tubeplayer see here Overview
more info on module | tubeplayer see here Online Tutorials
more info on module | tubeplayer see here Overview
more info on module | tubeplayer see here Online Tutorials
PLUGIN
MODULE TUBEPLAYER - PROPERTIES
b5.6
b5.6
CALLBACK:
event | on playing - cued - unstarted - paused - end - quality change - invalid parameter
add a function on player controls - more info see here
the callback function in full range is beyond the scope of this manual
for an in depth on callback and run on call see here
• fn: onQualityChange: function (quality) { }
quality = returns current movie quality - default, small, medium, large, hd720
explain short:
cued = player is called in stopped state
unstarted = player is called in cue/stopped state and if controlled starts play
end = on movie end
invalid parameter = on invalid - external - parameter
NOTE: fires on external parameters only!
use this ie. on external cued videos > if not found = invalid parameter
event | on playing - cued - unstarted - paused - end - quality change - invalid parameter
add a function on player controls - more info see here
the callback function in full range is beyond the scope of this manual
for an in depth on callback and run on call see here
• fn: onQualityChange: function (quality) { }
quality = returns current movie quality - default, small, medium, large, hd720
explain short:
cued = player is called in stopped state
unstarted = player is called in cue/stopped state and if controlled starts play
end = on movie end
invalid parameter = on invalid - external - parameter
NOTE: fires on external parameters only!
use this ie. on external cued videos > if not found = invalid parameter
b5.62
response | ratio
set the ratio of the movie to maintain a scaled ratio display, usually 16/9, adjust if necessary
•••• var: non-string
response | fullscreen | mode
this selector option changes the method in which the mode auto fullscreen operates
window = window level
selector = object level
more info into the different modes see here
set the ratio of the movie to maintain a scaled ratio display, usually 16/9, adjust if necessary
•••• var: non-string
response | fullscreen | mode
this selector option changes the method in which the mode auto fullscreen operates
window = window level
selector = object level
more info into the different modes see here
b5.62