Optional configuration: UIPlayerConfigurationReadonly abrThe adaptive bitrate configuration.
Optional Readonly adsThe ads API.
- Only available with the feature 'ads'.
Optional Readonly analyticsThe analytics API.
Optional Readonly audioThe web audio API.
- Only available with the feature 'webaudio'.
List of audio tracks of the current source.
Whether the player should immediately start playback after source change.
- To autoplay with sound on certain platforms, ChromelessPlayer.prepareWithUserAction must be called at least once.
- To autoplay without sound, PlayerConfiguration.mutedAutoplay must be configured.
Readonly bufferedReturns a TimeRanges object that represents the ranges of the media resource that the player has buffered.
Readonly canvasThe canvas of the player.
Optional Readonly castThe cast API.
- Only available with the feature 'airplay' or 'chromecast'.
Readonly clipThe clip API.
Whether the player controls are visible.
The current playback position of the media, as a timestamp.
- The relation between ChromelessPlayer.currentProgramDateTime and ChromelessPlayer.currentTime is determined by the manifest.
The current playback position of the media, in seconds.
The duration of the media, in seconds.
- On source change, duration becomes available after ChromelessPlayer.readyState is at least 1 (HAVE_METADATA).
The HTML element containing the player.
Whether playback of the media is ended.
- Playback is ended when the current playback position is at the end of the media, and the player does not ChromelessPlayer.loop.
The last error that occurred for the current source, if any.
use ChromelessPlayer.errorObject instead
The last error that occurred for the current source, if any.
- This will equal the ErrorEvent.errorObject property from the last ErrorEvent.
Optional Readonly hespThe HESP API.
- Note: This API is in an experimental stage and may be subject to breaking changes.
- Only available with the feature 'hesp'.
Optional imagineThe Imagine API.
- Only available with the feature 'imagine'.
The latency manager for low latency live playback.
Whether playback of the media is looped.
- When playback is looped, upon reaching the end of the media, playback immediately continues at the start of the media.
- Looped media is never ChromelessPlayer.ended.
Readonly metricsThe metrics API.
Whether audio is muted.
- This affects capabilities of ChromelessPlayer.autoplay.
Readonly networkThe network API.
Whether the player is paused.
The playback rate of the media.
<br/> - `playbackRate = 0.70` will slow down the playback rate of the media by 30%.
<br/> - `playbackRate = 1.25` will speed up the playback rate of the media by 25%.
- Playback rate is represented by a number where 1 is default playback speed.
- Playback rate must be a positive number.
- It is recommended that you limit the range to between 0.5 and 4.
Returns a TimeRanges object that represents the ranges of the media resource that the player has played.
The poster of the current source.
- An empty string ('') clears the current poster.
- The SourceConfiguration.poster has priority over this poster.
The preload setting of the player.
Readonly presentationThe presentation API.
Optional presentationThe presentation mode of the player.
Superseded by Presentation.currentMode and Presentation.requestMode.
'inline'
The ready state of the player, represented by a value from the following list:
- 0 (HAVE_NOTHING): The player has no information about the duration of its source.
- 1 (HAVE_METADATA): The player has information about the duration of its source.
- 2 (HAVE_CURRENT_DATA): The player has its current frame in its buffer.
- 3 (HAVE_FUTURE_DATA): The player has enough data for immediate playback.
- 4 (HAVE_ENOUGH_DATA): The player has enough data for continuous playback.
- See the HTML Media Specification
Optional Readonly relatedThe related content UI API.
- Only available with the feature 'relatedcontent'.
Returns a TimeRanges object that represents the ranges of the media resource that are seekable by the player.
- On source change, seekable becomes available after ChromelessPlayer.readyState is at least 1.
Whether the player is seeking.
Optional Readonly socialThe social sharing UI API.
- Only available with the feature 'social'.
The current source which describes desired playback of a media resource.
- Changing source might ChromelessPlayer.preload and ChromelessPlayer.autoplay.
- Changing source will ChromelessPlayer.stop the previous source.
The current URL of the media resource.
- Prefer ChromelessPlayer.source instead.
Readonly textThe text track style API.
List of text tracks of the current source.
Readonly uiThe Video.js player on which the UI is built.
Unique ID of the player.
Optional Readonly upnextThe up next UI API.
- Only available with the feature 'upnext'.
Optional Readonly verizonThe Verizon Media API.
- Only available with the feature 'verizonmedia'.
The height of the active video rendition, in pixels.
List of video tracks of the current source.
The width of the active video rendition, in pixels.
Optional Readonly visibilityThe visibility API.
- Only available with the feature 'visibility'.
The volume of the audio.
<br/> - `volume = 0.7` will reduce the audio volume of the media by 30%.
- Volume is represented by a floating point number between 0.0 and 1.0.
Optional Readonly vrThe VR API.
- Only available with the feature 'vr'.
Optional Readonly yospaceThe Yospace API.
- Only available with the feature 'yospace'.
Add the given listener for the given event type(s).
The type of the event.
The callback which is executed when the event occurs.
Prepare the player to ChromelessPlayer.autoplay on platforms where autoplay is restricted without user action.
- Any invocation must happen on user action.
- Affected platforms include all mobile platforms and Safari 11+.
Remove the given listener for the given event type(s).
The type of the event.
The callback which will be removed.
Set current source which describes desired playback of a media resource.
Superseded by ChromelessPlayer.source.
Stop playback.
- All resources associated with the current source are released.
- The player can be reused by setting a new ChromelessPlayer.source.
Generated using TypeDoc
The player API extended with UI functionality.
Remarks
- Only available with the feature
'ui'.