Element/Sound

The sound element represents a custom sound sent to the client via the use of the file parameter inside the meta file and created either by playSound or playSound3D.

A sound element is created using playSound3D or playSound and can be manipulated with the following element functions:.

• setElementPosition
• setElementDimension

Sound elements can also be manipulated using the other Client audio functions.

The element type of this class is "sound".

Related scripting functions

Client

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM
• getSoundBufferLength

* FEATURE ADDED IN 1.5.9 (REVISION: r20914)

• getSoundEffectParameters

• getSoundEffects
• getSoundFFTData
• getSoundLength
• getSoundLevelData
• getSoundMaxDistance
• getSoundMetaTags
• getSoundMinDistance
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData

* FEATURE ADDED IN 1.5.9 (REVISION: r20785)

• isSoundLooped

• isSoundPanningEnabled
• isSoundPaused
• playSFX3D
• playSFX
• playSound3D
• playSound
• playSoundFrontEnd
• setRadioChannel
• setSoundEffectEnabled

* FEATURE ADDED IN 1.5.9 (REVISION: r20914)

• setSoundEffectParameter

* FEATURE ADDED IN 1.5.9 (REVISION: r20785)

• setSoundLooped

• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPaused
• setSoundPosition
• setSoundProperties
• setSoundSpeed
• setSoundVolume
• stopSound