1. Epic GamesDeveloper
  3. PixelStreaming

PixelStreaming

API > API/Plugins

Classes

  Type Name Description
Public struct BufferBuilder    
Public class FPixelStreamingCreateSessionDescriptionObserver    
Public class FPixelStreamingDataChannel A specialized representation of a WebRTC data channel for Pixel Streaming.  
Public class FPixelStreamingPeerConnection A specialized representation of a WebRTC peer connection for Pixel Streaming.  
Public struct FPixelStreamingPlayerConfig    
Public class 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_)  
Public class FPixelStreamingSettings A collection of static methods used to expose settings and their values to other modules dependedant on PixelStreaming  
Public class FPixelStreamingSignallingConnection A specialized signalling server connection object for web socket based Pixel Streaming signalling servers.  
Public struct FPixelStreamingSimulcastParameters A struct representing the simulcast paramaters used by PixelStreaming.  
Public class FPixelStreamingVideoInput The input of the Pixel Streaming system.  
Public class FPixelStreamingVideoInputBackBuffer Use this if you want to send the UE backbuffer as video input.  
Public class FPixelStreamingVideoInputI420 A Generic video input for I420 frames  
Public class FPixelStreamingVideoInputNV12 A Generic video input for NV12 frames  
Public class FPixelStreamingVideoInputPIEViewport An extension of the back buffer input that can handle PIE sessions.  
Public class FPixelStreamingVideoInputRenderTarget Use this if you want to send the contents of a render target.  
Public class FPixelStreamingVideoInputRHI A Generic video input for RHI frames  
Public class FWebRTCSoundGenerator An `ISoundGenerator_ implementation to pump some audio from WebRTC into this synth component  
Public class IPixelStreamingAudioConsumer Interface for consuming audio coming in from the browser.  
Public class IPixelStreamingAudioInput    
Public class IPixelStreamingAudioSink Interface for a sink that collects audio coming in from the browser and passes into into UE's audio system.  
Public class IPixelStreamingModule The public interface of the Pixel Streaming module.  
Public class IPixelStreamingSignallingConnection A specialized signalling server connection object for Pixel Streaming signalling servers.  
Public class IPixelStreamingSignallingConnectionObserver Callback interface for `FPixelStreamingSignallingConnection_  
Public class IPixelStreamingStreamer    
Public class UClass Blueprintable ClassGroup, Meta UPixelStreamingAudioComponent Allows in-engine playback of incoming WebRTC audio from a particular Pixel Streaming player/peer using their mic in the browser.  
Public class UClass UPixelStreamingDelegates    
Public class UClass Blueprintable ClassGroup, Meta UPixelStreamingInput Copyright Epic Games, Inc. All Rights Reserved.  

Constants

Name Description
INVALID_PLAYER_ID  
SFU_PLAYER_ID  

Typedefs

Name Description
FPixelStreamingPlayerId  

Enums

  Type Name Description
Public enum EPixelStreamingCodec    

Functions

  Type Name Description
Public function int32  
Public function FPixelStreamingPlayerId

ToPlayerId ( FString PlayerIdString
)

  
Public function FPixelStreamingPlayerId

ToPlayerId ( int32 PlayerIdInteger
)

  
Public function const void *  
Public function const void *  
Public function size_t  
Public function size_t  

Variables

  Type Name Description
Public variable const FName AvgSendDelay Public name, available to the world.
Public variable const FName Bitrate Public name, available to the world.
Public variable const FName BytesReceived Public name, available to the world.
Public variable const FName BytesSent Public name, available to the world.
Public variable const FName DecodedFramesPerSecond Public name, available to the world.
Public variable const FName EncodedFramesPerSecond Public name, available to the world.
Public variable const FName FirCount Public name, available to the world.
Public variable const FName Fps Public name, available to the world.
Public variable const FName FrameHeight Public name, available to the world.
Public variable const FName FramesCorrupted Public name, available to the world.
Public variable const FName FramesDecoded Public name, available to the world.
Public variable const FName FramesDropped Public name, available to the world.
Public variable const FName FramesEncoded Public name, available to the world.
Public variable const FName FramesPerSecond Public name, available to the world.
Public variable const FName FramesReceived Public name, available to the world.
Public variable const FName FramesReceivedPerSecond Public name, available to the world.
Public variable const FName FramesSent Public name, available to the world.
Public variable const FName FramesSentPerSecond Calculated stats.
Public variable const FName FrameWidth Public name, available to the world.
Public variable const FName FreezeCount Public name, available to the world.
Public variable const FName FullFramesLost Public name, available to the world.
Public variable const FName HugeFramesSent Public name, available to the world.
Public variable const FName InputController Public name, available to the world.
Public variable const FName InterruptionCount Public name, available to the world.
Public variable const FName JitterBufferDelay  
Public variable const FName JitterBufferTargetDelay Public name, available to the world.
Public variable const FName KeyFramesEncoded Public name, available to the world.
Public variable const FName MeanEncodeTime Public name, available to the world.
Public variable const FName MeanQPPerSecond Public name, available to the world.
Public variable const FName MeanSendDelay Public name, available to the world.
Public variable const FName NackCount Public name, available to the world.
Public variable const FName PartialFramesLost Public name, available to the world.
Public variable const FName PauseCount Public name, available to the world.
Public variable const FName PliCount Public name, available to the world.
Public variable const FName QPSum Public name, available to the world.
Public variable const FName QualityController Public name, available to the world.
Public variable const FName RetransmittedBytesSent Public name, available to the world.
Public variable const FName SliCount Public name, available to the world.
Public variable const FName SourceFps Public name, available to the world.
Public variable const FName TargetBitrate Public name, available to the world.
Public variable const FName TotalEncodeBytesTarget Public name, available to the world.
Public variable const FName TotalEncodeTime Public name, available to the world.
Public variable const FName TotalFreezesDuration Public name, available to the world.
Public variable const FName TotalInterruptionDuration Public name, available to the world.
Public variable const FName TotalPacketSendDelay Public name, available to the world.
Public variable const FName TotalPausesDuration Public name, available to the world.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page