1. Epic GamesDeveloper
  3. IMovieScenePlayer

IMovieScenePlayer

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

API > API/Runtime > API/Runtime/MovieScene

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

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

Syntax

class IMovieScenePlayer : public UE::MovieScene::IObjectBindingNotifyPlaybackCapability

Derived Classes

IMovieScenePlayer derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

IMovieScenePlayer()

   IMovieScenePlayer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IMovieScenePlayer()

   IMovieScenePlayer.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BindingOverrides TMap< FMovieSceneEvaluationOperand, FMovieSceneEvaluationOperand > & List of binding overrides to use for the sequence IMovieScenePlayer.h  
PreAnimatedState FMovieScenePreAnimatedState Container that stores any per-animated state tokens IMovieScenePlayer.h  
State FMovieSceneEvaluationState Evaluation state that stores global state to do with the playback operation IMovieScenePlayer.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
NullRegister FNullMovieSceneSpawnRegister Null register that asserts on use IMovieScenePlayer.h  
StaticBindingOverrides UE::MovieScene::FStaticBindingOverrides Static binding overrides IMovieScenePlayer.h  
UniqueIndex uint16 This player's unique Index IMovieScenePlayer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBindingOverride ( const FMovieSceneEvaluationOperand& InOperand,
const FMovieSceneEvaluationOperand& InOverrideOperand
)

 Adds an override for the given operand IMovieScenePlayer.h  

virtual UObject * AsUObject()

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

virtual bool CanUpdateCameraCut()

   IMovieScenePlayer.h  

virtual UMovieSceneEntitySystemLinker * ConstructEntitySystemLinker()

 Called to retrieve or construct an entity linker for the specified playback context IMovieScenePlayer.h  

virtual FGuid CreateBinding ( UMovieSceneSequence* InSequence,
UObject* InObject
)

 Attempts to create a binding for the given object in the given sequence. IMovieScenePlayer.h  

void DiscardPreAnimatedState()

 Discard all pre-animated state without restoring it IMovieScenePlayer.h  

TArrayView< TWeakObjectPtr<> > FindBoundObjects ( const FGuid& ObjectBindingID,
FMovieSceneSequenceIDRef SequenceID
)

 Locate objects bound to the specified object guid, in the specified sequence IMovieScenePlayer.h  
Locate objects bound to the specified sequence operand IMovieScenePlayer.h  

FGuid FindCachedObjectId ( UObject& InObject,
FMovieSceneSequenceIDRef SequenceID
)

 Attempt to find the object binding ID for the specified object, in the specified sequence IMovieScenePlayer.h  

FGuid FindObjectId ( UObject& InObject,
FMovieSceneSequenceIDRef SequenceID
)

 Attempt to find the object binding ID for the specified object, in the specified sequence IMovieScenePlayer.h  
  IMovieScenePlayer.h  
Returns the evaluated sequence instance's shared playback state, if any. IMovieScenePlayer.h  

FMovieSceneEvaluationOperand * GetBindingOverride ( const FMovieSceneEvaluationOperand& InOperand
)

 Retrieves any override for the given operand IMovieScenePlayer.h  

FMovieSceneEvaluationState * GetEvaluationState()

 Gets the evaluation state that stores global state to do with the playback operation IMovieScenePlayer.h  

FMovieSceneRootEvaluationTemplateInstance & GetEvaluationTemplate()

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

virtual TArray< UObject * > GetEventContexts()

 Access the event contexts for this movie scene player IMovieScenePlayer.h  
Used to access the Observer in MovieSceneSequencePlayer IMovieScenePlayer.h  

UObject * GetOrCreateDirectorInstance ( TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
FMovieSceneSequenceIDRef SequenceID
)

 Gets a new or existing director blueprint instance for the given root or sub sequence IMovieScenePlayer.h  
Access the client in charge of playback IMovieScenePlayer.h  
  IMovieScenePlayer.h  

virtual UObject * GetPlaybackContext()

 Access the playback context for this movie scene player IMovieScenePlayer.h  

EMovieScenePlayerStatus::Type GetPlaybackStatus()

   IMovieScenePlayer.h  
Returns the evaluated sequence instance's shared playback state, asserts if there is none. IMovieScenePlayer.h  
  IMovieScenePlayer.h  

