GetSoundFFTData: Difference between revisions
mNo edit summary |
No edit summary |
||
| Line 13: | Line 13: | ||
just type "startmusic mystreamurl" in your console and it will play on the cinema billboard near A51 | just type "startmusic mystreamurl" in your console and it will play on the cinema billboard near A51 | ||
{{New_feature|3.0139|1.3.2| | |||
If the element is a player, this function will use the players voice. | |||
}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight> | <syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight> | ||
| Line 35: | Line 37: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
==Changelog== | |||
{{ChangelogHeader}} | |||
{{ChangelogItem|1.3.2|Added player element to use a players voice}} | |||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[Category:Needs Example]] | [[Category:Needs Example]] | ||
Revision as of 22:42, 4 May 2013
|
Script Example Missing Function 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
-- not done yet
Changelog
| Version | Description |
|---|
| 1.3.2 | Added player element to use a players voice |
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
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd