Navigation
API > API/Runtime > API/Runtime/MovieScene
| Name | FMovieSceneAudioTriggerChannel |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneAudioTriggerChannel.h |
| Include Path | #include "Channels/MovieSceneAudioTriggerChannel.h" |
Syntax
USTRUCT ()
struct FMovieSceneAudioTriggerChannel : public FMovieSceneChannel
Inheritance Hierarchy
- FMovieSceneChannel → FMovieSceneAudioTriggerChannel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneAudioTriggerChannel() |
Channels/MovieSceneAudioTriggerChannel.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| KeyHandles | FMovieSceneKeyHandleMap | This needs to be a UPROPERTY so it gets saved into editor transactions but transient so it doesn't get saved into assets. | Channels/MovieSceneAudioTriggerChannel.h |
|
| Times | TArray< FFrameNumber > | Channels/MovieSceneAudioTriggerChannel.h |
|
|
| Values | TArray< bool > | These are all 1s, but are required for the templates to bind correctly. | Channels/MovieSceneAudioTriggerChannel.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool EvaluatePossibleTriggers
(
const FMovieSceneContext& InContext, |
Evaluate this channel | Channels/MovieSceneAudioTriggerChannel.h | |
TMovieSceneChannelData< bool > GetData () |
Access a mutable interface for this channel's data | Channels/MovieSceneAudioTriggerChannel.h | |
TMovieSceneChannelData< const bool > GetData () |
Access a constant interface for this channel's data | Channels/MovieSceneAudioTriggerChannel.h | |
TArrayView< const FFrameNumber > GetTimes() |
Const access to this channel's times | Channels/MovieSceneAudioTriggerChannel.h | |
bool HasAnyData() |
Check whether this channel has any data | Channels/MovieSceneAudioTriggerChannel.h |
Overridden from FMovieSceneChannel
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TRange< FFrameNumber > ComputeEffectiveRange() |
Compute the effective range of this channel, for example, the extents of its key times | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void DeleteKeys
(
TArrayView< const FKeyHandle > InHandles |
Delete the keys for the specified key handles | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void DeleteKeysFrom
(
FFrameNumber InTime, |
Delete keys before or after a specified time | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void DuplicateKeys
(
TArrayView< const FKeyHandle > InHandles, |
Duplicate the keys for the specified key handles | Channels/MovieSceneAudioTriggerChannel.h | |
virtual FKeyHandle GetHandle
(
int32 Index |
Retrieve a key handle for the specified key time index | Channels/MovieSceneAudioTriggerChannel.h | |
virtual int32 GetIndex
(
FKeyHandle Handle |
Attempt to retrieve the index of key from its handle | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void GetKeys
(
const TRange< FFrameNumber >& WithinRange, |
Get key information pertaining to all keys that exist within the specified range | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void GetKeyTimes
(
TArrayView< const FKeyHandle > InHandles, |
Get all key times for the specified key handles | Channels/MovieSceneAudioTriggerChannel.h | |
virtual int32 GetNumKeys() |
Get the total number of keys on this channel | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void Offset
(
FFrameNumber DeltaPosition |
Offset the keys within this channel by a given delta position | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void Optimize
(
const FKeyDataOptimizationParams& InParameters |
Optimize this channel by removing any redundant data according to the specified parameters | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void RemapTimes
(
const UE::MovieScene::IRetimingInterface& Retimer |
Remap the times contained within this channel using a custom remapper | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void Reset() |
Reset this channel back to its original state | Channels/MovieSceneAudioTriggerChannel.h | |
virtual void SetKeyTimes
(
TArrayView< const FKeyHandle > InHandles, |
Set key times for the specified key handles | Channels/MovieSceneAudioTriggerChannel.h |