Interface CompositeAudioNode

The CompositeAudioNode can be used to mixin different AudioNodes into single one. In the ParamMgr's case. the ParamMgrNode can be used to proxy the WebAudioModule interface, the _wamNode, then let other AudioNodes to connect to the host's audio graph, the _output.

interface CompositeAudioNode {
    _output: AudioNode;
    _wamNode: WamNode;
    channelCount: number;
    channelCountMode: ChannelCountMode;
    channelInterpretation: ChannelInterpretation;
    context: BaseAudioContext;
    gain: AudioParam;
    groupId: string;
    instanceId: string;
    module: WebAudioModule<WamNode>;
    moduleId: string;
    numberOfInputs: number;
    numberOfOutputs: number;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    clearEvents(): void;
    connect(destinationNode, output?, input?): AudioNode;
    connect(destinationParam, output?): void;
    connectEvents(toId, output?): void;
    destroy(): void;
    disconnect(): void;
    disconnect(output): void;
    disconnect(destinationNode): void;
    disconnect(destinationNode, output): void;
    disconnect(destinationNode, output, input): void;
    disconnect(destinationParam): void;
    disconnect(destinationParam, output): void;
    disconnectEvents(toId?, output?): void;
    dispatchEvent(event): boolean;
    getCompensationDelay(): Promise<number>;
    getParameterInfo(...parameterIdQuery): Promise<WamParameterInfoMap>;
    getParameterValues(normalized?, ...parameterIdQuery): Promise<WamParameterDataMap>;
    getState(): Promise<any>;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    scheduleEvents(...event): void;
    setParameterValues(parameterValues): Promise<void>;
    setState(state): Promise<void>;
}

Hierarchy

  • Omit<GainNode, keyof EventTarget>
  • WamNode
    • CompositeAudioNode

Properties

_output _wamNode channelCount channelCountMode channelInterpretation context gain groupId instanceId module moduleId numberOfInputs numberOfOutputs

Methods

addEventListener clearEvents connect connectEvents destroy disconnect disconnectEvents dispatchEvent getCompensationDelay getParameterInfo getParameterValues getState removeEventListener scheduleEvents setParameterValues setState

Properties

_output

_output: AudioNode

undefined by default, override it after calling every this.connect()

_wamNode

_wamNode: WamNode

undefined by default, override it for proxying the interface

channelCount

channelCount: number

MDN Reference

channelCountMode

channelCountMode: ChannelCountMode

MDN Reference

channelInterpretation

channelInterpretation: ChannelInterpretation

MDN Reference

Readonly context

context: BaseAudioContext

MDN Reference

Readonly gain

gain: AudioParam

Readonly groupId

groupId: string

Readonly instanceId

instanceId: string

Readonly module

module: WebAudioModule<WamNode>

Current WebAudioModule.

Readonly moduleId

moduleId: string

Readonly numberOfInputs

numberOfInputs: number

MDN Reference

Readonly numberOfOutputs

numberOfOutputs: number

MDN Reference

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Register a callback function so it will be called when matching events are processed.

    Type Parameters

    • K extends keyof WamEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

clearEvents

  • clearEvents(): void

  • Clear all pending WamEvents.

    Returns void

connect

  • connect(destinationNode, output?, input?): AudioNode

  • MDN Reference

    Parameters

    • destinationNode: AudioNode
    • Optional output: number
    • Optional input: number

    Returns AudioNode

  • connect(destinationParam, output?): void

  • Parameters

    • destinationParam: AudioParam
    • Optional output: number

    Returns void

connectEvents

  • connectEvents(toId, output?): void

  • Connect an event output stream to another WAM. If no output index is given, assume output 0.

    Parameters

    • toId: string
    • Optional output: number

    Returns void

destroy

  • destroy(): void

  • Stop processing and remove the node from the graph.

    Returns void

disconnect

  • disconnect(): void

  • MDN Reference

    Returns void

  • disconnect(output): void

  • Parameters

    • output: number

    Returns void

  • disconnect(destinationNode): void

  • Parameters

    • destinationNode: AudioNode

    Returns void

  • disconnect(destinationNode, output): void

  • Parameters

    • destinationNode: AudioNode
    • output: number

    Returns void

  • disconnect(destinationNode, output, input): void

  • Parameters

    • destinationNode: AudioNode
    • output: number
    • input: number

    Returns void

  • disconnect(destinationParam): void

  • Parameters

    • destinationParam: AudioParam

    Returns void

  • disconnect(destinationParam, output): void

  • Parameters

    • destinationParam: AudioParam
    • output: number

    Returns void

disconnectEvents

  • disconnectEvents(toId?, output?): void

  • Disconnect an event output stream from another WAM. If no arguments are given, all event streams will be disconnected.

    Parameters

    • Optional toId: string
    • Optional output: number

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

getCompensationDelay

  • getCompensationDelay(): Promise<number>

  • Compensation delay hint in samples

    Returns Promise<number>

getParameterInfo

  • getParameterInfo(...parameterIdQuery): Promise<WamParameterInfoMap>

  • Get parameter info for the specified parameter ids, or omit argument to get info for all parameters.

    Parameters

    • Rest ...parameterIdQuery: string[]

    Returns Promise<WamParameterInfoMap>

getParameterValues

  • getParameterValues(normalized?, ...parameterIdQuery): Promise<WamParameterDataMap>

  • Get parameter values for the specified parameter ids, or omit argument to get values for all parameters.

    Parameters

    • Optional normalized: boolean
    • Rest ...parameterIdQuery: string[]

    Returns Promise<WamParameterDataMap>

getState

  • getState(): Promise<any>

  • Returns an object (such as JSON or a serialized blob) that can be used to restore the WAM's state.

    Returns Promise<any>

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Deregister a callback function so it will no longer be called when matching events are processed.

    Type Parameters

    • K extends keyof WamEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

scheduleEvents

  • scheduleEvents(...event): void

  • Schedule a WamEvent. Listeners will be triggered when the event is processed.

    Parameters

    • Rest ...event: WamEvent[]

    Returns void

setParameterValues

  • setParameterValues(parameterValues): Promise<void>

  • Set parameter values for the specified parameter ids.

    Parameters

    • parameterValues: WamParameterDataMap

    Returns Promise<void>

setState

  • setState(state): Promise<void>

  • Use an object (such as JSON or a serialized blob) to restore the WAM's state.

    Parameters

    • state: any

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc