Navigation
API > API/Plugins > API/Plugins/AvidDNxMedia
Encoder class that takes sRGB 8-bit RGBA data and encodes it to AvidDNxHR or AvidDNxHD before placing it in an mxf container. The mxf container writer currently implemented does not support audio, so audio writing APIs have been omitted from this encoder.
| Name | FAvidDNxEncoder |
| Type | class |
| Header File | /Engine/Plugins/Media/AvidDNxMedia/Source/Source/Public/AvidDNxEncoder/AvidDNxEncoder.h |
| Include Path | #include "AvidDNxEncoder/AvidDNxEncoder.h" |
Syntax
class FAvidDNxEncoder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAvidDNxEncoder
(
const FAvidDNxEncoderOptions& InOptions |
AvidDNxEncoder/AvidDNxEncoder.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAvidDNxEncoder() |
AvidDNxEncoder/AvidDNxEncoder.h |
Structs
| Name | Remarks |
|---|---|
| FRGB_16bit | 16-bit RGB color. |
| FY0CbY1Cr | 8-bit sub-sampled YCbCr color. |
| FY0CbY1Cr_16bit | 16-bit sub-sampled YCbCr color. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFinalized | bool | AvidDNxEncoder/AvidDNxEncoder.h | ||
| bInitialized | bool | AvidDNxEncoder/AvidDNxEncoder.h | ||
| DNxHRencoder | DNX_Encoder | Encoder used for compressed output. | AvidDNxEncoder/AvidDNxEncoder.h | |
| DNxUncCompressedParams | DNXUncompressed_CompressedParams_t | AvidDNxEncoder/AvidDNxEncoder.h | ||
| DNxUncEncoder | DNXUncompressed_Encoder * | Encoder used for uncompressed output. | AvidDNxEncoder/AvidDNxEncoder.h | |
| DNxUncUncompressedParams | DNXUncompressed_UncompressedParams_t | AvidDNxEncoder/AvidDNxEncoder.h | ||
| EncodedBufferSize | int32 | How big each video sample is after compression based on given settings. | AvidDNxEncoder/AvidDNxEncoder.h | |
| MXFwriter | DNXMXF_Writer * | AvidDNxEncoder/AvidDNxEncoder.h | ||
| Options | FAvidDNxEncoderOptions | AvidDNxEncoder/AvidDNxEncoder.h | ||
| WriteEndTimeSeconds | double | When encoding and writing a frame finished. | AvidDNxEncoder/AvidDNxEncoder.h | |
| WriteStartTimeSeconds | double | When encoding and writing a frame started. | AvidDNxEncoder/AvidDNxEncoder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Finalize () |
Finalize the video file and finish writing it to disk. | AvidDNxEncoder/AvidDNxEncoder.h | |
const FAvidDNxEncoderOptions & GetOptions() |
Gets the options that the encoder was initialized with. | AvidDNxEncoder/AvidDNxEncoder.h | |
bool Initialize() |
Call to initialize the encoder. This must be done before attempting to write data to it. | AvidDNxEncoder/AvidDNxEncoder.h | |
bool WriteFrame
(
const uint8* InFrameData |
Appends a new frame onto the output file (8-bit). | AvidDNxEncoder/AvidDNxEncoder.h | |
bool WriteFrame_16bit
(
const FFloat16Color* InFrameData |
Appends a new frame onto the output file (16-bit). | AvidDNxEncoder/AvidDNxEncoder.h |