Navigation
API > API/Plugins > API/Plugins/PixelStreaming
A specialized representation of a WebRTC data channel for Pixel Streaming.
| Name | FPixelStreamingDataChannel |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamingDataChannel.h |
| Include Path | #include "PixelStreamingDataChannel.h" |
Syntax
class FPixelStreamingDataChannel :
public webrtc::DataChannelObserver,
public TSharedFromThis< FPixelStreamingDataChannel >
Inheritance Hierarchy
- webrtc::DataChannelObserver → FPixelStreamingDataChannel
- FSharedFromThisBase → TSharedFromThis → FPixelStreamingDataChannel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPixelStreamingDataChannel
(
rtc::scoped_refptr< webrtc::DataChannelInterface > InChannel |
PixelStreamingDataChannel.h | ||
FPixelStreamingDataChannel
(
FPixelStreamingPeerConnection& Connection, |
PixelStreamingDataChannel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FPixelStreamingDataChannel() |
PixelStreamingDataChannel.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnClosed | TMulticastDelegate_OneParam< void, FPixelStreamingDataChannel & > | Broadcast when the data channel state changes to closed | PixelStreamingDataChannel.h |
| FOnMessage | TMulticastDelegate_TwoParams< void, uint8, const webrtc::DataBuffer & > | Broadcast when data comes in from the data channel. | PixelStreamingDataChannel.h |
| FOnOpen | TMulticastDelegate_OneParam< void, FPixelStreamingDataChannel & > | Broadcast when the data channel state changes to open | PixelStreamingDataChannel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnClosed | FOnClosed | PixelStreamingDataChannel.h | ||
| OnMessageReceived | FOnMessage | PixelStreamingDataChannel.h | ||
| OnOpen | FOnOpen | PixelStreamingDataChannel.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| RecvChannel | rtc::scoped_refptr< webrtc::DataChannelInterface > | PixelStreamingDataChannel.h | ||
| SendChannel | rtc::scoped_refptr< webrtc::DataChannelInterface > | PixelStreamingDataChannel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool SendArbitraryData
(
uint8 Type, |
Sends a large buffer of data to the data channel. | PixelStreamingDataChannel.h | |
bool SendMessage
(
uint8 Type, |
Sends a series of arguments to the data channel with the given type. | PixelStreamingDataChannel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnMessage
(
const webrtc::DataBuffer& Buffer |
PixelStreamingDataChannel.h | ||
virtual void OnStateChange() |
Webrtc::DataChannelObserver implementation. | PixelStreamingDataChannel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< FPixelStreamingDataChannel > Create
(
rtc::scoped_refptr< webrtc::DataChannelInterface > InChannel |
PixelStreamingDataChannel.h | ||
static TSharedPtr< FPixelStreamingDataChannel > Create
(
FPixelStreamingPeerConnection& Connection, |
PixelStreamingDataChannel.h |