unreal.MovieSceneSequencePlayer

class unreal.MovieSceneSequencePlayer(outer=None, name='None')

Bases: unreal.Object

Abstract class that provides consistent player behaviour for various animation players

C++ Source:

  • Module: MovieScene
  • File: MovieSceneSequencePlayer.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_finished (OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player finishes naturally (without explicitly calling stop)
  • on_pause (OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player is paused
  • on_play (OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player is played
  • on_play_reverse (OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player is played in reverse
  • on_stop (OnMovieSceneSequencePlayerEvent): [Read-Write] Event triggered when the level sequence player is stopped
change_playback_direction() → None

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

get_bound_objects(object_binding) -> Array(Object)

Retrieve all objects currently bound to the specified binding identifier

Parameters:object_binding (MovieSceneObjectBindingID) –
Returns:
Return type:Array(Object)
get_current_time() → QualifiedTime

Get the current playback position

Returns:The current playback position
Return type:QualifiedTime
get_disable_camera_cuts() → bool

Set whether to disable camera cuts

Returns:
Return type:bool
get_duration() → QualifiedTime

Get the total duration of the sequence

Returns:
Return type:QualifiedTime
get_end_time() → QualifiedTime

Get the offset within the level sequence to finish playing

Returns:
Return type:QualifiedTime
get_frame_duration() → int32

Get this sequence’s duration in frames

Returns:
Return type:int32
get_frame_rate() → FrameRate

Get this sequence’s display rate.

Returns:
Return type:FrameRate
get_length() → float

Get Length deprecated: Please use GetDuration instead

Returns:
Return type:float
get_object_bindings(object) -> Array(MovieSceneObjectBindingID)

Get the object bindings for the requested object

Parameters:object (Object) –
Returns:
Return type:Array(MovieSceneObjectBindingID)
get_play_rate() → float

Get the playback rate of this player.

Returns:
Return type:float
get_playback_end() → float

Get Playback End deprecated: Please use GetEndTime instead

Returns:
Return type:float
get_playback_position() → float

Get Playback Position deprecated: Please use GetCurrentTime instead

Returns:
Return type:float
get_playback_start() → float

Get Playback Start deprecated: Please use GetStartTime instead

Returns:
Return type:float
get_start_time() → QualifiedTime

Get the offset within the level sequence to start playing

Returns:
Return type:QualifiedTime
go_to_end_and_stop() → None

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

is_paused() → bool

Check whether the sequence is paused.

Returns:
Return type:bool
is_playing() → bool

Check whether the sequence is actively playing.

Returns:
Return type:bool
is_reversed() → bool

Check whether playback is reversed.

Returns:
Return type:bool
jump_to_frame(new_position) → None

Low-level call to set the current time of the player by evaluating only the specified time, as if scrubbing the timeline. Will trigger only events that exist at the specified time. Does not alter the persistent playback status of the player (IsPlaying).

Parameters:new_position (FrameTime) – The new frame time to jump to
jump_to_marked_frame(label) → bool

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

Parameters:label (str) – The desired marked frame label to jump to
Returns:Whether the marked frame was found
Return type:bool
jump_to_position(new_playback_position) → None

Jump to Position deprecated: Please use ScrubToTime instead

Parameters:new_playback_position (float) –
jump_to_seconds(time_in_seconds) → None

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

Parameters:time_in_seconds (float) – The desired time in seconds
on_finished

(OnMovieSceneSequencePlayerEvent) – [Read-Write] Event triggered when the level sequence player finishes naturally (without explicitly calling stop)

on_pause

(OnMovieSceneSequencePlayerEvent) – [Read-Write] Event triggered when the level sequence player is paused

on_play

(OnMovieSceneSequencePlayerEvent) – [Read-Write] Event triggered when the level sequence player is played

on_play_reverse

(OnMovieSceneSequencePlayerEvent) – [Read-Write] Event triggered when the level sequence player is played in reverse

on_stop

(OnMovieSceneSequencePlayerEvent) – [Read-Write] Event triggered when the level sequence player is stopped

pause() → None

Pause playback.

play() → None

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

play_looping(num_loops=-1) → None

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

Parameters:num_loops (int32) – The number of loops to play. -1 indicates infinite looping.
play_reverse() → None

Reverse playback.

play_to_frame(new_position) → None

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. Triggers events that lie within the evaluated range. Does not alter the persistent playback status of the player (IsPlaying).

Parameters:new_position (FrameTime) – The new frame time to play to
play_to_marked_frame(label) → bool

Play the sequence from the current time, to the specified marked frame by label

Parameters:label (str) – The desired marked frame label to play to
Returns:Whether the marked frame was found
Return type:bool
play_to_seconds(time_in_seconds) → None

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

Parameters:time_in_seconds (float) – The desired time in seconds
scrub() → None

Scrub playback.

scrub_to_frame(new_position) → None

Low-level call to set the current time of the player by evaluating only the specified time. Will not trigger any events. Does not alter the persistent playback status of the player (IsPlaying).

Parameters:new_position (FrameTime) – The new frame time to scrub to
scrub_to_marked_frame(label) → bool

Scrub the sequence from the current time, to the specified marked frame by label

Parameters:label (str) – The desired marked frame label to scrub to
Returns:Whether the marked frame was found
Return type:bool
scrub_to_seconds(time_in_seconds) → None

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

Parameters:time_in_seconds (float) – The desired time in seconds
set_disable_camera_cuts(disable_camera_cuts) → None

Set whether to disable camera cuts

Parameters:disable_camera_cuts (bool) –
set_frame_range(start_frame, duration) → None

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

Parameters:
  • start_frame (int32) – The frame number to start playing back the sequence
  • duration (int32) – The number of frames to play
set_frame_rate(frame_rate) → None

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

Parameters:frame_rate (FrameRate) –
set_play_rate(play_rate) → None

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

Parameters:play_rate (float) – The new rate of playback for the animation.
set_playback_position(new_playback_position) → None

Set Playback Position deprecated: Please use PlayToFrame instead

Parameters:new_playback_position (float) –
set_playback_range(new_start_time, new_end_time) → None

Set Playback Range deprecated: Please use SetFrameRange or SetTimeRange instead

Parameters:
  • new_start_time (float) –
  • new_end_time (float) –
set_time_range(start_time, duration) → None

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

Parameters:
  • start_time (float) – The time to start playing back the sequence in seconds
  • duration (float) – The length to play for
stop() → None

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

stop_at_current_time() → None

Stop playback without moving the cursor.