1. Epic GamesDeveloper
  3. UMovieSceneAudioSection

UMovieSceneAudioSection

Audio section, for use in the audio track, or by attached audio objects

API > API/Runtime > API/Runtime/MovieSceneTracks

Audio section, for use in the audio track, or by attached audio objects

   
Name UMovieSceneAudioSection
Type class
Header File /Engine/Source/Runtime/MovieSceneTracks/Public/Sections/MovieSceneAudioSection.h
Include Path #include "Sections/MovieSceneAudioSection.h"

Syntax

UCLASS (MinimalAPI)  
class UMovieSceneAudioSection :  
    public UMovieSceneSection ,  
    public IMovieSceneEntityProvider ,  
    public IMovieSceneScalingDriver

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneAudioSection ( const FObjectInitializer& ObjectInitializer
)

   Sections/MovieSceneAudioSection.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AttachActorData FMovieSceneActorReferenceData   Sections/MovieSceneAudioSection.h  
AttenuationSettings TObjectPtr< class USoundAttenuation > The attenuation settings to use. Sections/MovieSceneAudioSection.h
  • EditAnywhere
  • Category="Attenuation"
  • Meta=(EditCondition="bOverrideAttenuation")
bLooping bool Allow looping if the section length is greater than the sound duration Sections/MovieSceneAudioSection.h
  • EditAnywhere
  • Category="Audio"
bOverrideAttenuation bool Should the attenuation settings on this section be used. Sections/MovieSceneAudioSection.h
  • EditAnywhere
  • Category="Attenuation"
bSuppressSubtitles bool   Sections/MovieSceneAudioSection.h
  • EditAnywhere
  • Category="Audio"
Inputs_Bool TMap< FName, FMovieSceneBoolChannel >   Sections/MovieSceneAudioSection.h  
Inputs_Float TMap< FName, FMovieSceneFloatChannel > Generic inputs for the sound Sections/MovieSceneAudioSection.h  
Inputs_Int TMap< FName, FMovieSceneIntegerChannel >   Sections/MovieSceneAudioSection.h  
Inputs_String TMap< FName, FMovieSceneStringChannel >   Sections/MovieSceneAudioSection.h  
Inputs_Trigger TMap< FName, FMovieSceneAudioTriggerChannel >   Sections/MovieSceneAudioSection.h  
OnAudioFinished FOnAudioFinished Called when we finish playing audio, either because it played to completion or because a Stop() call turned it off early Sections/MovieSceneAudioSection.h  
OnAudioPlaybackPercent FOnAudioPlaybackPercent   Sections/MovieSceneAudioSection.h  
OnQueueSubtitles FOnQueueSubtitles Called when subtitles are sent to the SubtitleManager. Sections/MovieSceneAudioSection.h  
PitchMultiplier FMovieSceneFloatChannel The pitch multiplier the sound will be played with. Sections/MovieSceneAudioSection.h  
Sound TObjectPtr< USoundBase > The sound cue or wave that this section plays Sections/MovieSceneAudioSection.h
  • EditAnywhere
  • Category="Audio"
  • BlueprintGetter=GetSound
  • BlueprintSetter=SetSound
SoundVolume FMovieSceneFloatChannel The volume the sound will be played with. Sections/MovieSceneAudioSection.h  
StartFrameOffset FFrameNumber The offset into the beginning of the audio clip Sections/MovieSceneAudioSection.h
  • EditAnywhere
  • Category="Audio"
  • Meta=(UIFrameDisplayAs="NonMusical|Position")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual EMovieSceneChannelProxyType CacheChannelProxy()

   Sections/MovieSceneAudioSection.h  

void ForEachInput ( TFunction< void(FName, const FMovieSceneIntegerChannel&)> InFunction
) const

   Sections/MovieSceneAudioSection.h  

void ForEachInput ( TFunction< void(FName, const FMovieSceneStringChannel&)> InFunction
) const

   Sections/MovieSceneAudioSection.h  

void ForEachInput ( TFunction< void(FName, const FMovieSceneBoolChannel&)> InFunction
) const

 Overloads for each input type, const Sections/MovieSceneAudioSection.h  

void ForEachInput ( TFunction< void(FName, const FMovieSceneFloatChannel&)> InFunction
) const

   Sections/MovieSceneAudioSection.h  

void ForEachInput ( TFunction< void(FName, const FMovieSceneAudioTriggerChannel&)> InFunction
) const

   Sections/MovieSceneAudioSection.h  

const FMovieSceneActorReferenceData & GetAttachActorData()

   Sections/MovieSceneAudioSection.h  

USceneComponent * GetAttachComponent ( const AActor* InParentActor,
const FMovieSceneActorReferenceKey& Key
) const

   Sections/MovieSceneAudioSection.h  

USoundAttenuation * GetAttenuationSettings()

   Sections/MovieSceneAudioSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

bool GetLooping()

   Sections/MovieSceneAudioSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

