1. Epic GamesDeveloper
  3. UMovieSceneSequencePlayer

UMovieSceneSequencePlayer

Abstract class that provides consistent player behaviour for various animation players

API > API/Runtime > API/Runtime/MovieScene

Abstract class that provides consistent player behaviour for various animation players

   
Name UMovieSceneSequencePlayer
Type class
Header File /Engine/Source/Runtime/MovieScene/Public/MovieSceneSequencePlayer.h
Include Path #include "MovieSceneSequencePlayer.h"

Syntax

UCLASS (Abstract, BlueprintType, MinimalAPI)  
class UMovieSceneSequencePlayer :  
    public UObject ,  
    public IMovieScenePlayer ,  
    public IMovieSceneSequenceTickManagerClient

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneSequencePlayer ( const FObjectInitializer&
)

   MovieSceneSequencePlayer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UMovieSceneSequencePlayer()

   MovieSceneSequencePlayer.h  

Classes

Name Remarks
FOnMovieSceneSequencePlayerUpdated An event that is broadcast each time this level sequence player is updated

Structs

Name Remarks
FMovieSceneUpdateArgs  
FPauseOnArgs  
FServerTimeSample  

Typedefs

Name Type Remarks Include Path
FOnEvaluationCallback TBaseDelegate_NoParams< void > Pre and post evaluation callbacks, for async evaluations MovieSceneSequencePlayer.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Observer TScriptInterface< IMovieSceneSequencePlayerObserver > Obeserver interface used for controlling whether this sequence can be played. MovieSceneSequencePlayer.h
  • Replicated
OnFinished FOnMovieSceneSequencePlayerEvent Event triggered when the level sequence player finishes naturally (without explicitly calling stop) MovieSceneSequencePlayer.h
  • BlueprintAssignable
  • Category="Sequencer|Player"
OnNativeFinished FOnMovieSceneSequencePlayerNativeEvent Native event triggered when the level sequence player finishes naturally (without explicitly calling stop) MovieSceneSequencePlayer.h  
OnPause FOnMovieSceneSequencePlayerEvent Event triggered when the level sequence player is paused MovieSceneSequencePlayer.h
  • BlueprintAssignable
  • Category="Sequencer|Player"
OnPlay FOnMovieSceneSequencePlayerEvent Event triggered when the level sequence player is played MovieSceneSequencePlayer.h
  • BlueprintAssignable
  • Category="Sequencer|Player"
OnPlayReverse FOnMovieSceneSequencePlayerEvent Event triggered when the level sequence player is played in reverse MovieSceneSequencePlayer.h
  • BlueprintAssignable
  • Category="Sequencer|Player"
OnStop FOnMovieSceneSequencePlayerEvent Event triggered when the level sequence player is stopped MovieSceneSequencePlayer.h
  • BlueprintAssignable
  • Category="Sequencer|Player"

Protected

Name Type Remarks Include Path Unreal Specifiers
bOverridingDynResFrameTimeBudget bool Whether dynamic resolution frame time budget is being overridden. MovieSceneSequencePlayer.h  
LastTickGameTimeSeconds TOptional< float > The last world game time at which we were ticked. MovieSceneSequencePlayer.h  
OldMaxTickRate TOptional< double > The maximum tick rate prior to playing (used for overriding delta time during playback). MovieSceneSequencePlayer.h  
OnMovieSceneSequencePlayerUpdate FOnMovieSceneSequencePlayerUpdated The event that will be broadcast every time the sequence is updated MovieSceneSequencePlayer.h  
PauseOnFrame TOptional< FPauseOnArgs > If set, pause playback on this frame MovieSceneSequencePlayer.h  
PostEvaluationCallbacks TArray< FOnEvaluationCallback >   MovieSceneSequencePlayer.h  
PreEvaluationCallbacks TArray< FOnEvaluationCallback >   MovieSceneSequencePlayer.h  
RegisteredTickInterval TOptional< FMovieSceneSequenceTickInterval > The tick interval we are currently registered with (if any) MovieSceneSequencePlayer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ChangePlaybackDirection()

 Changes the direction of playback (go in reverse if it was going forward, or vice versa) MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

