Navigation
API > API/Plugins > API/Plugins/AVCodecsCore
Inheritance Hierarchy
- TDomain< TResource >
- TAVCoder
- TAudioDecoder
- TAudioDecoder<>
- TAudioEncoder
- FAudioEncoderWMF
- TAudioEncoder<>
- TVideoDecoder
- FVideoDecoderNVDEC
- TVideoDecoderAMF
- TVideoDecoderLibVpxVP8
- TVideoDecoderLibVpxVP9
- TVideoDecoderRHI
- TVideoDecoder<>
- TVideoEncoder
- FVideoEncoderNVENCCUDA
- TVideoEncoderAMF
- TVideoEncoderLibVpxVP8
- TVideoEncoderLibVpxVP9
- TVideoEncoderRHI
- TVideoEncoder<>
References
| Module | AVCodecsCore |
| Header | /Engine/Plugins/Experimental/AVCodecs/AVCodecsCore/Source/AVCodecsCore/Public/AVCoder.h |
| Include | #include "AVCoder.h" |
Syntax
template<template< typename TResource=void, typename TConfig=void > typename TDomain, typename TResource, typename TConfig>
class TAVCoder : public TDomain< TResource >
Remarks
HOW TO USE
Terms:
- Domain: A specialized area of coding, such as 'video encoding', 'video decoding', 'audio decoding', 'subtitle encoding', etc.
- Configuration: An external collection of parameters that determine how the coder's underlying architecture is created and operates.
- Instance: The shared data cache of a coder. Contains all current state and configuration applied to a coder.
- Resource: An abstract wrapper to device memory used by a coder (can be on the CPU/GPU or an external device).
- Device: The physical hardware or software device that a coder operates on. Provides access to coder resources.
- Packet: A segment of a raw bitstream that contains any amount of frame data. Encoders create these and decoders consume them.
TAVCoder uses an 'interleaved' inheritance model between itself and a 'domain', to support inheritance of select functionality (full, config-less, resource+config-less).
1) TVideoDecoder
Common coder base with a factory, that supports typesafe resource handling and configuration.
Usage: To be inherited by a domain implementation, see top of file.
Specializations
TAVCoder< TDomain, TResource, void >
TAVCoder< TDomain, void, void >
Variables
| Type | Name | Description | |
|---|---|---|---|
| TConfig | AppliedConfig | The currently active configuration, for comparison with PendingConfig. Never modify this directly. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FAVResult | ApplyConfig () |
Force any pending configuration to apply. | |
| TConfig & | |||
| TConfig const & | |||
| TConfig const & | |||
| void | SetPendingConfig
(
TConfig const& NewPendingConfig |
Set the pending configuration, to be applied on the next call to ApplyConfig. |
Classes
| Type | Name | Description | |
|---|---|---|---|
| TWrapper | Wrapper coder that transforms resource/config types for use with a differently typed child coder. |
Typedefs
| Name | Description |
|---|---|
| ConfigType |