const FOnAudioFinished & GetOnAudioFinished()

 Called when we finish playing audio, either because it played to completion or because a Stop() call turned it off early Sections/MovieSceneAudioSection.h  

const FOnAudioPlaybackPercent & GetOnAudioPlaybackPercent()

   Sections/MovieSceneAudioSection.h  
Called when subtitles are sent to the SubtitleManager. Sections/MovieSceneAudioSection.h  

bool GetOverrideAttenuation()

   Sections/MovieSceneAudioSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

float GetPitchMultiplier ( FFrameTime InTime
) const

 Return the pitch multiplier Sections/MovieSceneAudioSection.h  

const FMovieSceneFloatChannel & GetPitchMultiplierChannel()

 Gets the sound pitch curve Sections/MovieSceneAudioSection.h  

USoundBase * GetPlaybackSound()

 Gets the sound that this section should use for playback, taking into account localization concerns Sections/MovieSceneAudioSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

USoundBase * GetSound()

 Gets the sound for this section Sections/MovieSceneAudioSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

float GetSoundVolume ( FFrameTime InTime
) const

 Return the sound volume Sections/MovieSceneAudioSection.h  

const FMovieSceneFloatChannel & GetSoundVolumeChannel()

 Gets the sound volume curve Sections/MovieSceneAudioSection.h  

FFrameNumber GetStartOffset()

 Get the offset into the beginning of the audio clip Sections/MovieSceneAudioSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

bool GetSuppressSubtitles()

   Sections/MovieSceneAudioSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

virtual void ImportEntityImpl ( UMovieSceneEntitySystemLinker* EntityLinker,
const FEntityImportParams& Params,
FImportedEntity* OutImportedEntity
)

   Sections/MovieSceneAudioSection.h  

virtual bool PopulateEvaluationFieldImpl ( const TRange< FFrameNumber >& EffectiveRange,
const FMovieSceneEvaluationFieldEntityMetaData& InMetaData,
FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder
)

   Sections/MovieSceneAudioSection.h  

void SetAttenuationSettings ( USoundAttenuation* InAttenuationSettings
)

 Set the attenuation settings for this audio section Sections/MovieSceneAudioSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetLooping ( bool bInLooping
)

 Set whether the sound should be looped Sections/MovieSceneAudioSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetOnAudioFinished ( const FOnAudioFinished& InOnAudioFinished
)

 Called when we finish playing audio, either because it played to completion or because a Stop() call turned it off early Sections/MovieSceneAudioSection.h  

void SetOnAudioPlaybackPercent ( const FOnAudioPlaybackPercent& InOnAudioPlaybackPercent
)

   Sections/MovieSceneAudioSection.h  

void SetOnQueueSubtitles ( const FOnQueueSubtitles& InOnQueueSubtitles
)

 Called when subtitles are sent to the SubtitleManager. Sections/MovieSceneAudioSection.h  

void SetOverrideAttenuation ( bool bInOverrideAttenuation
)

 Set whether the attentuation should be overriden Sections/MovieSceneAudioSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetSound ( USoundBase* InSound
)

 Sets this section's sound Sections/MovieSceneAudioSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetStartOffset ( FFrameNumber InStartOffset
)

 Set the offset into the beginning of the audio clip Sections/MovieSceneAudioSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetSuppressSubtitles ( bool bInSuppressSubtitles
)

 Set whether subtitles should be suppressed Sections/MovieSceneAudioSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

Overridden from UMovieSceneSection

Name Remarks Include Path Unreal Specifiers

virtual TOptional< TRange< FFrameNumber > > GetAutoSizeRange()

   Sections/MovieSceneAudioSection.h  

virtual TOptional< FFrameTime > GetOffsetTime()

   Sections/MovieSceneAudioSection.h  

virtual UObject * GetSourceObject()

   Sections/MovieSceneAudioSection.h  

virtual void MigrateFrameTimes ( FFrameRate SourceRate,
FFrameRate DestinationRate
)

   Sections/MovieSceneAudioSection.h  

virtual UMovieSceneSection * SplitSection ( FQualifiedFrameTime SplitTime,
bool bDeleteKeys
)

   Sections/MovieSceneAudioSection.h  

virtual void TrimSection ( FQualifiedFrameTime TrimTime,
bool bTrimLeft,
bool bDeleteKeys
)

   Sections/MovieSceneAudioSection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

 ~UObject interface Sections/MovieSceneAudioSection.h  

Overridden from IMovieSceneScalingDriver

Name Remarks Include Path Unreal Specifiers

virtual void PopulateAnchors ( TMap< FGuid, FMovieSceneScalingAnchor >& OutAnchors
)

   Sections/MovieSceneAudioSection.h  

virtual void PopulateInitialAnchors ( TMap< FGuid, FMovieSceneScalingAnchor >& OutAnchors
)

   Sections/MovieSceneAudioSection.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ForEachInternal ( ForEachFunction InFunction,
const TMap< FName, ChannelType >& InMapToIterate
)

   Sections/MovieSceneAudioSection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page