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 player's voice.

OOP Syntax Help! I don't understand this!

• Method:sound:getWaveData(...)

Syntax

​table|false getSoundWaveData ( ​sound/​player theSound, ​int samples )

Required arguments

• theSound: A sound element that is created using playSound or playSound3D. Streams are also supported
• samples: Allowed samples are 256, 512, 1024, 2048, 4096, 8192 and 16384.

Returns

Returns a table of samples 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.

• table|false: wave-data

Code Examples

Example 1 Example 2 (OOP) Example 3 Example 4 Example 5

client

This example creates a sound visualizer on the top left corner of the screen.

local soundHandler = playSound("sound.wav")

function onSoundPlayRender()
    if (soundHandler) then
        local waveData = getSoundWaveData(soundHandler, 256)
        if (waveData) then
            for i = 0, 255 do
                dxDrawRectangle(i, 128, 1, waveData[i] * 128)
            end
        end
    end
end
addEventHandler("onClientRender", getRootElement(), onSoundPlayRender)

client

OOP Required

This example creates a sound visualizer on the top left corner of the screen.

local soundHandler = Sound("sound.wav")

function onSoundPlayRender()
    if (soundHandler) then
        local waveData = soundHandler:getWaveData(256)
        if (waveData) then
            for i = 0, 255 do
                dxDrawRectangle(i, 128, 1, waveData[i] * 128)
            end
        end
    end
end
addEventHandler("onClientRender", getRootElement(), onSoundPlayRender)

client

This example creates a sound viewer, but only with bars down.

local soundHandler = playSound("audio.mp3")
local samples = 256

function renderWave()
    if (isElement(soundHandler)) then
        local waveData = getSoundWaveData(soundHandler, samples)
        if (waveData) then -- Avoid NaN values.
            for i = 0, samples - 1 do
                dxDrawRectangle(i, 128, 1, math.abs(waveData[i]) * 128)
            end
        end
    end
end
addEventHandler("onClientRender", root, renderWave)

client

This example creates a sound viewer, but only with bars up.

local soundHandler = playSound("audio.mp3")
local samples = 256

function renderWave()
    if (isElement(soundHandler)) then
        local waveData = getSoundWaveData(soundHandler, samples)
        if (waveData) then -- Avoid NaN values.
            for i = 0, samples - 1 do
                dxDrawRectangle(i, 128, 1, math.abs(waveData[i]) * -128)
            end
        end
    end
end
addEventHandler("onClientRender", root, renderWave)

client

This example creates a sound viewer on the bottom right corner of the screen.

local soundHandler = playSound("audio.mp3")
local x, y = guiGetScreenSize()
local samples = 256

function renderWave()
    if (isElement(soundHandler)) then
        local waveData = getSoundWaveData(soundHandler, samples)
        if (waveData) then -- Avoid NaN values.
            for i = 0, samples - 1 do
                dxDrawRectangle((x - samples) + i, y - 128, 1, waveData[i] * 128)
            end
        end
    end
end
addEventHandler("onClientRender", root, renderWave)

Changelog

1.3.2

Added player element to use a players voice.

See Also

Audio Functions

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM
• getSoundBufferLength
• getSoundEffectParameters
• getSoundEffects
• getSoundFFTData
• getSoundLength
• getSoundLevelData
• getSoundMaxDistance
• getSoundMetaTags
• getSoundMinDistance
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData
• isSoundLooped
• isSoundPanningEnabled
• isSoundPaused
• playSFX
• playSFX3D
• playSound
• playSound3D
• playSoundFrontEnd
• setRadioChannel
• setSoundEffectEnabled
• setSoundEffectParameter
• setSoundLooped
• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPaused
• setSoundPosition
• setSoundProperties
• setSoundSpeed
• setSoundVolume
• stopSound

Audio Elements

• sound

Reference

• Scripting Functions