UAudioCurveSourceComponent

An audio component that also provides curves to drive animation

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

FacialAnimation

Header

/Engine/Plugins/Editor/FacialAnimation/Source/FacialAnimation/Public/AudioCurveSourceComponent.h

Include

#include "AudioCurveSourceComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=Audio, Experimental, Meta=(BlueprintSpawnableComponent))
class UAudioCurveSourceComponent :
    public UAudioComponent,
    public ICurveSourceInterface

Remarks

An audio component that also provides curves to drive animation

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FName

 

CurveSourceBindingName

Get the name that this curve source can be bound to by.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

CurveSyncOffset

Offset in time applied to audio position when evaluating curves

Constructors

Name Description

Public function

UAudioCurveSourceComponent()

Functions

Overridden from UAudioComponent

Name Description

Public function Virtual

void

 

FadeIn

(
    float FadeInDuration,
    float FadeVolumeLevel,
    float StartTime,
    const EAudioFaderCurve FadeType
)

UAudioComponent interface

Public function Virtual

void

 

FadeOut

(
    float FadeOutDuration,
    float FadeVolumeLevel,
    const EAudioFaderCurve FadeCurve
)

This function allows designers to call a delayed Stop on an Audio Component instance while applying a volume curve over time.

Public function Virtual Const

bool

 

IsPlaying()

Returns TRUE if the targeted Audio Component's sound is playing.

Public function Virtual

void

 

Play

(
    float StartTime
)

Begins playing the targeted Audio Component's sound at the designated Start Time, seeking into a sound.

Public function Virtual

void

 

Stop()

Stop an audio component's sound, issue any delegates if needed

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorComponentTickFunction* T...
)

UActorComponent interface

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