unreal.PixelStreaming2Delegates

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

Bases: Object

Pixel Streaming Delegates that can be invoked when pixel streaming events take place. Includes blueprint and native c++ delegates.

C++ Source:

  • Plugin: PixelStreaming2

  • Module: PixelStreaming2

  • File: PixelStreaming2Delegates.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_all_connections_closed (AllConnectionsClosed): [Read-Write] Invoked when all connections have closed and nobody is viewing or interacting with the app. This is an opportunity to reset the app.

  • on_closed_connection (ClosedConnection): [Read-Write] Invoked when a connection to a player was lost.

  • on_connected_to_signalling_server (ConnectedToSignallingServer): [Read-Write] Invoked when a connection to the signalling server was made.

  • on_data_track_closed (DataTrackClosed): [Read-Write] Invoked when an existing data track has been closed.

  • on_data_track_open (DataTrackOpen): [Read-Write] Invoked when a new data track has been opened.

  • on_disconnected_from_signalling_server (DisconnectedFromSignallingServer): [Read-Write] Invoked when a connection to the signalling server was lost.

  • on_fallback_to_software_encoding (FallbackToSoftwareEncoding): [Read-Write] Invoked when the GPU ran out of available hardware encoders and fell back to software encoders.

  • on_new_connection (NewConnection): [Read-Write] Invoked when a new connection has been made to the session.

  • on_stat_changed (StatsChanged): [Read-Write] Invoked when a pixel streaming stat has changed.

property on_all_connections_closed: AllConnectionsClosed

[Read-Write] Invoked when all connections have closed and nobody is viewing or interacting with the app. This is an opportunity to reset the app.

Type:

(AllConnectionsClosed)

property on_closed_connection: ClosedConnection

[Read-Write] Invoked when a connection to a player was lost.

Type:

(ClosedConnection)

property on_connected_to_signalling_server: ConnectedToSignallingServer

[Read-Write] Invoked when a connection to the signalling server was made.

Type:

(ConnectedToSignallingServer)

property on_data_track_closed: DataTrackClosed

[Read-Write] Invoked when an existing data track has been closed.

Type:

(DataTrackClosed)

property on_data_track_open: DataTrackOpen

[Read-Write] Invoked when a new data track has been opened.

Type:

(DataTrackOpen)

property on_disconnected_from_signalling_server: DisconnectedFromSignallingServer

[Read-Write] Invoked when a connection to the signalling server was lost.

Type:

(DisconnectedFromSignallingServer)

property on_fallback_to_software_encoding: FallbackToSoftwareEncoding

[Read-Write] Invoked when the GPU ran out of available hardware encoders and fell back to software encoders.

Type:

(FallbackToSoftwareEncoding)

property on_new_connection: NewConnection

[Read-Write] Invoked when a new connection has been made to the session.

Type:

(NewConnection)

property on_stat_changed: StatsChanged

[Read-Write] Invoked when a pixel streaming stat has changed.

Type:

(StatsChanged)