Class Audio`Abstract`

Provides global functionality relating to sounds and music.

Index

Constructors

Accessors

activeDevice allDevices defaultDevice volume

Methods

exportClipToPCMWAV isPaused playOneShot setPaused

Constructors

constructor

new Audio(): Audio

Returns Audio

Accessors

`Static`activeDevice

get activeDevice(): Immutable<AudioDevice>

Determines the device on which is the audio played back on.

Returns Immutable<AudioDevice>
set activeDevice(value: Immutable<AudioDevice>): void
Parameters
- value: Immutable<AudioDevice>
Returns void

`Static`allDevices

get allDevices(): Iterable<AudioDevice>

Returns a list of all available audio devices.

Returns Iterable<AudioDevice>

`Static`defaultDevice

get defaultDevice(): Immutable<AudioDevice>

Returns the default audio device identifier.

Returns Immutable<AudioDevice>

`Static`volume

get volume(): number

Determines global audio volume. In range [0, 1].

Returns number
set volume(value: number): void
Parameters
- value: number
Returns void

Methods

`Static`exportClipToPCMWAV

exportClipToPCMWAV(
clip: AudioClip | ResourceHandle<AudioClip>,
outputStream: DataStream,
): UncertainAsyncOp<void, string>
Exports the given clip to an outputStream as a PCM WAV file.
Parameters
- clip: AudioClip | ResourceHandle<AudioClip>
- outputStream: DataStream
Returns UncertainAsyncOp<void, string>

`Static`isPaused

isPaused(sceneInstance: SceneInstance): boolean
Determines if audio reproduction is paused for the sceneInstance.
Parameters
- sceneInstance: SceneInstance
Returns boolean

`Static`playOneShot

playOneShot(
    sceneInstance: SceneInstance,
    clip: AudioClip,
    position?: Immutable<Vector3>,
    volume?: number,
    pitch?: number,
    minimumDistance?: number,
    attenuation?: number,
): ActiveAudioSource
Starts playback of the provided audio clip as a 'one-shot' source. This can be used for a quicker way of creating audio sources if you don't need the full control provided by creating AudioSource manually.
Parameters
- sceneInstance: SceneInstance
- clip: AudioClip
  Audio clip to play.
- Optionalposition: Immutable<Vector3>
  Position in world space to play the clip at. Only relevant if the clip is 3D.
- Optionalvolume: number
  Volume to play the clip at.
- Optionalpitch: number
  The pitch of the clip. Default is 1.
- OptionalminimumDistance: number
  The distance in units that no attenuation occurs. Default is 10.
- Optionalattenuation: number
  Increases or lower distance attenuation. 0, disables distance attenuation. Default is 1.
Returns ActiveAudioSource
The AudioSource if successfull or null.

`Static`setPaused

setPaused(sceneInstance: SceneInstance, paused: boolean): void
Pauses the audio for the specified sceneInstance. Set sceneInstance to null to pause all scenes.
Parameters
- sceneInstance: SceneInstance
- paused: boolean
Returns void

Note
Implementing classes must call super.