Navigation
API > API/Plugins > API/Plugins/PixelStreaming
Inheritance Hierarchy
- IPixelCaptureCapturerSource
- FPixelStreamingVideoInput
- FPixelStreamingVideoInputI420
- FPixelStreamingVideoInputNV12
- FPixelStreamingVideoInputRHI
- FPixelStreamingVideoInputBackBuffer
- FPixelStreamingVideoInputBackBufferComposited
- FPixelStreamingVideoInputPIEViewport
- FPixelStreamingVideoInputRenderTarget
- FPixelStreamingVideoInputVCam
- FPixelStreamingVideoInputViewport
References
| Module | PixelStreaming |
| Header | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamingVideoInput.h |
| Include | #include "PixelStreamingVideoInput.h" |
Syntax
class FPixelStreamingVideoInput : public IPixelCaptureCapturerSource
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
| FOnFrameCaptured | OnFrameCaptured |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddOutputFormat
(
int32 Format |
||
| rtc::scoped_refptr< webrtc::VideoFrameBuffer > | Used internally by the encode process. | ||
| bool | IsReady () |
||
| void | OnFrame
(
const IPixelCaptureInputFrame& InputFrame |
Feed the input with a new captured frame. | |
| TSharedPtr< IPixelCaptureOutputFrame > | RequestFormat
(
int32 Format, |
||
| FString | ToString () |
A human readable identifier used when displaying what the streamer is streaming in the toolbar |
Typedefs
| Name | Description |
|---|---|
| FOnFrameCaptured | This is broadcast each time a frame exits the adapt process. |
Constants
| Name | Description |
|---|---|
| NextStreamId |