GetSoundBPM

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 supported server	n/a
Minimum supported client	1.3.0-9.04162

Note: Using this function 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
• getSoundEffects
• getSoundFFTData
• getSoundLength
• getSoundLevelData
• getSoundMaxDistance
• getSoundMetaTags
• getSoundMinDistance
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData
• isSoundPanningEnabled
• isSoundPaused
• playSFX
• playSFX3D
• playSound
• playSound3D
• playSoundFrontEnd
• setRadioChannel
• setSoundEffectEnabled
• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPaused
• setSoundPosition
• setSoundProperties
• setSoundSpeed
• setSoundVolume
• stopSound