Class PlayerText

Implements

PlayerTextApi
Destroyable

Index

Constructors

Accessors

onEvent$ shown state

Methods

destroy getHandler getTracks hide show switchTrack toggleShowHide wirePlayer

Constructors

constructor

new PlayerText(ompProvider: OmpProvider, player: PlayerInternalApi): PlayerText
Parameters
- ompProvider: OmpProvider
- player: PlayerInternalApi
Returns PlayerText
- Defined in src/player/player-text.ts:56

Accessors

onEvent$

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

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

shown

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

Returns boolean
Implementation of PlayerTextApi.shown
- Defined in src/player/player-text.ts:117

state

get state(): PlayerTextState
Current text state snapshot.

Returns PlayerTextState
Implementation of PlayerTextApi.state
- Defined in src/player/player-text.ts:145

Methods

destroy

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

getHandler

getHandler(id: string): TextTrackHandlerApi | undefined
Returns the handler for a specific text track.
Parameters
- id: string
Returns TextTrackHandlerApi | undefined
Implementation of PlayerTextApi.getHandler
- Defined in src/player/player-text.ts:83

getTracks

getTracks(): TextTrack<TextTrackState, never>[]
Returns tracks loaded by player

Returns TextTrack<TextTrackState, never>[]
Implementation of PlayerTextApi.getTracks
- Defined in src/player/player-text.ts:87

hide

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

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

show

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

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

switchTrack

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

toggleShowHide

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

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

wirePlayer

wirePlayer(player: PlayerInternalApi): void
Parameters
- player: PlayerInternalApi
Returns void
- Defined in src/player/player-text.ts:62