Class AudioEngineV2Abstract

Abstract ReadonlycurrentTime

Abstract Readonlylistener

Abstract ReadonlymainOut

Abstract Readonlystate

Abstractvolume

defaultMainBus

• get defaultMainBus(): Nullable<MainAudioBus>

  The default main bus that will be used for audio buses and sounds if their outBus option is not set.

  Returns Nullable<MainAudioBus>

  See

  • IAudioBusOptions.outBus
  • IAbstractSoundOptions.outBus

nodes

• get nodes(): ReadonlySet<AbstractNamedAudioNode>

  The list of top-level audio nodes (sounds, sound sources, buses, main buses) owned by the audio engine.

  Returns ReadonlySet<AbstractNamedAudioNode>

onDisposeObservable

• get onDisposeObservable(): IReadonlyObservable<AudioEngineV2>

  Observable that notifies when this engine is disposed.

  • Fires from AudioEngineV2.dispose after the engine has been removed from AudioEngineV2.Instances.

  Returns IReadonlyObservable<AudioEngineV2>

onNodeAddedObservable

• get onNodeAddedObservable(): IReadonlyObservable<AbstractNamedAudioNode>

  Observable that notifies when a top-level audio node (sound, sound source, bus, or main bus) is added to this engine.

  Returns IReadonlyObservable<AbstractNamedAudioNode>

onNodeRemovedObservable

• get onNodeRemovedObservable(): IReadonlyObservable<AbstractNamedAudioNode>

  Observable that notifies when a top-level audio node (sound, sound source, bus, or main bus) is removed from this engine.

  Returns IReadonlyObservable<AbstractNamedAudioNode>

parameterRampDuration

• get parameterRampDuration(): number

  The smoothing duration to use when changing audio parameters, in seconds. Defaults to 0.01 (10 milliseconds).

  Returns number

• set parameterRampDuration(value: number): void

  Parameters

  • value: number

  Returns void

sounds

• get sounds(): readonly AbstractSound[]

  The list of static and streaming sounds created by the audio engine.

  Returns readonly AbstractSound[]

StaticInstances

• get Instances(): readonly AudioEngineV2[]

  The list of v2 audio engines that have been created and not yet disposed.

  • Engines are added on construction and removed on AudioEngineV2.dispose.

  Returns readonly AudioEngineV2[]

AbstractcreateBusAsync

• createBusAsync(
      name: string,
      options?: Partial<IAudioBusOptions>,
  ): Promise<AudioBus>

  Creates a new audio bus.

  Parameters

  • name: string

    The name of the audio bus.

  • Optionaloptions: Partial<IAudioBusOptions>

    The options to use when creating the audio bus.

  Returns Promise<AudioBus>

  A promise that resolves with the created audio bus.

AbstractcreateMainBusAsync

• createMainBusAsync(
      name: string,
      options?: Partial<IMainAudioBusOptions>,
  ): Promise<MainAudioBus>

  Creates a new main audio bus.

  Parameters

  • name: string

    The name of the main audio bus.

  • Optionaloptions: Partial<IMainAudioBusOptions>

    The options to use when creating the main audio bus.

  Returns Promise<MainAudioBus>

  A promise that resolves with the created main audio bus.

AbstractcreateMicrophoneSoundSourceAsync

• createMicrophoneSoundSourceAsync(
      name: string,
      options?: Partial<ISoundSourceOptions>,
  ): Promise<AbstractSoundSource>

  Creates a new microphone sound source.

  Parameters

  • name: string

    The name of the sound.

  • Optionaloptions: Partial<ISoundSourceOptions>

    The options for the sound source.

  Returns Promise<AbstractSoundSource>

  A promise that resolves to the created sound source.

AbstractcreateSoundAsync

• createSoundAsync(
      name: string,
      source: string | string[] | ArrayBuffer | AudioBuffer | StaticSoundBuffer,
      options?: Partial<IStaticSoundOptions>,
  ): Promise<StaticSound>

  Creates a new static sound.

  Parameters

  • name: string

    The name of the sound.

  • source: string | string[] | ArrayBuffer | AudioBuffer | StaticSoundBuffer

    The source of the sound.

  • Optionaloptions: Partial<IStaticSoundOptions>

    The options for the static sound.

  Returns Promise<StaticSound>

  A promise that resolves to the created static sound.

AbstractcreateSoundBufferAsync

• createSoundBufferAsync(
      source:
          | string
          | string[]
          | ArrayBuffer
          | AudioBuffer
          | StaticSoundBuffer,
      options?: Partial<IStaticSoundBufferOptions>,
  ): Promise<StaticSoundBuffer>

  Creates a new static sound buffer.

  Parameters

  • source: string | string[] | ArrayBuffer | AudioBuffer | StaticSoundBuffer

    The source of the sound buffer.

  • Optionaloptions: Partial<IStaticSoundBufferOptions>

    The options for the static sound buffer.

  Returns Promise<StaticSoundBuffer>

  A promise that resolves to the created static sound buffer.

AbstractcreateSoundSourceAsync

• createSoundSourceAsync(
      name: string,
      source: AudioNode,
      options?: Partial<ISoundSourceOptions>,
  ): Promise<AbstractSoundSource>

  Creates a new sound source.

  Parameters

  • name: string

    The name of the sound.

  • source: AudioNode

    The source of the sound.

  • Optionaloptions: Partial<ISoundSourceOptions>

    The options for the sound source.

  Returns Promise<AbstractSoundSource>

  A promise that resolves to the created sound source.

AbstractcreateStreamingSoundAsync

• createStreamingSoundAsync(
      name: string,
      source: string | string[] | HTMLMediaElement,
      options?: Partial<IStreamingSoundOptions>,
  ): Promise<StreamingSound>

  Creates a new streaming sound.

  Parameters

  • name: string

    The name of the sound.

  • source: string | string[] | HTMLMediaElement

    The source of the sound.

  • Optionaloptions: Partial<IStreamingSoundOptions>

    The options for the streaming sound.

  Returns Promise<StreamingSound>

  A promise that resolves to the created streaming sound.

dispose

• dispose(): void

  Releases associated resources.

  Returns void

AbstractisFormatValid

• isFormatValid(format: string): boolean

  Checks if the specified format is valid.

  Parameters

  • format: string

    The format to check as an audio file extension like "mp3" or "wav".

  Returns boolean

  true if the format is valid; otherwise false.

AbstractpauseAsync

• pauseAsync(): Promise<void>

  Pauses the audio engine if it is running.

  Returns Promise<void>

  A promise that resolves when the audio engine is paused.

AbstractresumeAsync

• resumeAsync(): Promise<void>

  Resumes the audio engine if it is not running.

  Returns Promise<void>

  A promise that resolves when the audio engine is running.

AbstractsetVolume

• setVolume(value: number, options?: Partial<IAudioParameterRampOptions>): void

  Sets the audio output volume with optional ramping. If the duration is 0 then the volume is set immediately, otherwise it is ramped to the new value over the given duration using the given shape. If a ramp is already in progress then the volume is not set and an error is thrown.

  Parameters

  • value: number

    The value to set the volume to.

  • Optionaloptions: Partial<IAudioParameterRampOptions>

    The options to use for ramping the volume change.

  Returns void

unlockAsync

• unlockAsync(): Promise<void>

  Unlocks the audio engine if it is locked.

  • Note that the returned promise may already be resolved if the audio engine is already unlocked.

  Returns Promise<void>

  A promise that is resolved when the audio engine is unlocked.