Class HRTFInput

HRTFInput represents a spatialized audio source being heard by the Listener / HRTFOutput node. The audio source can be a local source or one recieved over WebRTC.

Example

 let sourceNode = new AudioBufferSourceNode(audioContext);
 sourceNode.buffer = audioBuffer;
 sourceNode.loop = true;
 let hrtfInput = new HRTFInput(audioContext);
 sourceNode.connect(hrtfInput);

let mediaStreamTrack = audioTrack.getMediaStreamTrack();
let mediaStream = new MediaStream([mediaStreamTrack]);
let sourceNode = audioContext.createMediaStreamSource(mediaStream);
let hrtfInput = new HRTFInput(audioContext);
sourceNode.connect(hrtfInput);

Hierarchy

  • AudioWorkletNode
    • HRTFInput

Constructors

constructor

Properties

channelCount channelCountMode channelInterpretation context numberOfInputs numberOfOutputs onprocessorerror parameters port

Methods

addEventListener connect disconnect dispatchEvent removeEventListener setPosition

Constructors

constructor

  • Parameters

    • audioContext: AudioContext

      The AudioContext to use. It should be created with a sample rate of 48000.

    Returns HRTFInput

Properties

channelCount

channelCount: number

channelCountMode

channelCountMode: ChannelCountMode

channelInterpretation

channelInterpretation: ChannelInterpretation

Readonly context

context: BaseAudioContext

Readonly numberOfInputs

numberOfInputs: number

Readonly numberOfOutputs

numberOfOutputs: number

onprocessorerror

onprocessorerror: ((this: AudioWorkletNode, ev: Event) => any)

Type declaration

    • (this: AudioWorkletNode, ev: Event): any

    • Parameters

      • this: AudioWorkletNode
      • ev: Event

      Returns any

Readonly parameters

parameters: AudioParamMap

Readonly port

port: MessagePort

Methods

addEventListener

  • Type Parameters

    • K extends "processorerror"

    Parameters

    • type: K
    • listener: ((this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]) => any)
        • (this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]): any

        • Parameters

          • this: AudioWorkletNode
          • ev: AudioWorkletNodeEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

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

    Returns void

connect

  • Parameters

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

    Returns AudioNode

  • Parameters

    • destinationParam: AudioParam
    • Optional output: number

    Returns void

disconnect

  • Disconnect this WebAudio node from other nodes.

    Returns void

dispatchEvent

  • 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

removeEventListener

  • Type Parameters

    • K extends "processorerror"

    Parameters

    • type: K
    • listener: ((this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]) => any)
        • (this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]): any

        • Parameters

          • this: AudioWorkletNode
          • ev: AudioWorkletNodeEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

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

    Returns void

setPosition

  • Set the position of this audio source relative to the Listener.

    Parameters

    • azimuth: number

      angle in radians measured between the direction the Listener is facing and the direction to the Source.

    • distance: number

      the Source's distance from the Listener in meters.

      WebAudio Nodes

    Returns void

Settings

Member Visibility

Theme

© 2023 High Fidelity, Inc. | All rights reserved Terms of Service | Privacy Policy