Navigation
API > API/Plugins > API/Plugins/PixelStreaming
The input of the Pixel Streaming system. Frames enter the system when OnFrame is called. The input buffers might need to be converted/adapted to suit the selected video encoder. CreateAdaptProcess should create a PixelStreamingFrameAdapterProcess that does this work.
| Name | FPixelStreamingVideoInput |
| Type | class |
| Header File | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamingVideoInput.h |
| Include Path | #include "PixelStreamingVideoInput.h" |
Syntax
class FPixelStreamingVideoInput : public IPixelCaptureCapturerSource
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPixelStreamingVideoInput() |
PixelStreamingVideoInput.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FPixelStreamingVideoInput() |
PixelStreamingVideoInput.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnFrameCaptured | TMulticastDelegate_NoParams< void > | This is broadcast each time a frame exits the adapt process. | PixelStreamingVideoInput.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NextStreamId | uint32 | PixelStreamingVideoInput.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnFrameCaptured | FOnFrameCaptured | PixelStreamingVideoInput.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CaptureCompleteHandle | FDelegateHandle | PixelStreamingVideoInput.h | ||
| FrameCapturer | TSharedPtr< FPixelCaptureCapturerMultiFormat > | PixelStreamingVideoInput.h | ||
| LastFrameHeight | int32 | PixelStreamingVideoInput.h | ||
| LastFrameWidth | int32 | PixelStreamingVideoInput.h | ||
| PreInitFormats | TSet< int32 > | PixelStreamingVideoInput.h | ||
| Ready | bool | PixelStreamingVideoInput.h | ||
| StreamId | uint32 | Video inputs need a unique stream id so we can properly divide hardware encoders between inputs | PixelStreamingVideoInput.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddOutputFormat
(
int32 Format |
PixelStreamingVideoInput.h | ||
rtc::scoped_refptr< webrtc::VideoFrameBuffer > GetEmptyFrameBuffer() |
Used internally by the encode process. | PixelStreamingVideoInput.h | |
rtc::scoped_refptr< webrtc::VideoFrameBuffer > GetFrameBuffer() |
Used internally by the encode process. | PixelStreamingVideoInput.h | |
bool IsReady() |
PixelStreamingVideoInput.h | ||
virtual void OnFrame
(
const IPixelCaptureInputFrame& InputFrame |
Feed the input with a new captured frame. | PixelStreamingVideoInput.h | |
TSharedPtr< IPixelCaptureOutputFrame > RequestFormat
(
int32 Format, |
PixelStreamingVideoInput.h | ||
virtual FString ToString() |
A human readable identifier used when displaying what the streamer is streaming in the toolbar | PixelStreamingVideoInput.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static uint32 GetUniqueStreamId() |
PixelStreamingVideoInput.h |