Navigation
API > API/Plugins > API/Plugins/ElectraCodecFactory > API/Plugins/ElectraCodecFactory/IElectraCodecFactory
Description
Queries whether or not this codec factory can create a decoder or encoder of the specified format. The codec format string is the "codecs" part (RFC 6381) of a MIME type like "video/mp4" (RFC 6838).
For example (back quote characters ``are for clarity only, they do not appear in actual strings): _avc1.4d002aif the full MIME type were_video/mp4; codecs="avc1.4d002a"_mp4a.40.2if the full MIME type were_audio/mp4; codecs="mp4a.40.2"
Note that only a single format must be specified. Should there be several codecs specified in a MIME type they must be separated and each format queried for individually.
Format profiles may be omitted if they are not known. Asking for an `avc1_ decoder might result in a supported decoder, but there is no guarantee that it is capable of decoding every profile.
Format names are case sensitive. Profile case depends on the format.
Additional options may be provided to specify the format more closely, which may help selecting the best suited implementation. See below.
Returns 0 if not supported. If supported the return value indicates a priority value. If multiple factories are registered that claim support for the format the one with the highest priority is chosen.
| Name | SupportsFormat |
| Type | function |
| Header File | /Engine/Plugins/Media/ElectraCodecs/Source/ElectraCodecFactory/Public/IElectraCodecFactory.h |
| Include Path | #include "IElectraCodecFactory.h" |
int32 SupportsFormat
(
TMap < FString, FVariant > & OutFormatInfo,
const FString & InCodecFormat,
bool bInEncoder,
const TMap < FString, FVariant > & InOptions
) const