UAudioComponent

Inheritance Hierarchy

Syntax

class UAudioComponent : public USceneComponent

Remarks

AudioComponent is used to play a Sound

Functions

Name Description

Public function

bool

 

BP_GetAttenuationSettingsToApply

(
    FAttenuationSettings & OutAttenuati...
)

Public function

void

 

CollectAttenuationShapesForVisualization

Collects the various attenuation shapes that may be applied to the sound played by the audio component for visualization in the editor or via the in game debug visualization.

Public function

const FAtten ...

 

GetAttenuationSettingsToApply()

Returns a pointer to the attenuation settings to be used (if any) for this audio component dependent on the SoundAttenuation asset or overrides set.

Public function Static

UAudioCompon ...

 

GetAudioComponentFromID

(
    uint64 AudioComponentID
)

Public function

uint64

 

GetAudioComponentID()

Public function

FAudioDevice ...

 

GetAudioDevice()

Returns the active audio device to use for this component based on whether or not the component is playing in a world.

Public function

void

 

SetSoundParameter

(
    const FAudioComponentParam & Param
)

Sets the sound instance parameter.

Public function

void

 

UpdateInteriorSettings

(
    bool bFullUpdate
)

Overridden from USceneComponent

Name Description

Public function Virtual

void

 

OnUpdateTransform

(
    EUpdateTransformFlags UpdateTransfo...,
    ETeleportType Teleport
)

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

Activate

(
    bool bReset
)

Activates the SceneComponent

Public function Virtual

const UObjec ...

 

AdditionalStatObject()

Give a readable name for this component, including asset name if applicable

Public function Virtual

void

 

Deactivate()

Deactivates the SceneComponent.

Public function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Public function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

FString

 

GetDetailedInfoInternal()

WITH_EDITOR.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object, and immediately after any undo/redo.

Constants

See Also

[](Audio/Overview/)

USoundBase

References

Module

Engine

Header

Runtime/Engine/Classes/Components/AudioComponent.h