AAmbientSound

A sound actor that can be placed in a level

Windows
MacOS
Linux

Inheritance Hierarchy

Syntax

class AAmbientSound : public AActor

Remarks

A sound actor that can be placed in a level

Constructors

Name Description

Public function

AAmbientSound

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

AdjustVolume

(
    float AdjustVolumeDuration,
    float AdjustVolumeLevel
)

Public function

void

 

FadeIn

(
    float FadeInDuration,
    float FadeVolumeLevel
)

BEGIN DEPRECATED (use component functions now in level script)

Public function

void

 

FadeOut

(
    float FadeOutDuration,
    float FadeVolumeLevel
)

Public function Const

UAudioCompon...

 

GetAudioComponent()

Returns AudioComponent subobject

Public function

FString

 

GetInternalSoundCueName()

Public function

void

 

Play

(
    float StartTime
)

Public function

void

 

Stop()

Overridden from AActor

Name Description

Public function Virtual

void

 

CheckForErrors()

Function that gets called from within Map_Check to allow this actor to check itself for any potential errors and register them with map check dialog.

Public function Virtual Const

bool

 

GetReferencedContentObjects

(
    TArray< UObject* >& Objects
)

Used by the "Sync to Content Browser" right-click menu option in the editor.

Public function Virtual

void

 

PostRegisterAllComponents()

Called after all the components in the Components array are registered, called both in editor and during gameplay

References

Module

Engine

Header

Runtime/Engine/Classes/Sound/AmbientSound.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback