Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: improved formatting and wording
Section
Column

Transport Controls

Play

Pause

Stop

Forward

Rewind

Column

Volume Controls

Set Volume

Toggle Mute

Column

Timing

Get Current Time

Get Duration

Get Buffered Time

Column

Video Data

Get Video Title

Switch Video

Start video

 




Anchor
play
play

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Play

Begin playing the video at the (optionally

: at the second given

) specified time.

PanelbgColor#DCDCDC
Code Block
language
jsthemeConfluenceborderStylenone
text
player
Player
.play(time);
ParameterData TypeDescription
timeinteger

default = null

optional:

The time in seconds that

the video should begin playing

.

from this time (in seconds)

default = null


Anchor
pause
pause

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Pause

video

Pauses

a played-out

the video; there is no effect if the

player Stops a played-out video;

Player is already paused.

Code Block
language
Panel
bgColor#DCDCDC
languagejs
themeConfluence
borderStylenone
Player.pause()

Stop video

text
player.pause();


Anchor
stop
stop

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Stop

Stops the video; 

no effect if the

player

Player is already stopped.

PanelbgColor
Code Block
#DCDCDC
language
js
text
player
themeConfluenceborderStylenonePlayer
.stop();

Set volume

Adjusts volume level in the scale values from 0.0, 0.1, 0.2, ... 1.


Anchor
forward
forward

Panel
borderColor#f2f2f2
bgColor
#DCDCDC
#f2f2f2
languagejsthemeConfluenceborderStylenone

Player.setVolume(volume)

Mute

Toggles the audio on or off.

Panel
bgColor#DCDCDC
languagejs
themeConfluence
borderStylenone
Player.toggleMute()

Jump forward

Jump forward by milliseconds given.

Forward

Fast forward the video by the number of milliseconds given.

Code Block
languagetext
player.forward(millis);
ParameterData TypeDescription
millisintegerinterval in milliseconds


Anchor
rewind
rewind

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Rewind

Rewind the video by the number of milliseconds given.

Code Block
languagetext
player.rewind(millis);
Panel
bgColor#DCDCDC
languagejs
themeConfluence
borderStylenone
Player.forward(millis)
ParameterData TypeDescription
millisinteger
Interval
interval in milliseconds
.


Anchor

Rewind

setVolume
setVolume

Reverse the video by milliseconds given.

Panel
borderColor#f2f2f2
bgColor
#DCDCDC
#f2f2f2
languagejsthemeConfluenceborderStylenonePlayer.rewind(millis)

Set Volume

Sets the volume of a video to a specified level.

Code Block
languagetext
player.setVolume(volume);
ParameterData TypeDescription
millis
volume
integer

Interval in milliseconds.

Get current time

The current playing time in seconds will be returned.

Panel
bgColor#DCDCDC
languagejs
themeConfluence
borderStylenone
Player.getCurrentTime()

Get video length

Returns the video length of the current video.

Panel
bgColor#DCDCDC
languagejs
themeConfluence
borderStylenone
Player.getDuration()

Get buffered time of video

Returns how far the video has been already buffered.

Panel
bgColor#DCDCDC
languagejs
themeConfluence
borderStylenone
Player.getBufferedTime()
floatlevel to set the volume of the video to (range from 0.0 to 1.0 with a step size of 0.1)


Anchor
toggleMute
toggleMute

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Toggle Mute

Toggles the audio on or off.

Code Block
languagetext
player.toggleMute();


Anchor
getCurrentTime
getCurrentTime

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Get Current Time

Returns the current video time in seconds.

Code Block
languagetext
player.getCurrentTime();


Anchor
getDuration
getDuration

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Get Duration

Returns the duration of the current video in seconds.

Code Block
languagetext
player.getDuration();


Anchor
getBufferedTime
getBufferedTime

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Get Buffered Time

Returns the total time of the video that has been buffered in seconds.

Code Block
languagetext
player.getBufferedTime();


Anchor
getVideoTitle
getVideoTitle

Panel
borderColor#f2f2f2
bgColor#f2f2f2

Get Video Title

Get video title

Returns the title of the current video.

panel
Code Block
bgColor
language
#DCDCDCborderStylenonePlayer
text
player.getApi(
'metaData'
"metadata").getVideoTitle();


Anchor
switchVideo
switchVideo

Panel
borderColor#f2f2f2
Switch player sources
bgColor#f2f2f2

Switch Video

Load a video specified by ID.

panel
Code Block
bgColor
language
#DCDCDC
text
Player
player.switchVideo(videoId);
ParameterData TypeDescription
videoIdstringID of the video to be loaded
.