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]

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)

property media_texture: MediaTexture

[Read-Only]

Type:

(MediaTexture)

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)

property requested_seek_frame: int

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

Type:

(int32)

property texture_config: MediaStreamTextureConfig

[Read-Write]

Type:

(MediaStreamTextureConfig)