unreal.PixelStreamingBlueprints

class unreal.PixelStreamingBlueprints(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Pixel Streaming Blueprints

C++ Source:

  • Plugin: PixelStreaming

  • Module: PixelStreaming

  • File: PixelStreamingBlueprints.h

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_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.

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 unfreeze_frame() → None

Unfreeze Pixel Streaming.