UMovieSceneSequencePlayer

Abstract class that provides consistent player behaviour for various animation players

Windows
MacOS
Linux

Inheritance Hierarchy

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

Protected variable

uint32 : 1

 

bIsEvaluating

Set to true while the player's sequence is being evaluated

Protected variable

uint32 : 1

 

bIsMainLevelUpdate

Set to true when the player is currently in the main level update

Protected variable

uint32 : 1

 

bPendingOnStartedPlaying

Set to true to invoke OnStartedPlaying on first update tick for started playing

Protected variable

uint32 : 1

 

bReversePlayback

Whether we're currently playing in reverse.

Protected variable

int32

 

CurrentNumLoops

The number of times we have looped in the current playback

Protected variable

int32

 

DurationFrames

Time (in playback frames) at which to stop playing the sequence (defaults to the upper bound of the sequence's play range)

Protected variable

float

 

DurationSubFrames

Protected variable

FMovieSceneSequ ...

 

NetSyncProps

Replicated playback status and current time that are replicated to clients

Public variable

FOnMovieSceneSe ...

 

OnFinished

Event triggered when the level sequence player finishes naturally (without explicitly calling stop)

Public variable

FOnMovieSceneSe ...

 

OnPause

Event triggered when the level sequence player is paused

Public variable

FOnMovieSceneSe ...

 

OnPlay

Event triggered when the level sequence player is played

Public variable

FOnMovieSceneSe ...

 

OnPlayReverse

Event triggered when the level sequence player is played in reverse

Public variable

FOnMovieSceneSe ...

 

OnStop

Event triggered when the level sequence player is stopped

Protected variable

TScriptInterfac ...

 

PlaybackClient

External client pointer in charge of playing back this sequence

Protected variable

FMovieSceneSequ ...

 

PlaybackSettings

Specific playback settings for the animation.

Protected variable

FMovieScenePlay ...

 

PlayPosition

Play position helper

Protected variable

FMovieSceneRoot ...

 

RootTemplateInstance

The root template instance we're evaluating

Protected variable

UMovieSceneSequ ...

 

Sequence

The sequence to play back

Protected variable

TSharedPtr < FMo ...

 

SpawnRegister

Protected variable

FFrameNumber

 

StartTime

Time (in playback frames) at which to start playing the sequence (defaults to the lower bound of the sequence's play range)

Protected variable

TEnumAsByte < EM ...

 

Status

Movie player status.

Protected variable

UMovieSceneSequ ...

 

TickManager

Global tick manager, held here to keep it alive while world sequences are in play

Protected variable

TSharedPtr < FMo ...

 

TimeController

(Optional) Externally supplied time controller

Constructors

Name Description

Public function

UMovieSceneSequencePlayer

(
    const FObjectInitializer &
)

Destructors

Name Description

Public function Virtual

~UMovieSceneSequencePlayer()

Functions

Name Description

Protected function Virtual Const

bool

 

CanPlay()

Public function

void

 

ChangePlaybackDirection()

Changes the direction of playback (go in reverse if it was going forward, or vice versa)

Public function

TArray < UObj ...

 

GetBoundObjects

(
    FMovieSceneObjectBindingID ObjectBi...
)

Retrieve all objects currently bound to the specified binding identifier

Public function Const

FQualifiedFr ...

 

GetCurrentTime()

Get the current playback position

Public function

bool

 

GetDisableCameraCuts()

Set whether to disable camera cuts

Public function Const

FQualifiedFr ...

 

GetDuration()

Get the total duration of the sequence

Public function Const

FQualifiedFr ...

 

GetEndTime()

Get the offset within the level sequence to finish playing

Public function Const

int32

 

GetFrameDuration()

Get this sequence's duration in frames

Public function Const

FFrameRate

 

GetFrameRate()

Get this sequence's display rate.

Protected function Const

FFrameTime

 

GetLastValidTime()

Public function

TArray < FMov ...

 

GetObjectBindings

(
    UObject * InObject
)

Get the object bindings for the requested object

Protected function Const

UWorld *

 

GetPlaybackWorld()

Public function Const

float

 

GetPlayRate()

Get the playback rate of this player.

Public function Const

UMovieSceneS ...

 

GetSequence()

Access the sequence this player is playing

Public function Const

FQualifiedFr ...

 

GetStartTime()

Get the offset within the level sequence to start playing

Public function

void

 

GoToEndAndStop()

Go to end and stop.

Public function

void

 

Initialize

(
    UMovieSceneSequence * InSequenc...,
    const FMovieSceneSequencePlaybackSe ...
)

Initialize this player with a sequence and some settings

Public function Const

bool

 

IsPaused()

Check whether the sequence is paused.

Public function Const

bool

 

IsPlaying()

Check whether the sequence is actively playing.

Public function Const

bool

 

IsReversed()

Check whether playback is reversed.

Protected function Const

bool

 

NeedsQueueLatentAction()

Protected function Virtual

void

 

OnLooped()

Protected function Virtual

void

 

OnPaused()

Public function Const

FOnMovieScen ...

 

OnSequenceUpdated()

Protected function Virtual

void

 

OnStartedPlaying()

Protected function Virtual

void

 

OnStopped()

Public function

void

 

Pause()

Pause playback.

Public function

void

 

Play()

Start playback forwards from the current time cursor position, using the current play rate.

Protected function

void

 

PlayInternal()

Public function

void

 

PlayLooping

(
    int32 NumLoops
)

Start playback from the current time cursor position, looping the specified number of times.

Public function

void

 

PlayReverse()

Reverse playback.

Public function

void

 

PlayTo

Play from the current position to the requested position and pause.

Protected function Const

void

 

QueueLatentAction

Protected function

void

 

RunLatentActions()

Public function

void

 

Scrub()

Scrub playback.

Public function

void

 

SetDisableCameraCuts

(
    bool bInDisableCameraCuts
)

Set whether to disable camera cuts

Public function

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

Public function

void

 

SetFrameRate

(
    FFrameRate FrameRate
)

Set the frame-rate that this player should play with, making all frame numbers in the specified time-space

Public function

void

 

SetPlaybackClient

Assign a playback client interface for this sequence player, defining instance data and binding overrides

Public function

void

 

SetPlaybackPosition

Set the current time of the player by evaluating from the current time to the specified time, as if the sequence is playing.

Public function

void

 

SetPlayRate

(
    float PlayRate
)

Set the playback rate of this player. Negative values will play the animation in reverse.

Public function

void

 

SetTimeController

Assign a time controller for this sequence player allowing custom time management implementations.

Public function

void

 

SetTimeRange

(
    float StartTime,
    float Duration
)

Set the valid play range for this sequence, determined by a starting time and a duration (in seconds)

Protected function Const

bool

 

ShouldPause

(
    FFrameTime NewPosition
)

Protected function Const

bool

 

ShouldStopOrLoop

(
    FFrameTime NewPosition
)

Public function

void

 

Stop()

Stop playback and move the cursor to the end (or start, for reversed playback) of the sequence.

Public function

void

 

StopAtCurrentTime()

Stop playback without moving the cursor.

Protected function

void

 

StopInternal

(
    FFrameTime TimeToResetTo
)

Public function

void

 

Update

(
    const float DeltaSeconds
)

Update the sequence for the current time, if playing

Protected function

void

 

UpdateMovieSceneInstance

(
    FMovieSceneEvaluationRange InRange,
    EMovieScenePlayerStatus::Type Playe...,
    bool bHasJumped
)

Protected function Virtual

void

 

UpdateMovieSceneInstance

(
    FMovieSceneEvaluationRange InRange,
    EMovieScenePlayerStatus::Type Playe...,
    const FMovieSceneUpdateArgs & Args
)

Protected function

void

 

UpdateTimeCursorPosition

(
    FFrameTime NewPosition,
    EUpdatePositionMethod Method
)

Overridden from UObject

Name Description

Protected function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Protected function Virtual

bool

 

CallRemoteFunction

(
    UFunction * Function,
    void * Parms,
    FOutParmRec * OutParms,
    FFrame * Stack
)

Call the actor's function remotely

Protected function Virtual

int32

 

GetFunctionCallspace

(
    UFunction * Function,
    FFrame * Stack
)

Return the space this function should be called.

Protected function Virtual Const

bool

 

IsSupportedForNetworking()

IsSupportedForNetworking means an object can be referenced over the network

Protected function Virtual

void

 

PostNetReceive()

Called right after receiving a bunch

Overridden from IMovieScenePlayer

Name Description

Protected function Virtual

UObject *...

 

AsUObject()

Cast this player instance as a UObject if possible

Protected function Virtual Const

bool

 

CanUpdateCameraCut()

Whether this player can update the camera cut

Protected function Virtual

UMovieSceneE ...

 

ConstructEntitySystemLinker()

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

Protected function Virtual

FMovieSceneR ...

 

GetEvaluationTemplate()

Access the evaluation template that we are playing back

Protected function Virtual

IMovieSceneP ...

 

GetPlaybackClient()

Access the client in charge of playback

Protected function Virtual Const

EMovieSceneP ...

 

GetPlaybackStatus()

Protected function Virtual

FMovieSceneS ...

 

GetSpawnRegister()

Obtain an object responsible for managing movie scene spawnables

Protected function Virtual Const

void

 

GetViewportSettings

(
    TMap < FViewportClient *, EMovie ...
)

Get the current perspective viewport settings

Protected function Virtual

void

 

PostEvaluation

(
    const FMovieSceneContext & Context
)

Called by the evaluation system after evaluation has occured

Protected function Virtual

void

 

PreEvaluation

(
    const FMovieSceneContext & Context
)

Called by the evaluation system when evaluation has just started.

Protected function Virtual Const

void

 

ResolveBoundObjects

(
    const FGuid & InBindingId,
    FMovieSceneSequenceID SequenceID,
    UMovieSceneSequence & Sequence,
    UObject * ResolutionContext,
    TArray < UObject *, TInlineAlloc ...
)

Resolve objects bound to the specified binding ID

Protected function Virtual

void

 

SetPlaybackStatus

(
    EMovieScenePlayerStatus::Type InPla...
)

Protected function Virtual

void

 

SetViewportSettings

(
    const TMap < FViewportClient *, ...
)

Set the perspective viewport settings

Protected function Virtual

void

 

UpdateCameraCut

(
    UObject * CameraObject,
    const EMovieSceneCameraCutParams & ...
)

Updates the perspective viewports with the actor to view through

Classes

Name

Description

Protected struct

FMovieSceneUpdateArgs

Public class

FOnMovieSceneSequencePlayerUpdated

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

Typedefs

Name

Description

FOnEvaluationCallback

Pre and post evaluation callbacks, for async evaluations

Deprecated Functions

Name Description

Public function

void

 

JumpToFrame

(
    FFrameTime NewPosition
)

JumpToFrame is deprecated, use SetPlaybackPosition.

Public function

bool

 

JumpToMarkedFrame

(
    const FString & InLabel
)

JumpToMarkedFrame is deprecated, use SetPlaybackPosition.

Public function

void

 

JumpToSeconds

(
    float TimeInSeconds
)

JumpToSeconds is deprecated, use SetPlaybackPosition.

Public function

void

 

PlayToFrame

(
    FFrameTime NewPosition
)

PlayToFrame is deprecated, use SetPlaybackPosition.

Public function

bool

 

PlayToMarkedFrame

(
    const FString & InLabel
)

PlayToMarkedFrame is deprecated, use SetPlaybackPosition.

Public function

void

 

PlayToSeconds

(
    float TimeInSeconds
)

PlayToSeconds is deprecated, use SetPlaybackPosition.

Public function

void

 

ScrubToFrame

(
    FFrameTime NewPosition
)

ScrubToFrame is deprecated, use SetPlaybackPosition.

Public function

bool

 

ScrubToMarkedFrame

(
    const FString & InLabel
)

ScrubToMarkedFrame is deprecated, use SetPlaybackPosition.

Public function

void

 

ScrubToSeconds

(
    float TimeInSeconds
)

ScrubToSeconds is deprecated, use SetPlaybackPosition.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback