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)

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_object_bindings(object)

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

Jump to Frame deprecated: JumpToFrame is deprecated, use SetPlaybackPosition.

Parameters

new_position (FrameTime) –

jump_to_marked_frame(label) → bool

Jump to Marked Frame deprecated: JumpToMarkedFrame is deprecated, use SetPlaybackPosition.

Parameters

label (str) –

Returns

Return type

bool

jump_to_seconds(time_in_seconds) → None

Jump to Seconds deprecated: JumpToSeconds is deprecated, use SetPlaybackPosition.

Parameters

time_in_seconds (float) –

property on_finished

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

Type

(OnMovieSceneSequencePlayerEvent)

property on_pause

[Read-Write] Event triggered when the level sequence player is paused

Type

(OnMovieSceneSequencePlayerEvent)

property on_play

[Read-Write] Event triggered when the level sequence player is played

Type

(OnMovieSceneSequencePlayerEvent)

property on_play_reverse

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

Type

(OnMovieSceneSequencePlayerEvent)

property on_stop

[Read-Write] Event triggered when the level sequence player is stopped

Type

(OnMovieSceneSequencePlayerEvent)

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(playback_params) → None

Play from the current position to the requested position and pause. If requested position is before the current position, playback will be reversed. Playback to the requested position will be cancelled if Stop() or Pause() is invoked during this playback.

Parameters

playback_params (MovieSceneSequencePlaybackParams) – The position settings (ie. the position to play to)

play_to_frame(new_position) → None

Play to Frame deprecated: PlayToFrame is deprecated, use SetPlaybackPosition.

Parameters

new_position (FrameTime) –

play_to_marked_frame(label) → bool

Play to Marked Frame deprecated: PlayToMarkedFrame is deprecated, use SetPlaybackPosition.

Parameters

label (str) –

Returns

Return type

bool

play_to_seconds(time_in_seconds) → None

Play to Seconds deprecated: PlayToSeconds is deprecated, use SetPlaybackPosition.

Parameters

time_in_seconds (float) –

restore_state() → None

Restore any changes made by this player to their original state

scrub() → None

Scrub playback.

scrub_to_frame(new_position) → None

Scrub to Frame deprecated: ScrubToFrame is deprecated, use SetPlaybackPosition.

Parameters

new_position (FrameTime) –

scrub_to_marked_frame(label) → bool

Scrub to Marked Frame deprecated: ScrubToMarkedFrame is deprecated, use SetPlaybackPosition.

Parameters

label (str) –

Returns

Return type

bool

scrub_to_seconds(time_in_seconds) → None

Scrub to Seconds deprecated: ScrubToSeconds is deprecated, use SetPlaybackPosition.

Parameters

time_in_seconds (float) –

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, sub_frames=0.0) → 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

• sub_frames (float) –

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(playback_params) → None

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

playback_params (MovieSceneSequencePlaybackParams) – The position settings (ie. the position to set playback to)

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.