Interface OmakasePlayerApi

interface OmakasePlayerApi {
    get alerts(): AlertsApi;
    get audio(): AudioApi;
    get EVENTS(): OmakasePlayerEventsMappingType<OmakasePlayerEventMap>;
    get subtitles(): SubtitlesApi;
    get timeline(): undefined | TimelineApi;
    get video(): VideoApi;
    createMarkerList(config: MarkerListConfig): Observable<MarkerListApi>;
    createTimeline(config: Partial<ConfigWithOptionalStyle<TimelineConfig>>): Observable<TimelineApi>;
    destroy(): void;
    emit<K>(eventKey: K, event: OmakasePlayerEventMap[K]): void;
    listenerCount<K>(eventKey: K): void;
    listeners<K>(eventKey: K): OmakaseEventListener<OmakasePlayerEventMap[K]>[];
    loadVideo(videoSourceUrl: string, frameRate: string | number): Observable<Video>;
    loadVideo(videoSourceUrl: string, frameRate: string | number, options?: VideoLoadOptions): Observable<Video>;
    off<K>(eventKey: K, handler: OmakaseEventListener<OmakasePlayerEventMap[K]>): void;
    on<K>(eventKey: K, handler: OmakaseEventListener<OmakasePlayerEventMap[K]>): void;
    once<K>(eventKey: K, handler: OmakaseEventListener<OmakasePlayerEventMap[K]>): void;
    removeAllListeners<K>(eventKey?: K): void;
    setAuthentication(authentication: AuthenticationData): void;
    setThumbnailVttUrl(thumbnailVttUrl: string): void;
}

Hierarchy (view full)

Implemented by

Accessors

alerts audio EVENTS subtitles timeline video

Methods

createMarkerList createTimeline destroy emit listenerCount listeners loadVideo off on once removeAllListeners setAuthentication setThumbnailVttUrl

Accessors

alerts

audio

EVENTS

subtitles

timeline

video

Methods

createMarkerList

createTimeline

destroy

emit

  • emit<K>(eventKey, event): void

  • Type Parameters

    • K extends
          | (keyof VideoEventMap)
          | "omakaseAudioSwitched"
          | (keyof SubtitlesEventMap)
          | (keyof TimelineEventMap)
          | (keyof MarkerListEventMap)

    Parameters

    Returns void

listenerCount

  • listenerCount<K>(eventKey): void

  • Type Parameters

    • K extends
          | (keyof VideoEventMap)
          | "omakaseAudioSwitched"
          | (keyof SubtitlesEventMap)
          | (keyof TimelineEventMap)
          | (keyof MarkerListEventMap)

    Parameters

    • eventKey: K

    Returns void

listeners

  • listeners<K>(eventKey): OmakaseEventListener<OmakasePlayerEventMap[K]>[]

  • Type Parameters

    • K extends
          | (keyof VideoEventMap)
          | "omakaseAudioSwitched"
          | (keyof SubtitlesEventMap)
          | (keyof TimelineEventMap)
          | (keyof MarkerListEventMap)

    Parameters

    • eventKey: K

    Returns OmakaseEventListener<OmakasePlayerEventMap[K]>[]

loadVideo

off

  • off<K>(eventKey, handler): void

  • Type Parameters

    • K extends
          | (keyof VideoEventMap)
          | "omakaseAudioSwitched"
          | (keyof SubtitlesEventMap)
          | (keyof TimelineEventMap)
          | (keyof MarkerListEventMap)

    Parameters

    Returns void

on

  • on<K>(eventKey, handler): void

  • Type Parameters

    • K extends
          | (keyof VideoEventMap)
          | "omakaseAudioSwitched"
          | (keyof SubtitlesEventMap)
          | (keyof TimelineEventMap)
          | (keyof MarkerListEventMap)

    Parameters

    Returns void

once

  • once<K>(eventKey, handler): void

  • Type Parameters

    • K extends
          | (keyof VideoEventMap)
          | "omakaseAudioSwitched"
          | (keyof SubtitlesEventMap)
          | (keyof TimelineEventMap)
          | (keyof MarkerListEventMap)

    Parameters

    Returns void

removeAllListeners

  • removeAllListeners<K>(eventKey?): void

  • Type Parameters

    • K extends
          | (keyof VideoEventMap)
          | "omakaseAudioSwitched"
          | (keyof SubtitlesEventMap)
          | (keyof TimelineEventMap)
          | (keyof MarkerListEventMap)

    Parameters

    • OptionaleventKey: K

    Returns void

setAuthentication

  • setAuthentication(authentication): void

  • Set authentication for HLS.js, VTT and thumbnail image requests

    Parameters

    • authentication: AuthenticationData

      Basic authentication, Bearer token authentication or custom authentication function

    Returns void

setThumbnailVttUrl

Settings

Member Visibility

On This Page

Accessors
Methods