UMovieSceneSequencePlayer

Abstract class that provides consistent player behaviour for various animation players

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneSequencePlayer

	UActorSequencePlayer
	ULevelSequencePlayer
	UTemplateSequencePlayer

References

Module	MovieScene
Header	/Engine/Source/Runtime/MovieScene/Public/MovieSceneSequencePlayer.h
Include	#include "MovieSceneSequencePlayer.h"

Syntax

class UMovieSceneSequencePlayer :
public UObject,
public IMovieScenePlayer

Remarks

Abstract class that provides consistent player behaviour for various animation players

Variables

	Name	Description
uint32: 1	bIsAsyncUpdate	Set to true when the player is currently in the main level update
uint32: 1	bIsEvaluating	Set to true while the player's sequence is being evaluated
uint32: 1	bPendingOnStartedPlaying	Set to true to invoke OnStartedPlaying on first update tick for started playing
uint32: 1	bReversePlayback	Whether we're currently playing in reverse.
uint32: 1	bSkipNextUpdate	Flag that allows the player to tick its time controller without actually evaluating the sequence
int32	CurrentNumLoops	The number of times we have looped in the current playback
TOptional< FFra...	DisableEventTriggersUntilTime	Disable event triggers until given time
int32	DurationFrames	Time (in playback frames) at which to stop playing the sequence (defaults to the upper bound of the sequence's play range)
float	DurationSubFrames
FMovieSceneLate...	LatentActionManager	Local latent action manager for when we're running a blocking sequence
FMovieSceneSequ...	NetSyncProps	Replicated playback status and current time that are replicated to clients
FOnMovieSceneSe...	OnFinished	Event triggered when the level sequence player finishes naturally (without explicitly calling stop)
FOnMovieSceneSe...	OnPause	Event triggered when the level sequence player is paused
FOnMovieSceneSe...	OnPlay	Event triggered when the level sequence player is played
FOnMovieSceneSe...	OnPlayReverse	Event triggered when the level sequence player is played in reverse
FOnMovieSceneSe...	OnStop	Event triggered when the level sequence player is stopped
TScriptInterfac...	PlaybackClient	External client pointer in charge of playing back this sequence
FMovieSceneSequ...	PlaybackSettings	Specific playback settings for the animation.
FMovieScenePlay...	PlayPosition	Play position helper
FMovieSceneRoot...	RootTemplateInstance	The root template instance we're evaluating
TObjectPtr< UMo...	Sequence	The sequence to play back
TArray< FServer...	ServerTimeSamples	Array of server sequence times in seconds, with ping compensation baked in.
TSharedPtr< FMo...	SpawnRegister	Spawn register
FFrameNumber	StartTime	Time (in playback frames) at which to start playing the sequence (defaults to the lower bound of the sequence's play range)
TEnumAsByte< EM...	Status	Movie player status.
TObjectPtr< UMo...	TickManager	Global tick manager, held here to keep it alive while world sequences are in play
TSharedPtr< FMo...	TimeController	(Optional) Externally supplied time controller

Constructors

	Name	Description
	UMovieSceneSequencePlayer ( const FObjectInitializer& )

Destructors

	Name	Description
	~UMovieSceneSequencePlayer()

Functions

	Name	Description
bool	CanPlay()
void	ChangePlaybackDirection()	Changes the direction of playback (go in reverse if it was going forward, or vice versa)
void	FinishPlaybackInternal ( FFrameTime TimeToFinishAt )
TArray< UObj...	GetBoundObjects ( FMovieSceneObjectBindingID ObjectBi... )	Retrieve all objects currently bound to the specified binding identifier
FQualifiedFr...	GetCurrentTime()	Get the current playback position
bool	GetDisableCameraCuts()	Set whether to disable camera cuts
FFrameRate	GetDisplayRate()
FQualifiedFr...	GetDuration()	Get the total duration of the sequence
FQualifiedFr...	GetEndTime()	Get the offset within the level sequence to finish playing
int32	GetFrameDuration()	Get this sequence's duration in frames
FFrameRate	GetFrameRate()	Get this sequence's display rate.
FFrameTime	GetLastValidTime()
TArray< FMov...	GetObjectBindings ( UObject* InObject )	Get the object bindings for the requested object
TOptional< T...	GetPauseRange ( const FFrameTime& NewPosition )	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.
UWorld *	GetPlaybackWorld()
float	GetPlayRate()	Get the playback rate of this player.
UMovieSceneS...	GetSequence()	Access the sequence this player is playing
FString	GetSequenceName ( bool bAddClientInfo )	Get the name of the sequence this player is playing
FQualifiedFr...	GetStartTime()	Get the offset within the level sequence to start playing
UMovieSceneS...	GetTickManager()	Access this player's tick manager
void	GoToEndAndStop()	Go to end and stop.
void	Initialize ( UMovieSceneSequence* InSequenc..., const FMovieSceneSequencePlaybackSe... )	Initialize this player with a sequence and some settings
void	InitializeForTick ( UObject* Context )	Ensure that this player's tick manager is set up correctly for the specified context
bool	IsPaused()	Check whether the sequence is paused.
bool	IsPlaying()	Check whether the sequence is actively playing.
bool	IsReversed()	Check whether playback is reversed.
bool	NeedsQueueLatentAction()
void	OnLooped()
void	OnPaused()
FOnMovieScen...	OnSequenceUpdated()
void	OnStartedPlaying()
void	OnStopped()
void	Pause()	Pause playback.
void	Play()	Start playback forwards from the current time cursor position, using the current play rate.
void	PlayInternal()
void	PlayLooping ( int32 NumLoops )	Start playback from the current time cursor position, looping the specified number of times.
void	PlayReverse()	Reverse playback.
void	PlayTo ( FMovieSceneSequencePlaybackParams P..., FMovieSceneSequencePlayToParams Pla... )	Play from the current position to the requested position and pause.
void	QueueLatentAction ( FMovieSceneSequenceLatentActionDele... )
void	RestoreState()	Restore any changes made by this player to their original state
void	RunLatentActions()
void	Scrub()	Scrub playback.
void	SetDisableCameraCuts ( bool bInDisableCameraCuts )	Set whether to disable camera cuts
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
void	SetFrameRate ( FFrameRate FrameRate )	Set the frame-rate that this player should play with, making all frame numbers in the specified time-space
void	SetPlaybackClient ( TScriptInterface< IMovieScenePlayba... )	Assign a playback client interface for this sequence player, defining instance data and binding overrides
void	SetPlaybackPosition ( FMovieSceneSequencePlaybackParams P... )	Set the current time of the player by evaluating from the current time to the specified time, as if the sequence is playing.
void	SetPlayRate ( float PlayRate )	Set the playback rate of this player. Negative values will play the animation in reverse.
void	SetTimeController ( TSharedPtr< FMovieSceneTimeControll... )	Assign a time controller for this sequence player allowing custom time management implementations.
void	SetTimeRange ( float StartTime, float Duration )	Set the valid play range for this sequence, determined by a starting time and a duration (in seconds)
bool	ShouldStopOrLoop ( FFrameTime NewPosition )
void	Stop()	Stop playback and move the cursor to the end (or start, for reversed playback) of the sequence.
void	StopAtCurrentTime()	Stop playback without moving the cursor.
void	StopInternal ( FFrameTime TimeToResetTo )
void	Update ( const float DeltaSeconds )	Update the sequence for the current time, if playing
void	UpdateAsync ( const float DeltaSeconds )	Update the sequence for the current time, if playing, asynchronously
void	UpdateMovieSceneInstance ( FMovieSceneEvaluationRange InRange, EMovieScenePlayerStatus::Type Playe..., bool bHasJumped )
void	UpdateMovieSceneInstance ( FMovieSceneEvaluationRange InRange, EMovieScenePlayerStatus::Type Playe..., const FMovieSceneUpdateArgs& Args )
void	UpdateTimeCursorPosition ( FFrameTime NewPosition, EUpdatePositionMethod Method, bool bHasJumpedOverride )

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	CallRemoteFunction ( UFunction* Function, void* Parms, FOutParmRec* OutParms, FFrame* Stack )	Call the actor's function remotely
int32	GetFunctionCallspace ( UFunction* Function, FFrame* Stack )	Return the space this function should be called.
bool	IsSupportedForNetworking()	IsSupportedForNetworking means an object can be referenced over the network
void	PostNetReceive()	Called right after receiving a bunch

Overridden from IMovieScenePlayer

	Name	Description
UObject *...	AsUObject()	Cast this player instance as a UObject if possible
bool	CanUpdateCameraCut()	Whether this player can update the camera cut
UMovieSceneE...	ConstructEntitySystemLinker()	Called to retrieve or construct an entity linker for the specified playback context
FMovieSceneR...	GetEvaluationTemplate()	Access the evaluation template that we are playing back
IMovieSceneP...	GetPlaybackClient()	Access the client in charge of playback
EMovieSceneP...	GetPlaybackStatus()
FMovieSceneS...	GetSpawnRegister()	Obtain an object responsible for managing movie scene spawnables
void	GetViewportSettings ( TMap< FViewportClient*, EMovie... )	Get the current perspective viewport settings
bool	IsDisablingEventTriggers ( FFrameTime& DisabledUntilTime )	Returns whether event triggers are disabled and if so, until what time.
void	PostEvaluation ( const FMovieSceneContext& Context )	Called by the evaluation system after evaluation has occured
void	PreEvaluation ( const FMovieSceneContext& Context )	Called by the evaluation system when evaluation has just started.
void	ResolveBoundObjects ( const FGuid& InBindingId, FMovieSceneSequenceID SequenceID, UMovieSceneSequence& Sequence, UObject* ResolutionContext, TArray< UObject*, TInlineAlloc... )	Resolve objects bound to the specified binding ID
void	SetPlaybackStatus ( EMovieScenePlayerStatus::Type InPla... )
void	SetViewportSettings ( const TMap< FViewportClient*, ... )	Set the perspective viewport settings
void	UpdateCameraCut ( UObject* CameraObject, const EMovieSceneCameraCutParams& ... )	Updates the perspective viewports with the actor to view through

Classes

	Name	Description
	FMovieSceneUpdateArgs
	FOnMovieSceneSequencePlayerUpdated	An event that is broadcast each time this level sequence player is updated
	FServerTimeSample

Typedefs

Name	Description
FOnEvaluationCallback	Pre and post evaluation callbacks, for async evaluations

Deprecated Functions

	Name	Description
void	JumpToFrame ( FFrameTime NewPosition )	JumpToFrame is deprecated, use SetPlaybackPosition.
bool	JumpToMarkedFrame ( const FString& InLabel )	JumpToMarkedFrame is deprecated, use SetPlaybackPosition.
void	JumpToSeconds ( float TimeInSeconds )	JumpToSeconds is deprecated, use SetPlaybackPosition.
void	PlayToFrame ( FFrameTime NewPosition )	PlayToFrame is deprecated, use SetPlaybackPosition.
bool	PlayToMarkedFrame ( const FString& InLabel )	PlayToMarkedFrame is deprecated, use SetPlaybackPosition.
void	PlayToSeconds ( float TimeInSeconds )	PlayToSeconds is deprecated, use SetPlaybackPosition.
void	ScrubToFrame ( FFrameTime NewPosition )	ScrubToFrame is deprecated, use SetPlaybackPosition.
bool	ScrubToMarkedFrame ( const FString& InLabel )	ScrubToMarkedFrame is deprecated, use SetPlaybackPosition.
void	ScrubToSeconds ( float TimeInSeconds )	ScrubToSeconds is deprecated, use SetPlaybackPosition.