SetSoundVolume
Jump to navigation
Jump to search
This function is used to change the volume level of the specified sound element. Use a player element to control a players voice with this function.
Syntax
bool setSoundVolume ( element theSound, float volume )
OOP Syntax Help! I don't understand this!
- Method: sound:setVolume(...)
- Variable: .volume
- Counterpart: getSoundVolume
Required Arguments
- theSound: The sound element which volume you want to modify.
- volume: A floating point number representing the desired volume level. Range is from 0.0 to 1.0
Returns
Returns true if the sound element volume was successfully changed, false otherwise.
Example
=addEventHandler("onClientGUIScroll",ScrollName,
function( )
local Scroll = guiScrollBarGetScrollPosition(ScrollName)
Volume = Scroll / 100
if not isElement( iSound ) then
return
end
setSoundVolume(iSound,Volume)
end,false
)
Changelog
| Version | Description |
|---|
| 1.3.2 | Added player element for voice control |
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
- playSoundFrontEnd