Interface ApiAudio`Item`

A handle to manipulate audio.

interface ApiAudio {
    volume: number;
    attach(subNode: SubNode): void;
    attachToRoot(): void;
    play(): void;
    stop(): void;
}

Index

Properties

Methods

attach attachToRoot play stop

Properties

volume

volume: number

A property representing the volume of the audio. This property cannot be accessed at the top level of the script.

The default is 1. The volume can be a number between 0 and 2.5.

Methods

attach

attach(subNode: SubNode): void
Set the spatial origin of the audio's positional playback to the specified SubNode.

By default, the audio's spatial origin is the item's root position.
If a non-existent SubNode is specified, the audio's spatial origin will be set to the item's root position.
Parameters
- subNode: SubNode
Returns void

attachToRoot

attachToRoot(): void
Set the spatial origin of the audio's positional playback to the item's root position.

Returns void

play

play(): void
Plays the audio.

When called against an audio already in playback, the playback will stop, then restart from the beginning.

Returns void

stop

stop(): void
Stops the audio.

Returns void