Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AbstractWamNode

Hierarchy

  • AudioNode
    • AbstractWamNode

Index

Properties

Methods

Properties

channelCount

channelCount: number

channelCountMode

channelCountMode: ChannelCountMode

channelInterpretation

channelInterpretation: ChannelInterpretation

Readonly context

context: BaseAudioContext

Readonly groupId

groupId: string

Readonly instanceId

instanceId: string

Readonly module

module: AbstractWebAudioModule<AbstractWamNode>

Current WebAudioModule.

Readonly moduleId

moduleId: string

Readonly numberOfInputs

numberOfInputs: number

Readonly numberOfOutputs

numberOfOutputs: number

Methods

addEventListener

  • addEventListener<K>(type: K, listener: (this: AbstractWamNode | AudioWorkletNode, ev: CustomEvent<WamEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: (this: AbstractWamNode | AudioWorkletNode, ev: CustomEvent<any>) => any, options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

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

    Type parameters

    Parameters

    Returns void

  • Parameters

    • type: string
    • listener: (this: AbstractWamNode | AudioWorkletNode, ev: CustomEvent<any>) => any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

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

    Returns void

clearEvents

  • clearEvents(): void

connect

  • connect(destinationNode: AudioNode, output?: number, input?: number): AudioNode
  • connect(destinationParam: AudioParam, output?: number): void

  • Parameters

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

    Returns AudioNode

  • Parameters

    • destinationParam: AudioParam
    • Optional output: number

    Returns void

connectEvents

  • connectEvents(toId: string, output?: number): 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
  • disconnect(output: number): void
  • disconnect(destinationNode: AudioNode): void
  • disconnect(destinationNode: AudioNode, output: number): void
  • disconnect(destinationNode: AudioNode, output: number, input: number): void
  • disconnect(destinationParam: AudioParam): void
  • disconnect(destinationParam: AudioParam, output: number): void

  • Returns void

  • Parameters

    • output: number

    Returns void

  • Parameters

    • destinationNode: AudioNode

    Returns void

  • Parameters

    • destinationNode: AudioNode
    • output: number

    Returns void

  • Parameters

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

    Returns void

  • Parameters

    • destinationParam: AudioParam

    Returns void

  • Parameters

    • destinationParam: AudioParam
    • output: number

    Returns void

disconnectEvents

  • disconnectEvents(toId?: string, output?: number): 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: 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.

    Parameters

    • event: Event

    Returns boolean

getCompensationDelay

  • getCompensationDelay(): Promise<number>

getParameterInfo

  • 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?: boolean, ...parameterIdQuery: string[]): 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: K, listener: (this: AbstractWamNode | AudioWorkletNode, ev: CustomEvent<WamEventMap[K]>) => any, options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: (this: AbstractWamNode | AudioWorkletNode, ev: CustomEvent<any>) => any, options?: boolean | AddEventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

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

    Type parameters

    Parameters

    Returns void

  • Parameters

    • type: string
    • listener: (this: AbstractWamNode | AudioWorkletNode, ev: CustomEvent<any>) => any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

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

    Returns void

scheduleEvents

  • scheduleEvents(...event: WamEvent[]): void

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

    Parameters

    Returns void

setParameterValues

setState

  • setState(state: any): Promise<void>

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

    Parameters

    • state: any

    Returns Promise<void>

Generated using TypeDoc