Class MovieSceneSequencePlayer

Abstract class that provides consistent player behaviour for various animation players

Inheritance

System.Object

UObject

MovieSceneSequencePlayer

ActorSequencePlayer

LevelSequencePlayer

Inherited Members

UObject.TransientPackage

UObject.CastTo<T>(UObject)

UObject.CastTo(UObject, Type)

UObject.RemoveObject(UObject)

UObject.MakeObjectArrayField<T>(NativeArray*)

UObject.NotImplemented<T>()

UObject.Construct()

UObject.GetHashCode()

UObject.GetName()

UObject.ToString()

UObject.Name

UObject._None

UObject.None

UObject.ObjPointer

UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)

UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)

UObject.GetPropertyFor<T>(Name)

UObject.ExecuteUbergraph

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: UE4.MovieScene

Assembly: UE4DotNet.dll

Syntax

public class MovieSceneSequencePlayer : UObject

Properties

bReversePlayback

Declaration

public bool bReversePlayback { get; set; }

Property Value

Type	Description
System.Boolean

CurrentNumLoops

The number of times we have looped in the current playback

Declaration

public int CurrentNumLoops { get; set; }

Property Value

Type	Description
System.Int32

DefaultObject

Get UE4 Default Object for this Class

Declaration

public static MovieSceneSequencePlayer DefaultObject { get; }

Property Value

Type	Description
MovieSceneSequencePlayer

DurationFrames

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

Declaration

public int DurationFrames { get; set; }

Property Value

Type	Description
System.Int32

PlaybackSettings

Specific playback settings for the animation.

Declaration

public MovieSceneSequencePlaybackSettings PlaybackSettings { get; set; }

Property Value

Type	Description
MovieSceneSequencePlaybackSettings

RootTemplateInstance

The root template instance we're evaluating

Declaration

public MovieSceneRootEvaluationTemplateInstance RootTemplateInstance { get; set; }

Property Value

Type	Description
MovieSceneRootEvaluationTemplateInstance

Sequence

The sequence to play back

Declaration

public MovieSceneSequence Sequence { get; set; }

Property Value

Type	Description
MovieSceneSequence

StartTime

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

Declaration

public FrameNumber StartTime { get; set; }

Property Value

Type	Description
FrameNumber

StaticClass

Get UE4 Class

Declaration

public static Class StaticClass { get; }

Property Value

Type	Description
Class

Status

Movie player status.

Declaration

public byte Status { get; set; }

Property Value

Type	Description
System.Byte

Methods

ChangePlaybackDirection()

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

Declaration

public void ChangePlaybackDirection()

GetBoundObjects(MovieSceneObjectBindingID)

Retrieve all objects currently bound to the specified binding identifier

Declaration

public IReadOnlyCollection<UObject> GetBoundObjects(MovieSceneObjectBindingID ObjectBinding)

Parameters

Type	Name	Description
MovieSceneObjectBindingID	ObjectBinding

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<UObject>

GetCurrentTime()

Get the current playback position @

Declaration

public QualifiedFrameTime GetCurrentTime()

Returns

Type	Description
QualifiedFrameTime

Remarks

return The current playback position

GetDisableCameraCuts()

Set whether to disable camera cuts

Declaration

public bool GetDisableCameraCuts()

Returns

Type	Description
System.Boolean

GetDuration()

Get the total duration of the sequence

Declaration

public QualifiedFrameTime GetDuration()

Returns

Type	Description
QualifiedFrameTime

GetEndTime()

Get the offset within the level sequence to finish playing

Declaration

public QualifiedFrameTime GetEndTime()

Returns

Type	Description
QualifiedFrameTime

GetFrameDuration()

Get this sequence's duration in frames

Declaration

public int GetFrameDuration()

Returns

Type	Description
System.Int32

GetFrameRate()

Get this sequence's display rate.

Declaration

public FrameRate GetFrameRate()

Returns

Type	Description
FrameRate

GetLength()

Get Length

Declaration

public float GetLength()

Returns

Type	Description
System.Single

GetObjectBindings(UObject)

Get the object bindings for the requested object

Declaration

public IReadOnlyCollection<MovieSceneObjectBindingID> GetObjectBindings(UObject InObject)

Parameters

Type	Name	Description
UObject	InObject

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<MovieSceneObjectBindingID>

GetPlaybackEnd()

Get Playback End

Declaration

public float GetPlaybackEnd()

Returns

Type	Description
System.Single

GetPlaybackPosition()

Get Playback Position

Declaration

public float GetPlaybackPosition()

Returns

Type	Description
System.Single

GetPlaybackStart()

Get Playback Start

Declaration

public float GetPlaybackStart()

Returns

Type	Description
System.Single

GetPlayRate()

Get the playback rate of this player.

Declaration

public float GetPlayRate()

Returns

Type	Description
System.Single

GetStartTime()

Get the offset within the level sequence to start playing

Declaration

public QualifiedFrameTime GetStartTime()

Returns

Type	Description
QualifiedFrameTime

GoToEndAndStop()

Go to end of the sequence and stop. Adheres to 'When Finished' section rules.

Declaration

public void GoToEndAndStop()

IsPaused()

Check whether the sequence is paused.

Declaration

public bool IsPaused()

Returns

Type	Description
System.Boolean

IsPlaying()

Check whether the sequence is actively playing.

Declaration

public bool IsPlaying()

Returns

Type	Description
System.Boolean

IsReversed()

Check whether playback is reversed.

Declaration

public bool IsReversed()

Returns

Type	Description
System.Boolean

JumpToFrame(FrameTime)

Jump to the specified frame position, without evaluating the sequence in between the current and desired time (as if in a paused state) @

Declaration

public void JumpToFrame(FrameTime NewPosition)

Parameters

Type	Name	Description
FrameTime	NewPosition

Remarks

param NewPosition The new frame time to jump to

JumpToPosition(Single)

Jump to Position

Declaration

public void JumpToPosition(float NewPlaybackPosition)

Parameters

Type	Name	Description
System.Single	NewPlaybackPosition

JumpToSeconds(Single)

Jump to the specified time in seconds, without evaluating the sequence in between the current and desired time (as if in a paused state) @

Declaration

public void JumpToSeconds(float TimeInSeconds)

Parameters

Type	Name	Description
System.Single	TimeInSeconds

Remarks

param TimeInSeconds The desired time in seconds

New(UObject, Name)

Spawn an object of this class

Declaration

public static MovieSceneSequencePlayer New(UObject obj = null, Name name = default(Name))

Parameters

Type	Name	Description
UObject	obj
Name	name

Returns

Type	Description
MovieSceneSequencePlayer

Pause()

Pause playback.

Declaration

public void Pause()

Play()

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

Declaration

public void Play()

PlayLooping(Int32)

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

Declaration

public void PlayLooping(int NumLoops)

Parameters

Type	Name	Description
System.Int32	NumLoops

Remarks

@param NumLoops - The number of loops to play. -1 indicates infinite looping.

PlayReverse()

Reverse playback.

Declaration

public void PlayReverse()

PlayToFrame(FrameTime)

Play the sequence from the current time, to the specified frame position @

Declaration

public void PlayToFrame(FrameTime NewPosition)

Parameters

Type	Name	Description
FrameTime	NewPosition

Remarks

param NewPosition The new frame time to play to

PlayToSeconds(Single)

Play the sequence from the current time, to the specified time in seconds @

Declaration

public void PlayToSeconds(float TimeInSeconds)

Parameters

Type	Name	Description
System.Single	TimeInSeconds

Remarks

param TimeInSeconds The desired time in seconds

Scrub()

Scrub playback.

Declaration

public void Scrub()

ScrubToFrame(FrameTime)

Scrub the sequence from the current time, to the specified frame position @

Declaration

public void ScrubToFrame(FrameTime NewPosition)

Parameters

Type	Name	Description
FrameTime	NewPosition

Remarks

param NewPosition The new frame time to scrub to

ScrubToSeconds(Single)

Scrub the sequence from the current time, to the specified time in seconds @

Declaration

public void ScrubToSeconds(float TimeInSeconds)

Parameters

Type	Name	Description
System.Single	TimeInSeconds

Remarks

param TimeInSeconds The desired time in seconds

SetDisableCameraCuts(Boolean)

Set whether to disable camera cuts

Declaration

public void SetDisableCameraCuts(bool bInDisableCameraCuts)

Parameters

Type	Name	Description
System.Boolean	bInDisableCameraCuts

SetFrameRange(Int32, Int32)

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 @

Declaration

public void SetFrameRange(int StartFrame, int Duration)

Parameters

Type	Name	Description
System.Int32	StartFrame
System.Int32	Duration

Remarks

param StartFrame The frame number to start playing back the sequence @param Duration The number of frames to play

SetFrameRate(FrameRate)

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

Declaration

public void SetFrameRate(FrameRate FrameRate)

Parameters

Type	Name	Description
FrameRate	FrameRate

SetPlaybackPosition(Single)

Set Playback Position

Declaration

public void SetPlaybackPosition(float NewPlaybackPosition)

Parameters

Type	Name	Description
System.Single	NewPlaybackPosition

SetPlaybackRange(Single, Single)

Set Playback Range

Declaration

public void SetPlaybackRange(float NewStartTime, float NewEndTime)

Parameters

Type	Name	Description
System.Single	NewStartTime
System.Single	NewEndTime

SetPlayRate(Single)

Set the playback rate of this player.

Declaration

public void SetPlayRate(float PlayRate)

Parameters

Type	Name	Description
System.Single	PlayRate

Remarks

Negative values will play the animation in reverse. @param PlayRate - The new rate of playback for the animation.

SetTimeRange(Single, Single)

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

Declaration

public void SetTimeRange(float StartTime, float Duration)

Parameters

Type	Name	Description
System.Single	StartTime
System.Single	Duration

Remarks

param StartTime The time to start playing back the sequence in seconds @param Duration The length to play for

Stop()

Stop playback.

Declaration

public void Stop()

Operators

Implicit(IntPtr to MovieSceneSequencePlayer)

Convert from IntPtr to UObject

Declaration

public static implicit operator MovieSceneSequencePlayer(IntPtr p)

Parameters

Type	Name	Description
System.IntPtr	p

Returns

Type	Description
MovieSceneSequencePlayer