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

    Interface PlayerController

    interface PlayerController {
        createMediaElementSourceEnabled: boolean;
        mediaElementPlayback: MediaElementPlayback | undefined;
        mediaRotation: MediaRotationValue;
        mediaTemporalConverter: MediaTemporalConverter | undefined;
        onEvent$: Observable<PlayerControllerEvent>;
        playbackRate: number;
        textImscElement: HTMLElement;
        textMediaCaptionsElement: HTMLElement;
        textTracksDisplayed: boolean;
        videoElement: HTMLVideoElement;
        convertTime<S extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[S],
            valueFormat: S,
            destinationFormat: SECONDS,
        ): number;
        convertTime<S extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[S],
            valueFormat: S,
            destinationFormat: FRAME_COUNT,
        ): number;
        convertTime<S extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[S],
            valueFormat: S,
            destinationFormat: PERCENT,
        ): number;
        convertTime<S extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[S],
            valueFormat: S,
            destinationFormat: TIMECODE,
        ): string;
        convertTime<S extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[S],
            valueFormat: S,
            destinationFormat: MEDIA_TIME,
        ): string;
        convertTime<S extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[S],
            valueFormat: S,
            destinationFormat: COUNTDOWN_MEDIA_TIME,
        ): string;
        convertTime<S extends MediaTemporalFormat, D extends MediaTemporalFormat>(
            value: MediaTemporalFormatValueMap[S],
            valueFormat: S,
            destinationFormat: D,
        ): MediaTemporalFormatValueMap[D];
        destroy(): void;
        extractVideoKeyframe(
            options?: VideoKeyframeOptions,
        ): Observable<VideoKeyframe>;
        getCurrentTime(): number;
        getCurrentTime<F extends MediaTemporalFormat>(
            format: F,
        ): MediaTemporalFormatValueMap[F];
        getDuration(): number;
        getDuration<F extends MediaTemporalFormat>(
            format: F,
        ): MediaTemporalFormatValueMap[F];
        isAudioTrackActive(track: AudioState): boolean;
        isTextTrackActive(track: TextTrackState): boolean;
        loadMainMedia(args: LoadMainMediaArgsType): Observable<boolean>;
        pause(): Observable<void>;
        play(): Observable<void>;
        resolveActiveAudioTracks(tracks: AudioState[]): AudioState[];
        resolveActiveTextTracks(track: TextTrackState[]): TextTrackState[];
        resolveAudioTrackIdentifier(track: AudioState): any;
        resolveLiveState(): PlayerLiveState | undefined;
        resolveTextTrackIdentifier(track: TextTrackState): any;
        restoreMainMediaSession(
            args: RestoreMainMediaSessionArgsType,
        ): Observable<void>;
        seekFromCurrentTime(value: number): Observable<boolean>;
        seekFromCurrentTime(value: number, format: SECONDS): Observable<boolean>;
        seekFromCurrentTime(
            value: number,
            format: FRAME_COUNT,
        ): Observable<boolean>;
        seekFromCurrentTime(value: number, format: PERCENT): Observable<boolean>;
        seekFromCurrentTime(value: string, format: TIMECODE): Observable<boolean>;
        seekFromCurrentTime(value: string, format: MEDIA_TIME): Observable<boolean>;
        seekFromCurrentTime(
            value: string,
            format: COUNTDOWN_MEDIA_TIME,
        ): Observable<boolean>;
        seekFromCurrentTime(
            value: string | number,
            format: MediaTemporalFormat,
        ): Observable<boolean>;
        seekTo(value: number): Observable<boolean>;
        seekTo(value: number, format: SECONDS): Observable<boolean>;
        seekTo(value: number, format: FRAME_COUNT): Observable<boolean>;
        seekTo(value: number, format: PERCENT): Observable<boolean>;
        seekTo(value: string, format: TIMECODE): Observable<boolean>;
        seekTo(value: string, format: MEDIA_TIME): Observable<boolean>;
        seekTo(value: string, format: COUNTDOWN_MEDIA_TIME): Observable<boolean>;
        seekTo(
            value: string | number,
            format: MediaTemporalFormat,
        ): Observable<boolean>;
        seekToLive(): Observable<boolean>;
        setPlaybackRate(playbackRate: number): Observable<void>;
        setTextTracksDisplayed(textTracksDisplayed: boolean): void;
        setWaitingForSyncedMedia(syncedMediaWaiting: boolean): void;
        switchAudioTrack(track: AudioState, activate: boolean): Observable<void>;
        switchTextTrack(track: TextTrackState, activate: boolean): Observable<void>;
        unwireEvents(): void;
        wireEvents(mainMediaState: MainMediaState): void;
    }

    Hierarchy

    • Destroyable
      • PlayerController
    Index

    Properties

    createMediaElementSourceEnabled mediaElementPlayback mediaRotation mediaTemporalConverter onEvent$ playbackRate textImscElement textMediaCaptionsElement textTracksDisplayed videoElement

    Methods

    convertTime destroy extractVideoKeyframe getCurrentTime getDuration isAudioTrackActive isTextTrackActive loadMainMedia pause play resolveActiveAudioTracks resolveActiveTextTracks resolveAudioTrackIdentifier resolveLiveState resolveTextTrackIdentifier restoreMainMediaSession seekFromCurrentTime seekTo seekToLive setPlaybackRate setTextTracksDisplayed setWaitingForSyncedMedia switchAudioTrack switchTextTrack unwireEvents wireEvents

    Properties

    createMediaElementSourceEnabled: boolean
    mediaElementPlayback: MediaElementPlayback | undefined
    mediaRotation: MediaRotationValue
    mediaTemporalConverter: MediaTemporalConverter | undefined
    onEvent$: Observable<PlayerControllerEvent>
    playbackRate: number
    textImscElement: HTMLElement
    textMediaCaptionsElement: HTMLElement
    textTracksDisplayed: boolean
    videoElement: HTMLVideoElement

    Methods

    • Parameters

      • Optionaloptions: VideoKeyframeOptions

      Returns Observable<VideoKeyframe>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods