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

    Interface PlayerDetachedApi

    Shared API surface inherited by all player variants (PlayerApi, PlayerInternalApi, PlayerLocalApi, PlayerDetachedApi).

    Provides playback control, seeking (supporting multiple temporal formats), time conversion, playback rate, and fullscreen toggling.

    interface PlayerDetachedApi {
        audioInternal: PlayerAudioInternalApi;
        isMainMediaLoaded: boolean;
        onEvent$: Observable<PlayerEvent>;
        playerSession: PlayerSession;
        textInternal: PlayerTextInternalApi;
        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];
        loadMainMedia(mainMediaId: string): Observable<MainMediaState>;
        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>;
        setPlaybackRate(playbackRate: number): Observable<void>;
        toggleFullScreen(): Observable<void>;
        unloadMainMedia(): Observable<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    audioInternal isMainMediaLoaded onEvent$ playerSession textInternal

    Methods

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

    Properties

    audioInternal: PlayerAudioInternalApi
    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