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

    Interface AudioApi

    interface AudioApi {
        onAudioLoaded$: Observable<AudioLoadedEvent | undefined>;
        onAudioOutputVolumeChange$: Observable<VolumeChangeEvent>;
        onAudioSwitched$: Observable<AudioSwitchedEvent>;
        onAudioUpdated$: Observable<AudioUpdatedEvent>;
        onMainAudioChange$: Observable<MainAudioChangeEvent | undefined>;
        onMainAudioInputSoloMute$: Observable<
            MainAudioInputSoloMuteEvent
            | undefined,
        >;
        onMainAudioPeakProcessorMessage$: Observable<
            AudioPeakProcessorMessageEvent,
        >;
        onSidecarAudioChange$: Observable<SidecarAudioChangeEvent>;
        onSidecarAudioCreate$: Observable<SidecarAudioCreateEvent>;
        onSidecarAudioInputSoloMute$: Observable<SidecarAudioInputSoloMuteEvent>;
        onSidecarAudioLoaded$: Observable<SidecarAudioLoadedEvent>;
        onSidecarAudioPeakProcessorMessage$: Observable<
            SidecarAudioPeakProcessorMessageEvent,
        >;
        onSidecarAudioRemove$: Observable<SidecarAudioRemoveEvent>;
        onSidecarAudiosChange$: Observable<SidecarAudiosChangeEvent>;
        onSidecarAudioVolumeChange$: Observable<SidecarAudioVolumeChangeEvent>;
        activateSidecarAudioTracks(
            ids: string[] | undefined,
            deactivateOthers: boolean | undefined,
        ): 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: OmpAudioTrackCreateType,
        ): Observable<OmpAudioTrack>;
        createSidecarAudioTracks(
            tracks: OmpAudioTrackCreateType[],
        ): Observable<OmpAudioTrack[]>;
        deactivateSidecarAudioTracks(ids: string[] | undefined): Observable<void>;
        exportMainAudioTracksToSidecar(
            mainAudioTrackIds: string[],
        ): Observable<OmpAudioTrack[]>;
        exportMainAudioTrackToSidecar(
            mainAudioTrackId: string,
        ): Observable<OmpAudioTrack>;
        getActiveAudioTrack(): OmpAudioTrack | undefined;
        getActiveSidecarAudioTracks(): OmpAudioTrack[];
        getAudioContext(): AudioContext;
        getAudioOutputVolume(): number;
        getAudioTracks(): OmpAudioTrack[];
        getMainAudioInputSoloMuteState(): | OmpMainAudioInputSoloMuteState
        | undefined;
        getMainAudioNode(): AudioNode | undefined;
        getMainAudioRouter(): OmpAudioRouter | undefined;
        getMainAudioRouterInitialRoutingConnections(): | OmpAudioRoutingConnection[]
        | undefined;
        getMainAudioState(): OmpMainAudioState | undefined;
        getSidecarAudio(id: string): SidecarAudioApi | undefined;
        getSidecarAudioInputSoloMuteState(
            id: string,
        ): OmpSidecarAudioInputSoloMuteState | undefined;
        getSidecarAudioRouterInitialRoutingConnections(
            id: string,
        ): OmpAudioRoutingConnection[] | undefined;
        getSidecarAudios(): SidecarAudioApi[];
        getSidecarAudioState(id: string): OmpSidecarAudioState | undefined;
        getSidecarAudioTracks(): OmpAudioTrack[];
        isAudioOutputMuted(): boolean;
        muteAudioOutput(): Observable<void>;
        muteSidecar(ids: string[] | undefined): Observable<void>;
        removeAllSidecarAudioTracks(): Observable<void>;
        removeMainAudioEffectsGraphs(
            routingPath?: Partial<OmpAudioRoutingPath>,
        ): Observable<void>;
        removeSidecarAudioEffectsGraphs(
            sidecarAudioTrackId: string,
            routingPath?: Partial<OmpAudioRoutingPath>,
        ): Observable<void>;
        removeSidecarAudioTracks(ids: string[]): Observable<void>;
        setActiveAudioTrack(id: string): Observable<void>;
        setAudioOutputMuted(muted: boolean): Observable<void>;
        setAudioOutputVolume(volume: number): Observable<void>;
        setMainAudioEffectsGraphs(
            effectsGraphDef: OmpAudioEffectsGraphDef,
            routingPath?: Partial<OmpAudioRoutingPath>,
        ): Observable<void>;
        setMainAudioEffectsParams(
            param: OmpAudioEffectParam,
            filter?: { routingPath?: Partial<OmpAudioRoutingPath> } & OmpAudioEffectFilter,
        ): Observable<void>;
        setMainAudioRouterInitialRoutingConnections(
            connections: OmpAudioRoutingConnection[],
        ): Observable<void>;
        setSidecarAudioEffectsGraph(
            sidecarAudioTrackId: string,
            effectsGraphDef: OmpAudioEffectsGraphDef,
            routingPath?: Partial<OmpAudioRoutingPath>,
        ): Observable<void>;
        setSidecarAudioEffectsParams(
            sidecarAudioTrackId: string,
            param: OmpAudioEffectParam,
            filter?: { routingPath?: Partial<OmpAudioRoutingPath> } & OmpAudioEffectFilter,
        ): Observable<void>;
        setSidecarAudioRouterInitialRoutingConnections(
            id: string,
            connections: OmpAudioRoutingConnection[],
        ): Observable<void>;
        setSidecarMuted(
            muted: boolean,
            ids: string[] | undefined,
        ): Observable<void>;
        setSidecarVolume(
            volume: number,
            ids: string[] | undefined,
        ): Observable<void>;
        toggleAudioOutputMuteUnmute(): Observable<void>;
        toggleMainAudioRouterMute(
            routingPath: OmpAudioRoutingInputType,
        ): Observable<void>;
        toggleMainAudioRouterSolo(
            routingPath: OmpAudioRoutingInputType,
        ): Observable<void>;
        toggleSidecarAudioRouterMute(
            sidecarAudioTrackId: string,
            routingPath: OmpAudioRoutingInputType,
        ): Observable<void>;
        toggleSidecarAudioRouterSolo(
            sidecarAudioTrackId: string,
            routingPath: OmpAudioRoutingInputType,
        ): Observable<void>;
        unmuteAudioOutput(): Observable<void>;
        unmuteSidecar(ids: string[] | undefined): Observable<void>;
        updateAudioTrack(audioTrack: OmpAudioTrack): Observable<void>;
        updateMainAudioRouterConnections(
            connections: OmpAudioRoutingConnection[],
        ): Observable<void>;
        updateSidecarAudioRouterConnections(
            sidecarAudioTrackId: string,
            connections: OmpAudioRoutingConnection[],
        ): Observable<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    onAudioLoaded$ onAudioOutputVolumeChange$ onAudioSwitched$ onAudioUpdated$ onMainAudioChange$ onMainAudioInputSoloMute$ onMainAudioPeakProcessorMessage$ onSidecarAudioChange$ onSidecarAudioCreate$ onSidecarAudioInputSoloMute$ onSidecarAudioLoaded$ onSidecarAudioPeakProcessorMessage$ onSidecarAudioRemove$ onSidecarAudiosChange$ onSidecarAudioVolumeChange$

    Methods

    activateSidecarAudioTracks createMainAudioPeakProcessor createMainAudioRouter createMainAudioRouterWithOutputsResolver createSidecarAudioPeakProcessor createSidecarAudioRouter createSidecarAudioTrack createSidecarAudioTracks deactivateSidecarAudioTracks exportMainAudioTracksToSidecar exportMainAudioTrackToSidecar getActiveAudioTrack getActiveSidecarAudioTracks getAudioContext getAudioOutputVolume getAudioTracks getMainAudioInputSoloMuteState getMainAudioNode getMainAudioRouter getMainAudioRouterInitialRoutingConnections getMainAudioState getSidecarAudio getSidecarAudioInputSoloMuteState getSidecarAudioRouterInitialRoutingConnections getSidecarAudios getSidecarAudioState getSidecarAudioTracks isAudioOutputMuted muteAudioOutput muteSidecar removeAllSidecarAudioTracks removeMainAudioEffectsGraphs removeSidecarAudioEffectsGraphs removeSidecarAudioTracks setActiveAudioTrack setAudioOutputMuted setAudioOutputVolume setMainAudioEffectsGraphs setMainAudioEffectsParams setMainAudioRouterInitialRoutingConnections setSidecarAudioEffectsGraph setSidecarAudioEffectsParams setSidecarAudioRouterInitialRoutingConnections setSidecarMuted setSidecarVolume toggleAudioOutputMuteUnmute toggleMainAudioRouterMute toggleMainAudioRouterSolo toggleSidecarAudioRouterMute toggleSidecarAudioRouterSolo unmuteAudioOutput unmuteSidecar updateAudioTrack updateMainAudioRouterConnections updateSidecarAudioRouterConnections

    Properties

    onAudioLoaded$: Observable<AudioLoadedEvent | undefined>

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

    onAudioOutputVolumeChange$: Observable<VolumeChangeEvent>

    Fires on master audio output volume change

    onAudioSwitched$: Observable<AudioSwitchedEvent>

    Fires on audio track switched

    onAudioUpdated$: Observable<AudioUpdatedEvent>

    Fires on audio track updated

    onMainAudioChange$: Observable<MainAudioChangeEvent | undefined>

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

    onMainAudioInputSoloMute$: Observable<MainAudioInputSoloMuteEvent | undefined>

    Fires on Main audio input solo/mute action

    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

    onSidecarAudioInputSoloMute$: Observable<SidecarAudioInputSoloMuteEvent>

    Fires on Sidecar audio input solo/mute action

    onSidecarAudioLoaded$: Observable<SidecarAudioLoadedEvent>

    Fires when Sidecar audio is loaded

    onSidecarAudioPeakProcessorMessage$: Observable<
        SidecarAudioPeakProcessorMessageEvent,
    >

    Fires on Sidecar audio peak processor message

    onSidecarAudioRemove$: Observable<SidecarAudioRemoveEvent>

    Fires when Sidecar audio is removed

    onSidecarAudiosChange$: Observable<SidecarAudiosChangeEvent>

    Fires when any Sidecar audio is created, removed or changed

    onSidecarAudioVolumeChange$: Observable<SidecarAudioVolumeChangeEvent>

    Fires when Sidecar audio volume changes.

    Methods

    • Activates Sidecar audio tracks

      Parameters

      • ids: string[] | undefined

        Sidecar audio track OmpAudioTrack.ids, if undefined changes will affect all tracks

      • deactivateOthers: boolean | undefined

        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>

    • Deactivates Sidecar audio tracks, if undefined changes will affect all tracks

      Parameters

      Returns Observable<void>

    • Returns OmpMainAudioInputSoloMuteState | undefined

      Main audio input state

    • Parameters

      • id: string

      Returns OmpSidecarAudioInputSoloMuteState | undefined

      Sidecar audio input state

    • Mutes sidecar audio

      Parameters

      • ids: string[] | undefined

        Sidecar audio track OmpAudioTrack.ids, if undefined changes will affect all tracks

      Returns Observable<void>

    • Sets master output audio muted. Master output volume control is located in chain after main audio and sidecar audios. It affects main audio level and sidecar audios levels.

      Parameters

      • muted: boolean

      Returns Observable<void>

    • Sets master output audio volume. Master output volume control is located in chain after main audio and sidecar audios. It affects main audio level and sidecar audios levels.

      Parameters

      • volume: number

        volume level

      Returns Observable<void>

    • Sets sidecar audio muted / unmuted

      Parameters

      • muted: boolean

        muted (true) or unmuted (false)

      • ids: string[] | undefined

        Sidecar audio track OmpAudioTrack.ids, if undefined changes will affect all tracks

      Returns Observable<void>

    • Sets sidecar audio volume. Unmutes audio.

      Parameters

      • volume: number
      • ids: string[] | undefined

        Sidecar audio track OmpAudioTrack.ids, if undefined changes will affect all tracks

      Returns Observable<void>

    • Mute or unmute (depending on current input state) given main audio router input

      Parameters

      • routingPath: OmpAudioRoutingInputType

      Returns Observable<void>

    • Solo or unsolo (depending on current input state) given main audio router input

      Parameters

      • routingPath: OmpAudioRoutingInputType

      Returns Observable<void>

    • Mute or unmute (depending on current input state) given sidecar audio router input

      Parameters

      • sidecarAudioTrackId: string
      • routingPath: OmpAudioRoutingInputType

      Returns Observable<void>

    • Solo or unsolo (depending on current input state) given sidecar audio router input

      Parameters

      • sidecarAudioTrackId: string
      • routingPath: OmpAudioRoutingInputType

      Returns Observable<void>

    • Unmutes sidecar audio

      Parameters

      • ids: string[] | undefined

        Sidecar audio track OmpAudioTrack.ids, if undefined changes will affect all tracks

      Returns Observable<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    activateSidecarAudioTrackscreateMainAudioPeakProcessorcreateMainAudioRoutercreateMainAudioRouterWithOutputsResolvercreateSidecarAudioPeakProcessorcreateSidecarAudioRoutercreateSidecarAudioTrackcreateSidecarAudioTracksdeactivateSidecarAudioTracksexportMainAudioTracksToSidecarexportMainAudioTrackToSidecargetActiveAudioTrackgetActiveSidecarAudioTracksgetAudioContextgetAudioOutputVolumegetAudioTracksgetMainAudioInputSoloMuteStategetMainAudioNodegetMainAudioRoutergetMainAudioRouterInitialRoutingConnectionsgetMainAudioStategetSidecarAudiogetSidecarAudioInputSoloMuteStategetSidecarAudioRouterInitialRoutingConnectionsgetSidecarAudiosgetSidecarAudioStategetSidecarAudioTracksisAudioOutputMutedmuteAudioOutputmuteSidecarremoveAllSidecarAudioTracksremoveMainAudioEffectsGraphsremoveSidecarAudioEffectsGraphsremoveSidecarAudioTrackssetActiveAudioTracksetAudioOutputMutedsetAudioOutputVolumesetMainAudioEffectsGraphssetMainAudioEffectsParamssetMainAudioRouterInitialRoutingConnectionssetSidecarAudioEffectsGraphsetSidecarAudioEffectsParamssetSidecarAudioRouterInitialRoutingConnectionssetSidecarMutedsetSidecarVolumetoggleAudioOutputMuteUnmutetoggleMainAudioRouterMutetoggleMainAudioRouterSolotoggleSidecarAudioRouterMutetoggleSidecarAudioRouterSolounmuteAudioOutputunmuteSidecarupdateAudioTrackupdateMainAudioRouterConnectionsupdateSidecarAudioRouterConnections