unreal.LevelSequencePlaybackController

class unreal.LevelSequencePlaybackController(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Level Sequence Playback Controller

C++ Source:

• Plugin: VirtualCamera

• Module: VirtualCamera

• File: LevelSequencePlaybackController.h

clear_active_level_sequence() → None

Clears the current level sequence player, needed when recording clean takes of something.

get_active_level_sequence() → LevelSequence

Returns:

the currently selected LevelSequence

Return type:

LevelSequence

get_active_level_sequence_name() → str

Returns:

the name of the currently selected sequence; returns empty string if no selected sequence

Return type:

str

get_current_sequence_duration() → FrameNumber

Returns:

the duration of the sequence in FrameNumber

Return type:

FrameNumber

get_current_sequence_frame_rate() → FrameRate

Returns:

the FrameRate of the currently loaded sequence FrameRate

Return type:

FrameRate

get_current_sequence_playback_end() → FrameNumber

Returns:

The FrameNumber of the sequence’s end.

Return type:

FrameNumber

get_current_sequence_playback_position() → FrameTime

Returns:

the current FrameTime of the sequence playback.

Return type:

FrameTime

get_current_sequence_playback_start() → FrameNumber

Returns:

The FrameNumber of the sequence’s start.

Return type:

FrameNumber

get_current_sequence_playback_timecode() → Timecode

Returns:

The current Timecode of the sequence playback.

Return type:

Timecode

get_level_sequences() → Array[LevelSequenceData]

Returns the names of each level sequence actor that is present in the level.

Returns:

out_level_sequence_names (Array[LevelSequenceData]):

Return type:

Array[LevelSequenceData]

is_sequence_playback_active() → bool

Returns:

true if a valid LevelSequence is being played.

Return type:

bool

is_sequencer_locked_to_camera_cut() → bool

Returns:

true if the active Sequencer is locked to camera cut

Return type:

bool

jump_to_playback_position(frame_number) → None

Moves the current sequence to a desired playback position

Parameters:

frame_number (FrameNumber) –

pause_level_sequence() → None

Pause the currently active sequence

play_level_sequence() → None

Starts playing the currently active sequence

play_level_sequence_reverse() → None

Starts playing the currently active sequence in reverse

set_active_level_sequence(new_level_sequence) → bool

Changes the active level sequence to a new level sequence.

Parameters:

new_level_sequence (LevelSequence) – The LevelSequence to select

Returns:

true if a valid LevelSequence was passed and sequencer was successfully found.

Return type:

bool

set_sequencer_locked_to_camera_cut(lock_view) → None

Sets the current Sequencer perspective to be locked to camera cut

Parameters:

lock_view (bool) –

stop_level_sequence_play() → None

Stops playing the currently active sequence