USoundVisualizationStatics::GetAmplitude

Gathers the amplitude of the wave data for a window of time for the SoundWave

Windows
MacOS
Linux

References

Module

SoundVisualizations

Header

/Engine/Plugins/Runtime/SoundVisualizations/Source/SoundVisualizations/Classes/SoundVisualizationStatics.h

Include

#include "SoundVisualizationStatics.h"

Source

/Engine/Plugins/Runtime/SoundVisualizations/Source/SoundVisualizations/Private/SoundVisualizationStatics.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="SoundVisualization")
static void GetAmplitude
(
    USoundWave * SoundWave,
    int32 Channel,
    float StartTime,
    float TimeLength,
    int32 AmplitudeBuckets,
    TArray< float > & OutAmplitudes
)

Remarks

Gathers the amplitude of the wave data for a window of time for the SoundWave

Returns

OutAmplitudes - The resulting amplitudes

Parameters

Parameter

Description

SoundWave

The wave to get samples from

Channel

The channel of the sound to get. Specify 0 to combine channels together

StartTime

The beginning of the window to get the amplitude from

TimeLength

The duration of the window to get the amplitude from

AmplitudeBuckets

How many samples to divide the data in to. The amplitude is averaged from the wave samples for each bucket

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss