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 > IMovieScenePlayer

Light Theme

Dark Theme

IMovieScenePlayer

Interface for movie scene players Provides information for playback of a movie scene

Windows

MacOS

Linux

Inheritance Hierarchy

IMovieScenePlayer

ISequencer

UMovieSceneSequencePlayer

	UActorSequencePlayer
	ULevelSequencePlayer
	UTemplateSequencePlayer

UUMGSequencePlayer

References

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

Syntax

class IMovieScenePlayer

Remarks

Interface for movie scene players Provides information for playback of a movie scene

Variables

	Name	Description
TMap< FMovieSce...	BindingOverrides	List of binding overrides to use for the sequence
TInlineValue< I...	MotionVectorSimulation	Motion Vector Simulation
FMovieScenePreA...	PreAnimatedState	Container that stores any per-animated state tokens
FMovieSceneEval...	State	Evaluation state that stores global state to do with the playback operation

Destructors

	Name	Description
	~IMovieScenePlayer()

Functions

	Name	Description
UObject *...	AsUObject()	Cast this player instance as a UObject if possible
bool	CanUpdateCameraCut()	Whether this player can update the camera cut
void	DiscardEntityTokens()	Discard any tokens that relate to entity animation (ie sections or tracks) without restoring the values.
TArrayView< ...	FindBoundObjects ( const FGuid& ObjectBindingID, FMovieSceneSequenceIDRef SequenceID )	Locate objects bound to the specified object guid, in the specified sequence
TArrayView< ...	FindBoundObjects ( const FMovieSceneEvaluationOperand ... )	Locate objects bound to the specified sequence operand
FGuid	FindCachedObjectId ( UObject& InObject, FMovieSceneSequenceIDRef SequenceID )	Attempt to find the object binding ID for the specified object, in the specified sequence
FGuid	FindObjectId ( UObject& InObject, FMovieSceneSequenceIDRef SequenceID )	Attempt to find the object binding ID for the specified object, in the specified sequence
FMovieSceneR...	GetEvaluationTemplate()	Access the evaluation template that we are playing back
TArray< UObj...	GetEventContexts()	Access the event contexts for this movie scene player
const UObjec...	GetInstanceData()	Access the global instance data object for this movie scene player
IMovieSceneP...	GetPlaybackClient()	Access the client in charge of playback
UObject *...	GetPlaybackContext()	Access the playback context for this movie scene player
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	IsPreview()	Test whether this is a preview player or not.
void	NotifyBindingsChanged()	Called whenever any object bindings have changed
void	NotifyBindingUpdate ( const FGuid& InGuid, FMovieSceneSequenceIDRef InSequence..., TArrayView< TWeakObjectPtr<>> Objec... )	Called whenever an object binding has been resolved to give the player a chance to interact with the objects before they are animated
void	OnObjectSpawned ( UObject* InObject, const FMovieSceneEvaluationOperand ... )	Called wehn an object is spawned by sequencer
void	ResolveBoundObjects ( const FGuid& InBindingId, FMovieSceneSequenceID SequenceID, UMovieSceneSequence& Sequence, UObject* ResolutionContext, TArray< UObject*, TInlineAlloc... )	Resolve objects bound to the specified binding ID
void	RestorePreAnimatedState()	Restore all pre-animated state
void	RestorePreAnimatedState ( UObject& Object )	Restore any pre-animated state that has been cached for the specified object
void	RestorePreAnimatedState ( UClass* GeneratedClass )	Restore any pre-animated state that has been cached for the specified class
void	RestorePreAnimatedState ( const FMovieSceneEvaluationKey& En... )	Restore any pre-animated state that has been cached from the specified entity (a section or, less commonly, a track)
void	RestorePreAnimatedState ( UObject& Object, TFunctionRef< bool... )	Restore any pre-animated state that has been cached for the specified object
void	SaveGlobalPreAnimatedState ( UObject& InObject, FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedTokenPr... )	Attempt to save specific global state for the specified token state before it animates an object.
void	SavePreAnimatedState ( FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedGlobalT... )	Attempt to save specific state for the specified token state before it mutates state.
void	SavePreAnimatedState ( UObject& InObject, FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedTokenPr... )	Attempt to save specific state for the specified token state before it animates an object.
void	SavePreAnimatedState ( FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedGlobalT..., FMovieSceneEvaluationKey CaptureEnt... )	Attempt to save specific state for the specified token state before it mutates state.
void	SavePreAnimatedState ( UObject& InObject, FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedTokenPr..., FMovieSceneEvaluationKey CaptureEnt... )	Attempt to save specific state for the specified token state before it animates an object.
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
void	UpdateCameraCut ( UObject* CameraObject, UObject* UnlockIfCameraObject, bool bJumpCut )	Updates the perspective viewports with the actor to view through

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

Take our survey

Dismiss