Class PlayerTextInternal

Implements

PlayerTextInternalApi
Destroyable

Index

Constructors

constructor

new PlayerTextInternal(config: PlayerTextConfig): PlayerTextInternal
Parameters
- config: PlayerTextConfig
Returns PlayerTextInternal
- Defined in src/player/player-text.ts:172

Accessors

onEvent$

get onEvent$(): Observable<PlayerTextEvent>
Observable that emits text events as they occur.

Returns Observable<PlayerTextEvent>
Implementation of PlayerTextInternalApi.onEvent$
- Defined in src/player/player-text.ts:608

shown

get shown(): boolean
Whether active text tracks are currently visible.

Returns boolean
Implementation of PlayerTextInternalApi.shown
- Defined in src/player/player-text.ts:384

state

get state(): PlayerTextState
Current text state snapshot.

Returns PlayerTextState
Implementation of PlayerTextInternalApi.state
- Defined in src/player/player-text.ts:533

Methods

_removeAllSidecarTracks

_removeAllSidecarTracks(): void
Returns void
- Defined in src/player/player-text.ts:525

_removeSidecarTrack

_removeSidecarTrack(id: string): void
Parameters
- id: string
Returns void
- Defined in src/player/player-text.ts:497

destroy

destroy(): void
Returns void
Implementation of Destroyable.destroy
- Defined in src/player/player-text.ts:612

getHandler

getHandler(trackId: string): TextTrackHandlerApi | undefined
Returns the handler for a specific text track.
Parameters
- trackId: string
  ID of the text track.
Returns TextTrackHandlerApi | undefined
Implementation of PlayerTextInternalApi.getHandler
- Defined in src/player/player-text.ts:346

getTracks

getTracks(): TextTrackState[]
Returns TextTrackState[]
Implementation of PlayerTextInternalApi.getTracks
- Defined in src/player/player-text.ts:330
getTracks(playerTextTrackType: MAIN): TextTrackState[]
Parameters
- playerTextTrackType: MAIN
Returns TextTrackState[]
Implementation of PlayerTextInternalApi.getTracks
- Defined in src/player/player-text.ts:331
getTracks(playerTextTrackType: SIDECAR): TextTrackState[]
Parameters
- playerTextTrackType: SIDECAR
Returns TextTrackState[]
Implementation of PlayerTextInternalApi.getTracks
- Defined in src/player/player-text.ts:332

hide

hide(): Observable<void>
Hides text tracks.

Returns Observable<void>
Implementation of PlayerTextInternalApi.hide
- Defined in src/player/player-text.ts:361

loadSidecarTrack

loadSidecarTrack(
    trackState: TextTrackState,
    trackUpdater: (
        attrs: TextTrackUpdateableAttrs,
    ) => Observable<TextTrackState>,
    loadOptions?: PlayerTextTrackLoadOptions,
): Observable<TextTrackState>
Parameters
- trackState: TextTrackState
- trackUpdater: (attrs: TextTrackUpdateableAttrs) => Observable<TextTrackState>
- OptionalloadOptions: PlayerTextTrackLoadOptions
Returns Observable<TextTrackState>
Implementation of PlayerTextInternalApi.loadSidecarTrack
- Defined in src/player/player-text.ts:396

removeAllSidecarTracks

removeAllSidecarTracks(): Observable<void>
Returns Observable<void>
Implementation of PlayerTextInternalApi.removeAllSidecarTracks
- Defined in src/player/player-text.ts:518

removeSidecarTrack

removeSidecarTrack(id: string): Observable<void>
Parameters
- id: string
Returns Observable<void>
Implementation of PlayerTextInternalApi.removeSidecarTrack
- Defined in src/player/player-text.ts:490

restoreState

restoreState(state: PlayerTextState): Observable<void>
Parameters
- state: PlayerTextState
Returns Observable<void>
- Defined in src/player/player-text.ts:557

setup

setup(
    playerController: PlayerController,
    mainMediaState: MainMediaState,
    playerTextHandlerType: PlayerTextHandlerType[],
): void
Parameters
- playerController: PlayerController
- mainMediaState: MainMediaState
- playerTextHandlerType: PlayerTextHandlerType[]
Returns void
- Defined in src/player/player-text.ts:222

show

show(): Observable<void>
Shows text tracks.

Returns Observable<void>
Implementation of PlayerTextInternalApi.show
- Defined in src/player/player-text.ts:357

switchTrack

switchTrack(trackId: string, activate?: boolean): Observable<void>
Switches the active text track.
Parameters
- trackId: string
  ID of the track to switch to.
- activate: boolean = true
Returns Observable<void>
Implementation of PlayerTextInternalApi.switchTrack
- Defined in src/player/player-text.ts:267

teardown

teardown(): void
Returns void
- Defined in src/player/player-text.ts:195

toggleShowHide

toggleShowHide(): Observable<void>
Toggles show and hide.

Returns Observable<void>
Implementation of PlayerTextInternalApi.toggleShowHide
- Defined in src/player/player-text.ts:392

updateTrack

updateTrack(trackState: TextTrackState): void
Parameters
- trackState: TextTrackState
Returns void
Implementation of PlayerTextInternalApi.updateTrack
- Defined in src/player/player-text.ts:324

Class PlayerTextInternal

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PlayerTextInternal

Accessors

onEvent$

Returns Observable<PlayerTextEvent>

shown

Returns boolean

state

Returns PlayerTextState

Methods

_removeAllSidecarTracks

Returns void

_removeSidecarTrack

Parameters

Returns void

destroy

Returns void

getHandler

Parameters

Returns TextTrackHandlerApi | undefined

getTracks

Returns TextTrackState[]

Parameters

Returns TextTrackState[]

Parameters

Returns TextTrackState[]

hide

Returns Observable<void>

loadSidecarTrack

Parameters

Returns Observable<TextTrackState>

removeAllSidecarTracks

Returns Observable<void>

removeSidecarTrack

Parameters

Returns Observable<void>

restoreState

Parameters

Returns Observable<void>

setup

Parameters

Returns void

show

Returns Observable<void>

switchTrack

Parameters

Returns Observable<void>

teardown

Returns void

toggleShowHide

Returns Observable<void>

updateTrack

Parameters

Returns void

Settings

On This Page