Multi Theft Auto: Wiki - User contributions [en]

GetSoundLevelData

2020-07-25T07:37:21Z

SDraw: Undo revision 67085 by SDraw (talk)

__NOTOC__
{{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>
{{OOP||[[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==
<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|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}}

[[hu:getSoundLevelData]]
[[ar:getSoundLevelData]]
[[ro:getSoundLevelData]]

GetSoundLevelData

2020-07-25T07:10:26Z

SDraw: 2^15 possible values (first value - 0, last value - 32767)

__NOTOC__
{{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>
{{OOP||[[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 32767.

==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 / 32767 * 256, tocolor ( 255, 0, 0 ) )
dxDrawRectangle ( 64, 0, 64, rightData / 32767 * 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}}

[[hu:getSoundLevelData]]
[[ar:getSoundLevelData]]
[[ro:getSoundLevelData]]

GetSoundWaveData

2018-07-10T18:50:56Z

SDraw:

GetSoundFFTData

2018-07-10T18:26:09Z

SDraw:

__NOTOC__
{{Client function}}
This function gets the fast fourier transform generates a table of all the frequencies of the current audio frame which starts at the bass end of the spectrum to mids to highs in that order
This allows things like visualisations.

==Syntax==
<syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight>
{{OOP||[[sound]]:getFFTData}}
===Required Arguments===
*'''sound:''' a sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' allowed samples are 256, 512, 1024, 2048, 4096, 8192 and 16384.

===Optional Arguments===
*'''iBands:''' post processing option allows you to split the samples into the desired amount of bands or bars so if you only need 5 bars this saves a lot of cpu power compared to trying to do it in Lua.

===Returns===
Returns a table of '''iSamples'''/2 (or '''iBands''' if '''iBands''' is used) ''floats'' representing the current audio frame.
Returns ''false'' if the sound is not playing yet or hasn't buffered in the
case of streams.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ( "sound.wav" )

function onSoundPlayRender ( )
if ( soundHandler ) then
local soundFFT = getSoundFFTData ( soundHandler, 2048, 256 )
if ( soundFFT ) then
for i = 0, 255 do -- Data starts from index 0
dxDrawRectangle ( i, 0, 1, math.sqrt ( soundFFT[i] ) * 256 )
end
end
end
end
addEventHandler ( "onClientRender", getRootElement(), onSoundPlayRender )
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}

==See Also==
{{Client_audio_functions}}
[[ES:getSoundFFTData]]
[[AR:getSoundFFTData]]

GetSoundWaveData

2018-07-10T18:22:44Z

SDraw:

2014-07-15T23:13:21Z

SDraw: Wrong parameter description and sample code

__NOTOC__
{{Client function}}
This function is used to change the seek position of the specified [[sound]] element.
Use a player element to control a players voice with this function.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, float pos )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which seek position you want to modify.
*'''pos:''' An float value representing the new seek position of the sound. Integer part of this value - seconds, fractional part - milliseconds.

===Returns===
Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.

==Example==
This example allows the player to set how many milliseconds into the song he wants it to play from
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function setSongPos(cmd, tm)
tm = tonumber(tm)
local ssp = setSoundPosition(theSound,tm)
if ssp then
outputChatBox("Sound is now playing from: "..tostring(tm))
else
outputChatBox("An error has occured. Please make sure there are at least")
end
end
addCommandHandler("skipsong", setSongPos)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

==See Also==
{{Client_audio_functions}}
[[AR:setSoundPosition]]

IsElementFrozen

2014-04-19T15:11:16Z

2014-03-14T14:44:43Z

SDraw: moved Base64encode to Base64Encode over redirect: It's 'Encode'. Try in any script before editing.

#REDIRECT [[Base64Encode]]

Base64Encode

2014-03-14T14:44:43Z

SDraw: moved Base64encode to Base64Encode over redirect: It's 'Encode'. Try in any script before editing.

__NOTOC__
{{Server client function}}
{{New feature/item|9.06056|1.3.5|6056|
This function returns the [https://en.wikipedia.org/wiki/Base64 base64] representation of the encrypted block of data
}}

==Syntax==
<syntaxhighlight lang="lua">
string base64Encode ( string data )
</syntaxhighlight>

===Required arguments===
*'''data:''' The block of data you want to encrypt

===Returns===
Returns the [https://en.wikipedia.org/wiki/Base64 base64] representation of the encrypted data if the encryption process was successfully completed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
local k = base64Encode("Hello, world!")
outputConsole(k)
--Output: SGVsbG8sIHdvcmxkIQ==
</syntaxhighlight>

==See Also==
{{Utility_functions}}

Base64decode

2014-03-14T14:43:19Z

SDraw: moved Base64decode to Base64Decode over redirect: It's 'Decode'. Try in any script before editing.

#REDIRECT [[Base64Decode]]

Base64Decode

2014-03-14T14:43:19Z

SDraw: moved Base64decode to Base64Decode over redirect: It's 'Decode'. Try in any script before editing.

__NOTOC__
{{Server client function}}
{{New feature/item|9.06056|1.3.5|6056|
This function returns the decrypted data from [https://en.wikipedia.org/wiki/Base64 base64] representation of the encrypted block
}}

==Syntax==
<syntaxhighlight lang="lua">
string base64Decode(string data)
</syntaxhighlight>

===Required arguments===
*'''data:''' The block of data you want to decrypt

===Returns===
Returns the decrypted data from [https://en.wikipedia.org/wiki/Base64 base64] representation of the encrypted block if the decryption process was successfully completed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
local k = base64Decode("SGVsbG8sIHdvcmxkIQ==")
outputConsole(k)
--Output: Hello, world!
</syntaxhighlight>

==See Also==
{{Utility_functions}}

Base64Encode

2014-03-14T14:39:58Z

SDraw:

2013-12-15T08:33:00Z

SDraw: /* Example */

__NOTOC__
{{Client function}}
This function gets the fast fourier transform data for an audio stream which is a table of floats representing the current audio frame.
This allows things like visualisations.

a fast fourier transform generates a table of all the frequencies of the current audio frame which starts at the bass end of the spectrum to mids to highs in that order

Should you have any problems there is an example resource located on the resource svn here:
[https://code.google.com/p/mtasa-resources/source/browse/#svn%2Ftrunk%2F%5Bgameplay%5D%2FVisualiser Visualiser]

just type "startmusic mystreamurl" in your console and it will play on the cinema billboard near A51
If the element is a player, this function will use the players voice.

==Syntax==
<syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight>

===Required Arguments===
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' Allowed samples are 256, 512, 1024, 2048, 4096, 8192 and 16384.

===Optional Arguments===
*'''iBands:''' Post processing option allows you to split the samples into the desired amount of bands or bars so if you only need 5 bars this saves a lot of cpu power compared to trying to do it in Lua.

===Returns===
Returns a table of '''iSamples'''/2 (or '''iBands'''-1 if '''iBands''' is used) floats representing the current audio frame.
Returns false if the sound is not playing yet or hasn't buffered in the
case of streams.

==Example==
This code creates vertical spectrum analyzer with thin lines in center of screen from top to bottom. [http://imageshack.com/a/img543/79/i4oz.png] Key '''9''' - start, key '''0''' - stop.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local handl = nil
local sx,_ = guiGetScreenSize()

function clientRenderFunc()
if(handl) then
dxDrawRectangle(sx/2,0,1,256,tocolor(255,255,255,127))
local bt = getSoundFFTData(handl,2048,257)
for i=1,256 do
bt[i] = math.sqrt(bt[i])*256 --scale it (sqrt to make low values more visible)
dxDrawRectangle(sx/2-bt[i]/2,i-1,bt[i],1)
end
end
end

function musicStartFunc()
if(not handl) then
handl = playSound('btr.mp3')
addEventHandler("onClientRender",root,clientRenderFunc)
end
end

function musicStopFunc()
if(handl) then
stopSound(handl)
handl = nil
removeEventHandler("onClientRender",root,clientRenderFunc)
end
end

bindKey("9","down",musicStartFunc)
bindKey("0","down",musicStopFunc)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}

==See Also==
{{Client_audio_functions}}
[[AR:getSoundFFTData]]

Timer

2013-12-14T22:47:16Z

SDraw:

A [[timer]] object refers to a timer set to execute a function a certain number of times with a specified delay.

Note that after a timer has completed all its iterations, it is destroyed and any stored pointers to it become invalid. Also timers are not under the ''resource'' hierarchy, because they are not elements, for instance, if you create a timer, it will not be destroyed when the resource in which it was created is stopped, so in this case you should kill the timer manually.

==Related scripting functions==
* [[getTimers]]
* [[killTimer]]
* [[setTimer]]
* [[getTimerDetails]]

GetSoundLevelData

2013-12-14T19:18:26Z

SDraw:

__NOTOC__
{{Client function}}
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==
<syntaxhighlight lang="lua">int, int getSoundLevelData ( element theSound )</syntaxhighlight>

===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. [http://imageshack.com/a/img716/8689/4ud1.png] Key '''9''' - start, key '''0''' - stop.
<syntaxhighlight lang="lua">
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)
dxDrawRectangle(sx/2-10,0,10,128*(ls/32768),colors[1])
dxDrawRectangle(sx/2+10,0,10,128*(rs/32768),colors[2])
end
end

function musicStartFunc()
if(not handl) then
handl = playSound('btr.mp3')
addEventHandler("onClientRender",root,clientRenderFunc)
end
end

function musicStopFunc()
if(handl) then
stopSound(handl)
handl = nil
removeEventHandler("onClientRender",root,clientRenderFunc)
end
end

bindKey("9","down",musicStartFunc)
bindKey("0","down",musicStopFunc)
</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}}
[[AR:getSoundLevelData]]