Player Events
This documentation applies to player version V0.8.x and higher. Please refer to API, section Instantiation in order to learn how to add and remove listeners.
scheduleLoading
Triggered in case of an AJAX call fetching an external playlist from server has been initiated
scheduleModified
Fired whenever an item has been added to or removed from schedule after the player has been initialized successfully.
scheduled
The initial scheduling process has finished and the player is ready for action.
configModified
Fired if player configuration has been altered as the result of an AJAX call (e.g. in conjunction with “schduleLoading”).
item (itemIndex)
Triggered once a new item got the “current” focus.
displayReady
Triggered as soon as the media display for the current item has been successfully initialized. May result in a poster-image or media playback.
pluginsReady
Triggered as soon as all plugins are ready to go for the current item.
ready
Triggered as soon as the player is ready for action and ready to play the current item. This is the case after “displayReady” and “pluginsReady” has been fired. Depending on “autostart” or “continuous” config this may either result in an IDLE or a PLAYING state.
starting
The player got triggered to start and synchronizes the model with the controller.
start
The media playback started and the first frame has been displayed.
state (string)
Triggered when ever the state of the current playback component changes to one of the following:
possible states
IDLE The playback component is waiting for user-interaction and has not started playback yet. Usually a poster-image is shown at this state.
AWAKENING The playback component begins playback for the very first time and initializes. This may be either if “autoplay” is FALSE and the user clicked “start” or the player is configured to AUTOPLAY and starts automatically.
PLAYING The playback component is currently playing (SNAFU).
PAUSED The playback component has been paused by the user or via an external JS API call.
STOPPED The playback component has stopped playing either because of user-interaction or close of the corresponding browser window.
COMPLETED The current media item has been played back completely.
ERROR An error occured.
buffer (string)
Triggered when ever the buffer-state of the current playback component changed.
possible states
EMPTY The buffer under-run, the playback component has been paused and new media data is being buffered.
FULL Enough data has been buffered in order to play the current media item back.
volume (currentVolume:float)
Triggered on change of volume of the current playback component. Is also triggered during the playback component´s initialization process.
mute
(> V0.9.05) Fired once the player gets muted (volume equal 0).
unmute
(> V0.9.05) Fired once the player gets unmuted (volume gets adjusted from 0 to >0).
resume
(> V0.9.05) Fired once the current media continues playback after a prior “PAUSED” state.
time (float)
Continuously triggered during change of play-head position but at a maximum of a 500 millisecond interval.
progress (float)
Continuously triggered during change of buffer-load but at a maximum of a 500 millisecond interval. Will stop once the media file has been completely buffered or became available for random-seeking.
seek (float)
The user or a script sent the “setSeek” command and the player component does everything necessary in order to continue playback from the specified position.
fullscreen (boolean)
Triggered whenever the player switches from or into fullscreen / full viewport mode.
resize
The document or the player itself has been resized.
scale
Triggered once the current media (video or image) has been scaled to fit the player dimensions.
qualitychange
The playback-quality has been changed.
detach
The current playback component detached the actual media and destroyed itself successfully.
mousemove
The user moved the mouse while the pointer is over the player instance.
mouseenter
The user moved the mouse pointer over the player instance.
leftclick / rightclick / middleclick (Click:event
Triggered whenever the player either receives a left-, right- or middle- click.
mouseleave
The user moved the mouse beyond the borders of the player instance.
key (KeydownEvent:event)
The player instance has the focus and the user hit a key on keyboard (or remote control). Note that most keys (e.g. alphanumeric) will result in a keyCode equal 0 due to underlying security restrictions.
done
Triggered if the current item is the last one scheduled and reached the “COMPLETED” state ⇒ “playlist completely played back”



