1. Epic GamesDeveloper
  3. IPixelStreamingSignallingConnection

IPixelStreamingSignallingConnection

A specialized signalling server connection object for Pixel Streaming signalling servers.

API > API/Plugins > API/Plugins/PixelStreaming

A specialized signalling server connection object for Pixel Streaming signalling servers.

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

Syntax

class IPixelStreamingSignallingConnection

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPixelStreamingSignallingConnection()

   IPixelStreamingSignallingConnection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Disconnect ( FString Reason
)

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

void Disconnect ()

 Disconnects from the signalling server. Safe to call even when not connected. IPixelStreamingSignallingConnection.h  

bool IsConnected()

 Checks if the connection is established. IPixelStreamingSignallingConnection.h  
Request a list of active streamers from the signalling server. IPixelStreamingSignallingConnection.h  

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

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

void SendAnswer ( const webrtc::SessionDescriptionInterface& SDP
)

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

void SendDisconnectPlayer ( FPixelStreamingPlayerId PlayerId,
const FString& Reason
)

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

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

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

void SendIceCandidate ( const webrtc::IceCandidateInterface& IceCandidate
)

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

void SendMessage ( const FString& Msg
)

 Send a message to the signalling server. IPixelStreamingSignallingConnection.h  

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

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

void SendOffer ( const webrtc::SessionDescriptionInterface& SDP
)

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

void SendSubscribe ( const FString& StreamerId
)

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

void SendUnsubscribe()

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

void SetAutoReconnect ( bool bAutoReconnect
)

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

void SetKeepAlive ( bool bKeepAlive
)

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

void TryConnect ( FString URL
)

 Connect to a specified signalling server at ths given URL IPixelStreamingSignallingConnection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page