Enable text
Returns true if text tracks are enabled, false otherwise.
true if text tracks are enabled, false otherwise
Select track
Sets the default audio language when loading a stream
the default audio language code based on ISO 639-2
the default audio track kind
Sets the default text tracks enable state when loading a stream
true if text tracks are enabled by default
Sets the default text language when loading a stream
the default text language code based on ISO 639-2
the default text track kind
Enable/disable 3D audio
true to enable 3D audio, false otherwise
Enable/disable bitrate level
true to display bitrate menu list
Get current bitrate level list
bitrate list
Get current bitrate identifier
the identifier of current bitrate set. If empty, no bitrate level is configured
Is bitrate level enabled
true if bitrate level is enabled false otherwise
Reset bitrate level configuration. The bitrate list will be cleaned
Set bitrate level list
: the list of bitrate level
: the default bitrate item identifier
: the minimum bitrate item identifier
Enable display of csa panel on stream load. Default is false
true to enable csa display on load, false otherwise
Cast an orange media file This can be done only if cast is enbaled and is CONNECTED state
: the orange media cast to be casted
Only on Chrome Browser Enable cast function. By default, cast function is not enabled. Be careful, once enabled, you cannot disable it (restriction due to the way cast context is created, by Google)
: application id to start
Get cast state
cast state
Display info banner
Get channels data This is used for live
information about current channel
Get the current clock offset between server backend and local time of the user device
offset time offset in seconds
Get current content meta data This can be used for both ondemand and live
information about current content (can be null)
Get current channel information This is used for live
information about current channel
Set channels informations, to display a VZL for instance This is used for live
: information about channels
Set the clock offset between server time and the local time of the user device
: offset in seconds
Set current content meta data, to display informations about video. This can be used for both ondemand and live
: information about current content
Set current channel information, to display informations about current channel (logo, name ...) This is used for live
: information about current channel
Set configuration of info display panel
: the configuration (can be null)
Give a playlist of video content This is used for ondemand
: the playlist
Add a custom action button to toolbar
: the action
Remove a custom action button from toolbar
: the action id to be removed
Remove all custom action buttons from toolbar
Show/hide info panel button from control bar
: true to show the button, false otherwise
Enable/disable fullscreen application handling (in electron for example ) If true, fulscreen will have to be managed by application
true to enable fullscreen application mode
Enable/disable fullscreen mode
true to enable fullscreen mode, false otherwise
Check if one player ui is in fullscreen mode
true if fullscreen mode is activated
Inform oneplayerui that application is fullscreen
promise
Set one player ui in fullscreen mode
promise
Add a custom action button to header
: the action
Remove a custom action button from header
: the action id to be removed
Remove all custom action buttons from header
Delete current message box
Display an error message If another message box is displayed, the previous one is dismissed
Display a warning message If another message box is displayed, the previous one is dismissed
Open and display a message box If another message box is displayed, the previous one is dismissed
Display a warning message If another message box is displayed, the previous one is dismissed
Show/hide next content (chapter, episode...) button in header control bar When loading a new stream, the button is reinitialized and hidden
: true to show the button, false otherwise
: the button text to display ("Episode suivant" by default)
Enable/disable caching last media settings such as last audio and text selected language and text tracks state. When enabling caching, the settings are stored in local storage (if enabled) When disable caching, all stored settings are removed from local storage
true to enable, false to disable.
the local storage key for storing media settings (if enabled). Default value is 'oneplayer-media-settings'
Give focus to player
Set VOPlayer license. This is mandatory to use oneplayerui. You must ask for a licence
Enable/disable pip mode
true to enable pip mode, false otherwise
Check if one player ui is in pip mode
true if pip mode is activated
Set one player ui in pip mode
promise
Enable pause of video when timeline is being dragged (true by default) If true, this has effect only if stream has thumbnails. This parameter has priority over seekPreview parameter.
Enable seek
Enable preview video when seeking (false by default)
Get player current time
Get tooltip when seek is disabled
Get player duration
Get player state
Current Player State
Get video element
Is pause of video enabled when timeline is being dragged (true by default)
Get enabled seek flag
true if seek is enabled , false otherwise
Is preview video enabled when seeking
true show preview video while dragging the progress bar thumb , false otherwise
Load/open a video stream and start playback.
Load current playlist.
index of item to start
Pause playback of the media.
Play/resume playback of the media.
Reload stream (this will reload the stream without displaying launching img...). It can be used to restart a stream after an error for example
Seek the media to the new time. For LIVE streams, this function can be used to perform seeks within the DVR window if available.
the new time value in seconds
When seek is disabled, a tooltip can be dispalyed to explain why
an optional string message to be displayed in progress bar tooltip, to explain why seek is disabled
Stops/reset the playback of the video stream.
Update (live) stream manifest URL stream. The manifest URL has to be refreshed once the event https://oneplayerui.noprod-b.kmt.orange.com/doc/enums/_src_types_events_.oneplayeruievents.html#live_manifest_update has been triggered. This enables maintaining live manifest updates while original url may have been expired (token).
the new manifest urk to be used by the player when updatng manifest
Set level for filtering internal player log messages.
the log level
Show/Hide player debug window. By default, debug window is disabled
Enable/disable record button
true to display record button, false otherwise
Get record button state
true if is recording, false otherwise
Is Record button enabled
true if record button is enabled false otherwise
Update record button state
get current service type for component. This will change control bar and some other UI components aspect
type : the current service type
Initialize the component
a promise which is resolved if player creation is successfull In case of failure, the promise is rejected with :
Gets initialisation state
true if component is initialised, false otherwise
Reset the component NB : You must recall init method if you want to reuse the component
Set level for filtering log messages.
the log level
Set configuration parameters that are specific to VOPlayer.
Use this method if you want to override some default parameter value(s).
PlayerConfiguration documentationdashConfiguration), please refer to PlayerSettings documentationSet current service type for component. This will change control bar and some other UI components aspect
: the new service type
Returns current style
current style
Set current style
the new style
Deacrease volume with 0.1 step (do the same as Down arrow)
Returns state of mute
true if mute is active, false otherwise
Returns current volume level (between 0 and 1)
current volume
Increase volume with 0.1 step (do the same as Up arrow)
Set mute for the player
true to mute the player, false otherwose
Sets current volume (between 0 and 1)
the new volume
Generated using TypeDoc
API of oneplayerui.js