SetSoundProperties: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} This function edit's the properties of a specific sound.<br /> <br /> ==Syntax== <syntaxhighlight lang="lua">bool setSoundProperties(element sound, float fS...") |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function edit's the properties of a specific [[sound]]. | {{New feature/item|4.0140|1.3.0|4097| | ||
This function edit's the properties of a specific [[sound]]. | |||
}} | |||
==Syntax== | ==Syntax== | ||
Revision as of 09:32, 30 July 2012
Syntax
bool setSoundProperties(element sound, float fSampleRate, float fTempo, float fPitch, bool bReverse )
Required Arguments
- sound: A sound element that is created using playSound or playSound3D
- fSampleRate: A float that defines the new sound's sample rate
- fTempo: A float that defines the new sound tempo
- fPitch: A float that defines the new sound pitch
- bReverse: A boolean representing whether the sound will be reversed or not.
Returns
Returns true if the properties sucessfully set, false otherwise.
Example
Click to collapse [-]
Client-- not done yet
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd