GetSoundLevelData: Difference between revisions

Revision as of 16:40, 17 October 2014

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 )

Required Arguments

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

Returns

Returns a 2 values with Left, Right level data from sound (range is [0,32768]), false otherwise.

Example

This code creates vertical lines of right and left level in center of screen from top to bottom. [1] Key 9 - start, key 0 - stop.

local handl = nil
local sx,_ = guiGetScreenSize()
local colors = { tocolor(255,0,0),tocolor(0,255,0) }
 
function clientRenderFunc()
    if(handl) then
	local ls,rs = getSoundLevelData(handl)
	if(ls ~= false) then
            dxDrawRectangle(sx/2-10,0,10,128*(ls/32768),colors[1])
            dxDrawRectangle(sx/2+10,0,10,128*(rs/32768),colors[2])
	end
    end
end

function clientSoundStopFunc(_)
    if(source == handl) then
	removeEventHandler("onClientRender",root,clientRenderFunc)
	removeEventHandler("onClientSoundStopped",root,clientSoundStopFunc)
	handl = nil
    end
end
 
function musicStartFunc()
    if(not handl) then
        handl = playSound('nya.mp3')
        addEventHandler("onClientRender",root,clientRenderFunc)
	addEventHandler("onClientSoundStopped",root,clientSoundStopFunc)
    end
end
 
function musicStopFunc()
    if(handl) then
        stopSound(handl)
        handl = nil
        removeEventHandler("onClientRender",root,clientRenderFunc)
	removeEventHandler("onClientSoundStopped",root,clientSoundStopFunc)
    end
end
 
bindKey("9","down",musicStartFunc)
bindKey("0","down",musicStopFunc)

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 2: / Line 2: @@
 {{Client function}}
 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>
 ===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===
@@ Line 68: / Line 69: @@
 ==See Also==
 {{Client_audio_functions}}
-[[AR:getSoundLevelData]]
+[[ar:getSoundLevelData]]