1. Epic GamesDeveloper
  3. PixelStreaming

PixelStreaming

API > API/Plugins

   
Name PixelStreaming
Type Plugin
Part of Plugins Pixel Streaming
Location /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/
Module Build Rules PixelStreaming.Build.cs

Classes

Name Remarks
FPixelStreamingCreateSessionDescriptionObserver  
FPixelStreamingDataChannel A specialized representation of a WebRTC data channel for Pixel Streaming.
FPixelStreamingPeerConnection A specialized representation of a WebRTC peer connection for Pixel Streaming.
FPixelStreamingSetSessionDescriptionObserver FPixelStreamingSetSessionDescriptionObserver WebRTC requires an implementation of webrtc::SetSessionDescriptionObserver_ interface as a callback for setting session description, either on receiving remote offer_ (PeerConnection::SetRemoteDescription_) of on sending answer_ (`PeerConnection::SetLocalDescription_)
FPixelStreamingSettings A collection of static methods used to expose settings and their values to other modules dependedant on PixelStreaming
FPixelStreamingSignallingConnection A specialized signalling server connection object for web socket based Pixel Streaming signalling servers.
FPixelStreamingVideoInput The input of the Pixel Streaming system.
FPixelStreamingVideoInputBackBuffer Use this if you want to send the UE backbuffer as video input.
FPixelStreamingVideoInputI420 A Generic video input for I420 frames
FPixelStreamingVideoInputNV12 A Generic video input for NV12 frames
FPixelStreamingVideoInputPIEViewport An extension of the back buffer input that can handle PIE sessions.
FPixelStreamingVideoInputRenderTarget Use this if you want to send the contents of a render target.
FPixelStreamingVideoInputRHI A Generic video input for RHI frames
FPixelStreamingVideoSink  
FWebRTCSoundGenerator An `ISoundGenerator_ implementation to pump some audio from WebRTC into this synth component
UPixelStreamingAudioComponent Allows in-engine playback of incoming WebRTC audio from a particular Pixel Streaming player/peer using their mic in the browser.
UPixelStreamingDelegates  
UPixelStreamingInput  

Structs

Name Remarks
BufferBuilder  
FPixelStreamingPlayerConfig  
FPixelStreamingSimulcastParameters A struct representing the simulcast paramaters used by PixelStreaming.

Interfaces

Name Remarks
IPixelStreamingAudioConsumer Interface for consuming audio coming in from the browser.
IPixelStreamingAudioInput  
IPixelStreamingAudioSink Interface for a sink that collects audio coming in from the browser and passes into into UE's audio system.
IPixelStreamingModule The public interface of the Pixel Streaming module.
IPixelStreamingSignallingConnection A specialized signalling server connection object for Pixel Streaming signalling servers.
IPixelStreamingSignallingConnectionObserver Callback interface for `FPixelStreamingSignallingConnection_
IPixelStreamingStats Add stats that Pixel Streaming can display on screen or be used internally.
IPixelStreamingStatsSource An interface that allows us to collect regular stats from anything that implements it (we use this for WebRTC stats polling internally).
IPixelStreamingStreamer  

Typedefs

Name Type Remarks Include Path
FPixelStreamingPlayerId FString   PixelStreamingPlayerId.h

Enums

Public

Name Remarks
EPixelStreamingCodec  

Constants

Name Type Remarks Include Path
INVALID_PLAYER_ID const FPixelStreamingPlayerId   PixelStreamingPlayerId.h
SFU_PLAYER_ID const FPixelStreamingPlayerId   PixelStreamingPlayerId.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AvgSendDelay const FName   PixelStreamingStatNames.h  
Bitrate const FName Calculated stats. PixelStreamingStatNames.h  
BitrateMegabits const FName   PixelStreamingStatNames.h  
BytesReceived const FName   PixelStreamingStatNames.h  
BytesSent const FName   PixelStreamingStatNames.h  
DataChannelBytesReceived const FName   PixelStreamingStatNames.h  
DataChannelBytesSent const FName Data-channel stats. PixelStreamingStatNames.h  
DataChannelMessagesReceived const FName   PixelStreamingStatNames.h  
DataChannelMessagesSent const FName   PixelStreamingStatNames.h  
DecodedFramesPerSecond const FName   PixelStreamingStatNames.h  
EncodedFramesPerSecond const FName   PixelStreamingStatNames.h  
FirCount const FName   PixelStreamingStatNames.h  
Fps const FName   PixelStreamingStatNames.h  
FrameHeight const FName   PixelStreamingStatNames.h  
FramesCorrupted const FName   PixelStreamingStatNames.h  
FramesDecoded const FName   PixelStreamingStatNames.h  
FramesDropped const FName   PixelStreamingStatNames.h  
FramesEncoded const FName   PixelStreamingStatNames.h  
FramesPerSecond const FName   PixelStreamingStatNames.h  
FramesReceived const FName   PixelStreamingStatNames.h  
FramesReceivedPerSecond const FName   PixelStreamingStatNames.h  
FramesSent const FName   PixelStreamingStatNames.h  
FramesSentPerSecond const FName   PixelStreamingStatNames.h  
FrameWidth const FName   PixelStreamingStatNames.h  
FreezeCount const FName   PixelStreamingStatNames.h  
FullFramesLost const FName   PixelStreamingStatNames.h  
HugeFramesSent const FName   PixelStreamingStatNames.h  
InputController const FName Pixel Streaming specific stats. PixelStreamingStatNames.h  
InterruptionCount const FName   PixelStreamingStatNames.h  
JitterBufferDelay const FName WebRTC stats. PixelStreamingStatNames.h  
JitterBufferTargetDelay const FName   PixelStreamingStatNames.h  
KeyFramesEncoded const FName   PixelStreamingStatNames.h  
MeanEncodeTime const FName   PixelStreamingStatNames.h  
MeanQPPerSecond const FName   PixelStreamingStatNames.h  
MeanSendDelay const FName   PixelStreamingStatNames.h  
MessagesReceived const FName   PixelStreamingStatNames.h  
MessagesSent const FName   PixelStreamingStatNames.h  
NackCount const FName   PixelStreamingStatNames.h  
PartialFramesLost const FName   PixelStreamingStatNames.h  
PauseCount const FName   PixelStreamingStatNames.h  
PliCount const FName   PixelStreamingStatNames.h  
QPSum const FName   PixelStreamingStatNames.h  
QualityController const FName   PixelStreamingStatNames.h  
RetransmittedBytesSent const FName   PixelStreamingStatNames.h  
SliCount const FName   PixelStreamingStatNames.h  
SourceFps const FName   PixelStreamingStatNames.h  
TargetBitrate const FName   PixelStreamingStatNames.h  
TargetBitrateMegabits const FName   PixelStreamingStatNames.h  
TotalEncodeBytesTarget const FName   PixelStreamingStatNames.h  
TotalEncodeTime const FName   PixelStreamingStatNames.h  
TotalFreezesDuration const FName   PixelStreamingStatNames.h  
TotalInterruptionDuration const FName   PixelStreamingStatNames.h  
TotalPacketSendDelay const FName   PixelStreamingStatNames.h  
TotalPausesDuration const FName   PixelStreamingStatNames.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 PlayerIdToInt ( FPixelStreamingPlayerId PlayerId
)

   PixelStreamingPlayerId.h  

FPixelStreamingPlayerId ToPlayerId ( FString PlayerIdString
)

   PixelStreamingPlayerId.h  

FPixelStreamingPlayerId ToPlayerId ( int32 PlayerIdInteger
)

   PixelStreamingPlayerId.h  

const void * UE::PixelStreaming::ValueLoc ( T&& Value
)

   PixelStreamingBufferBuilder.h  

const void * UE::PixelStreaming::ValueLoc ( FString&& Value
)

   PixelStreamingBufferBuilder.h  

size_t UE::PixelStreaming::ValueSize ( T&& Value
)

   PixelStreamingBufferBuilder.h  

size_t UE::PixelStreaming::ValueSize ( FString&& Value
)

   PixelStreamingBufferBuilder.h  

UE_TRACE_CHANNEL_EXTERN ( PixelStreamingChannel,
PIXELSTREAMING_API
)

   PixelStreamingTrace.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page