unreal.SequencerPlaylistPlayer

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

Bases: Object

Controls playback of playlist items

C++ Source:

  • Plugin: SequencerPlaylists

  • Module: SequencerPlaylists

  • File: SequencerPlaylistPlayer.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_playlist_set (OnPlayerSequencerPlaylistSet): [Read-Write]

classmethod get_default_player() SequencerPlaylistPlayer

Get Default Player deprecated: There is no longer a “default” player. Open a specific Playlist asset to create a player associated with it.

Return type:

SequencerPlaylistPlayer

get_playback_state(item) SequencerPlaylistPlaybackState

Get Playback State

Parameters:

item (SequencerPlaylistItem) –

Return type:

SequencerPlaylistPlaybackState

get_playlist() SequencerPlaylist

Get Playlist

Return type:

SequencerPlaylist

is_playing(item) bool

Is Playing

Parameters:

item (SequencerPlaylistItem) –

Return type:

bool

property on_playlist_set: OnPlayerSequencerPlaylistSet

[Read-Write]

Type:

(OnPlayerSequencerPlaylistSet)

pause_all() bool

Pause All

Return type:

bool

pause_item(item) bool

Pause Item

Parameters:

item (SequencerPlaylistItem) –

Return type:

bool

play_all(direction=SequencerPlaylistPlaybackDirection.FORWARD) bool

Play All

Parameters:

direction (SequencerPlaylistPlaybackDirection) –

Return type:

bool

play_item(item, direction=SequencerPlaylistPlaybackDirection.FORWARD) bool

Play Item

Parameters:
Return type:

bool

reset_all() bool

Reset All

Return type:

bool

reset_item(item) bool

Reset Item

Parameters:

item (SequencerPlaylistItem) –

Return type:

bool

set_playlist(playlist) None

Set Playlist

Parameters:

playlist (SequencerPlaylist) –

stop_all() bool

Stop All

Return type:

bool

stop_item(item) bool

Stop Item

Parameters:

item (SequencerPlaylistItem) –

Return type:

bool