1. Epic GamesDeveloper
  3. IPixelStreamingSignallingConnection

IPixelStreamingSignallingConnection

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

API > API/Plugins > API/Plugins/PixelStreaming

Inheritance Hierarchy

References

   
Module PixelStreaming
Header /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/IPixelStreamingSignallingConnection.h
Include #include "IPixelStreamingSignallingConnection.h"

Syntax

class IPixelStreamingSignallingConnection

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Disconnects from the signalling server. Safe to call even when not connected.
Public function Const bool Checks if the connection is established.
Public function void Request a list of active streamers from the signalling server.
Public function void

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

 [Streamer only] Sends an answer to the specified player.
Public function void

SendAnswer ( const webrtc::SessionDescriptionInterface& SDP
)

 [Stream receiver only] Sends an answer back to the streamer after receiving an offer.
Public function void [Streamer only] Send a disconnect message to the specified player.
Public function void

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

 [Streamer only] Sends ice candidate information to the specified player.
Public function void

SendIceCandidate ( const webrtc::IceCandidateInterface& IceCandidate
)

 [Stream receiver only] Sends ICE candidate information to the streamer.
Public function void

SendMessage ( const FString& Msg
)

 Send a message to the signalling server.
Public function void

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

 [Streamer only] Sends an offer to the specified player.
Public function void

SendOffer ( const webrtc::SessionDescriptionInterface& SDP
)

 [Stream receiver only] Sends an offer to the streamer.
Public function void

SendSubscribe ( const FString& StreamerId
)

 [Stream receiver only] Send a subscription request to the signalling server.
Public function void [Stream receiver only] Send an unsubscribe request to the signalling server.
Public function void

SetAutoReconnect ( bool bAutoReconnect
)

 Toggles automatic reconnecting when websocket is closed or unreachable.
Public function void

SetKeepAlive ( bool bKeepAlive
)

 Enables or disables the keep alive pings on this connection.
Public function void Connect to a specified signalling server at ths given URL

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page