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

    Interface AudioApi

    interface AudioApi {
        onAudioLoaded$: Observable<undefined | AudioLoadedEvent>;
        onAudioSwitched$: Observable<AudioSwitchedEvent>;
        onMainAudioChange$: Observable<undefined | MainAudioChangeEvent>;
        onMainAudioPeakProcessorMessage$: Observable<
            AudioPeakProcessorMessageEvent,
        >;
        onSidecarAudioChange$: Observable<SidecarAudioChangeEvent>;
        onSidecarAudioCreate$: Observable<SidecarAudioCreateEvent>;
        onSidecarAudioPeakProcessorMessage$: Observable<
            SidecarAudioPeakProcessorMessageEvent,
        >;
        onSidecarAudioRemove$: Observable<SidecarAudioRemoveEvent>;
        activateSidecarAudioTracks(
            ids: string[],
            deactivateOthers: undefined | boolean,
        ): Observable<void>;
        createMainAudioPeakProcessor(
            audioMeterStandard?: AudioMeterStandard,
        ): Observable<Observable<AudioPeakProcessorMessageEvent>>;
        createMainAudioRouter(
            inputsNumber: number,
            outputsNumber?: number,
        ): Observable<OmpAudioRouterState>;
        createMainAudioRouterWithOutputsResolver(
            inputsNumber: number,
            outputsNumberResolver: (maxChannelCount: number) => number,
        ): Observable<OmpAudioRouterState>;
        createSidecarAudioPeakProcessor(
            sidecarAudioTrackId: string,
            audioMeterStandard?: AudioMeterStandard,
        ): Observable<Observable<AudioPeakProcessorMessageEvent>>;
        createSidecarAudioRouter(
            sidecarAudioTrackId: string,
            inputsNumber?: number,
            outputsNumber?: number,
        ): Observable<OmpAudioRouterState>;
        createSidecarAudioTrack(
            track: Partial<OmpAudioTrack>,
        ): Observable<OmpAudioTrack>;
        createSidecarAudioTracks(
            tracks: Partial<OmpAudioTrack>[],
        ): Observable<OmpAudioTrack[]>;
        deactivateSidecarAudioTracks(ids: string[]): Observable<void>;
        exportMainAudioTracksToSidecar(
            mainAudioTrackIds: string[],
        ): Observable<OmpAudioTrack[]>;
        exportMainAudioTrackToSidecar(
            mainAudioTrackId: string,
        ): Observable<OmpAudioTrack>;
        getActiveAudioTrack(): undefined | OmpAudioTrack;
        getActiveSidecarAudioTracks(): OmpAudioTrack[];
        getAudioContext(): AudioContext;
        getAudioTracks(): OmpAudioTrack[];
        getMainAudioRouter(): undefined | OmpAudioRouter;
        getMainAudioSourceNode(): AudioNode;
        getMainAudioState(): undefined | OmpMainAudioState;
        getSidecarAudio(id: string): undefined | SidecarAudioApi;
        getSidecarAudios(): SidecarAudioApi[];
        getSidecarAudioTracks(): OmpAudioTrack[];
        removeAllSidecarAudioTracks(): Observable<void>;
        removeSidecarAudioTracks(ids: string[]): Observable<void>;
        routeMainAudioRouterNodes(
            newAudioInputOutputNodes: AudioInputOutputNode[],
        ): Observable<void>;
        routeSidecarAudioRouterNodes(
            sidecarAudioTrackId: string,
            newAudioInputOutputNodes: AudioInputOutputNode[],
        ): Observable<void>;
        setActiveAudioTrack(id: string): Observable<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    onAudioLoaded$ onAudioSwitched$ onMainAudioChange$ onMainAudioPeakProcessorMessage$ onSidecarAudioChange$ onSidecarAudioCreate$ onSidecarAudioPeakProcessorMessage$ onSidecarAudioRemove$

    Methods

    activateSidecarAudioTracks createMainAudioPeakProcessor createMainAudioRouter createMainAudioRouterWithOutputsResolver createSidecarAudioPeakProcessor createSidecarAudioRouter createSidecarAudioTrack createSidecarAudioTracks deactivateSidecarAudioTracks exportMainAudioTracksToSidecar exportMainAudioTrackToSidecar getActiveAudioTrack getActiveSidecarAudioTracks getAudioContext getAudioTracks getMainAudioRouter getMainAudioSourceNode getMainAudioState getSidecarAudio getSidecarAudios getSidecarAudioTracks removeAllSidecarAudioTracks removeSidecarAudioTracks routeMainAudioRouterNodes routeSidecarAudioRouterNodes setActiveAudioTrack

    Properties

    onAudioLoaded$: Observable<undefined | AudioLoadedEvent>

    Fires on audio load. Initial value is undefined. Always emits the current value on subscription.

    onAudioSwitched$: Observable<AudioSwitchedEvent>

    Fires on audio track switched

    onMainAudioChange$: Observable<undefined | MainAudioChangeEvent>

    Fires when Main audio topology changes. For example, audio router is created.

    onMainAudioPeakProcessorMessage$: Observable<AudioPeakProcessorMessageEvent>

    Fires on Main audio peak processor message

    onSidecarAudioChange$: Observable<SidecarAudioChangeEvent>

    Fires when Sidecar audio topology changes. For example, audio router is created.

    onSidecarAudioCreate$: Observable<SidecarAudioCreateEvent>

    Fires when Sidecar audio is created

    onSidecarAudioPeakProcessorMessage$: Observable<
        SidecarAudioPeakProcessorMessageEvent,
    >

    Fires on Sidecar audio peak processor message

    onSidecarAudioRemove$: Observable<SidecarAudioRemoveEvent>

    Fires when Sidecar audio is removed

    Methods

    • Activates Sidecar audio tracks

      Parameters

      • ids: string[]

        Sidecar audio OmpAudioTrack.id array to activate

      • deactivateOthers: undefined | boolean

        Set to true if other sidecar audios should be deactivated

      Returns Observable<void>

    • Creates Main audio router

      Parameters

      • inputsNumber: number

        Number of inputs

      • outputsNumberResolver: (maxChannelCount: number) => number

        Function for resolving number of router outputs. Provides outputsNumberResolver.maxChannelCount as function input

      Returns Observable<OmpAudioRouterState>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods