getSoundVolume
Client-side
Server-side
Shared
This function is used to return the volume level of the specified sound element. If the element is a player, this function will use the players voice.
OOP Syntax Help! I don't understand this!
- Method: sound:getVolume(...)
- Variable: .volume
Syntax
float|false getSoundVolume ( sound/player theSound )Required Arguments
- theSound: The sound element which volume you want to return.
Returns
- float|false: volume
Returns a float representing the volume level of the sound element, false if invalid arguments were passed.
Code Examples
client
This example creates a sound then outputs the volume for it.
function wasted (killer, weapon, bodypart) local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder outputChatBox("Wasted Sound volume: "..getSoundVolume(sound)) --outputs to the client the volume of the soundendaddEventHandler("onClientPlayerWasted", localPlayer, wasted) --add the event handlerChangelog
See Also
Audio Functions
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundFFTData
- getSoundEffects
- getSoundLength
- getSoundMaxDistance
- getSoundLevelData
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundSpeed
- getSoundWaveData
- getSoundVolume
- isSoundPaused
- isSoundPanningEnabled
- playSFX
- isSoundLooped
- getSoundProperties
- playSound
- playSFX3D
- setRadioChannel
- playSound3D
- setSoundEffectParameter
- setSoundEffectEnabled
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPaused
- setSoundPanningEnabled
- setSoundSpeed
- setSoundPosition
- setSoundProperties
- setSoundVolume
- stopSound