GetSoundFFTData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 12: Line 12:
===Required Arguments===  
===Required Arguments===  
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''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, 8092 and 16184
*'''iSamples:''' Allowed samples are 128, 256, 512, 1024, 2048, 4096, 8192 and 16384


===Optional Arguments===
===Optional Arguments===

Revision as of 15:13, 18 December 2012

Accessories-text-editor.png Script Example Missing Function GetSoundFFTData needs a script example, help out by writing one.
Before submitting check out Editing Guidelines Script Examples.
ADDED/UPDATED IN VERSION 1.3.0 r4125:

This function gets the FFT data for an audio stream which is a table of floats representing the current audio frame. This allows things like visualisations.

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

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

Click to collapse [-]
Client
-- not done yet

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetSoundFFTData?oldid=34280"