Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieScene > UMovieSceneSequencePlayer

Light Theme

Dark Theme

UMovieSceneSequencePlayer

Abstract class that provides consistent player behaviour for various animation players

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	bIsEvaluating	Set to true while evaluating to prevent reentrancy
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.
int32	CurrentNumLoops	The number of times we have looped in the current playback
int32	DurationFrames	Time (in playback frames) at which to stop playing the sequence (defaults to the upper bound of the sequence's play range)
TArray< FLatent...	LatentActions	Set of latent actions that are to be performed when the sequence has finished evaluating this frame
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
UMovieSceneSequ...	Sequence	The sequence to play back
TSharedPtr< FMo...	SpawnRegister
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.
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)
int32	FindMarkedFrameByLabel ( const FString& InLabel )
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
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
UWorld *	GetPlaybackWorld()
float	GetPlayRate()	Get the playback rate of this player.
UMovieSceneS...	GetSequence()	Access the sequence this player is playing
FQualifiedFr...	GetStartTime()	Get the offset within the level sequence to start playing
void	GoToEndAndStop()	Go to end and stop.
void	Initialize ( UMovieSceneSequence* InSequenc..., const FMovieSceneSequencePlaybackSe... )	Initialize this player with a sequence and some settings
bool	IsPaused()	Check whether the sequence is paused.
bool	IsPlaying()	Check whether the sequence is actively playing.
bool	IsReversed()	Check whether playback is reversed.
void	JumpToFrame ( FFrameTime NewPosition )	Low-level call to set the current time of the player by evaluating only the specified time, as if scrubbing the timeline.
bool	JumpToMarkedFrame ( const FString& InLabel )	Low-level call to set the current time of the player to the marked frame by label by evaluating only the specified time, as if scrubbing the timeline.
void	JumpToSeconds ( float TimeInSeconds )	Low-level call to set the current time of the player by evaluating only the specified time, as if scrubbing the timeline.
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	PlayToFrame ( FFrameTime NewPosition )	Low-level call to set the current time of the player by evaluating from the current time to the specified time, as if the sequence is playing.
bool	PlayToMarkedFrame ( const FString& InLabel )	Low-level call to set the current time of the player to the marked frame by label by evaluating only the specified time.
void	PlayToSeconds ( float TimeInSeconds )	Low-level call to set the current time of the player by evaluating only the specified time.
void	Scrub()	Scrub playback.
void	ScrubToFrame ( FFrameTime NewPosition )	Low-level call to set the current time of the player by evaluating only the specified time.
bool	ScrubToMarkedFrame ( const FString& InLabel )	Low-level call to set the current time of the player to the marked frame by label by evaluating only the specified time.
void	ScrubToSeconds ( float TimeInSeconds )	Low-level call to set the current time of the player by evaluating only the specified time.
void	SetDisableCameraCuts ( bool bInDisableCameraCuts )	Set whether to disable camera cuts
void	SetFrameRange ( int32 StartFrame, int32 Duration )	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	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	UpdateMovieSceneInstance ( FMovieSceneEvaluationRange InRange, EMovieScenePlayerStatus::Type Playe..., bool bHasJumped )
void	UpdateTimeCursorPosition ( FFrameTime NewPosition, EUpdatePositionMethod Method )

Overridden from UObject

	Name	Description
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	IsDestructionThreadSafe()	Called during garbage collection to determine if an object can have its destructor called on a worker thread.
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
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
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
	FLatentAction
	FOnMovieSceneSequencePlayerUpdated	An event that is broadcast each time this level sequence player is updated

Deprecated Functions

	Name	Description
float	GetLength()	Please use GetDuration instead
float	GetPlaybackEnd()	Please use GetEndTime instead
float	GetPlaybackPosition()	Please use GetCurrentTime instead
float	GetPlaybackStart()	Please use GetStartTime instead
void	JumpToPosition ( float NewPlaybackPosition )	Please use ScrubToTime instead
void	SetPlaybackPosition ( float NewPlaybackPosition )	Please use PlayToFrame instead
void	SetPlaybackRange ( const float NewStartTime, const float NewEndTime )	Please use SetFrameRange or SetTimeRange instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss