unreal.MediaStreamLocalPlayer

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

Bases: Object

Media Stream Local Player. Plays a media source using a UMediaPlayer.

C++ Source:

• Plugin: MediaStream

• Module: MediaStream

• File: MediaStreamLocalPlayer.h

Editor Properties: (see get_editor_property/set_editor_property)

• media_texture (MediaTexture): [Read-Only]

• playback_state (MediaStreamPlaybackState): [Read-Write]

• player (MediaPlayer): [Read-Write]

• player_config (MediaStreamPlayerConfig): [Read-Write]

• playlist_index (int32): [Read-Write] The index playing in the playlist. -1 to ignore.

• requested_seek_frame (int32): [Read-Write] Attempts to seek to this frame. Any value below 0 is ignored.

• texture_config (MediaStreamTextureConfig): [Read-Write]

apply_player_config() → None

Applies the current player config to the current media player. This is generally automatic.

apply_texture_config() → None

Applies the current texture config to the current media texture. This is generally automatic.

bp_set_playback_state(state) → None

BP Set Playback State

Parameters:

state (MediaStreamPlaybackState)

bp_set_playlist_index(index) → None

BP Set Playlist Index

Parameters:

index (int32)

bp_set_requested_seek_frame(seek_frame) → None

BP Set Requested Seek Frame

Parameters:

seek_frame (int32)

bp_set_requested_seek_time(seek_time) → None

BP Set Requested Seek Time

Parameters:

seek_time (float)

close() → bool

Closes the current media player.

Returns:

True if successful.

Return type:

bool

fast_forward() → bool

Seeks to the end of the current media.

Returns:

True if successful.

Return type:

bool

get_media_stream() → MediaStream

Get Media Stream

Return type:

MediaStream

get_media_texture() → MediaTexture

Returns:

Gets the media texture subobject.

Return type:

MediaTexture

get_playback_state() → MediaStreamPlaybackState

Returns:

Gets the media player playback state.

Return type:

MediaStreamPlaybackState

get_player() → MediaPlayer

Returns:

The active player, if there is one and it is valid.

Return type:

MediaPlayer

get_player_config() → MediaStreamPlayerConfig

Returns:

The current player config.

Return type:

MediaStreamPlayerConfig

get_playlist_index() → int32

Returns:

Gets the active playlist index. May not match the actual player. -1 on error.

Return type:

int32

get_playlist_num() → int32

Returns:

The size of the current playlist. -1 on error.

Return type:

int32

get_requested_seek_frame() → int32

Returns:

The frame offset in the media that has been requested.

Return type:

int32

get_requested_seek_time() → float

Returns:

The time offset in the media that has been requested.

Return type:

float

get_source_stream() → MediaStream

Returns:

For proxy streams, returns the stream this is getting data from.

Return type:

MediaStream

get_texture_config() → MediaStreamTextureConfig

Returns:

The current texture config.

Return type:

MediaStreamTextureConfig

has_valid_player() → bool

Returns:

True if there is an active and valid player.

Return type:

bool

is_read_only() → bool

Returns whether this player’s controls can do anything.

Return type:

bool

property media_texture: MediaTexture

[Read-Only]

Type:

(MediaTexture)

next() → bool

Goes to the next item in the playlist. Only possible with playlist sources.

Returns:

True if successful.

Return type:

bool

on_created() → None

On Created

open_source() → bool

Opens the source if it is not already opened.

Returns:

True if successful.

Return type:

bool

pause() → bool

Pauses playback of the current media.

Returns:

True if successful.

Return type:

bool

play() → bool

Continues play of the current media.

Returns:

True if successful.

Return type:

bool

property playback_state: MediaStreamPlaybackState

[Read-Write]

Type:

(MediaStreamPlaybackState)

property player: MediaPlayer

[Read-Only]

Type:

(MediaPlayer)

property player_config: MediaStreamPlayerConfig

[Read-Write]

Type:

(MediaStreamPlayerConfig)

property playlist_index: int

[Read-Write] The index playing in the playlist. -1 to ignore.

Type:

(int32)

previous() → bool

Goes to the previous item in the playlist. Only possible with playlist sources.

Returns:

True if successful.

Return type:

bool

property requested_seek_frame: int

[Read-Write] Attempts to seek to this frame. Any value below 0 is ignored.

Type:

(int32)

rewind() → bool

Seeks to the start of the current media.

Returns:

True if successful.

Return type:

bool

set_playback_state(state) → bool

Sets the media player playback state.

Parameters:

state (MediaStreamPlaybackState) – The state to change to.

Returns:

True on success. False on failure or invalid player.

Return type:

bool

set_player_config(player_config) → None

Update the current player’s (and any newly set player’s) config.

Parameters:

player_config (MediaStreamPlayerConfig) – The new config.

set_playlist_index(index) → bool

Setter for events.

Parameters:

index (int32) – The index to start playing.

Returns:

True on success. False on failure or invalid player.

Return type:

bool

set_requested_seek_frame(frame) → bool

Sets the frame in the currently playing player, if possible.

Parameters:

frame (int32) – The frame offset in the media to request.

Returns:

True on success. False on failure or invalid player.

Return type:

bool

set_requested_seek_time(time) → bool

Sets the time in the currently playing player, if possible.

Parameters:

time (float) – The time offset in the media to request.

Returns:

True on success. False on failure or invalid player.

Return type:

bool

set_texture_config(texture_config) → None

Update the current texture’s (and any newly set texture’s) config.

Parameters:

texture_config (MediaStreamTextureConfig) – The new config.

property texture_config: MediaStreamTextureConfig

[Read-Write]

Type:

(MediaStreamTextureConfig)