GetSoundFFTData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 17: Line 17:


===Optional Arguments===
===Optional Arguments===
*'''iBands:''' Post processing option
*'''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===

Revision as of 21:15, 13 April 2013

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

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

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

See Also

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