Interface SubtitlesApi

interface SubtitlesApi {
    onCreate$: Observable<SubtitlesCreateEvent>;
    onHide$: Observable<SubtitlesEvent>;
    onRemove$: Observable<SubtitlesEvent>;
    onShow$: Observable<SubtitlesEvent>;
    onSubtitlesLoaded$: Observable<undefined | SubtitlesLoadedEvent>;
    createVttTrack(
        track: Pick<
            SubtitlesVttTrack,
            "default"
            | "id"
            | "label"
            | "src"
            | "language",
        >,
    ): Observable<undefined | SubtitlesVttTrack>;
    getActiveTrack(): undefined | SubtitlesVttTrack;
    getTracks(): SubtitlesVttTrack[];
    hideActiveTrack(): Observable<void>;
    hideTrack(id: string): Observable<void>;
    removeAllTracks(): Observable<void>;
    removeTrack(id: string): Observable<void>;
    showActiveTrack(): Observable<void>;
    showTrack(id: string): Observable<void>;
    toggleShowHideActiveTrack(): Observable<void>;
}

Hierarchy (View Summary)

Api
- SubtitlesApi

Index

Properties

onCreate$ onHide$ onRemove$ onShow$ onSubtitlesLoaded$

Methods

createVttTrack getActiveTrack getTracks hideActiveTrack hideTrack removeAllTracks removeTrack showActiveTrack showTrack toggleShowHideActiveTrack

Properties

`Readonly`onCreate$

onCreate$: Observable<SubtitlesCreateEvent>

Fires on subtitles create

`Readonly`onHide$

onHide$: Observable<SubtitlesEvent>

Fires on subtitles hide

`Readonly`onRemove$

onRemove$: Observable<SubtitlesEvent>

Fires on subtitles remove

`Readonly`onShow$

onShow$: Observable<SubtitlesEvent>

Fires on subtitles show

`Readonly`onSubtitlesLoaded$

onSubtitlesLoaded$: Observable<undefined | SubtitlesLoadedEvent>

Fires on subtitles load. Initial value is undefined. Always emits the current value on subscription.

Methods

createVttTrack

createVttTrack(
    track: Pick<
        SubtitlesVttTrack,
        "default"
        | "id"
        | "label"
        | "src"
        | "language",
    >,
): Observable<undefined | SubtitlesVttTrack>
Creates new Subtitles VTT track
Parameters
- track: Pick<SubtitlesVttTrack, "default" | "id" | "label" | "src" | "language">
Returns Observable<undefined | SubtitlesVttTrack>
- Defined in project/src/api/subtitles-api.ts:58

getActiveTrack

getActiveTrack(): undefined | SubtitlesVttTrack
Returns undefined | SubtitlesVttTrack
active VTT track
- Defined in project/src/api/subtitles-api.ts:79

getTracks

getTracks(): SubtitlesVttTrack[]
Returns SubtitlesVttTrack[]
all VTT tracks
- Defined in project/src/api/subtitles-api.ts:63

hideActiveTrack

hideActiveTrack(): Observable<void>
Hides active VTT track

Returns Observable<void>
- Defined in project/src/api/subtitles-api.ts:101

hideTrack

hideTrack(id: string): Observable<void>
Hides VTT track by ID
Parameters
- id: string
  VTT track ID
Returns Observable<void>
- Defined in project/src/api/subtitles-api.ts:91

removeAllTracks

removeAllTracks(): Observable<void>
Removes all VTT tracks

Returns Observable<void>
- Defined in project/src/api/subtitles-api.ts:74

removeTrack

removeTrack(id: string): Observable<void>
Removes VTT track by ID
Parameters
- id: string
  VTT track ID
Returns Observable<void>
- Defined in project/src/api/subtitles-api.ts:69

showActiveTrack

showActiveTrack(): Observable<void>
Shows active VTT track

Returns Observable<void>
- Defined in project/src/api/subtitles-api.ts:96

showTrack

showTrack(id: string): Observable<void>
Shows VTT track by ID
Parameters
- id: string
  VTT track ID
Returns Observable<void>
- Defined in project/src/api/subtitles-api.ts:85

toggleShowHideActiveTrack

toggleShowHideActiveTrack(): Observable<void>
Toggles show / hide of active VTT track

Returns Observable<void>
- Defined in project/src/api/subtitles-api.ts:106