GetSoundProperties: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{Needs_Example}} | |||
{{New feature/item|3.0130|1.3.0|4097| | {{New feature/item|3.0130|1.3.0|4097| | ||
This function gets the properties of a specific [[sound]]. | This function gets the properties of a specific [[sound]]. | ||
| Line 25: | Line 26: | ||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[AR:getSoundProperties]] | [[AR:getSoundProperties]] | ||
Revision as of 12:34, 2 January 2014
|
Script Example Missing Function GetSoundProperties needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
This function gets the properties of a specific sound.
Syntax
float, float, float, bool getSoundProperties( element sound )
Required Arguments
- sound: A sound element that is created using playSound or playSound3D
Returns
This function returns 3 floats and a boolean value:
The first float is the sound's sample rate, the second one the sound's tempo, and the third one the pitch of the sound. The boolean representing whether the sound is reversed or not.
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
- playSoundFrontEnd
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound