Navigation
API > API/Plugins > API/Plugins/PixelCapture > API/Plugins/PixelCapture/FPixelCaptureCapturerMultiFormat
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IPixelCaptureOutputFrame > WaitForFormat
(
int32 Format, |
Like RequestFormat except if the format does not exist it will add it and then wait for the format to have output. | PixelCaptureCapturerMultiFormat.h | |
TSharedPtr< IPixelCaptureOutputFrame > WaitForFormat
(
int32 Format, |
Like RequestFormat except if the format does not exist it will add it and then wait for the format to have output. | PixelCaptureCapturerMultiFormat.h |
WaitForFormat(int32, FIntPoint, uint32)
Description
Like RequestFormat except if the format does not exist it will add it and then wait for the format to have output. NOTE: This will block the calling thread so it is important that the capture process is not dependent on this calling thread or we will deadlock.
| Name | WaitForFormat |
| Type | function |
| Header File | /Engine/Plugins/Media/PixelCapture/Source/PixelCapture/Public/PixelCaptureCapturerMultiFormat.h |
| Include Path | #include "PixelCaptureCapturerMultiFormat.h" |
| Source | /Engine/Plugins/Media/PixelCapture/Source/PixelCapture/Private/PixelCaptureCapturerMultiFormat.cpp |
TSharedPtr < IPixelCaptureOutputFrame > WaitForFormat
(
int32 Format,
FIntPoint LayerSize,
uint32 MaxWaitTime
)
The final buffer of a given format or null in case of timeout or the capturer has been disconnected.
Parameters
| Name | Remarks |
|---|---|
| Format | The format we want the output in. |
| LayerSize | The resolution of the layer we want to get the output of. |
| MaxWaitTime | The max number of milliseconds to wait for a frame. Default is 5 seconds. |
WaitForFormat(int32, int32, uint32)
Description
Like RequestFormat except if the format does not exist it will add it and then wait for the format to have output. NOTE: This will block the calling thread so it is important that the capture process is not dependent on this calling thread or we will deadlock.
| Name | WaitForFormat |
| Type | function |
| Header File | /Engine/Plugins/Media/PixelCapture/Source/PixelCapture/Public/PixelCaptureCapturerMultiFormat.h |
| Include Path | #include "PixelCaptureCapturerMultiFormat.h" |
TSharedPtr < IPixelCaptureOutputFrame > WaitForFormat
(
int32 Format,
int32 LayerIndex,
uint32 MaxWaitTime
)
The final buffer of a given format or null in case of timeout or the capturer has been disconnected.
Parameters
| Name | Remarks |
|---|---|
| Format | The format we want the output in. |
| LayerIndex | The layer we want to get the output of. |
| MaxWaitTime | The max number of milliseconds to wait for a frame. Default is 5 seconds. |