GetSoundLevelData: Difference between revisions

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

theSound: the sound element which level data you want to return.

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

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-{{New feature/item|4.0140|1.3.0|4162|
 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==
 <syntaxhighlight lang="lua">int, int getSoundLevelData ( element theSound )</syntaxhighlight>
+{{OOP||[[sound]]:getLevelData}}
 ===Required Arguments===
-*'''theSound''' The [[sound]] [[element]] which level data you want to return.
+*'''theSound:''' the [[sound]] [[element]] which level data you want to return.
 ===Returns===
-Returns a 2 values with Left, Right level data from sound, ''false'' otherwise.
+Returns a two ''integers'' in range from 0 to 32768.
 ==Example==
-TODO
 <syntaxhighlight lang="lua">
---TODO
+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|n/a|1.3.0-9.04162|}}
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element to use a players voice}}
 ==See Also==
 {{Client_audio_functions}}
-[[Category:Needs Example]]
+[[hu:getSoundLevelData]]
+[[ar:getSoundLevelData]]
+[[ro:getSoundLevelData]]
+[[pt-br:getSoundLevelData]]