How to Map OSMF Events to Equivalent KDP3 Notifications

Printer-friendly version
Audience / Tech Expertise: 

OSMP events may be mapped to notifications withing the KDP 3. Event names may change with new versions of the OSMF, however the names of the KDP notifications will remain the same. Check the KDP documentation for more information about notifications and their usage.

OSMP EVENT NAME NOTIFICATIONS WITHIN THE KDP3
DisplayObjectEvent.DISPLAY_OBJECT_CHANGE MEDIA_VIEWABLE_CHANGE ("mediaViewableChange")
DisplayObjectEvent.MEDIA_SIZE_CHANGE  No notification fired
MediaPlayerStateChangeEvent.MEDIA_PLAYER_STATE_CHANGE PLAYER_STATE_CHANGE ("playerStateChange"), body of the notification contains the state ("uninitialized", "loading", "ready", "playing", "paused", "stopped", "buffering")
TimeEvent.CURRENT_TIME_CHANGE PLAYER_UPDATE _PLAYHEAD ("playerUpdatePlayhead") body of the notification contains the current time of the player.
AudioEvent.VOLUME_CHANGE  VOLUME_CHANGED ("volumeChanged"), body of the notification contains the new volume.
BufferEvent.BUFFER_TIME_CHANGE  BUFFER_PROGRESS ("bufferProgress"), body of the notification contains the new buffered time
BufferEvent.BUFFERING_CHANGE BUFFER_CHANGE ("bufferChange"), body of the notification contains the buffering state (true/false)
MediaErrorEvent.MEDIA_ERROR MEDIA_ERROR ("mediaError")
LoadEvent.BYTES_TOTAL_CHANGE BYTES_TOTAL_CHANGE ("bytesTotalChange") , body of the notification contains the new total bytes value.
LoadEvent.BYTES_LOADED_CHANGE BYTES_DOWNLOADED_CHANGE ("bytesDownloadedChange"), body of the notification contains the downloaded bytes
TimeEvent.DURATION_CHANGE DURATION_CHANGE ("durationChange"), the body of the notification contains the new duration.
DynamicStreamEvent.SWITCHING_CHANGE SWITCHING_CHANGE

 

FAQ Type: 
(34182 reads)