TArray< UObject * > GetBoundObjects ( FMovieSceneObjectBindingID ObjectBinding
)

 Retrieve all objects currently bound to the specified binding identifier MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

EMovieSceneCompletionModeOverride GetCompletionModeOverride()

 Get the state of the completion mode override MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Game|Cinematic"

FQualifiedFrameTime GetCurrentTime()

 Get the current playback position MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

bool GetDisableCameraCuts()

 Set whether to disable camera cuts MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

FQualifiedFrameTime GetDuration()

 Get the total duration of the sequence MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

FQualifiedFrameTime GetEndTime()

 Get the offset within the level sequence to finish playing MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

int32 GetFrameDuration()

 Get this sequence's duration in frames MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

FFrameRate GetFrameRate()

 Get this sequence's display rate. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

bool GetHideHud()

 Get if the hud is hidden during play. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

TArray< FMovieSceneObjectBindingID > GetObjectBindings ( UObject* InObject
)

 Get the object bindings for the requested object MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

float GetPlayRate()

 Get the playback rate of this player. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

UMovieSceneSequence * GetSequence()

 Access the sequence this player is playing MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

FString GetSequenceName ( bool bAddClientInfo
) const

 Get the name of the sequence this player is playing MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

FQualifiedFrameTime GetStartTime()

 Get the offset within the level sequence to start playing MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

UMovieSceneSequenceTickManager * GetTickManager()

 Access this player's tick manager MovieSceneSequencePlayer.h  

TSharedPtr< FMovieSceneTimeController > GetTimeController()

 Retrieve the currently assigned time controller MovieSceneSequencePlayer.h  

void GoToEndAndStop()

 Go to end and stop. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"
  • Meta=(ToolTip="Go to end of the sequence and stop. Adheres to 'When Finished' section rules.")

void Initialize ( UMovieSceneSequence* InSequence,
const FMovieSceneSequencePlaybackSettings& InSettings
)

 Initialize this player with a sequence and some settings MovieSceneSequencePlayer.h  

void Initialize ( UMovieSceneSequence* InSequence
)

 Initialize this player using its existing playback settings MovieSceneSequencePlayer.h  

void InitializeForTick ( UObject* Context
)

 Ensure that this player's tick manager is set up correctly for the specified context MovieSceneSequencePlayer.h  

bool IsPaused()

 Check whether the sequence is paused. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

bool IsPlaying()

 Check whether the sequence is actively playing. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

bool IsReversed()

 Check whether playback is reversed. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

bool IsValid()

 Returns whether this player is valid, i.e. it has been initialized and not torn down yet MovieSceneSequencePlayer.h  

FOnMovieSceneSequencePlayerUpdated & OnSequenceUpdated()

   MovieSceneSequencePlayer.h  

void Pause()

 Pause playback. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void Play()

 Start playback forwards from the current time cursor position, using the current play rate. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void PlayLooping ( int32 NumLoops
)

 Start playback from the current time cursor position, looping the specified number of times. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void PlayReverse()

 Reverse playback. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"
Play from the current position to the requested position and pause. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void RemoveWeight ()

 Removes a previously assigned weight MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void RemoveWeight ( FMovieSceneSequenceID SequenceID
)

 Removes a previously assigned weight MovieSceneSequencePlayer.h  
Invalidates the given binding, forcing it to be refetched. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void RestoreState()

 Restore any changes made by this player to their original state MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Game|Cinematic"

void Scrub()

 Scrub playback. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"
Set the state of the completion mode override. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Game|Cinematic"