virtual FMovieSceneSpawnRegister & GetSpawnRegister()

 Obtain an object responsible for managing movie scene spawnables IMovieScenePlayer.h  
Gets the list of binding overrides to use for the sequence IMovieScenePlayer.h  

uint16 GetUniqueIndex()

   IMovieScenePlayer.h  

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

 Get the current perspective viewport settings IMovieScenePlayer.h  

virtual bool HasDynamicWeighting()

 Whether this player utilizes dynamic weighting IMovieScenePlayer.h  

virtual void InitializeRootInstance ( TSharedRef< UE::MovieScene::FSharedPlaybackState > NewSharedPlaybackState
)

 Initializes a new root sequence instance and its shared playback state. IMovieScenePlayer.h  

void InvalidateCachedData()

 Invalidate any cached state contained within this player causing all entities to be forcibly re-linked and evaluated IMovieScenePlayer.h  

virtual bool IsDisablingEventTriggers ( FFrameTime& DisabledUntilTime
) const

 Returns whether event triggers are disabled and if so, until what time. IMovieScenePlayer.h  

bool IsEvaluating()

   IMovieScenePlayer.h  

virtual bool IsPreview ()

 Test whether this is a preview player or not. IMovieScenePlayer.h  

virtual void NotifyBindingUpdate ( const FGuid& InGuid,
FMovieSceneSequenceIDRef InSequenceID,
TArrayView< TWeakObjectPtr<> > Objects
)

 Called whenever an object binding has been resolved to give the player a chance to interact with the objects before they are animated IMovieScenePlayer.h  

virtual void OnObjectSpawned ( UObject* InObject,
const FMovieSceneEvaluationOperand& Operand
)

 Called when an object is spawned by sequencer IMovieScenePlayer.h  

virtual void PopulateUpdateFlags ( UE::MovieScene::ESequenceInstanceUpdateFlags& OutFlags
)

 Called to initialize the flag structure that denotes what functions need to be called on this updater IMovieScenePlayer.h  

virtual void PostEvaluation ( const FMovieSceneContext& Context
)

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

virtual void PreEvaluation ( const FMovieSceneContext& Context
)

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

void RemoveBindingOverride ( const FMovieSceneEvaluationOperand& InOperand
)

 Removes any override set for the given operand IMovieScenePlayer.h  

void ResetDirectorInstances()

 Remove all director blueprint instances IMovieScenePlayer.h  

virtual void ResolveBoundObjects ( const FGuid& InBindingId,
FMovieSceneSequenceID SequenceID,
UMovieSceneSequence& Sequence,
UObject* ResolutionContext,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
) const

 Resolve objects bound to the specified binding ID IMovieScenePlayer.h  

void RestorePreAnimatedState()

 Restore all pre-animated state IMovieScenePlayer.h  

void SavePreAnimatedState ( UObject& InObject,
FMovieSceneAnimTypeID InTokenType,
const IMovieScenePreAnimatedTokenProducer& InProducer
)

 Attempt to save specific state for the specified token state before it animates an object. IMovieScenePlayer.h  
Attempt to save specific state for the specified token state before it mutates state. IMovieScenePlayer.h  

void SetPlaybackStatus ( EMovieScenePlayerStatus::Type InPlaybackStatus
)

   IMovieScenePlayer.h  

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

 Set the perspective viewport settings IMovieScenePlayer.h  

virtual void UpdateCameraCut ( UObject* CameraObject,
const EMovieSceneCameraCutParams& CameraCutParams
)

   IMovieScenePlayer.h  

virtual void UpdateCameraCut ( UObject* CameraObject,
UObject* UnlockIfCameraObject,
bool bJumpCut
)

   IMovieScenePlayer.h  

Overridden from IObjectBindingNotifyPlaybackCapability

Name Remarks Include Path Unreal Specifiers

virtual void NotifyBindingsChanged()

 Called whenever any object bindings have changed IMovieScenePlayer.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

Static

Name Remarks Include Path Unreal Specifiers

static void Get ( TArray< IMovieScenePlayer* >& OutPlayers,
bool bOnlyUnstoppedPlayers
)

   IMovieScenePlayer.h  

static IMovieScenePlayer * Get ( uint16 InUniqueIndex
)

   IMovieScenePlayer.h  

static void SetIsEvaluatingFlag ( uint16 InUniqueIndex,
bool bIsUpdating
)

   IMovieScenePlayer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page