1. Epic GamesDeveloper
  3. UPixelStreamingSignallingComponent

UPixelStreamingSignallingComponent

A blueprint class representing a Pixel Streaming Signalling connection.

API > API/Plugins > API/Plugins/PixelStreamingPlayer

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

   
Name UPixelStreamingSignallingComponent
Type class
Header File /Engine/Plugins/Experimental/PixelStreamingPlayer/Source/PixelStreamingPlayer/Public/PixelStreamingSignallingComponent.h
Include Path #include "PixelStreamingSignallingComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPixelStreamingSignallingComponent ( const FObjectInitializer& ObjectInitializer
)

   PixelStreamingSignallingComponent.h  

Classes

Name Remarks
FSignallingObserver  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
MediaSource TObjectPtr< UStreamMediaSource > If this media source is set we will use its supplied URL instead of the Url parameter on the connect call. PixelStreamingSignallingComponent.h
  • EditDefaultsOnly
  • Category="Properties"
  • Meta=(DisplayName="Stream Media Source", AllowPrivateAccess=true)
OnAnswer FPixelStreamingSignallingComponentAnswer Fired when the connection receives an answer from the server. PixelStreamingSignallingComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
OnConfig FPixelStreamingSignallingComponentConfig Fired when the connection receives a config message from the server. PixelStreamingSignallingComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
OnConnected FPixelStreamingSignallingComponentConnected Fired when the signalling connection is successfully established. PixelStreamingSignallingComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
OnConnectionError FPixelStreamingSignallingComponentConnectionError Fired if the connection failed or an error occurs during the connection. PixelStreamingSignallingComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
OnDisconnected FPixelStreamingSignallingComponentDisconnected Fired when the connection successfully closes. PixelStreamingSignallingComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
OnIceCandidate FPixelStreamingSignallingComponentIceCandidate Fired when the server sends through an ice candidate. PixelStreamingSignallingComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"
OnOffer FPixelStreamingSignallingComponentOffer Fired when the connection receives an offer from the server. PixelStreamingSignallingComponent.h
  • BlueprintAssignable
  • Category="Components|Activation"

Protected

Name Type Remarks Include Path Unreal Specifiers
SignallingConnection TUniquePtr< IPixelStreamingSignallingConnection >   PixelStreamingSignallingComponent.h  
SignallingServerConnectionObserver TSharedPtr< IPixelStreamingSignallingConnectionObserver >   PixelStreamingSignallingComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Used by the async bp node. PixelStreamingSignallingComponent.h  

void Connect ( const FString& Url
)

 Attempt to connect to a specified signalling server. PixelStreamingSignallingComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void Disconnect()

 Disconnect from the signalling server. No action if no connection exists. PixelStreamingSignallingComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void SendAnswer ( const FPixelStreamingSessionDescriptionWrapper& Answer
)

 Send an answer created from a Peer Connection to the signalling server. PixelStreamingSignallingComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void SendIceCandidate ( const FPixelStreamingIceCandidateWrapper& CandidateWrapper
)

 Send an Ice Candidate to the signalling server that is generated from a Peer Connection. PixelStreamingSignallingComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void SendOffer ( const FPixelStreamingSessionDescriptionWrapper& Offer
)

 Send an offer created from a Peer Connection to the signalling server. PixelStreamingSignallingComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void Subscribe ( const FString& StreamerId
)

 Send a subscribe message to the signalling server to subscribe to a specific streamer. PixelStreamingSignallingComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

void Unsubscribe()

 Send an unsubscribe message to the signalling server to unsubscribe from a streamer. PixelStreamingSignallingComponent.h
  • BlueprintCallable
  • Category="PixelStreaming"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page