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

    Interface PlayerAudioApi

    interface PlayerAudioApi {
        audioContext: AudioContext;
        audioEffects: AudioEffectsRegistry;
        muted: boolean;
        onEvent$: Observable<PlayerAudioEvent>;
        state: PlayerAudioState;
        volume: number;
        getHandler(playerAudioType: OUTPUT | MAIN): AudioHandlerApi | undefined;
        getHandler(
            playerAudioType: SIDECAR,
            id: string,
        ): AudioHandlerApi | undefined;
        getTracks(): Audio[];
        getTracks(playerAudioType: MAIN): Audio[];
        getTracks(playerAudioType: SIDECAR): Audio[];
        mute(): 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>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    audioContext audioEffects muted onEvent$ state volume

    Methods

    getHandler getTracks mute setMuted setVolume switchTrack toggleMuted unmute

    Properties

    audioContext: AudioContext
    audioEffects: AudioEffectsRegistry

    Audio effects registry — use to register custom audio effect implementations.

    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