Player V3 JavaScript API Functions

Player V3 JavaScript functions can be used to customize the player behavior and appearance.

Note: Ooyala Player V3 has been deprecated and is scheduled to be disabled. For details and alternatives, see the OVP Release Notes.

All Ooyala APIs are shown at Ooyala API Documentation.

The Player JavaScript APIs are fully described at Player JavaScript API Reference.

The following table briefly describes the Player JavaScript API Functions, and includes links to their complete descriptions contained in the Player JavaScript API Reference.
Function Description
create Creates a player object and attaches it to the specified element.
destroy Destroys the item.
getBitrateInfo Retrieves all bitrate information, including bitrates, bitrate qualities, target bitrates, and target bitrate qualities.
getBitrateQualitiesAvailable Retrieves the bitrate quality encodings that are available.
getBitratesAvailable Retrieves an array with the total number of bitrates, in kbps, or an empty array when the number of encodings is not available.
getBufferLength Retrieves the current size of the buffer in seconds.
getCurrentItem (Deprecated) Retrieves an object describing the current video.
getCurrentItemClosedCaptionsLanguages Retrieves a list of supported closed captions languages for the currently playing item.
getCurrentItemDescription (Deprecated) Retrieves the description of the current video.
getCurrentItemEmbedCode Retrieves the embed code for the current player.
getCurrentItemTitle (Deprecated) Retrieves the title of the current video.
getErrorCode Retrieves the current error code if it exists.
getErrorText (Deprecated) Retrieves a string corresponding to the current error code.
getFullscreen (Deprecated) Determines whether the player is in full screen mode.
getPlayheadTime Retrieves the playhead position in seconds.
getState Retrieves the current player state.
getTargetBitrate Retrieves the target bitrate, in kpbs, if it was previously set.
getTargetBitrateQuality Retrieves the target bitrate quality.
getTotalTime (Deprecated) Retrieves the total duration, in milliseconds, of the video.
getVolume Retrieves the current volume on a best-effort basis according to underlying device limitations.
isolate Isolates the specified player for debugging.
pause Pauses the current video playback.
pauseMovie (Deprecated) Pauses the current video playback.
play Plays the current video and the entire asset including ads, or queues it for playback if the video is not ready.
playMovie (Deprecated) Plays the current video and the entire asset including ads, or queues it for playback if the video is not ready.
seek Seeks to the specified number of seconds from the beginning.
setClosedCaptionsLanguage Sets the language of the closed captions (CC) that will be shown in the player.
setCurrentItemEmbedCode (Deprecated) Sets the embed code for the current player.
setEmbedCode Sets the embed code for the current player.
setPlayheadTime (Deprecated) Seeks to the specified number of seconds from the beginning.
setTargetBitrate Sets the target bitrate, in kbps.
setTargetBitrateQuality Sets the target bitrate quality.
setVolume Sets the current volume on a best-effort basis according to the underlying device limitations.
shouldDisplayCuePointMarkers (Deprecated) When called while a player is playing, this Boolean function shows or hides cue point markers on the scrubber bar during ad playback.
subscribe Subscribes to a specified event.
toggleInfoPanel (Deprecated) Toggles the visibility of the info screen.
toggleSharePanel (Deprecated) Toggles the visibility of the player share screen.

해당 내용이 도움 되었습니까?