unreal.PixelStreamingSignallingComponent

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

Bases: ActorComponent

A blueprint class representing a Pixel Streaming Signalling connection. Used to communicate with the signalling server and should route information to the peer connection.

C++ Source:

  • Plugin: PixelStreamingPlayer

  • Module: PixelStreamingPlayer

  • File: PixelStreamingSignallingComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • component_tags (Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • media_source (StreamMediaSource): [Read-Write] If this media source is set we will use its supplied URL instead of the Url parameter on the connect call.

  • on_answer (PixelStreamingSignallingComponentAnswer): [Read-Write] Fired when the connection receives an answer from the server. The streamer is answering a previously sent offer by us. Forward to the peer connection.

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • on_config (PixelStreamingSignallingComponentConfig): [Read-Write] Fired when the connection receives a config message from the server. This is the earliest place where the peer connection can be initialized.

  • on_connected (PixelStreamingSignallingComponentConnected): [Read-Write] Fired when the signalling connection is successfully established.

  • on_connection_error (PixelStreamingSignallingComponentConnectionError): [Read-Write] Fired if the connection failed or an error occurs during the connection. If this is fired at any point the connection should be considered closed.

  • on_disconnected (PixelStreamingSignallingComponentDisconnected): [Read-Write] Fired when the connection successfully closes.

  • on_ice_candidate (PixelStreamingSignallingComponentIceCandidate): [Read-Write] Fired when the server sends through an ice candidate. Forward this information on to the peer connection.

  • on_offer (PixelStreamingSignallingComponentOffer): [Read-Write] Fired when the connection receives an offer from the server. This means there is media being offered up to this connection. Forward to the peer connection.

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

connect(url) → None

Attempt to connect to a specified signalling server.

Parameters:

url (str) – The url of the signalling server. Ignored if this component has a MediaSource. In that case the URL on the media source will be used instead.

disconnect() → None

Disconnect from the signalling server. No action if no connection exists.

property on_answer: PixelStreamingSignallingComponentAnswer

[Read-Write] Fired when the connection receives an answer from the server. The streamer is answering a previously sent offer by us. Forward to the peer connection.

Type:

(PixelStreamingSignallingComponentAnswer)

property on_config: PixelStreamingSignallingComponentConfig

[Read-Write] Fired when the connection receives a config message from the server. This is the earliest place where the peer connection can be initialized.

Type:

(PixelStreamingSignallingComponentConfig)

property on_connected: PixelStreamingSignallingComponentConnected

[Read-Write] Fired when the signalling connection is successfully established.

Type:

(PixelStreamingSignallingComponentConnected)

property on_connection_error: PixelStreamingSignallingComponentConnectionError

[Read-Write] Fired if the connection failed or an error occurs during the connection. If this is fired at any point the connection should be considered closed.

Type:

(PixelStreamingSignallingComponentConnectionError)

property on_disconnected: PixelStreamingSignallingComponentDisconnected

[Read-Write] Fired when the connection successfully closes.

Type:

(PixelStreamingSignallingComponentDisconnected)

property on_ice_candidate: PixelStreamingSignallingComponentIceCandidate

[Read-Write] Fired when the server sends through an ice candidate. Forward this information on to the peer connection.

Type:

(PixelStreamingSignallingComponentIceCandidate)

property on_offer: PixelStreamingSignallingComponentOffer

[Read-Write] Fired when the connection receives an offer from the server. This means there is media being offered up to this connection. Forward to the peer connection.

Type:

(PixelStreamingSignallingComponentOffer)

send_answer(answer) → None

Send an answer created from a Peer Connection to the signalling server.

Parameters:

answer (PixelStreamingSessionDescriptionWrapper) – The answer object created from calling CreateAnswer on a Peer Connection.

send_ice_candidate(candidate_wrapper) → None

Send an Ice Candidate to the signalling server that is generated from a Peer Connection.

Parameters:

candidate_wrapper (PixelStreamingIceCandidateWrapper) –

send_offer(offer) → None

Send an offer created from a Peer Connection to the signalling server.

Parameters:

offer (PixelStreamingSessionDescriptionWrapper) – The answer object created from calling CreateAnswer on a Peer Connection.

subscribe(streamer_id) → None

Send a subscribe message to the signalling server to subscribe to a specific streamer.

Parameters:

streamer_id (str) – The name of the streamer to subscribe to.

unsubscribe() → None

Send an unsubscribe message to the signalling server to unsubscribe from a streamer.