Interface TextTrackHandlerApi

interface TextTrackHandlerApi {
    active: boolean;
    handlerType: PlayerTextHandlerType;
    onEvent$: Observable<
        { data: TextTrackHandlerEventData; type: TEXT_TRACK_HANDLER_CHANGE },
    >;
    shown: boolean;
    state: TextTrackHandlerState;
    hide(): Observable<void>;
    show(): Observable<void>;
    switch(active: boolean): Observable<void>;
    toggleShowHide(): Observable<void>;
}

Hierarchy (View Summary)

TextTrackHandlerApi
- PlayerTextTrackHandlerApi

Index

Properties

active handlerType onEvent$ shown state

Methods

hide show switch toggleShowHide

Properties

active

active: boolean

handlerType

handlerType: PlayerTextHandlerType

onEvent$

onEvent$: Observable<
{ data: TextTrackHandlerEventData; type: TEXT_TRACK_HANDLER_CHANGE },
>

shown

shown: boolean

state

state: TextTrackHandlerState

Methods

hide

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

show

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

switch

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

toggleShowHide

toggleShowHide(): Observable<void>
Returns Observable<void>
- Defined in src/text/text-track-handler.ts:76