GetSoundLevelData: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Tag: Rollback |
||
(21 intermediate revisions by 13 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New feature/item| | This function gets the left/right level from a [[sound]] [[element]]. | ||
{{New feature/item|3.0132|1.3.2|| | |||
}} | If the element is a player, this function will use the players voice. | ||
}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int | <syntaxhighlight lang="lua">int, int getSoundLevelData ( element theSound )</syntaxhighlight> | ||
{{OOP||[[sound]]:getLevelData}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theSound''' | *'''theSound:''' the [[sound]] [[element]] which level data you want to return. | ||
===Returns=== | ===Returns=== | ||
Returns a | Returns a two ''integers'' in range from 0 to 32768. | ||
==Example== | |||
<syntaxhighlight lang="lua"> | |||
local soundHandler = playSound ( "sound.wav" ) | |||
function onSoundPlayRender ( ) | |||
if ( soundHandler ) then | |||
local leftData, rightData = getSoundLevelData ( soundHandler ) | |||
if ( leftData ) then | |||
dxDrawRectangle ( 0, 0, 64, leftData / 32768 * 256, tocolor ( 255, 0, 0 ) ) | |||
dxDrawRectangle ( 64, 0, 64, rightData / 32768 * 256, tocolor ( 0, 0, 255 ) ) | |||
end | |||
end | |||
end | |||
addEventHandler ( "onClientRender", root, onSoundPlayRender ) | |||
</syntaxhighlight> | |||
==Requirements== | ==Requirements== | ||
{{Requirements|n/a|1.3.0-9.04162|}} | {{Requirements|n/a|1.3.0-9.04162|}} | ||
==Changelog== | |||
{{ChangelogHeader}} | |||
{{ChangelogItem|1.3.2|Added player element to use a players voice}} | |||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[hu:getSoundLevelData]] | |||
[[ar:getSoundLevelData]] | |||
[[ro:getSoundLevelData]] | |||
[[pt-br:getSoundLevelData]] |
Latest revision as of 16:36, 26 September 2021
This function gets the left/right level from a sound element. If the element is a player, this function will use the players voice.
Syntax
int, int getSoundLevelData ( element theSound )
OOP Syntax Help! I don't understand this!
- Method: sound:getLevelData(...)
Required Arguments
Returns
Returns a two integers in range from 0 to 32768.
Example
local soundHandler = playSound ( "sound.wav" ) function onSoundPlayRender ( ) if ( soundHandler ) then local leftData, rightData = getSoundLevelData ( soundHandler ) if ( leftData ) then dxDrawRectangle ( 0, 0, 64, leftData / 32768 * 256, tocolor ( 255, 0, 0 ) ) dxDrawRectangle ( 64, 0, 64, rightData / 32768 * 256, tocolor ( 0, 0, 255 ) ) end end end addEventHandler ( "onClientRender", root, onSoundPlayRender )
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" />
Changelog
Version | Description |
---|
1.3.2 | Added player element to use a players voice |
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