void SetDisableCameraCuts ( bool bInDisableCameraCuts
)

 Set whether to disable camera cuts MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void SetFrameRange ( int32 StartFrame,
int32 Duration,
float SubFrames
)

 Set the valid play range for this sequence, determined by a starting frame number (in this sequence player's plaback frame), and a number of frames duration MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"
  • DisplayName="Set Play Range (Frames)"

void SetFrameRate ( FFrameRate FrameRate
)

 Set the frame-rate that this player should play with, making all frame numbers in the specified time-space MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void SetHideHud ( bool HideHud
)

 Set if hiding the hud during play. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void SetIgnorePlaybackReplication ( bool bState
)

 Sets whether to listen or ignore playback replication events. MovieSceneSequencePlayer.h  

void SetPlaybackClient ( TScriptInterface< IMovieScenePlaybackClient > InPlaybackClient
)

 Assign a playback client interface for this sequence player, defining instance data and binding overrides MovieSceneSequencePlayer.h  
Set the current time of the player by evaluating from the current time to the specified time, as if the sequence is playing. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void SetPlaybackSettings ( const FMovieSceneSequencePlaybackSettings& InSettings
)

 Assign this player's playback settings MovieSceneSequencePlayer.h  

void SetPlayRate ( float PlayRate
)

 Set the playback rate of this player. Negative values will play the animation in reverse. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"
Assign a time controller for this sequence player allowing custom time management implementations. MovieSceneSequencePlayer.h  
Assign a time controller for this sequence player allowing custom time management implementations. MovieSceneSequencePlayer.h  

void SetTimeRange ( float StartTime,
float Duration
)

 Set the valid play range for this sequence, determined by a starting time and a duration (in seconds) MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"
  • DisplayName="Set Play Range (Seconds)"

void SetWeight ( double InWeight,
FMovieSceneSequenceID SequenceID
)

 Set a manual weight to be multiplied with all blendable elements within the specified sequence MovieSceneSequencePlayer.h  

void SetWeight ( double InWeight
)

 Set a manual weight to be multiplied with all blendable elements within this sequence MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void Stop()

 Stop playback and move the cursor to the end (or start, for reversed playback) of the sequence. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void StopAtCurrentTime()

 Stop playback without moving the cursor. MovieSceneSequencePlayer.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void TearDown()

 Perform any tear-down work when this player is no longer (and will never) be needed MovieSceneSequencePlayer.h  

void Update ( const float DeltaSeconds
)

 Update the sequence for the current time, if playing MovieSceneSequencePlayer.h  

void UpdateAsync ( const float DeltaSeconds
)

 Update the sequence for the current time, if playing, asynchronously MovieSceneSequencePlayer.h  

Overridden from IMovieScenePlayer

Name Remarks Include Path Unreal Specifiers

virtual FMovieSceneRootEvaluationTemplateInstance & GetEvaluationTemplate()

 Access the evaluation template that we are playing back MovieSceneSequencePlayer.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool CanPlay()

   MovieSceneSequencePlayer.h  

void FinishPlaybackInternal ( FFrameTime TimeToFinishAt
)

   MovieSceneSequencePlayer.h  

FFrameRate GetDisplayRate()

   MovieSceneSequencePlayer.h  

FFrameTime GetLastValidTime()

   MovieSceneSequencePlayer.h  

TOptional< TRange< FFrameTime > > GetPauseRange ( const FFrameTime& NewPosition
) const

 If the current sequence should pause (due to NewPosition overshooting a previously set ShouldPause) then a range of time that should be evaluated to reach there will be returned. MovieSceneSequencePlayer.h  

UWorld * GetPlaybackWorld()

   MovieSceneSequencePlayer.h  

bool NeedsQueueLatentAction()

   MovieSceneSequencePlayer.h  

virtual void OnLooped()

   MovieSceneSequencePlayer.h  

virtual void OnPaused()

   MovieSceneSequencePlayer.h  

virtual void OnStartedPlaying()

   MovieSceneSequencePlayer.h  

virtual void OnStopped()

   MovieSceneSequencePlayer.h  

void PlayInternal()

   MovieSceneSequencePlayer.h  

void QueueLatentAction ( FMovieSceneSequenceLatentActionDelegate Delegate
)

   MovieSceneSequencePlayer.h  

void RunLatentActions()

   MovieSceneSequencePlayer.h  

bool ShouldStopOrLoop ( FFrameTime NewPosition
) const

   MovieSceneSequencePlayer.h  

void StopInternal ( FFrameTime TimeToResetTo
)

   MovieSceneSequencePlayer.h  
  MovieSceneSequencePlayer.h  
  MovieSceneSequencePlayer.h  

void UpdateTimeCursorPosition ( FFrameTime NewPosition,
EUpdatePositionMethod Method,
bool bHasJumpedOverride
)

   MovieSceneSequencePlayer.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   MovieSceneSequencePlayer.h  

virtual bool CallRemoteFunction ( UFunction* Function,
void* Parameters,
FOutParmRec* OutParms,
FFrame* Stack
)

   MovieSceneSequencePlayer.h  

virtual int32 GetFunctionCallspace ( UFunction* Function,
FFrame* Stack
)

   MovieSceneSequencePlayer.h  

virtual bool IsSupportedForNetworking()

   MovieSceneSequencePlayer.h  

virtual void PostNetReceive()

   MovieSceneSequencePlayer.h  

Overridden from IMovieScenePlayer

Name Remarks Include Path Unreal Specifiers

virtual UObject * AsUObject()

 Cast this player instance as a UObject if possible MovieSceneSequencePlayer.h  

virtual UMovieSceneEntitySystemLinker * ConstructEntitySystemLinker()

 Called to retrieve or construct an entity linker for the specified playback context MovieSceneSequencePlayer.h  
Used to access the Observer in MovieSceneSequencePlayer MovieSceneSequencePlayer.h  

virtual IMovieScenePlaybackClient * GetPlaybackClient()

 Access the client in charge of playback MovieSceneSequencePlayer.h  

virtual EMovieScenePlayerStatus::Type GetPlaybackStatus()

   MovieSceneSequencePlayer.h  

virtual FMovieSceneSpawnRegister & GetSpawnRegister()

 Obtain an object responsible for managing movie scene spawnables MovieSceneSequencePlayer.h  

virtual void GetViewportSettings ( TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap
) const

 Get the current perspective viewport settings MovieSceneSequencePlayer.h  

virtual bool HasDynamicWeighting()

 Whether this player utilizes dynamic weighting MovieSceneSequencePlayer.h  

virtual void PostEvaluation ( const FMovieSceneContext& Context
)

 Called by the evaluation system after evaluation has occured MovieSceneSequencePlayer.h  

virtual void PreEvaluation ( const FMovieSceneContext& Context
)

 Called by the evaluation system when evaluation has just started. MovieSceneSequencePlayer.h  

virtual void ResolveBoundObjects ( UE::UniversalObjectLocator::FResolveParams& ResolveParams,
const FGuid& InBindingId,
FMovieSceneSequenceID SequenceID,
UMovieSceneSequence& Sequence,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
) const

 Resolve objects bound to the specified binding ID MovieSceneSequencePlayer.h  

virtual void SetPlaybackStatus ( EMovieScenePlayerStatus::Type InPlaybackStatus
)

   MovieSceneSequencePlayer.h  

virtual void SetViewportSettings ( const TMap< FViewportClient*, EMovieSceneViewportParams >& ViewportParamsMap
)

 Set the perspective viewport settings MovieSceneSequencePlayer.h  

Overridden from IMovieSceneSequenceTickManagerClient

Name Remarks Include Path Unreal Specifiers

virtual void TickFromSequenceTickManager ( float DeltaSeconds,
FMovieSceneEntitySystemRunner* Runner
)

   MovieSceneSequencePlayer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page