Navigation
API > API/Runtime > API/Runtime/MediaUtils
Records samples from a media player. Loop, seek or reverse and not supported. Currently only records texture samples and that support sample format 8bit BGRA, half float RBGA
| Name | FMediaRecorder |
| Type | class |
| Header File | /Engine/Source/Runtime/MediaUtils/Public/MediaRecorder.h |
| Include Path | #include "MediaRecorder.h" |
Syntax
class FMediaRecorder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMediaRecorder() |
Default constructor. | MediaRecorder.h |
Structs
| Name | Remarks |
|---|---|
| FMediaRecorderData |
Enums
Public
| Name | Remarks |
|---|---|
| EMediaRecorderNumerationStyle |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BaseFilename | FString | Media Recorder Data saved options. | MediaRecorder.h | |
| bRecording | bool | Whether recording is in progress. | MediaRecorder.h | |
| bSetAlpha | bool | MediaRecorder.h | ||
| bUnsupportedWarningShowed | bool | Warning for unsupported format have been showed. | MediaRecorder.h | |
| ClockSink | TSharedPtr< FMediaRecorderClockSink, ESPMode::ThreadSafe > | The recorder's media clock sink. | MediaRecorder.h | |
| CompletedFence | TFuture< void > | MediaRecorder.h | ||
| CompressionQuality | int32 | MediaRecorder.h | ||
| FrameCount | int32 | Number of frames recorded. | MediaRecorder.h | |
| ImageWriteQueue | IImageWriteQueue * | The image writer. | MediaRecorder.h | |
| NumerationStyle | EMediaRecorderNumerationStyle | MediaRecorder.h | ||
| SampleQueue | TSharedPtr< FMediaTextureSampleQueue, ESPMode::ThreadSafe > | Texture sample queue. | MediaRecorder.h | |
| TargetImageFormat | EImageFormat | MediaRecorder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsRecording() |
Is currently recording media samples. | MediaRecorder.h | |
void StartRecording
(
const FMediaRecorderData& InRecoderData |
Start recording samples from a given media player. | MediaRecorder.h | |
void StopRecording() |
Stop recording media samples. | MediaRecorder.h | |
bool WaitPendingTasks
(
const FTimespan& InDuration |
Blocking call that will wait for all frames to be recorded before returning. | MediaRecorder.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void TickRecording() |
Tick the recorder. | MediaRecorder.h |