PixelStreaming

Choose your operating system:

Windows

macOS

Linux

Classes

Name

Description

Public class

IPixelStreamingAudioConsumer

Interface for consuming audio coming in from the browser.

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 to this module

Public class

IPixelStreamingStatsConsumer

Interface for consuming stats from Pixel Streaming, simply implement and do as you wish with the stats.

Public class UClass Blueprintable ClassGroup, Meta

UPixelStreamerInputComponent

This component may be attached to an actor to allow UI interactions to be handled as the delegate will be notified about the interaction and will be supplied with a generic descriptor string containing, for example, JSON data.

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 Meta Config defaultconfig

UPixelStreamingSettings

Config loaded/saved to an .ini file. It is also exposed through the plugin settings page in editor.

Constants

Name

Description

INVALID_PLAYER_ID

SFU_PLAYER_ID

Typedefs

Name

Description

FPlayerId

Functions

Name Description

Public function

int32

 

PlayerIdToInt

(
    FPlayerId PlayerId
)

Public function

FPlayerId

 

ToPlayerId

(
    FString PlayerIdString
)

Public function

FPlayerId

 

ToPlayerId

(
    int32 PlayerIdInteger
)

Variables

Name Description

Public variable

const FName

 

Bitrate

Public name, available to the world.

Public variable

const FName

 

BytesSent

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

 

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

 

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

 

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

IPixelStreaming...

 

OnReady

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

 

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.