Interface AudioHandlerApi

interface AudioHandlerApi {
    channelCount: number;
    effects: AudioEffectsApi;
    enabled: boolean;
    inputAudioNode: AudioNode;
    muted: boolean;
    onEvent$: Observable<
        { data: AudioHandlerEventData; type: AUDIO_HANDLER_CHANGE },
    >;
    onPeakProcessorEvent$: Observable<AudioPeakProcessorEvent>;
    outputAudioNode: AudioNode;
    router: AudioRouterApi | undefined;
    state: AudioHandlerState;
    volume: number;
    createAudioRouter(
        inputsNumber?: number,
        outputsNumber?: number,
    ): Observable<AudioRouterApi>;
    createPeakProcessor(): Observable<void>;
    createPeakProcessor(
        meterStandard?: AudioPeakProcessorMeterStandard,
    ): Observable<void>;
    mute(): Observable<void>;
    setEnabled(enabled: boolean): Observable<void>;
    setMuted(muted: boolean): Observable<void>;
    setVolume(volume: number): Observable<void>;
    toggleMuted(): Observable<void>;
    unmute(): Observable<void>;
}

Index

Properties

channelCount effects enabled inputAudioNode muted onEvent$ onPeakProcessorEvent$ outputAudioNode router state volume

Methods

createAudioRouter createPeakProcessor mute setEnabled setMuted setVolume toggleMuted unmute

Properties

channelCount

channelCount: number

effects

effects: AudioEffectsApi

enabled

enabled: boolean

inputAudioNode

inputAudioNode: AudioNode

muted

muted: boolean

onEvent$

onEvent$: Observable<
{ data: AudioHandlerEventData; type: AUDIO_HANDLER_CHANGE },
>

onPeakProcessorEvent$

onPeakProcessorEvent$: Observable<AudioPeakProcessorEvent>

outputAudioNode

outputAudioNode: AudioNode

router

router: AudioRouterApi | undefined

state

state: AudioHandlerState

volume

volume: number

Methods

createAudioRouter

createAudioRouter(
inputsNumber?: number,
outputsNumber?: number,
): Observable<AudioRouterApi>
Parameters
- OptionalinputsNumber: number
- OptionaloutputsNumber: number
Returns Observable<AudioRouterApi>
- Defined in src/audio/audio-handler.ts:145

createPeakProcessor

createPeakProcessor(): Observable<void>
Returns Observable<void>
- Defined in src/audio/audio-handler.ts:142
createPeakProcessor(
meterStandard?: AudioPeakProcessorMeterStandard,
): Observable<void>
Parameters
- OptionalmeterStandard: AudioPeakProcessorMeterStandard
Returns Observable<void>
- Defined in src/audio/audio-handler.ts:143

mute

mute(): Observable<void>
Returns Observable<void>
- Defined in src/audio/audio-handler.ts:130

setEnabled

setEnabled(enabled: boolean): Observable<void>
Parameters
- enabled: boolean
Returns Observable<void>
- Defined in src/audio/audio-handler.ts:140

setMuted

setMuted(muted: boolean): Observable<void>
Parameters
- muted: boolean
Returns Observable<void>
- Defined in src/audio/audio-handler.ts:136

setVolume

setVolume(volume: number): Observable<void>
Parameters
- volume: number
Returns Observable<void>
- Defined in src/audio/audio-handler.ts:138

toggleMuted

toggleMuted(): Observable<void>
Returns Observable<void>
- Defined in src/audio/audio-handler.ts:134

unmute

unmute(): Observable<void>
Returns Observable<void>
- Defined in src/audio/audio-handler.ts:132