1. Epic GamesDeveloper
  3. FPixelStreamingSignallingConnection

FPixelStreamingSignallingConnection

A specialized signalling server connection object for web socket based Pixel Streaming signalling servers.

API > API/Plugins > API/Plugins/PixelStreaming

A specialized signalling server connection object for web socket based Pixel Streaming signalling servers.

   
Name FPixelStreamingSignallingConnection
Type class
Header File /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamingSignallingConnection.h
Include Path #include "PixelStreamingSignallingConnection.h"

Syntax

class FPixelStreamingSignallingConnection : public IPixelStreamingSignallingConnection

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FPixelStreamingSignallingConnection ( TSharedPtr< IPixelStreamingSignallingConnectionObserver > InObserver,
FString InStreamerId,
TSharedPtr< IWebSocket > InWebSocket
)

   PixelStreamingSignallingConnection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPixelStreamingSignallingConnection()

   PixelStreamingSignallingConnection.h  

Typedefs

Name Type Remarks Include Path
FJsonObjectPtr TSharedPtr< FJsonObject >   PixelStreamingSignallingConnection.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AliveSemaphore TSharedPtr< int > We can used WeakPtrs pointing to this SharedPtr to detect when this class is destroyed that allows the following Safe... PixelStreamingSignallingConnection.h  
bAutoReconnectEnabled bool   PixelStreamingSignallingConnection.h  
bIsConnected bool   PixelStreamingSignallingConnection.h  
bKeepAliveEnabled bool   PixelStreamingSignallingConnection.h  
KEEP_ALIVE_INTERVAL const float   PixelStreamingSignallingConnection.h  
MessageHandlers TMap< FString, TFunction< void(FJsonObjectPtr)> >   PixelStreamingSignallingConnection.h  
Observer TSharedPtr< IPixelStreamingSignallingConnectionObserver >   PixelStreamingSignallingConnection.h  
OnBinaryMessageHandle FDelegateHandle   PixelStreamingSignallingConnection.h  
OnClosedHandle FDelegateHandle   PixelStreamingSignallingConnection.h  
OnConnectedHandle FDelegateHandle   PixelStreamingSignallingConnection.h  
OnConnectionErrorHandle FDelegateHandle   PixelStreamingSignallingConnection.h  
OnMessageHandle FDelegateHandle   PixelStreamingSignallingConnection.h  
StreamerId FString   PixelStreamingSignallingConnection.h  
TimerHandle_KeepAlive FTimerHandle Handle for efficient management of KeepAlive timer PixelStreamingSignallingConnection.h  
TimerHandle_Reconnect FTimerHandle   PixelStreamingSignallingConnection.h  
Url FString   PixelStreamingSignallingConnection.h  
WebSocket TSharedPtr< IWebSocket >   PixelStreamingSignallingConnection.h  

Functions

Public

Overridden from IPixelStreamingSignallingConnection

Name Remarks Include Path Unreal Specifiers

virtual void Disconnect ( FString Reason
)

 Disconnects from the signalling server with a reason message. Safe to call even when not connected. PixelStreamingSignallingConnection.h  

virtual void Disconnect ()

   PixelStreamingSignallingConnection.h  

virtual bool IsConnected()

 Checks if the connection is established. PixelStreamingSignallingConnection.h  

virtual void RequestStreamerList ()

 Request a list of active streamers from the signalling server. PixelStreamingSignallingConnection.h  

virtual void SendAnswer ( FPixelStreamingPlayerId PlayerId,
const webrtc::SessionDescriptionInterface& SDP
)

 [Streamer only] Sends an answer to the specified player. PixelStreamingSignallingConnection.h  

virtual void SendAnswer ( const webrtc::SessionDescriptionInterface& SDP
)

 [Stream receiver only] Sends an answer back to the streamer after receiving an offer. PixelStreamingSignallingConnection.h  

virtual void SendDisconnectPlayer ( FPixelStreamingPlayerId PlayerId,
const FString& Reason
)

 [Streamer only] Send a disconnect message to the specified player. PixelStreamingSignallingConnection.h  

virtual void SendIceCandidate ( FPixelStreamingPlayerId PlayerId,
const webrtc::IceCandidateInterface& IceCandidate
)

 [Streamer only] Sends ice candidate information to the specified player. PixelStreamingSignallingConnection.h  

virtual void SendIceCandidate ( const webrtc::IceCandidateInterface& IceCandidate
)

 [Stream receiver only] Sends ICE candidate information to the streamer. PixelStreamingSignallingConnection.h  

virtual void SendMessage ( const FString& Msg
)

 Send a message to the signalling server. PixelStreamingSignallingConnection.h  

virtual void SendOffer ( FPixelStreamingPlayerId PlayerId,
const webrtc::SessionDescriptionInterface& SDP
)

 [Streamer only] Sends an offer to the specified player. PixelStreamingSignallingConnection.h  

virtual void SendOffer ( const webrtc::SessionDescriptionInterface& SDP
)

 [Stream receiver only] Sends an offer to the streamer. PixelStreamingSignallingConnection.h  

virtual void SendSubscribe ( const FString& StreamerId
)

 [Stream receiver only] Send a subscription request to the signalling server. PixelStreamingSignallingConnection.h  

virtual void SendUnsubscribe()

 [Stream receiver only] Send an unsubscribe request to the signalling server. PixelStreamingSignallingConnection.h  

virtual void SetAutoReconnect ( bool bAutoReconnect
)

 Toggles automatic reconnecting when websocket is closed or unreachable. PixelStreamingSignallingConnection.h  

virtual void SetKeepAlive ( bool bKeepAlive
)

 Enables or disables the keep alive pings on this connection. PixelStreamingSignallingConnection.h  

virtual void TryConnect ( FString URL
)

 IPixelStreamingSignallingConnection Interface PixelStreamingSignallingConnection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page