GetSoundBPM: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Improve example.) |
||
(19 intermediate revisions by 13 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New feature/item| | {{New feature/item|3.0131|1.3.0|4145| | ||
This function gets the beats per minute of a specific [[sound]] element. | 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== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getSoundBPM( element sound )</syntaxhighlight> | <syntaxhighlight lang="lua">int getSoundBPM ( element sound )</syntaxhighlight> | ||
{{OOP||[[sound]]:getBPM}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''sound:''' | *'''sound:''' a sound element that is created using [[playSound]] or [[playSound3D]] | ||
===Returns=== | ===Returns=== | ||
Line 17: | Line 18: | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function 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) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
Line 26: | Line 33: | ||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[ | [[hu:GetSoundBPM]] | ||
[[ru:getSoundBPM]] | |||
[[ar:getSoundBPM]] | |||
[[RO:getSoundBPM]] | |||
[[PT-BR:getSoundBPM]] |
Latest revision as of 15:54, 21 December 2021
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
- 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