Kaltura KDP API Compatibility

From HTML5 Video
Jump to: navigation, search
Event
KDP
HTML5
Description
jsCallbackReady
Yes
Yes
 
Events Listeners
 
 
 
kdpEmpty
Yes
Yes
Dispatched when the KDP layout has completed construction, but no media was loaded into the media player.
kdpReady
Yes
Yes
Dispatched when the KDP is Ready – meaning that the layout has completed construction and a media was loaded into the media player.
entryReady
Yes
Yes
Dispatched when the KDP is Ready – meaning that the layout has completed construction and a media was loaded into the media player.
mediaReady
Yes
Yes
The loadable media element has been constructed and awaits loading.
playerPlayed
Yes
Yes
Sent when the player has started playing the entry. (meaning the player is already in the “playing” state”).
playerPlayEnd
Yes
Yes
Dispatched when the media has reached the end - meaning currentTime == duration
startUp
Yes
 
The first command that register the main proxys and main view mediator
durationChange
Yes
Yes
The player dispatches this event when the duration of the media loaded into the OSMF media player has changed (for instance, when a new media is loaded).
initiatApp
Yes
 
Start the init macro commands
changeMedia
Yes
Yes
Start the init of change media macro commandsBody of notification is an object of the following structure : {entryId : String, flavorId : String, preferedFlavorBR the selected bitrate for the entry) : Number}
cleanMedia
Yes
Yes
Cleans the media in case of change media and entryId== -1
skinLoaded
Yes
 
Dispatched when the skin is loaded
skinLoadFailed
Yes
 
Skin load failed
entryFailed
Yes
Yes
Get Entry failed
sourceReady
Yes
 
When the source is ready we can set the media element to the media player
loadMedia
Yes
 
 
mediaLoading
Yes
 
 
mediaReady
Yes
Yes
The loadable media element has been constructed and awaits loading.
mediaUnloaded
Yes
 
 
mediaLoadError
Yes
Yes
 
mediaError
Yes
Yes
 
rootResize
Yes
 
The KDP has completed resizing
mediaViewableChange
Yes
 
Used to know when OSMF Media Player is viewable. Fired when triggered by OSMF event DISPLAY_OBJECT_CHANGE.
pre1Start
Yes
 
Strictly INTERNAL notification fired to trigger custom advertising plug-in action into beginning to play a pre-roll sequence.
post1Start
Yes
 
Strictly INTERNAL notification fired to trigger custom advertising plug-in action into beginning to play a post-roll sequence.
doPause
Yes
Yes
Command the player to pause;
doPlay
Yes
Yes
Command the player to play
doPlayEntry
Yes
 
 
doStop
Yes
Yes
Do stop command to the kplayer. Pause and move the playhead to 0
doReplay
Yes
Yes
Dispatched when a replay event occurs
doSeek
Yes
Yes
Do seek command to the kplayer. Additional data - number
doIntelligentSeek
Yes
 
Yes
doSwitch
Yes
 
Do switch command for switching manual switching between mbr streams within an rtmp dynamic stream resourceBody of the notification is:preferedFlavorBitrate : Number and carries the prefered bitrate to switch to.
layoutReady
Yes
 
Dispatched when the init macro command is done and the layout has completed contruction.
playerContainerReady
Yes
 
 
playerReady
Yes
Yes
Dispatches when player ready with content loaded into the media player.
playerStateChange
Yes
Yes
Indicates the state the player has ALREADY passed to - the states are “uninitialized”, “loading”, “ready”, “buffering”, “playing”, “paused”, and “playbackError”.Body of the notification : playerState : String
playerPaused
Yes
Yes
Sent when the player has paused the media (meaning the player is already in the “paused” state).
playerSeekStart
Yes
Yes
Dispatched when the player seeking property changed to true - meaning, when the seek operation has already started.
playerSeekEnd
Yes
Yes
Dispatched when the player seeking property changed to false – meaning the seek operation has already ended.
playerUpdatePlayhead
Yes
Yes
Dispatched every time the entry time has updated - occurs at a regular interval of about 0.3 of a second.Body of the notification : currentTime : Number;
playerDimensionChange
Yes
 
 
openFullScreen
Yes
Yes
open full screen
closeFullScreen
Yes
Yes
close full screen command
changeVolume
Yes
Yes
change volume. Body of the notification - volume value (0 to 1)
volumeChanged
Yes
Yes
Fired when the volume of the media has been changed in the OSMMF media player level (meaning the volume has actually changed).
enableGui
Yes
 
enable/disable gui. Addition data - Object{guiEnabled : Boolean,enableType : String}
fastForward
Yes
 
 
stopFastForward
Yes
 
 
bytesDownloadedChange
Yes
 
Notify the current and the previous value of bytesDownloaded
bytesTotalChange
Yes
 
Dispatched by the player when the value of the property "bytesTotal" has changed.
bufferProgress
Yes
 
Dispatched when the player has buffered the limit of buffering time specified for it.
bufferChange
Yes
 
Dispatched when the player start or stop buffering
playerDownloadComplete
Yes
 
 
endEntrySession
Yes
 
 
endPreSession
Yes
 
 
endPostSession
Yes
 
 
durationChange
Yes
Yes
The player dispatches this event when the duration of the media loaded into the OSMF media player has changed (for instance, when a new media is loaded).
hasCloseFullScreen
Yes
 
The player (already) left full-screen mode.
hasOpenedFullScreen
Yes
 
The player has (already) gone into full-screen mode.
switchingChange
Yes
 
Dispatched when the KDP has started or finished switching to a new bitrate flavor.
scrubberDragStart
Yes
 
The user started dragging the scrubber.
scrubberDragEnd
Yes
 
The user stopped dragging the scrubber.
alert
Yes
Yes
Pop up an alert. arguments: message, title
showUiElement
Yes
 
 
cancelAlerts
Yes
Yes
 
enableAlerts
Yes
Yes
 
freePreviewEnd
Yes
Yes
 
Send Notifications
 
 
 
doPause
Yes
Yes
Command the player to pause;
doPlay
Yes
Yes
Command the player to play;
changeMedia
Yes
Yes
Start the init of change media macro commandsBody of notification is an object of the following structure : {entryId : String, flavorId : String, preferedFlavorBR (the selected bitrate for the entry) : Number}
cleanMedia
Yes
Yes
Cleans the media in case of change media and entryId== -1
initiatApp
Yes
 
Start the init macro commands
loadMedia
Yes
 
 
doPlayEntry
Yes
 
 
doStop
Yes
Yes
Do stop command to the kplayer. Pause and move the playhead to 0
doSeek
Yes
Yes
Do seek command to the kplayer. Additional data - number
doIntelligentSeek
Yes
Yes
 
doSwitch
Yes
 
Do switch command for switching manual switching between mbr streams within an rtmp dynamic stream resource Body of the notification is:preferedFlavorBitrate : Number and carries the prefered bitrate to switch to.
changeVolume
Yes
Yes
change volume. Body of the notification - volume value (0 to 1)
enableGui
Yes
 
enable/disable gui. Addition data - Object{guiEnabled : Boolean,enableType : String}
fastForward
Yes
 
 
stopFastForward
Yes
 
 
alert
Yes
 
Pop up an alert. arguments: message, title
showUiElement
Yes
 
 
cancelAlerts
Yes
Yes
 
enableAlerts
Yes
Yes
 
mediaProxy.entry
Yes
Yes
 
configProxy.flashvars.autoPlay
Yes
Yes
 
playerStatusProxy.kdpStatus
Yes
Yes
 
showHideClosedCaptions
Yes
Yes
 
showClosedCaptions
>Yes
Yes
 
hideClosedCaptions
Yes
Yes
 
Playlist notification
( html5 > 1.6.11 )
 
 
 
playlistPlayPrevious
Yes
Yes
Play the previous item in a playlist.
playlistPlayNext
Yes
Yes
Play the next item in a playlist.
loadPlaylist
Yes
Yes
Load a new playlist. Body: kplName=kaltura playlist name, kplUrl=kaltura playlist Available only in KDP v3.5.52 and later
playlistFirstEntry
Yes
Yes
The playlist is playing the first entry now.
playlistLastEntry
Yes
Yes
The playlist is playing the last entry now.
playlistMiddleEntry
Yes
Yes
The playlist is playing one of the intermediate entries now.
playlistDone
Yes
Yes
This is the last entry in the playlist.


playlistReady
Yes
Yes
The playlist data provider is ready.
playlistsListed
Yes
 
playlistAPIMediator is registered.