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

    Interface PlayerConfig

    Configuration for the player.

    interface PlayerConfig {
        audioMode: PlayerAudioMode;
        controllerConfig?: {
            AUDIO_FILE?: Partial<AudioFilePlayerControllerConfig>;
            HLS?: Partial<HlsPlayerControllerConfig>;
            MP4?: Partial<Mp4PlayerControllerConfig>;
        };
        htmlElementId: string;
        playerDetachedUrlFn?: (mainMedia: MainMedia) => string | undefined;
        textMainTracksHandler: (EMBEDDED | NATIVE | MEDIA_CAPTIONS)[];
        textMode: SINGLE;
    }

    Hierarchy

    • PlayerCommonConfig
      • PlayerConfig
    Index

    Properties

    audioMode controllerConfig? htmlElementId playerDetachedUrlFn? textMainTracksHandler textMode

    Properties

    audioMode: PlayerAudioMode

    Audio track handling mode (single vs. multiple simultaneous tracks).

    controllerConfig?: {
        AUDIO_FILE?: Partial<AudioFilePlayerControllerConfig>;
        HLS?: Partial<HlsPlayerControllerConfig>;
        MP4?: Partial<Mp4PlayerControllerConfig>;
    }

    Optional per-media-type player controller configuration. Each key corresponds to a MainMediaType and its value is a partial config for the matching controller (e.g. HLS, MP4, AudioFile).

    htmlElementId: string

    DOM element id of the container that hosts the <video> element.

    playerDetachedUrlFn?: (mainMedia: MainMedia) => string | undefined

    Optional function that resolves the URL used when the player transitions to detached mode. Receives the current MainMedia and returns the URL for the detached player endpoint.

    textMainTracksHandler: (EMBEDDED | NATIVE | MEDIA_CAPTIONS)[]

    List of handlers used to render PlayerTextType.MAIN text tracks in the player:

    An empty array disables in-player rendering of PlayerTextType.MAIN text tracks.

    textMode: SINGLE

    Text track handling mode (single vs. multiple simultaneous tracks).

    Settings

    Member Visibility

    On This Page

    Properties