Page History
Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Start video
Begin playing the video (optionally: at the second given).
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Player.play(time) |
| Parameter | Data Type | Description |
|---|---|---|
| time | integer | default = null optional: The time in seconds that the video should begin playing. |
Pause video
Pauses a played-out video; no effect if the player is already paused.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Player.pause() |
Stop video
Stops a played-out video; no effect if the player is already stopped.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Player.stop() |
Set volume
Adjusts volume level in the scale values from 0.0, 0.1, 0.2, ... 1.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Player.setVolume(volume) |
Mute
Toggles the audio on or off.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Player.toggleMute() |
Jump forward
Jump forward by milliseconds given.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Player.forward(millis) |
| Parameter | Data Type | Description |
|---|---|---|
| millis | integer | Interval in milliseconds. |
Rewind
Reverse the video by milliseconds given.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Player.rewind(millis) |
| Parameter | Data Type | Description |
|---|---|---|
| millis | integer | Interval in milliseconds. |
Get current time
The current playing time in seconds will be returned.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Player.getCurrentTime() |
Get video length
Returns the video length of the current video.
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Player.getDuration() |
Get buffered time of video
Returns how far the video has been already buffered.
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
| Player.getBufferedTime() |
Set play head at given time
Sets the play head at the given time in seconds.| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
| Player.setCurrentTimegetBufferedTime(seconds) |
Get video title
Returns the title of the current video.
| Panel | ||||
|---|---|---|---|---|
| ||||
Player.getApi('metaData').getVideoTitle() |
Switch player sources
Load a video specified by ID.
| Panel | ||
|---|---|---|
| ||
Player.switchVideo(videoId) |
| Parameter | Data Type | Description |
|---|---|---|
| videoId | string | ID of the video to be loaded. |