GetSoundBPM: Difference between revisions

Revision as of 16:36, 26 September 2021

This function gets the beats per minute of a specific sound element.

[[\|link=\|]]	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 [-]

Client

function bpm ()
    -- Long version (might be more understandable as example)
    sound = playSound ( "song.mp3" ) -- Play the song
    beats = getSoundBPM ( sound ) -- Get the beats per minute of the song
    outputChatBox ( "Long code version: " .. beats ) -- Output the beats to the chat box
end
addCommandHandler ( "bpm", bpm )

Requirements

This template will be deleted.

@@ Line 1: / Line 1: @@
-'''Hacked By Ameir'''
+__NOTOC__
-''add me on''
+{{Client function}}
-[http://facebook.com/AhmedAlramSisYy facebook]
+{{New feature/item|3.0131|1.3.0|4145|
+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==
+<syntaxhighlight lang="lua">int getSoundBPM ( element sound )</syntaxhighlight>
+{{OOP||[[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==
+<section name="Client" class="client" show="true">
+<syntaxhighlight lang="lua">
+function bpm ()
+    -- Long version (might be more understandable as example)
+    sound = playSound ( "song.mp3" ) -- Play the song
+    beats = getSoundBPM ( sound ) -- Get the beats per minute of the song
+    outputChatBox ( "Long code version: " .. beats ) -- Output the beats to the chat box
+end
+addCommandHandler ( "bpm", bpm )
+</syntaxhighlight>
+</section>
+==Requirements==
+{{Requirements|n/a|1.3.0-9.04162|}}
+==See Also==
+{{Client_audio_functions}}
+[[hu:GetSoundBPM]]
+[[ru:getSoundBPM]]
+[[ar:getSoundBPM]]
+[[RO:getSoundBPM]]
+[[PT-BR:getSoundBPM]]