Skip to main content

TrackManager

Extends

  • default

Methods

enableAdaptiveVideo()

enableAdaptiveVideo(): Promise<void>

Enforces adaptive video playback.

Returns

Promise<void>


getAdaptiveVideoEnabled()

getAdaptiveVideoEnabled(): boolean

Returns whether adaptive video is enabled.

Returns

boolean


getAudioTrack()

getAudioTrack(): null | AudioTrack

Returns the active audio track.

Returns

null | AudioTrack


getAudioTracks()

getAudioTracks(): AudioTrack[]

Returns the audio tracks.

Returns

AudioTrack[]


getTextTrack()

getTextTrack(): null | TextTrack

Returns the active text track.

Returns

null | TextTrack


getTextTracks()

getTextTracks(): TextTrack[]

Returns the text tracks including side-loaded tracks.

Returns

TextTrack[]


getVideoRendition()

getVideoRendition(): null | VideoRendition

Returns the active video rendition. If adaptive video is enabled, returns null.

Returns

null | VideoRendition


getVideoTrack()

getVideoTrack(): null | VideoTrack

Returns the active video track.

Returns

null | VideoTrack


getVideoTracks()

getVideoTracks(): VideoTrack[]

Returns the video tracks.

Returns

VideoTrack[]


setAudioTrack()

setAudioTrack(track): Promise<void>

Switches to the given audio track.

Parameters

ParameterTypeDescription
trackAudioTrackThe audio track to switch to.

Returns

Promise<void>


setTextTrack()

setTextTrack(track): Promise<void>

Selects the text track. If the track is null, the text overlay will be hidden.

Parameters

ParameterTypeDescription
tracknull | TextTrackThe text track to switch to, or null to hide text overlay

Returns

Promise<void>


setVideoRendition()

setVideoRendition(rendition): Promise<void>

Switches to the given the video track. As a consequence, adaptive video will be disabled.

Parameters

ParameterTypeDescription
renditionVideoRenditionThe video rendition to switch to.

Returns

Promise<void>


setVideoTrack()

setVideoTrack(track): Promise<void>

Switches to the given the video track.

Parameters

ParameterTypeDescription
trackVideoTrackThe video track to switch to.

Returns

Promise<void>