GetSoundProperties: Difference between revisions
Jump to navigation
Jump to search
(OOP) |
No edit summary |
||
(One intermediate revision by one other user not shown) | |||
Line 9: | Line 9: | ||
{{OOP||[[sound]]:getProperties||setSoundProperties}} | {{OOP||[[sound]]:getProperties||setSoundProperties}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''sound:''' | *'''sound:''' a [[sound]] [[element]] that is created using [[playSound]] or [[playSound3D]] | ||
===Returns=== | ===Returns=== | ||
This function returns 3 floats and a boolean value: | This function returns 3 [[float|floats]] and a [[boolean]] value: | ||
The first float is the sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate], the second one the sound's [http://en.wikipedia.org/wiki/Tempo tempo], and the third one the [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch] of the sound. The boolean representing whether the sound is reversed or not. | The first float is the sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate], the second one the sound's [http://en.wikipedia.org/wiki/Tempo tempo], and the third one the [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch] of the sound. The boolean representing whether the sound is reversed or not. | ||
Line 38: | Line 38: | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[hu:getSoundProperties]] | |||
[[ar:getSoundProperties]] | [[ar:getSoundProperties]] |
Revision as of 10:16, 19 July 2018
This function gets the properties of a specific sound.
Syntax
float, float, float, bool getSoundProperties( element sound )
OOP Syntax Help! I don't understand this!
- Method: sound:getProperties(...)
- Counterpart: setSoundProperties
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
Example 1: This example would return three float values representing the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not, every 5 seconds.
local sound local timer addCommandHandler("playsound", function () sound = playSound("wasted.mp3") timer = setTimer(function() soundProperties(sound) end, 5000, 0) end ) function soundProperties(sound) local sampleRate, tempo, pitch, isReversed = getSoundProperties(sound) --gets the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not. outputChatBox(sampleRate.." "..tempo.." "..pitch.." "..tostring(isReversed)) end
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