1. Epic GamesDeveloper
  3. UPixelStreamingSignallingComponent

UPixelStreamingSignallingComponent

A blueprint class representing a Pixel Streaming Signalling connection.

API > API/Plugins > API/Plugins/PixelStreamingPlayer

Inheritance Hierarchy

References

   
Module PixelStreamingPlayer
Header /Engine/Plugins/Experimental/PixelStreamingPlayer/Source/PixelStreamingPlayer/Public/PixelStreamingSignallingComponent.h
Include #include "PixelStreamingSignallingComponent.h"

Syntax

UCLASS (BlueprintType, Blueprintable, Category="PixelStreaming",  
       Meta=(DisplayName="PixelStreaming Signalling Component", BlueprintSpawnableComponent))  
class UPixelStreamingSignallingComponent : public UActorComponent

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditDefaultsOnly, Meta TObjectPtr< UStreamMediaSource > MediaSource If this media source is set we will use its supplied URL instead of the Url parameter on the connect call.
Public variable UProperty Category BlueprintAssignable FPixelStreamingSignallingComponentAnswer OnAnswer Fired when the connection receives an answer from the server.
Public variable UProperty Category BlueprintAssignable FPixelStreamingSignallingComponentConfig OnConfig Fired when the connection receives a config message from the server.
Public variable UProperty Category BlueprintAssignable FPixelStreamingSignallingComponentConnected OnConnected Fired when the signalling connection is successfully established.
Public variable UProperty Category BlueprintAssignable FPixelStreamingSignallingComponentConnectionError OnConnectionError Fired if the connection failed or an error occurs during the connection.
Public variable UProperty Category BlueprintAssignable FPixelStreamingSignallingComponentDisconnected OnDisconnected Fired when the connection successfully closes.
Public variable UProperty Category BlueprintAssignable FPixelStreamingSignallingComponentIceCandidate OnIceCandidate Fired when the server sends through an ice candidate.
Public variable UProperty Category BlueprintAssignable FPixelStreamingSignallingComponentOffer OnOffer Fired when the connection receives an offer from the server.
Protected variable TFunction< void(const TArray< FString > &)> OnStreamerListCallback  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AsyncRequestStreamerList ( const TFunction< void(const TArray< FString >&)>& Callback
)

 Used by the async bp node.
Public function UFunction BlueprintCallable, Category void

Connect ( const FString& Url
)

 Attempt to connect to a specified signalling server.
Public function UFunction BlueprintCallable, Category void Disconnect from the signalling server. No action if no connection exists.
Public function UFunction BlueprintCallable, Category void Send an answer created from a Peer Connection to the signalling server.
Public function UFunction BlueprintCallable, Category void Send an Ice Candidate to the signalling server that is generated from a Peer Connection.
Public function UFunction BlueprintCallable, Category void Send an offer created from a Peer Connection to the signalling server.
Public function UFunction BlueprintCallable, Category void

Subscribe ( const FString& StreamerId
)

 Send a subscribe message to the signalling server to subscribe to a specific streamer.
Public function UFunction BlueprintCallable, Category void Send an unsubscribe message to the signalling server to unsubscribe from a streamer.

Classes

  Type Name Description
Protected class FSignallingObserver    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page