Interface OmakasePlayerApi

interface OmakasePlayerApi {
    get alerts(): AlertsApi;
    get audio(): AudioApi;
    get subtitles(): SubtitlesApi;
    get timeline(): undefined | TimelineApi;
    get video(): VideoApi;
    createMarkerList(config: MarkerListConfig): Observable<MarkerListApi>;
    createTimeline(
        config: Partial<ConfigWithOptionalStyle<TimelineConfig>>,
    ): Observable<TimelineApi>;
    destroy(): void;
    loadVideo(
        videoSourceUrl: string,
        frameRate: string | number,
    ): Observable<Video>;
    loadVideo(
        videoSourceUrl: string,
        frameRate: string | number,
        options?: VideoLoadOptions,
    ): Observable<Video>;
    setAuthentication(authentication: AuthenticationData): void;
    setThumbnailVttUrl(thumbnailVttUrl: string): void;
}

Hierarchy (View Summary)

  • Api
    • OmakasePlayerApi

Implemented by

Accessors

alerts audio subtitles timeline video

Methods

createMarkerList createTimeline destroy loadVideo setAuthentication setThumbnailVttUrl

Accessors

alerts

audio

subtitles

timeline

video

Methods

createMarkerList

createTimeline

destroy

loadVideo

setAuthentication

  • setAuthentication(authentication: AuthenticationData): 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

  • setThumbnailVttUrl(thumbnailVttUrl: string): void

  • Set thumbnail vtt url for media chrome thumbnail preview

    Parameters

    • thumbnailVttUrl: string

      Thumbnail Vtt Url

    Returns void

Settings

Member Visibility

On This Page

Accessors
Methods