AR/getSoundWaveData: Difference between revisions

Revision as of 10:51, 18 January 2014

This function gets the wave form data for an audio stream which is a table of floats representing the current audio frame as a wave. This allows things like visualisations. If the element is a player, this function will use the players voice.

Syntax

table getSoundWaveData ( element sound, int iSamples )

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 and determine how many samples to return from the currently playing audio

Returns

Returns a table of floats representing the current audio frame waveform. 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 waveform
    end
end
)

Changelog

Version	Description

1.3.2

Added player element to use a players voice

أنظر أيضاً

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-{{Needs Example}}
 {{New feature/item|3.0130|1.3.0|4125|
 This function gets the wave form data for an audio stream which is a table of floats representing the current audio frame as a wave.
@@ Line 22: / Line 21: @@
 ==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 waveform
+    end
+end
+)
 </syntaxhighlight>
-</section>
 ==Changelog==