The Sound class allows you to edit or create a Sound object within your zone. All settings can be manipulated through script.
![]() |
|
new(int objectID) | Description Gets a Sound object in the current zone from its object ID. Parameters int objectID
Returns Sound |
new(string path) | Description Creates a new Sound object in the current zone from a file path. Parameters string path
Returns Sound |
![]() |
|
FadeStop() | Description Stops the sound currently being played, fading out over the time period set by the fadeTime property. Parameters None Returns Void |
IsPlaying() | Description Pauses the sound at its current progress. Sound will resume from current point after the Play function is called. Parameters None Returns bool |
Play() | Description Plays the sound at its current progress. Parameters None Returns Void |
Stop() | Description Stops the sound and resets the progress to zero. Parameters None Returns Void |
UpdateEffects() | Description Applies all audio effect properties to the sound. This function must be called for any changes to sound effect properties to take effect. Parameters None Returns Void |
UpdateSound() | Description Applies all sound properties. This function must be called for any changes to sound properties to take effect. Parameters None Returns Void |
![]() |
|
float chorusDelay | Gets or sets the chorus effect delay of the sound. |
float chorusDepth | Gets or sets the chorus effect depth of the sound. |
bool chorusEnabled | Enables or Disables the chorus effect on the sound. |
float chorusFeedback | Gets or sets the chorus effect feedback of the sound. |
float chorusFrequency | Gets or sets the chorus effect frequency of the sound. |
int chorusPhase | Gets or sets the chorus effect phase of the sound. Value can only be set to -180, -90, 0, 90, or 180. |
int chorusWaveform | Gets or sets the chorus effect waveform of the sound.
|
float chorusWetDryMix | Gets or sets the chorus effect mix between wet and dry signal of the sound. |
float compressorAttack | Gets or sets the compressor effect attack of the sound. |
bool compressorEnabled | Enables or Disables the compressor effect on the sound. |
float compressorGain | Gets or sets the compressor effect gain of the sound. |
float compressorPredelay | Gets or sets the compressor effect pre-delay of the sound. |
float compressorRatio | Gets or sets the compressor effect ratio of the sound. |
float compressorRelease | Gets or sets the compressor effect release of the sound. |
float compressorThreshold | Gets or sets the compressor effect threshold of the sound. |
float distortionEdge | Gets or sets the distortion effect edge of the sound. |
bool distortionEnabled | Enables or Disables the distortion effect on the sound. |
float distortionGain | Gets or sets the distortion effect gain of the sound. |
float distortionPostEQBandwidth | Gets or sets the distortion effect post EQ bandwidth of the sound. |
float distortionPostEQFrequency | Gets or sets the distortion effect post EQ frequency of the sound. |
float distortionPreLowpassCutoff | Gets or sets the distortion effect lowpass cutoff of the sound. |
bool echoEnabled | Enables or Disables the echo effect on the sound. |
float echoFeedback | Gets or sets the echo effect feedback of the sound. |
float echoLeftDelay | Gets or sets the echo effect left delay of the sound. |
int echoPanDelay | Gets or sets the echo effect pan delay of the sound. |
float echoRightDelay | Gets or sets the echo effect right delay of the sound. |
float echoWetDryMix | Gets or sets the echo effect mix between wet and dry signal of the sound. |
float fadeTime | Gets or sets the fade time of the sound after FadeStop funciton is called. |
float flangerDelay | Gets or sets the flanger effect delay of the sound. |
float flangerDepth | Gets or sets the flanger effect depth of the sound. |
bool flangerEnabled | Enables or Disables the flanger effect on the sound. |
float flangerFeedback | Gets or sets the flanger effect feedback of the sound. |
float flangerFrequency | Gets or sets the flanger effect frequency of the sound. |
int flangerPhase | Gets or sets the flanger effect phase of the sound. Value can only be set to -180, -90, 0, 90, or 180. |
int flangerWaveform | Gets or sets the flanger effect waveform of the sound.
|
float flangerWetDryMix | Gets or sets the flanger effect mix between wet and dry signal of the sound. |
float garagleHzRate | Gets or sets the gargle effect hz rate of the sound. |
bool gargleEnabled | Enables or Disables the gargle effect on the sound. |
int gargleWaveform | Gets or sets the gargle effect waveform of the sound.
|
bool is3DSound | Gets or sets whether the sound is 3D. |
bool isLooped | Gets or sets whether the sound is looped. |
float maxDistance | Gets or sets the max distance of a 3D sound. |
float minDistance | Gets or sets the min distance of a 3D sound. |
float panning | Gets or sets the panning of the sound where -1.0 is left and +1.0 is right. |
float parametricBandwidth | Gets or sets the parametric EQ effect bandwidth of the sound. |
float parametricCenter | Gets or sets the parametric EQ effect center of the sound. |
bool parametricEnabled | Enables or Disables the parametric EQ effect on the sound. |
float parametricGain | Gets or sets the parametric EQ effect gain of the sound. |
float playbackSpeed | Gets or sets the playback speed of the sound. |
Vector3D position | Gets or sets the Position of the Sound. |
float positionX | Gets or sets the X Position of the Sound. |
float positionY | Gets or sets the Y Position of the Sound. |
float positionZ | Gets or sets the Z Position of the Sound. |
float reverbDecayHighFrequencyRatio | Gets or sets the reverb effect decay high frequency ratio of the sound. |
float reverbDecayTime | Gets or sets the reverb effect decay time of the sound. |
float reverbDelay | Gets or sets the reverb effect delay of the sound. |
float reverbDensity | Gets or sets the reverb effect density of the sound. |
float reverbDiffusion | Gets or sets the reverb effect diffusion of the sound. |
bool reverbEnabled | Enables or Disables the reverb effect on the sound. |
float reverbGain | Gets or sets the reverb effect gain of the sound. |
float reverbHighFrequencyReference | Gets or sets the reverb effect high frequency reference of the sound. |
int reverbHighFrequencyRoomAttenuation | Gets or sets the reverb effect high frequency room attenuation of the sound. |
float reverbHighFrequencyRTRatio | Gets or sets the reverb effect high frequency ratio of the sound. |
int reverbLateAttenuation | Gets or sets the reverb effect late attenuation of the sound. |
int reverbMethod | Gets or sets the reverb effect method of the sound.
|
float reverbMix | Gets or sets the reverb effect mix of the sound. |
int reverbReflections | Gets or sets the reverb effect reflections of the sound. |
float reverbReflectionsDelay | Gets or sets the reverb effect reflections delay of the sound. |
float reverbRolloffFactor | Gets or sets the reverb effect rollof factor of the sound. |
int reverbRoomAttenuation | Gets or sets the reverb effect room attenuation of the sound. |
float reverbTime | Gets or sets the reverb effect time of the sound. |
float volume | Gets or sets the volume of the sound. |