SoundObject

Description

Supported Script Types:

  • Interface Scripts
  • Client Entity Scripts
  • Avatar Scripts
  • Server Entity Scripts
  • Assignment Client Scripts
An audio resource, created by SoundCache.getSound, to be played back using Audio.playSound.

Supported formats:

  • WAV: 16-bit uncompressed at any sample rate, with 1 (mono), 2 (stereo), or 4 (ambisonic) channels.
  • MP3: Mono or stereo, at any sample rate.
  • RAW: 48khz 16-bit mono or stereo. File name must include ".stereo" to be interpreted as stereo.

Properties

Name Type Summary
downloaded boolean

true if the sound has been downloaded and is ready to be played, otherwise false. Read-only.

duration number

The duration of the sound, in seconds. Read-only.

Signals

Name Summary
ready

Triggered when the sound has been downloaded and is ready to be played.

Signal Details

ready( )
Returns: Signal

Triggered when the sound has been downloaded and is ready to be played.