AR/getSoundFFTData: Difference between revisions

Revision as of 16:37, 18 January 2014

	Script Example Missing Function AR/getSoundFFTData needs a script example, help out by writing one.
	Before submitting check out Editing Guidelines Script Examples.

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: 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

table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )

Required Arguments

sound: A sound element that is created using playSound or playSound3D. Streams are also supported
iSamples: Allowed samples are 128, 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 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

addCommandHandler("playsound",
function () 
    local sound  = playSound("wasted.mp3")
    local data = getSoundWaveData(sound, 512) -- returns table
    for i, v in pairs(data) do
        outputChatBox(v) -- outputs the float representing the current audio frame
    end
end
)

Changelog

Version	Description

1.3.2

Added player element to use a players voice

أنظر أيضاً

@@ Line 32: / Line 32: @@
 ==Example==
-<section name="Client" class="client" show="true">
 <syntaxhighlight lang="lua">
--- not done yet
+addCommandHandler("playsound",
+function ()
+    local sound  = playSound("wasted.mp3")
+    local data = getSoundWaveData(sound, 512) -- returns table
+    for i, v in pairs(data) do
+        outputChatBox(v) -- outputs the float representing the current audio frame
+    end
+end
+)
 </syntaxhighlight>
-</section>
 ==Changelog==