GetSoundBPM: Difference between revisions

Revision as of 16:15, 17 October 2014

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

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

    -- Short version + Would save some memory
    outputChatBox ( "Short code version: " .. getSoundBPM ( playSound ( "song.mp3" ) ) )
end
addCommandHandler ( "bpm", bpm )

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" />

@@ Line 7: / Line 7: @@
 ==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]]
+*'''sound:''' a sound element that is created using [[playSound]] or [[playSound3D]]
 ===Returns===
@@ Line 35: / Line 35: @@
 ==See Also==
 {{Client_audio_functions}}
-[[AR:getSoundBPM]]
+[[ar:getSoundBPM]]