unreal.PixelStreamingPeerComponent

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

Bases: ActorComponent

A blueprint representation of a Pixel Streaming Peer Connection. Should communicate with a Pixel Streaming Signalling Connection and will accept video sinks to receive video data.

C++ Source:

  • Plugin: PixelStreamingPlayer

  • Module: PixelStreamingPlayer

  • File: PixelStreamingPeerComponent.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

  • 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_ice_candidate (PixelStreamingOnIceCandidate): [Read-Write] Once negotiation is completed the Peer Connection can generate Ice Candidate objects. These need to be sent to a signalling server to allow proper connection.

  • on_ice_connection (PixelStreamingOnIceConnection): [Read-Write] Once a connection has been connected and streaming should be available.

  • on_ice_disconnection (PixelStreamingOnIceDisconnection): [Read-Write] When an ice connection is lost.

  • 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!

  • video_sink (PixelStreamingMediaTexture): [Read-Write] A sink for the video data received once this connection has finished negotiating.

create_answer(offer) → PixelStreamingSessionDescriptionWrapper

Creates an answer to the given offer objet that was provided.

Parameters:

offer (str) – The offer SDP string to create an answer for. Should be obtained from the signalling server On Offer event.

Returns:

The answer object generated. Send this to the signalling server to complete negotiation.

Return type:

PixelStreamingSessionDescriptionWrapper

create_offer() → PixelStreamingSessionDescriptionWrapper

Creates an offer.

Returns:

The offer object generated. Send this to the signalling server to initiate negotiation.

Return type:

PixelStreamingSessionDescriptionWrapper

property on_ice_candidate: PixelStreamingOnIceCandidate

[Read-Write] Once negotiation is completed the Peer Connection can generate Ice Candidate objects. These need to be sent to a signalling server to allow proper connection.

Type:

(PixelStreamingOnIceCandidate)

property on_ice_connection: PixelStreamingOnIceConnection

[Read-Write] Once a connection has been connected and streaming should be available.

Type:

(PixelStreamingOnIceConnection)

property on_ice_disconnection: PixelStreamingOnIceDisconnection

[Read-Write] When an ice connection is lost.

Type:

(PixelStreamingOnIceDisconnection)

receive_answer(offer) → None

Receives an answer from a streamer after we’ve sent an offer to receive.

Parameters:

offer (str) – The answer SDP. Should be obtained from the signalling server On Answer event.

receive_ice_candidate(candidate) → None

Notify the peer connection of an ICE candidate sent by the singalling connection.

Parameters:

candidate (PixelStreamingIceCandidateWrapper) – Provided by the singalling connection.

set_config(config) → None

Sets the RTC Configuration for this Peer Connection.

Parameters:

config (PixelStreamingRTCConfigWrapper) – The RTC configuration for this Peer Connection. Obtained from the signalling server On Config event.