unreal.PixelStreamingBlueprints

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

Bases: BlueprintFunctionLibrary

Pixel Streaming Blueprints

C++ Source:

  • Plugin: PixelStreaming

  • Module: PixelStreaming

  • File: PixelStreamingBlueprints.h

classmethod force_key_frame() → None

Force a key frame to be sent.

classmethod freeze_frame(texture) → None

Freeze Pixel Streaming.

Parameters:

texture (Texture2D) – The freeze frame to display. If null then the back buffer is captured.

classmethod get_connected_players() → Array[str]

brief: Get the connected players

Returns:

TArray<FString> The connected players

Return type:

Array[str]

classmethod get_default_streamer_id() → str

Get the default Streamer ID

Return type:

str

classmethod get_pixel_streaming_delegates() → PixelStreamingDelegates

Get the singleton. This allows application-specific blueprints to bind to delegates of interest.

Return type:

PixelStreamingDelegates

classmethod kick_player(player_id) → None

Kick a player. DEPRECATED deprecated: Kick player has been deprecated, will no longer function and will be removed in future versions.

Parameters:

player_id (str) – The ID of the player to kick.

classmethod send_file(filepath, mime_type, file_extension) → None

Send a specified file over the WebRTC peer connection data channel. The extension and mime type are used for file reconstruction on the front end

Parameters:

  • filepath (str) – The path to the file that will be sent

  • mime_type (str) – The mime type of the file. Used for file reconstruction on the front end

  • file_extension (str) – The file extension. Used for file reconstruction on the front end

classmethod send_file_as_byte_array(byte_array, mime_type, file_extension) → None

Send a specified byte array over the WebRTC peer connection data channel. The extension and mime type are used for file reconstruction on the front end

Parameters:

  • byte_array (Array[uint8]) – The raw data that will be sent over the data channel

  • mime_type (str) – The mime type of the file. Used for reconstruction on the front end

  • file_extension (str) – The file extension. Used for file reconstruction on the front end

classmethod set_player_layer_preference(player_id, spatial_layer_id, temporal_layer_id) → None

Set the layer preference for a specific player

Parameters:

  • player_id (str) – The ID of the player to set the layer preference for.

  • spatial_layer_id (int32) – The spatial layer ID

  • temporal_layer_id (int32) – The temporal layer ID

classmethod streamer_freeze_stream(streamer_id, texture) → None

Freeze Pixel Streaming.

Parameters:

  • streamer_id (str) – The id of the streamer to freeze.

  • texture (Texture2D) – The freeze frame to display. If null then the back buffer is captured.

classmethod streamer_get_connected_players(streamer_id) → Array[str]

brief: Get the connected players

Parameters:

streamer_id (str) – The streamer whose list of players you wish to get

Returns:

TArray<FString> The connected players

Return type:

Array[str]

classmethod streamer_kick_player(streamer_id, player_id) → None

Kick a player. DEPRECATED deprecated: Kick player has been deprecated, will no longer function and will be removed in future versions.

Parameters:

  • streamer_id (str) – The streamer which the player belongs

  • player_id (str) – The ID of the player to kick.

classmethod streamer_send_file(streamer_id, filepath, mime_type, file_extension) → None

Send a specified file over the WebRTC peer connection data channel. The extension and mime type are used for file reconstruction on the front end

Parameters:

  • streamer_id (str) – The streamer use when sending the data

  • filepath (str) – The path to the file that will be sent

  • mime_type (str) – The mime type of the file. Used for file reconstruction on the front end

  • file_extension (str) – The file extension. Used for file reconstruction on the front end

classmethod streamer_send_file_as_byte_array(streamer_id, byte_array, mime_type, file_extension) → None

Send a specified byte array over the WebRTC peer connection data channel. The extension and mime type are used for file reconstruction on the front end

Parameters:

  • streamer_id (str) – The streamer use when sending the data

  • byte_array (Array[uint8]) – The raw data that will be sent over the data channel

  • mime_type (str) – The mime type of the file. Used for reconstruction on the front end

  • file_extension (str) – The file extension. Used for file reconstruction on the front end

classmethod streamer_set_player_layer_preference(streamer_id, player_id, spatial_layer_id, temporal_layer_id) → None

Set the layer preference for a specific player

Parameters:

  • streamer_id (str) – The streamer which the player belongs

  • player_id (str) – The ID of the player to set the layer preference for.

  • spatial_layer_id (int32) – The spatial layer ID

  • temporal_layer_id (int32) – The temporal layer ID

classmethod streamer_unfreeze_stream(streamer_id) → None

Unfreeze Pixel Streaming.

Parameters:

streamer_id (str) – The id of the streamer to unfreeze.

classmethod unfreeze_frame() → None

Unfreeze Pixel Streaming.