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

    Interface PlayerAudioInternalApi

    interface PlayerAudioInternalApi {
        muted: boolean;
        onEvent$: Observable<PlayerAudioEvent>;
        state: PlayerAudioState;
        volume: number;
        getHandler(playerAudioType: OUTPUT | MAIN): AudioHandlerApi | undefined;
        getHandler(
            playerAudioType: SIDECAR,
            id: string,
        ): AudioHandlerApi | undefined;
        getTracks(): AudioState[];
        getTracks(playerAudioType: MAIN): AudioState[];
        getTracks(playerAudioType: SIDECAR): AudioState[];
        loadSidecarTrack(
            audioState: AudioState,
            trackUpdater: (attrs: AudioUpdateableAttrs) => Observable<AudioState>,
            loadOptions?: PlayerAudioLoadOptions,
        ): Observable<AudioState>;
        mute(): Observable<void>;
        removeAllSidecarTracks(): Observable<void>;
        removeSidecarTrack(id: string): Observable<void>;
        setMuted(muted: boolean): Observable<void>;
        setVolume(volume: number): Observable<void>;
        switchTrack(trackId: string, activate?: boolean): Observable<void>;
        toggleMuted(): Observable<void>;
        unmute(): Observable<void>;
        updateTrack(trackState: AudioState): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    muted onEvent$ state volume

    Methods

    getHandler getTracks loadSidecarTrack mute removeAllSidecarTracks removeSidecarTrack setMuted setVolume switchTrack toggleMuted unmute updateTrack

    Properties

    muted: boolean

    Whether audio is currently muted.

    onEvent$: Observable<PlayerAudioEvent>

    Observable that emits audio events as they occur.

    state: PlayerAudioState

    Current audio state snapshot.

    volume: number

    Current volume level, in the range [0, 1].

    Methods

    • Switches the active audio track.

      Parameters

      • trackId: string

        ID of the track to switch to.

      • Optionalactivate: boolean

        Whether to immediately activate the track. Defaults to true.

      Returns Observable<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods