Class SidecarTextTrackHandler

Functions with internal TextTrackController

Hierarchy (View Summary)

BasePlayerTextTrackHandler
- SidecarTextTrackHandler

Index

Constructors

Accessors

active handlerType id onEvent$ shown state textTrackController

Methods

destroy hide restoreState show switch toggleShowHide

Constructors

constructor

new SidecarTextTrackHandler(
    trackState: TextTrackState,
    playerController: PlayerController,
    loadOptions?: PlayerTextTrackLoadOptions,
): SidecarTextTrackHandler
Parameters
- trackState: TextTrackState
- playerController: PlayerController
- OptionalloadOptions: PlayerTextTrackLoadOptions
Returns SidecarTextTrackHandler
Overrides BasePlayerTextTrackHandler.constructor
- Defined in src/text/text-track-handler.ts:267

Accessors

active

get active(): boolean
Returns boolean
Inherited from BasePlayerTextTrackHandler.active
- Defined in src/text/text-track-handler.ts:140

handlerType

get handlerType(): PlayerTextHandlerType
Returns PlayerTextHandlerType
Overrides BasePlayerTextTrackHandler.handlerType
- Defined in src/text/text-track-handler.ts:273

id

get id(): string
Returns string
Inherited from BasePlayerTextTrackHandler.id
- Defined in src/text/text-track-handler.ts:132

onEvent$

get onEvent$(): Observable<
{ data: TextTrackHandlerEventData; type: TEXT_TRACK_HANDLER_CHANGE },
>
Returns Observable<{ data: TextTrackHandlerEventData; type: TEXT_TRACK_HANDLER_CHANGE }>
Inherited from BasePlayerTextTrackHandler.onEvent$
- Defined in src/text/text-track-handler.ts:136

shown

get shown(): boolean
Returns boolean
Inherited from BasePlayerTextTrackHandler.shown
- Defined in src/text/text-track-handler.ts:144

state

get state(): PlayerTextTrackHandlerState
Returns PlayerTextTrackHandlerState
Inherited from BasePlayerTextTrackHandler.state
- Defined in src/text/text-track-handler.ts:170

textTrackController

get textTrackController(): TextTrackController
Returns TextTrackController
- Defined in src/text/text-track-handler.ts:345

Methods

destroy

destroy(): void
Returns void
Overrides BasePlayerTextTrackHandler.destroy
- Defined in src/text/text-track-handler.ts:349

hide

hide(): Observable<void>
Returns Observable<void>
Overrides BasePlayerTextTrackHandler.hide
- Defined in src/text/text-track-handler.ts:321

restoreState

restoreState(state: PlayerTextTrackHandlerState): Observable<void>
Parameters
- state: PlayerTextTrackHandlerState
Returns Observable<void>
Inherited from BasePlayerTextTrackHandler.restoreState
- Defined in src/text/text-track-handler.ts:128

show

show(): Observable<void>
Returns Observable<void>
Overrides BasePlayerTextTrackHandler.show
- Defined in src/text/text-track-handler.ts:297

switch

switch(active: boolean): Observable<void>
Parameters
- active: boolean
Returns Observable<void>
Overrides BasePlayerTextTrackHandler.switch
- Defined in src/text/text-track-handler.ts:277

toggleShowHide

toggleShowHide(): Observable<void>
Returns Observable<void>
Inherited from BasePlayerTextTrackHandler.toggleShowHide
- Defined in src/text/text-track-handler.ts:148