THEOplayer > ChromelessPlayer

ChromelessPlayer class

The player API.

Signature:

export declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap> 

Constructors

Properties

Methods

Constructor Details

constructor

Constructs a new instance of the ChromelessPlayer class

Signature:

constructor(element: HTMLElement, configuration?: PlayerConfiguration);

Parameters

Property Details

abr

The adaptive bitrate configuration.

Signature:

readonly abr: ABRConfiguration;

ads

The ads API.

Signature:

readonly ads?: Ads;

Remarks

- Only available with the feature 'ads'.

analytics

The analytics API.

Signature:

readonly analytics?: Analytics;

audio

The web audio API.

Signature:

readonly audio?: WebAudio;

Remarks

- Only available with the feature 'webaudio'.

audioTracks

List of audio tracks of the current source.

Signature:

audioTracks: MediaTrackList;

autoplay

Whether the player should immediately start playback after source change.

Signature:

autoplay: boolean;

Remarks

- To autoplay with sound on certain platforms, ChromelessPlayer.prepareWithUserAction() must be called at least once.
- To autoplay without sound, PlayerConfiguration.mutedAutoplay must be configured.

buffered

Returns a TimeRanges object that represents the ranges of the media resource that the player has buffered.

Signature:

readonly buffered: TimeRanges;

canvas

The canvas of the player.

Signature:

readonly canvas: Canvas;

cast

The cast API.

Signature:

readonly cast?: Cast;

Remarks

- Only available with the feature 'airplay' or 'chromecast'.

clip

The clip API.

Signature:

readonly clip: Clip;

currentProgramDateTime

The current playback position of the media, as a timestamp.

Signature:

currentProgramDateTime: Date | null;

Remarks

- The relation between ChromelessPlayer.currentProgramDateTime and ChromelessPlayer.currentTime is determined by the manifest.

currentTime

The current playback position of the media, in seconds.

Signature:

currentTime: number;

duration

The duration of the media, in seconds.

Signature:

duration: number;

Remarks

- On source change, duration becomes available after ChromelessPlayer.readyState is at least 1 (HAVE_METADATA).

element

The HTML element containing the player.

Signature:

element: HTMLElement;

ended

Whether playback of the media is ended.

Signature:

ended: boolean;

Remarks

- Playback is ended when the current playback position is at the end of the media, and the player does not ChromelessPlayer.loop.

error

Warning: This API is deprecated.

use ChromelessPlayer.errorObject instead

The last error that occurred for the current source, if any.

Signature:

error: MediaError | undefined;

errorObject

The last error that occurred for the current source, if any.

Signature:

errorObject: THEOplayerError | undefined;

Remarks

- This will equal the property from the last .

hesp

The HESP API.

Signature:

readonly hesp?: HespApi;

Remarks

- Note: This API is in an experimental stage and may be subject to breaking changes.
- Only available with the feature 'hesp'.

imagine

The Imagine API.

Signature:

imagine?: Imagine;

Remarks

- Only available with the feature 'imagine'.

latency

The latency manager for low latency live playback.

Signature:

latency: LatencyManager;

Remarks

- Can currently only be used with HESP sources.

loop

Whether playback of the media is looped.

Signature:

loop: boolean;

Remarks

- 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.

metrics

The metrics API.

Signature:

readonly metrics: Metrics;

muted

Whether audio is muted.

Signature:

muted: boolean;

Remarks

- This affects capabilities of ChromelessPlayer.autoplay.

network

The network API.

Signature:

readonly network: Network;

paused

Whether the player is paused.

Signature:

paused: boolean;

playbackRate

The playback rate of the media.

Signature:

playbackRate: number;

Remarks

- 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.

Example

- playbackRate = 0.70 will slow down the playback rate of the media by 30%.
- playbackRate = 1.25 will speed up the playback rate of the media by 25%.

played

Returns a TimeRanges object that represents the ranges of the media resource that the player has played.

Signature:

played: TimeRanges;

poster

The poster of the current source.

Signature:

poster: string;

Remarks

- An empty string ('') clears the current poster.
- The SourceConfiguration.poster has priority over this poster.

preload

The preload setting of the player.

Signature:

preload: PreloadType;

presentation

The presentation API.

Signature:

readonly presentation: Presentation;

readyState

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.

Signature:

readyState: number;

Remarks

- See the HTML Media Specification

related

The related content API.

Signature:

readonly related?: RelatedContent;

Remarks

- Only available with the feature 'relatedcontent'.

seekable

Returns a TimeRanges object that represents the ranges of the media resource that are seekable by the player.

Signature:

seekable: TimeRanges;

Remarks

- On source change, seekable becomes available after ChromelessPlayer.readyState is at least 1.

seeking

Whether the player is seeking.

Signature:

seeking: boolean;

source

The current source which describes desired playback of a media resource.

Signature:

source: SourceDescription | undefined;

Remarks

- Changing source might ChromelessPlayer.preload and ChromelessPlayer.autoplay.
- Changing source will ChromelessPlayer.stop() the previous source.

src

The current URL of the media resource.

Signature:

src: string | undefined;

Remarks

- Prefer ChromelessPlayer.source instead.

textTracks

List of text tracks of the current source.

Signature:

textTracks: TextTracksList;

textTrackStyle

The text track style API.

Signature:

readonly textTrackStyle: TextTrackStyle;

uid

Unique ID of the player.

Signature:

uid: number;

verizonMedia

The Verizon Media API.

Signature:

readonly verizonMedia?: VerizonMedia;

Remarks

- Only available with the feature 'verizonmedia'.

videoHeight

The height of the active video rendition, in pixels.

Signature:

videoHeight: number;

videoTracks

List of video tracks of the current source.

Signature:

videoTracks: MediaTrackList;

videoWidth

The width of the active video rendition, in pixels.

Signature:

videoWidth: number;

visibility

The visibility API.

Signature:

readonly visibility?: Visibility;

Remarks

- Only available with the feature 'visibility'.

volume

The volume of the audio.

Signature:

volume: number;

Remarks

- Volume is represented by a floating point number between 0.0 and 1.0.

Example

- volume = 0.7 will reduce the audio volume of the media by 30%.

vr

The VR API.

Signature:

readonly vr?: VR;

Remarks

- Only available with the feature 'vr'.

yospace

The Yospace API.

Signature:

readonly yospace?: Yospace;

Remarks

- Only available with the feature 'yospace'.

Method Details

addEventListener

Add the given listener for the given event type(s).

Signature:

addEventListener<TType extends StringKeyOf<PlayerEventMap>>(type: TType | readonly TType[], listener: EventListener<PlayerEventMap[TType]>): void;

Parameters

destroy

Destroy the player.

Signature:

destroy(): void;

Remarks

- Available since v2.26.
- All resources associated with the current source are released.
- All resources associated with the player are released.
- The player can no longer be used.

pause

Pause playback.

Signature:

pause(): void;

play

Start or resume playback.

Signature:

play(): void;

prepareWithUserAction

Prepare the player to ChromelessPlayer.autoplay on platforms where autoplay is restricted without user action.

Signature:

prepareWithUserAction(): void;

Remarks

- Any invocation must happen on user action.
- Affected platforms include all mobile platforms and Safari 11+.

removeEventListener

Remove the given listener for the given event type(s).

Signature:

removeEventListener<TType extends StringKeyOf<PlayerEventMap>>(type: TType | readonly TType[], listener: EventListener<PlayerEventMap[TType]>): void;

Parameters

setSource

Warning: This API is deprecated.

Superseded by ChromelessPlayer.source.

Set current source which describes desired playback of a media resource.

Signature:

setSource(sourceDescription: SourceDescription | undefined): void;

Parameters

stop

Stop playback.

Signature:

stop(): void;

Remarks

- All resources associated with the current source are released.
- The player can be reused by setting a new ChromelessPlayer.source.