#include <MovieSceneAudioTriggerChannel.h>

Inheritance diagram for FMovieSceneAudioTriggerChannel:

Public Member Functions
	FMovieSceneAudioTriggerChannel ()=default

TMovieSceneChannelData< bool >	GetData ()

TMovieSceneChannelData< const bool >	GetData () const

TArrayView< const FFrameNumber >	GetTimes () const

bool	HasAnyData () const

MOVIESCENE_API bool	EvaluatePossibleTriggers (const FMovieSceneContext &InContext, FMoveSceneAudioTriggerState &InState, bool &OutTriggered) const

virtual MOVIESCENE_API void	GetKeys (const TRange< FFrameNumber > &WithinRange, TArray< FFrameNumber > OutKeyTimes, TArray< FKeyHandle > OutKeyHandles) override

virtual MOVIESCENE_API void	GetKeyTimes (TArrayView< const FKeyHandle > InHandles, TArrayView< FFrameNumber > OutKeyTimes) override

virtual MOVIESCENE_API void	SetKeyTimes (TArrayView< const FKeyHandle > InHandles, TArrayView< const FFrameNumber > InKeyTimes) override

virtual MOVIESCENE_API void	DuplicateKeys (TArrayView< const FKeyHandle > InHandles, TArrayView< FKeyHandle > OutNewHandles) override

virtual MOVIESCENE_API void	DeleteKeys (TArrayView< const FKeyHandle > InHandles) override

virtual MOVIESCENE_API void	DeleteKeysFrom (FFrameNumber InTime, bool bDeleteKeysBefore) override

virtual MOVIESCENE_API void	RemapTimes (const UE::MovieScene::IRetimingInterface &Retimer) override

virtual MOVIESCENE_API TRange< FFrameNumber >	ComputeEffectiveRange () const override

virtual MOVIESCENE_API int32	GetNumKeys () const override

virtual MOVIESCENE_API void	Reset () override

virtual MOVIESCENE_API void	Offset (FFrameNumber DeltaPosition) override

virtual MOVIESCENE_API void	Optimize (const FKeyDataOptimizationParams &InParameters) override

virtual MOVIESCENE_API FKeyHandle	GetHandle (int32 Index) override

virtual MOVIESCENE_API int32	GetIndex (FKeyHandle Handle) override

Public Member Functions inherited from FMovieSceneChannel
	FMovieSceneChannel ()

virtual	~FMovieSceneChannel ()

MOVIESCENE_API void	GetKeyTime (const FKeyHandle InHandle, FFrameNumber &OutKeyTime)

MOVIESCENE_API void	SetKeyTime (const FKeyHandle InHandle, const FFrameNumber InKeyTime)

virtual MOVIESCENE_API void	ChangeFrameResolution (FFrameRate SourceRate, FFrameRate DestinationRate)

virtual void	ClearDefault ()

virtual void	PostEditChange ()

FMovieSceneChannelDataKeyAddedEvent &	OnKeyAddedEvent ()

FMovieSceneChannelDataKeyDeletedEvent &	OnKeyDeletedEvent ()

FMovieSceneChannelDataKeyMovedEvent &	OnKeyMovedEvent ()

Additional Inherited Members
Protected Attributes inherited from FMovieSceneChannel
FMovieSceneChannelDataKeyAddedEvent	KeyAddedEvent

FMovieSceneChannelDataKeyDeletedEvent	KeyDeletedEvent

FMovieSceneChannelDataKeyMovedEvent	KeyMovedEvent

Constructor & Destructor Documentation

◆ FMovieSceneAudioTriggerChannel()

FMovieSceneAudioTriggerChannel::FMovieSceneAudioTriggerChannel ( )

default

Member Function Documentation

◆ ComputeEffectiveRange()

TRange< FFrameNumber > FMovieSceneAudioTriggerChannel::ComputeEffectiveRange ( ) const

overridevirtual

Compute the effective range of this channel, for example, the extents of its key times

Returns: A range that represents the greatest range of times occupied by this channel, in the sequence's frame resolution

Reimplemented from FMovieSceneChannel.

◆ DeleteKeys()

void FMovieSceneAudioTriggerChannel::DeleteKeys ( TArrayView< const FKeyHandle > InHandles )

overridevirtual

Delete the keys for the specified key handles

Parameters

InHandles Array of handles to delete

Reimplemented from FMovieSceneChannel.

◆ DeleteKeysFrom()

void FMovieSceneAudioTriggerChannel::DeleteKeysFrom	(	FFrameNumber	InTime,
		bool	bDeleteKeysBefore
	)

overridevirtual

Delete keys before or after a specified time

Parameters

InTime	Delete keys after this time
bDeleteKeysBefore	Whether to delete keys before the specified time

Reimplemented from FMovieSceneChannel.

◆ DuplicateKeys()

void FMovieSceneAudioTriggerChannel::DuplicateKeys	(	TArrayView< const FKeyHandle >	InHandles,
		TArrayView< FKeyHandle >	OutNewHandles
	)

overridevirtual

Duplicate the keys for the specified key handles

Parameters

InHandles	Array of handles to duplicate
OutKeyTimes	Pre-sized array to receive duplicated key handles. Invalid key handles will not be assigned to this array. Must match size of InHandles

Reimplemented from FMovieSceneChannel.

◆ EvaluatePossibleTriggers()

