UAudioComponent::GetAudioComponentUserID

function Engine Since 4.0

#include "Components/AudioComponent.h"

Access: public Specifiers: constinline

Description

Returns the serialized, designer-assigned name used by audio plugins to identify this component.

Caveats & Gotchas

• Unlike GetAudioComponentID(), this value is serialized and set explicitly by designers or plugin code — it is not auto-generated and defaults to NAME_None if never set.
• Third-party audio plugins (spatializers, occlusion plugins, etc.) commonly use this to correlate an audio component with their own external state; it has no meaning to the core engine.

Signature

FName GetAudioComponentUserID() const { return AudioComponentUserID; }

Return Type

FName

Example

Read the plugin-facing user ID C++

FName UserID = AudioComponent->GetAudioComponentUserID();
if (UserID != NAME_None)
{
    UE_LOG(LogTemp, Log, TEXT("Audio component tagged for plugin: %s"), *UserID.ToString());
}

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?