1. Epic GamesDeveloper
  3. FPixelStreamingPeerConnection

FPixelStreamingPeerConnection

A specialized representation of a WebRTC peer connection for Pixel Streaming.

API > API/Plugins > API/Plugins/PixelStreaming

Inheritance Hierarchy

  • PeerConnectionObserver
  • FPixelStreamingPeerConnection

References

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

Syntax

class FPixelStreamingPeerConnection : public PeerConnectionObserver

Remarks

A specialized representation of a WebRTC peer connection for Pixel Streaming.

Variables

  Type Name Description
Public variable FOnIceCandidate OnEmitIceCandidate  
Public variable FOnIceStateChanged OnIceStateChanged  
Public variable FOnDataChannel OnNewDataChannel  

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddRemoteIceCandidate ( const FString& SDPMid,
int SDPMLineIndex,
const FString& SDP
)

 Adds ICE candidate data to the peer connection. Usually supplied from the signalling server.
Public function Static TUniquePtr< FPixelStreamingPeerConnection >

Create ( const FRTCConfig& RTCConfig,
bool IsSFU
)

 Creates a new peer connection using the given RTC configuration.
Public function void

CreateAnswer ( EReceiveMediaOption ReceiveOption,
const SDPCallback& SuccessCallback,
const ErrorCallback& ErrorCallback
)

 Asynchronously creates an answer session description for this local peer connection.
Public function Static TSharedPtr< IPixelStreamingAudioInput >  
Public function TSharedPtr< FPixelStreamingDataChannel >

CreateDataChannel ( int Id,
bool Negotiated
)

 Creates a data connection associated with this peer connection.
Public function void

CreateOffer ( EReceiveMediaOption ReceiveOption,
const SDPCallback& SuccessCallback,
const ErrorCallback& ErrorCallback
)

 Asynchronously creates an offer session description for this local peer connection.
Public function Static void Causes the video stream to generate a keyframe
Public function Static rtc::scoped_refptr< webrtc::AudioSourceInterface > Gets the global audio source.
Public function TSharedPtr< IPixelStreamingAudioSink > Gets the currently set audio sink on this connection.
Public function Const rtc::scoped_refptr< webrtc::AudioSourceInterface > Gets the currently set audio source on this connection.
Public function Const const webrtc::SessionDescriptionInterface * Gets the current local description.
Public function Const EPixelStreamingCodec  
Public function Const const webrtc::SessionDescriptionInterface * Gets the current remote description.
Public function rtc::VideoSinkInterface< webrtc::VideoFrame > * Gets the currently set video sink on this connection.
Public function Const rtc::scoped_refptr< webrtc::VideoTrackSourceInterface > Gets the currently set video source on this connection.
Protected function Virtual void

OnAddStream ( rtc::scoped_refptr< webrtc::MediaStreamInterface > Stream
)

  
Protected function Virtual void

OnDataChannel ( rtc::scoped_refptr< webrtc::DataChannelInterface > Channel
)

  
Protected function Virtual void

OnIceCandidate ( const webrtc::IceCandidateInterface* Candidate
)

  
Protected function Virtual void

OnIceCandidatesRemoved ( const std::vector< cricket::Candidate >& candidates
)

  
Protected function Virtual void

OnIceConnectionChange ( webrtc::PeerConnectionInterface::IceConnectionState NewState
)

  
Protected function Virtual void

OnIceConnectionReceivingChange ( bool Receiving
)

  
Protected function Virtual void

OnIceGatheringChange ( webrtc::PeerConnectionInterface::IceGatheringState NewState
)

  
Protected function Virtual void

OnRemoveStream ( rtc::scoped_refptr< webrtc::MediaStreamInterface > Stream
)

  
Protected function Virtual void

OnRemoveTrack ( rtc::scoped_refptr< webrtc::RtpReceiverInterface > receiver
)

  
Protected function Virtual void  
Protected function Virtual void

OnSignalingChange ( webrtc::PeerConnectionInterface::SignalingState NewState
)

 Webrtc::PeerConnectionObserver implementation.
Protected function Virtual void

OnTrack ( rtc::scoped_refptr< webrtc::RtpTransceiverInterface > Transceiver
)

  
Public function Static void

PostSignalingTask ( FunctorT&& InFunc
)

 Post a task onto the WebRTC signalling thread.
Public function void

ReceiveAnswer ( const FString& SDP,
const VoidCallback& SuccessCallback,
const ErrorCallback& ErrorCallback
)

 Asynchronously sets the remote description from a session description string answered from a signalling server.
Public function void

ReceiveOffer ( const FString& SDP,
const VoidCallback& SuccessCallback,
const ErrorCallback& ErrorCallback
)

 Asynchronously sets the remote description from a session description string offered from a signalling server.
Public function Static void  
Public function void Sets an audio sink on this connection that will receive audio data from this connection.
Public function void

SetAudioSource ( rtc::scoped_refptr< webrtc::AudioSourceInterface > InAudioSource
)

 Sets an audio source that can supply this connection with audio data.
Public function void

SetLocalDescription ( webrtc::SessionDescriptionInterface* SDP,
const VoidCallback& SuccessCallback,
const ErrorCallback& ErrorCallback
)

 Asynchronously sets the local description using the given session description object.
Public function void

SetRemoteDescription ( webrtc::SessionDescriptionInterface* SDP,
const VoidCallback& SuccessCallback,
const ErrorCallback& ErrorCallback
)

 Asynchronously sets the remote description using the given session description object.
Public function void

SetVideoSink ( rtc::VideoSinkInterface< webrtc::VideoFrame >* InSink
)

 Sets a video sink on this connection that will receive frame data from this connection.
Public function void

SetVideoSource ( rtc::scoped_refptr< webrtc::VideoTrackSourceInterface > InVideoSource
)

 Sets a video source that can supply this connection with frame data.
Public function void

SetWebRTCStatsCallback ( rtc::scoped_refptr< webrtc::RTCStatsCollectorCallback > InCallback
)

 Sets the callback to be used when the stats collector comes knocking.
Public function Static void Shuts down the WebRTC thread and destroys the peer connection factory.

Enums

  Type Name Description
Public enum EReceiveMediaOption Flags for CreateOffer/CreateAnswer that indicate what kind of media we indend to receive.  
Private enum ESDPType    

Typedefs

Name Description
ErrorCallback  
FOnDataChannel Called when a data channel is opened from the remote side of this connection.
FOnIceCandidate Called when the ICE candidate is emitted.
FOnIceStateChanged Called when the ICE state changes.
FRTCConfig  
SDPCallback  
VoidCallback  

Constants

Name Description
ApplicationAudioSource  
AudioMixer  
PeerConnectionFactory  
SignallingThread  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page