UAudioComponent::SetWaveParameter
#include "Components/AudioComponent.h"
Access: public
Specifiers: UFUNCTIONBlueprintCallable
Description
Sets the parameter matching the given name to a specific sound wave, provided mainly for backward compatibility with legacy SoundCues.
Caveats & Gotchas
- • Per the header comment, this exists primarily for convenience/backward compatibility with SoundCues — for new MetaSound-driven content, prefer parameter interfaces designed for the wave/object type in use.
- • The parameter system accepts any UObject-derived value here; whether USoundWave is a valid type for a given parameter is determined entirely by the sound asset querying it, not by this function.
Signature
UFUNCTION(BlueprintCallable, Category = "Audio|Parameter")
ENGINE_API void SetWaveParameter(FName InName, USoundWave* InWave);Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| InName | FName | The name of the parameter to assign the wave to. | — |
| InWave | USoundWave* | The sound wave value to set. | — |
Return Type
void Example
Swap the wave used by a SoundCue Wave Param node C++
AudioComponent->SetWaveParameter(TEXT("FootstepWave"), GravelFootstepWave);See Also
Tags
Version History
Introduced in: 4.0
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?