UserEvents | OnePlayerUi.js

User Events definition

Index

Enumeration members

AUDIO_3D_TOGGLED

AUDIO_3D_TOGGLED: = "oneplayerui/user/audio3D/toggle"

User has toogle 3D audio Properties :

property: origin: EventOrigin - event origin
property: state: boolean - the new 3D audio state

AUDIO_CHANGE

AUDIO_CHANGE: = "oneplayerui/user/audio/change"

User has changed the audio language track Properties :

property: origin: EventOrigin - event origin
property: track: TrackInfo - new track info

CHANNEL_NEXT

CHANNEL_NEXT: = "oneplayerui/user/channel/next"

User wants to zap to next channel

CHANNEL_PREVIOUS

CHANNEL_PREVIOUS: = "oneplayerui/user/channel/previous"

User wants to zap to previous channel

CHANNEL_SELECTED

CHANNEL_SELECTED: = "oneplayerui/user/channel"

User has selected a new channel Properties :

property: channel: Channel - selected channel

DRAGGING_TIMELINE

DRAGGING_TIMELINE: = "oneplayerui/user/stream/dragging/timeline"

User has performed a seek using the timeline

FULLSCREEN_ENTER

FULLSCREEN_ENTER: = "oneplayerui/user/fullscreen/enter"

User wants to enter in fullscreen mode

FULLSCREEN_EXIT

FULLSCREEN_EXIT: = "oneplayerui/user/fullscreen/exit"

User wants to exit fullscreen mode

INFO_PANEL_HIDE

INFO_PANEL_HIDE: = "oneplayerui/user/infopanel/hide"

User hides info panel

INFO_PANEL_SHOW

INFO_PANEL_SHOW: = "oneplayerui/user/infopanel/show"

User displays info panel

KEEP_ALIVE

KEEP_ALIVE: = "oneplayerui/user/keepalive"

User is still watching the current stream

LANGUAGES_PANEL_HIDE

LANGUAGES_PANEL_HIDE: = "oneplayerui/user/language/hide"

User hides language panel

LANGUAGES_PANEL_SHOW

LANGUAGES_PANEL_SHOW: = "oneplayerui/user/language/show"

User displays language panel

NEXT_CLICK

NEXT_CLICK: = "oneplayerui/user/next_click"

User has clicked on next button Receiving this event, application has to manage next action (for example next episode to play).

ONEPLAYERUI_CLOSE

ONEPLAYERUI_CLOSE: = "oneplayerui/user/close"

User has clicked on close button of oneplayerui

PIP_ENTER

PIP_ENTER: = "oneplayerui/user/pip/enter"

User wants to enter in pip mode

PIP_EXIT

PIP_EXIT: = "oneplayerui/user/pip/exit"

User wants to exit pip mode

PLAYLIST_ITEM_SELECTED

PLAYLIST_ITEM_SELECTED: = "oneplayerui/user/playlist/item"

User has selected a new playlist item Properties :

property: item: PlaylistItem - selected item

PLAY_IN_LIVE

PLAY_IN_LIVE: = "oneplayerui/user/channel/play_in_live"

User has clicked on play in live mode Receiving this event, application has to call reload method to restart live playing, otherwise video will stay in pause

deprecated

PLAY_PLACEHOLDER_CLICK

PLAY_PLACEHOLDER_CLICK: = "oneplayerui/user/play_placeholder_click"

User has clicked on play placeholder (when video is paused due to autoplay policy) Receiving this event, application has to call reload method to restart live playing, otherwise video will stay in pause. For ondemand, playback start is automatic when clicking on play placeholdern, this event may only be useful for statistics

RECORD_CLICK

RECORD_CLICK: = "oneplayerui/user/record/click"

User has clicked on record button Properties :

property: origin: EventOrigin - event origin

SEEK_QUICK

SEEK_QUICK: = "oneplayerui/user/stream/seek/quick"

User has performed a quickseek

property: forward: boolean - true if forward, false otherwise
property: origin: EventOrigin - origin of the event (mouse, keyboard)

SEEK_TIMELINE

SEEK_TIMELINE: = "oneplayerui/user/stream/seek/timeline"

User has performed a seek using the timeline

SETTINGS_BITRATE_LEVEL_UPDATED

SETTINGS_BITRATE_LEVEL_UPDATED: = "oneplayerui/user/settings/bitrate/update"

User has changed bitrate Properties :

property: origin: EventOrigin - event origin
property: id: string - identifier of bitrate

SETTINGS_PANEL_HIDE

SETTINGS_PANEL_HIDE: = "oneplayerui/user/settings/hide"

User hides settings panel

SETTINGS_PANEL_SHOW

SETTINGS_PANEL_SHOW: = "oneplayerui/user/settings/show"

User displays settings panel

STREAM_PAUSE

STREAM_PAUSE: = "oneplayerui/user/stream/pause"

User has clicked on pause or used space bar to pause the stream

property: origin: EventOrigin - origin of the event (mouse, keyboard)

STREAM_PLAY

STREAM_PLAY: = "oneplayerui/user/stream/play"

User has clicked on play or used space bar to play the stream

property: origin: EventOrigin - origin of the event (mouse, keyboard)

SUBTITLES_BACKGROUND_COLOR_CHANGED

SUBTITLES_BACKGROUND_COLOR_CHANGED: = "oneplayerui/user/subtitles/background"

SUBTITLE - User has changed background color

property: color: Colors - new background color (undefined means that no custom background color is selected)

SUBTITLES_CHANGE

SUBTITLES_CHANGE: = "oneplayerui/user/subtitles/change"

User has changed the subtitles track Properties :

property: origin: EventOrigin - event origin
property: track: TrackInfo - new track info

SUBTITLES_DEFAULT_STYLE

SUBTITLES_DEFAULT_STYLE: = "oneplayerui/user/subtitles/defaultstyle"

SUBTITLE - User has clicked on default style

SUBTITLES_DISABLED

SUBTITLES_DISABLED: = "oneplayerui/user/subtitles/disable"

User has disabled subtitles

SUBTITLES_FONT_CHANGED

SUBTITLES_FONT_CHANGED: = "oneplayerui/user/subtitles/font"

SUBTITLE - User has changed font

property: font: SubtitleFonts - new font (undefined means that no custom font is selected)

SUBTITLES_FONT_COLOR_CHANGED

SUBTITLES_FONT_COLOR_CHANGED: = "oneplayerui/user/subtitles/color"

SUBTITLE - User has changed font color

property: color: Colors - new font color (undefined means that no custom color is selected)

SUBTITLES_FONT_SIZE_CHANGED

SUBTITLES_FONT_SIZE_CHANGED: = "oneplayerui/user/subtitles/size"

SUBTITLE - User has changed font size

property: size: SubtitleSize - new font size (undefined means that no custom font size is selected)

VOLUME_CHANGE

VOLUME_CHANGE: = "oneplayerui/user/volume/change"

User has changed volume Properties :

property: origin: EventOrigin - event origin
property: level: number - new volume level

VOLUME_MUTE

VOLUME_MUTE: = "oneplayerui/user/volume/mute"

User has clicked on mute Properties :

property: muted: boolean - true if muted, false otherwise

VZL_HIDE

VZL_HIDE: = "oneplayerui/user/vzl/hide"

User hides vzl

VZL_NEXT

VZL_NEXT: = "oneplayerui/user/vzl/next"

User has clicked on Next from VZL

VZL_PREVIOUS

VZL_PREVIOUS: = "oneplayerui/user/vzl/previous"

User has clicked on Previous from VZL

VZL_PROGRAMS_NEXT

VZL_PROGRAMS_NEXT: = "oneplayerui/user/vzl/programs/next"

User has clicked on 'Prgrams Next' from VZL

VZL_PROGRAMS_NOW

VZL_PROGRAMS_NOW: = "oneplayerui/user/vzl/programs/now"

User has clicked on 'Programs Now' from VZL

VZL_SHOW

VZL_SHOW: = "oneplayerui/user/vzl/show"

User displays vzl