GetSoundWaveData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 35: Line 35:
{{Client_audio_functions}}
{{Client_audio_functions}}
[[Category:Needs Example]]
[[Category:Needs Example]]
[[AR:getSoundWaveData]]

Revision as of 04:14, 6 May 2013

Accessories-text-editor.png Script Example Missing Function GetSoundWaveData needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

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

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

Changelog

Version Description
1.3.2 Added player element to use a players voice

See Also