GetSoundBPM
Jump to navigation
Jump to search
This function gets the beats per minute of a specific sound element.
| Warning: This function is expensive to call and will freeze the client about 1-3 seconds. Also, trying to get the BPM from a sound directly after its creation will make the sound start only after the client freeze. You can use a setTimer to call this function after song creation so it can play normally. |
Syntax
int getSoundBPM ( element sound )
OOP Syntax Help! I don't understand this!
- Method: sound:getBPM(...)
Required Arguments
- sound: a sound element that is created using playSound or playSound3D
Returns
Returns the beats per minute of the given sound.
Example
Click to collapse [-]
Clientfunction getBPM()
local soundElement = playSound("song.mp3") -- Play the song
local beatsValue = getSoundBPM(soundElement) -- Get the beats per minute of the song
outputChatBox("BPM: "..beatsValue) -- Output the beats to the chat box
end
addCommandHandler("bpm", getBPM)
Requirements
| Minimum server version | n/a |
|---|---|
| Minimum client version | 1.3.0-9.04162 |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04162" />
See Also
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData