events.md

UI Events

Events List
UI_CLICKED
UI_VISIBILITY_CHANGED
UI_PRESET_CHANGE
USER_CLICKED_PLAY
USER_CLICKED_PAUSE
USER_CLICKED_REWIND
USER_CLICKED_LIVE_TAG
USER_CLICKED_MUTE
USER_CLICKED_UNMUTE
USER_CHANGED_VOLUME
USER_SELECTED_CAPTION_TRACK
USER_SHOWED_CAPTIONS
USER_HID_CAPTIONS
USER_SELECTED_AUDIO_TRACK
USER_SELECTED_QUALITY_TRACK
USER_ENTERED_FULL_SCREEN
USER_EXITED_FULL_SCREEN
USER_SELECTED_CAPTIONS_STYLE
USER_SELECTED_SPEED
USER_SEEKED

Events

UI_CLICKED

Fires on any user interaction with the UI.

UI_VISIBILITY_CHANGED

Fires when the UI visibility state changes from visible to hidden or from hidden to visible.

payload parameters:

Name	Type	Description
visible	boolean	True when the UI is shown, false when the UI is hidden

UI_PRESET_CHANGE

Fires when preset change.

payload parameters:

Name	Type	Description
from	string	Preset name before change
to	string	Preset name after change

GUI_RESIZE

Fires when the gui resize.

payload parameters:

Name	Type	Description

PLAYER_RESIZE

Fires when the player resize.

payload parameters:

Name	Type	Description

VIDEO_RESIZE

Fires when the video resize.

payload parameters:

Name	Type	Description

USER_CLICKED_PLAY

Fires when the user initiated play by the UI.
It will fires neither by clicking the play button or by clicking the video area.

USER_CLICKED_PAUSE

Fires when the user initiated pause by the UI.
It will fires neither by clicking the pause button or by clicking the video area.

USER_CLICKED_REWIND

Fires when the rewind button has been clicked by the user.

payload parameters:

Name	Type	Description
from	number	The playback time before the click
to	number	The playback time after the click

USER_CLICKED_LIVE_TAG

Fires when the live tag button has been clicked by the user.

USER_CLICKED_MUTE

Fires when the user clicked the volume button and changed his state to mute.

USER_CLICKED_UNMUTE

Fires when the user clicked the volume button and changed his state to unmute.

USER_CHANGED_VOLUME

Fires when the user dragged the volume bar and changed its value.

payload parameters:

Name	Type	Description
volume	number	The new volume

USER_SELECTED_CAPTION_TRACK

Fires when the user selected a caption from the Captions dropdown.

payload parameters:

Name	Type	Description
captionTrack	Object	The selected caption track

USER_SHOWED_CAPTIONS

Fires when the user showed the captions by the CC button.

USER_HID_CAPTIONS

Fires when the user hid the captions by the CC button.

USER_SELECTED_AUDIO_TRACK

Fires when the user selected an audio track from the Audio dropdown.

payload parameters:

Name	Type	Description
audioTrack	Object	The selected audio track

USER_SELECTED_QUALITY_TRACK

Fires when the user selected quality from the Quality dropdown.

payload parameters:

Name	Type	Description
qualityTrack	Object	The selected quality track

USER_ENTERED_FULL_SCREEN

Fires when the UI is entered to full screen mode due to user gesture.
This can be done neither by clicking the full screen button or by double clicking the video area.

USER_EXITED_FULL_SCREEN

Fires when the UI is exited from full screen mode due to user gesture.
This can be done neither by clicking the full screen button or by double clicking the video area.

USER_SELECTED_CAPTIONS_STYLE

Fires when the user selected a captions style from the Advanced Captions Settings menu.

payload parameters:

Name	Type	Description
captionsStyle	Object	The selected captions style

USER_SELECTED_SPEED

Fires when the user selected a certain speed from the Speed dropdown.

payload parameters:

Name	Type	Description
speed	number	The selected speed

USER_SEEKED

Fires when the user initiated seek by dragging the seek bar.

payload parameters:

Name	Type	Description
from	number	The playback time before the seek
to	number	The playback time after the seek