@byomakase/omakase-player
    Preparing search index...

    Interface PlayerLocalApi

    interface PlayerLocalApi {
        audioInternal: PlayerAudioInternalApi;
        htmlMediaElement: HTMLMediaElement | undefined;
        isMainMediaLoaded: boolean;
        onEvent$: Observable<PlayerEvent>;
        playerSession: PlayerSession;
        textInternal: PlayerTextInternalApi;
        clearPlayerSession(): void;
        convertTime<S extends MediaTemporalFormat, D extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[S],
            valueFormat: S,
            destinationFormat: D,
        ): MediaTemporalFormatValueMap[D];
        destroy(): void;
        extractVideoKeyframe(
            options?: VideoKeyframeOptions,
        ): Observable<VideoKeyframe>;
        getCurrentTime<F extends MediaTemporalFormat>(
            format: F,
        ): MediaTemporalFormatValueMap[F];
        getDuration<F extends MediaTemporalFormat>(
            format: F,
        ): MediaTemporalFormatValueMap[F];
        getPlaybackEngine(mainMediaType: HLS): HlsPlayerPlaybackEngine;
        getPlaybackEngine(mainMediaType: MP4): Mp4PlayerPlaybackEngine;
        getPlaybackEngine(mainMediaType: AUDIO_FILE): AudioFilePlayerPlaybackEngine;
        getPlaybackEngine<T extends MainMediaType>(
            mainMediaType: T,
        ): PlayerPlaybackEngineMapping[T];
        loadMainMedia(mainMediaId: string): Observable<MainMedia>;
        loadSidecarTrack(
            trackId: string,
            loadOptions?: TrackLoadOptions,
        ): Observable<void>;
        pause(): Observable<void>;
        play(): Observable<void>;
        removeAllSidecarTracks(): Observable<void>;
        removeSidecarTrack(trackId: string): Observable<void>;
        restorePlayerSession(playerSession: PlayerSession): Observable<void>;
        seekFromCurrentTime<F extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[F],
            format: F,
        ): Observable<boolean>;
        seekTo<F extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[F],
            format: F,
        ): Observable<boolean>;
        setChromingInternal(chroming: ChromingInternalApi): void;
        setPlaybackRate(playbackRate: number): Observable<void>;
        toggleFullScreen(): Observable<void>;
        unloadMainMedia(): Observable<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    audioInternal htmlMediaElement isMainMediaLoaded onEvent$ playerSession textInternal

    Methods

    clearPlayerSession convertTime destroy extractVideoKeyframe getCurrentTime getDuration getPlaybackEngine loadMainMedia loadSidecarTrack pause play removeAllSidecarTracks removeSidecarTrack restorePlayerSession seekFromCurrentTime seekTo setChromingInternal setPlaybackRate toggleFullScreen unloadMainMedia

    Properties

    audioInternal: PlayerAudioInternalApi
    htmlMediaElement: HTMLMediaElement | undefined
    isMainMediaLoaded: boolean

    Whether a main media source is currently loaded and ready.

    onEvent$: Observable<PlayerEvent>

    Observable stream of player lifecycle and playback events.

    playerSession: PlayerSession

    Current player session state (playback position, audio/text selection, etc.).

    textInternal: PlayerTextInternalApi

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods