GetSoundFFTData: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|4.0140|1.3.0|4125| This function gets the FFT data for an audio stream which is a table of floats representing the current audio...") |
No edit summary |
||
| Line 7: | Line 7: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">table getSoundFFTData( element sound, int iSamples, | <syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight> | ||
===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, 8092 and 16184 | |||
===Optional Arguments=== | ===Optional Arguments=== | ||
*'''iBands:''' Post processing option | |||
*'''iBands''' Post processing option | |||
===Returns=== | ===Returns=== | ||
Revision as of 16:00, 22 August 2012
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, 8092 and 16184
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
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- playSoundFrontEnd
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound