1. Epic GamesDeveloper
  3. IAvaSequencePlaybackObject

IAvaSequencePlaybackObject

API > API/Plugins > API/Plugins/AvalancheSequence

   
Name IAvaSequencePlaybackObject
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheSequence/Public/AvaSequencePlaybackObject.h
Include Path #include "AvaSequencePlaybackObject.h"

Syntax

class IAvaSequencePlaybackObject

Typedefs

Name Type Remarks Include Path
FOnCameraCut TMulticastDelegate_TwoParams< void, UObject *, bool >   AvaSequencePlaybackObject.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CleanupPlayers()

 Tears down both the Active and Stopped Players in this Playback Object Should be only be called when ending play AvaSequencePlaybackObject.h  

UAvaSequencePlayer * ContinueSequence ( UAvaSequence* InSequence
)

 Triggers Continue for given sequence AvaSequencePlaybackObject.h  

TArray< UAvaSequencePlayer * > ContinueSequencesByLabel ( FName InSequenceLabel
)

 Triggers Continue for the playing sequences that match the given label AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Continue Sequences (by Label)"
  • Category="Playback"

TArray< UAvaSequencePlayer * > ContinueSequencesByLabels ( const TArray< FName >& InSequenceLabels
)

 Triggers Continues in multiple playing sequences given by an array of sequence labels AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Continue Sequences (by Labels)"
  • Category="Playback"

TArray< UAvaSequencePlayer * > ContinueSequencesByTag ( const FAvaTagHandle& InTagHandle,
bool bInExactMatch
)

 Triggers Continues in all the sequences matching the provided tag AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Continue Sequences (by Tag)"
  • Category="Playback"

UObject * CreateDirectorInstance ( IMovieScenePlayer& InPlayer,
FMovieSceneSequenceID InSequenceID
)

   AvaSequencePlaybackObject.h  

TArray< UAvaSequencePlayer * > GetAllSequencePlayers()

 Retrieves all Active Sequence Players AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Get Active Sequence Players"
  • Category="Playback"

FOnCameraCut & GetOnCameraCut()

   AvaSequencePlaybackObject.h  

UObject * GetPlaybackContext()

   AvaSequencePlaybackObject.h  

ULevel * GetPlaybackLevel()

   AvaSequencePlaybackObject.h  

UAvaSequencePlayer * GetSequencePlayer ( const UAvaSequence* InSequence
) const

   AvaSequencePlaybackObject.h  

TArray< UAvaSequencePlayer * > GetSequencePlayers ( TConstArrayView< const UAvaSequence* > InSequences
) const

 Retrieves the active sequence players for the given sequences, if any AvaSequencePlaybackObject.h  

TArray< UAvaSequencePlayer * > GetSequencePlayersByLabel ( FName InSequenceLabel
) const

 Retrieves the active sequence players for the given sequences that match the given label, if any AvaSequencePlaybackObject.h  

TArray< UAvaSequencePlayer * > GetSequencePlayersByLabels ( const TArray< FName >& InSequenceLabels
) const

 Retrieves the active sequence players for the given sequences that match the given labels, if any AvaSequencePlaybackObject.h  

TArray< UAvaSequencePlayer * > GetSequencePlayersByTag ( const FAvaTagHandle& InTagHandle,
bool bInExactMatch
) const

 Retrieves the active sequence players for the given sequences that match the given tag, if any AvaSequencePlaybackObject.h  

bool HasActiveSequencePlayers()

 Returns true if there are any Active Sequence Players AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Has Active Sequence Players"
  • Category="Playback"

void PauseSequence ( UAvaSequence* InSequence
)

 Pauses all players for a given sequence AvaSequencePlaybackObject.h  

void PauseSequencesByLabel ( FName InSequenceLabel
)

 Pauses all players for sequences that match the given label AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Pause Sequences (by Label)"
  • Category="Playback"

void PauseSequencesByLabels ( const TArray< FName >& InSequenceLabels
)

 Pauses all players for sequences that match the given labels AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Pause Sequences (by Labels)"
  • Category="Playback"

void PauseSequencesByTag ( const FAvaTagHandle& InTagHandle,
bool bInExactMatch
)

 Pauses all players for sequences that match the provided tag AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Pause Sequences (by Tag)"
  • Category="Playback"

TArray< UAvaSequencePlayer * > PlayScheduledSequences()

 Plays the Scheduled Sequences with the Scheduled Play Settings AvaSequencePlaybackObject.h
  • BlueprintCallable
  • Category="Playback"

UAvaSequencePlayer * PlaySequence ( UAvaSequence* InSequence,
const FAvaSequencePlayParams& InPlaySettings
)

   AvaSequencePlaybackObject.h  

UAvaSequencePlayer * PlaySequenceBySoftReference ( TSoftObjectPtr< UAvaSequence > InSequence,
const FAvaSequencePlayParams& InPlaySettings
)

 Plays a single sequence by its soft reference AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Play Sequence (by Soft Reference)"
  • Category="Playback"

TArray< UAvaSequencePlayer * > PlaySequencesByLabel ( FName InSequenceLabel,
const FAvaSequencePlayParams& InPlaySettings
)

 Plays all the sequences that have the provided label AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Play Sequences (by Label)"
  • Category="Playback"

TArray< UAvaSequencePlayer * > PlaySequencesByLabels ( const TArray< FName >& InSequenceLabels,
const FAvaSequencePlayParams& InPlaySettings
)

 Plays multiple Sequences by an array of sequence labels AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Play Sequences (by Labels)"
  • Category="Playback"

TArray< UAvaSequencePlayer * > PlaySequencesBySoftReference ( const TArray< TSoftObjectPtr< UAvaSequence > >& InSequences,
const FAvaSequencePlayParams& InPlaySettings
)

 Plays multiple Sequences by their Soft Reference AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Play Sequences (by Soft Reference)"
  • Category="Playback"

TArray< UAvaSequencePlayer * > PlaySequencesByTag ( const FAvaTagHandle& InTagHandle,
bool bInExactMatch,
const FAvaSequencePlayParams& InPlaySettings
)

 Plays all the Sequences that match the given gameplay tag(s) AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Play Sequences (by Tag)"
  • Category="Playback"

UAvaSequencePlayer * PreviewFrame ( UAvaSequence* InSequence
)

 Evaluates the Preview Frame of a Sequence. Does nothing if the Sequence has no preview frame. AvaSequencePlaybackObject.h  

void StopSequence ( UAvaSequence* InSequence
)

 Stops all players for a given sequence AvaSequencePlaybackObject.h  

void StopSequencesByLabel ( FName InSequenceLabel
)

 Stops all players for sequences that match the given label AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Stop Sequences (by Label)"
  • Category="Playback"

void StopSequencesByLabels ( const TArray< FName >& InSequenceLabels
)

 Stops all players for sequences that match the given labels AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Stop Sequences (by Labels)"
  • Category="Playback"

void StopSequencesByTag ( const FAvaTagHandle& InTagHandle,
bool bInExactMatch
)

 Stops all players for sequences that match the provided tag AvaSequencePlaybackObject.h
  • BlueprintCallable
  • DisplayName="Stop Sequences (by Tag)"
  • Category="Playback"

UObject * ToUObject()

   AvaSequencePlaybackObject.h  

void UpdateCameraCut ( const UE::MovieScene::FOnCameraCutUpdatedParams& InCameraCutParams
)

   AvaSequencePlaybackObject.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page