GetSoundLevelData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Remove obsolete Requirements section)
 
(15 intermediate revisions by 10 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|3.0130|1.3.0|4162|
This function gets the left/right level from a [[sound]] [[element]].
This function gets the left/right level from a [[sound]] [[element]].
}}
{{New feature/item|3.0132|1.3.2||
{{New_feature|3.0139|1.3.2|
If the element is a player, this function will use the players voice.
If the element is a player, this function will use the players voice.
}}
}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">int, int getSoundLevelData ( element theSound )</syntaxhighlight>  
<syntaxhighlight lang="lua">int, int getSoundLevelData ( element theSound )</syntaxhighlight>  
 
{{OOP||[[sound]]:getLevelData}}
===Required Arguments===  
===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===
Returns a 2 values with Left, Right level data from sound, ''false'' otherwise.
Returns a two ''integers'' in range from 0 to 32768.


==Example==
==Example==
TODO
<syntaxhighlight lang="lua">
<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>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.3.0-9.04162|}}


==Changelog==
==Changelog==
Line 30: Line 35:


==See Also==
==See Also==
{{Client_audio_functions}}
{{Audio_functions|client}}
[[Category:Needs Example]]
 
[[AR:getSoundLevelData]]
[[hu:getSoundLevelData]]
[[ar:getSoundLevelData]]
[[ro:getSoundLevelData]]
[[pt-br:getSoundLevelData]]

Latest revision as of 17:07, 7 November 2024

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 )

Changelog

Version Description
1.3.2 Added player element to use a players voice

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetSoundLevelData?oldid=81144"