bool FMovieSceneAudioTriggerChannel::EvaluatePossibleTriggers	(	const FMovieSceneContext &	InContext,
		FMoveSceneAudioTriggerState &	InState,
		bool &	OutTriggered
	)		const

Evaluate this channel

Parameters

InContext	Scene Context with time and directionality necessary to compute triggers
InState	A persistent state regard if the trigger has fired
OutTriggered	A Value that if set to true combined with the function returning true means there's a trigger

Returns: true if the channel was evaluated successfully, false otherwise

◆ GetData() [1/2]

TMovieSceneChannelData< bool > FMovieSceneAudioTriggerChannel::GetData ( )

inline

Access a mutable interface for this channel's data

Returns: An object that is able to manipulate this channel's data

◆ GetData() [2/2]

TMovieSceneChannelData< const bool > FMovieSceneAudioTriggerChannel::GetData ( ) const

inline

Access a constant interface for this channel's data

Returns: An object that is able to interrogate this channel's data

◆ GetHandle()

FKeyHandle FMovieSceneAudioTriggerChannel::GetHandle ( int32 Index )

overridevirtual

Retrieve a key handle for the specified key time index

Parameters

Index The index to retrieve

Returns: A key handle that identifies the key at the specified index, regardless of re-ordering

Reimplemented from FMovieSceneChannel.

◆ GetIndex()

int32 FMovieSceneAudioTriggerChannel::GetIndex ( FKeyHandle Handle )

overridevirtual

Attempt to retrieve the index of key from its handle

Parameters

Handle The handle to retrieve

Returns: The index of the key, or INDEX_NONE

Reimplemented from FMovieSceneChannel.

◆ GetKeys()

void FMovieSceneAudioTriggerChannel::GetKeys	(	const TRange< FFrameNumber > &	WithinRange,
		TArray< FFrameNumber > *	OutKeyTimes,
		TArray< FKeyHandle > *	OutKeyHandles
	)

overridevirtual

Get key information pertaining to all keys that exist within the specified range

Parameters

WithinRange	The range within which to return key information
OutKeyTimes	(Optional) Array to receive key times
OutKeyHandles	(Optional) Array to receive key handles

Reimplemented from FMovieSceneChannel.

◆ GetKeyTimes()

void FMovieSceneAudioTriggerChannel::GetKeyTimes	(	TArrayView< const FKeyHandle >	InHandles,
		TArrayView< FFrameNumber >	OutKeyTimes
	)

overridevirtual

Get all key times for the specified key handles

Parameters

InHandles	Array of handles to get times for
OutKeyTimes	Pre-sized array of key times to set. Invalid key handles will not assign to this array. Must match size of InHandles

Reimplemented from FMovieSceneChannel.

◆ GetNumKeys()

int32 FMovieSceneAudioTriggerChannel::GetNumKeys ( ) const

overridevirtual

Get the total number of keys on this channel

Returns: The number of keys on this channel

Reimplemented from FMovieSceneChannel.

◆ GetTimes()

TArrayView< const FFrameNumber > FMovieSceneAudioTriggerChannel::GetTimes ( ) const

inline

Const access to this channel's times

◆ HasAnyData()

bool FMovieSceneAudioTriggerChannel::HasAnyData ( ) const

inline

Check whether this channel has any data

◆ Offset()

void FMovieSceneAudioTriggerChannel::Offset ( FFrameNumber DeltaPosition )

overridevirtual

Offset the keys within this channel by a given delta position

Parameters

DeltaPosition The number of frames to offset by, in the sequence's frame resolution

Reimplemented from FMovieSceneChannel.

◆ Optimize()

void FMovieSceneAudioTriggerChannel::Optimize ( const FKeyDataOptimizationParams & InParameters )

overridevirtual

Optimize this channel by removing any redundant data according to the specified parameters

Parameters

InParameters Parameter struct specifying how to optimize the channel

Reimplemented from FMovieSceneChannel.

◆ RemapTimes()

void FMovieSceneAudioTriggerChannel::RemapTimes ( const UE::MovieScene::IRetimingInterface & Retimer )

overridevirtual

Remap the times contained within this channel using a custom remapper

Reimplemented from FMovieSceneChannel.

◆ Reset()

void FMovieSceneAudioTriggerChannel::Reset ( )

overridevirtual

Reset this channel back to its original state

Reimplemented from FMovieSceneChannel.

◆ SetKeyTimes()

void FMovieSceneAudioTriggerChannel::SetKeyTimes	(	TArrayView< const FKeyHandle >	InHandles,
		TArrayView< const FFrameNumber >	InKeyTimes
	)

overridevirtual

Set key times for the specified key handles

Parameters

InHandles	Array of handles to get times for
InKeyTimes	Array of times to apply - one per handle

Reimplemented from FMovieSceneChannel.

The documentation for this struct was generated from the following files:

Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneAudioTriggerChannel.h
Engine/Source/Runtime/MovieScene/Private/Channels/MovieSceneAudioTriggerChannel.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FMovieSceneAudioTriggerChannel()

Member Function Documentation

◆ ComputeEffectiveRange()

◆ DeleteKeys()

◆ DeleteKeysFrom()

◆ DuplicateKeys()

◆ EvaluatePossibleTriggers()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetHandle()

◆ GetIndex()

◆ GetKeys()

◆ GetKeyTimes()

◆ GetNumKeys()

◆ GetTimes()

◆ HasAnyData()

◆ Offset()

◆ Optimize()

◆ RemapTimes()

◆ Reset()

◆ SetKeyTimes()