Navigation
API > API/Plugins > API/Plugins/AVCodecsCore
Common coder base with a factory.
Usage: To be inherited by a domain implementation, see top of file.
| Name | TAVCoder< TDomain, void, void > |
| Type | class |
| Header File | /Engine/Plugins/Experimental/AVCodecs/AVCodecsCore/Source/AVCodecsCore/Public/AVCoder.h |
| Include Path | #include "AVCoder.h" |
Syntax
template<template< typename TResource=void, typename TConfig=void > typename TDomain>
class TAVCoder< TDomain, void, void > : public IAVCoder
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| RegisterPermutationsOf | Register a partially type-complete coder with the domain factory, but with multiple filter configurations and permuted typing. |
| TFactory | The individual factory type constructed by a call to Register. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FIsCompatible | TFunction< bool(TSharedRef< FAVDevice > const &, TSharedRef< FAVInstance > const &)> | Delegate used to test factory compatibility. | AVCoder.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Device | TSharedPtr< FAVDevice > | The physical device this coder runs on. | AVCoder.h | |
| Instance | TSharedPtr< FAVInstance > | The shared data cache of this coder. | AVCoder.h |
Functions
Public
Overridden from IAVCoder
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< FAVDevice > const & GetDevice() |
AVCoder.h | ||
virtual TSharedPtr< FAVInstance > const & GetInstance() |
AVCoder.h | ||
virtual FAVResult Open
(
TSharedRef< FAVDevice > const& NewDevice, |
Construct the underlying coder architecture on a physical device with a configuration. | AVCoder.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 CountSupported
(
TSharedRef< FAVDevice > const& NewDevice, |
Count the number of different coders that can be created to match this combination of resource and configuration. | AVCoder.h | |
static TSharedPtr< TDomain< TResource, TConfig > > Create
(
TSharedRef< FAVDevice > const& NewDevice, |
Create a type-safe coder if possible, open and ready for use. | AVCoder.h | |
static TSharedPtr< TDomain< TResource, TConfig > > Create
(
TSharedRef< FAVDevice > const& NewDevice, |
Create a type-safe coder if possible, open and ready for use. | AVCoder.h | |
static TSharedRef< TDomain< TResource, TConfig > > CreateChecked
(
TSharedRef< FAVDevice > const& NewDevice, |
Create a type-safe coder, open and ready for use. | AVCoder.h | |
static TSharedRef< TDomain< TResource, TConfig > > CreateChecked
(
TSharedRef< FAVDevice > const& NewDevice, |
Create a type-safe coder, open and ready for use. | AVCoder.h | |
| Internal getter for type-specific coder factories. | AVCoder.h | ||
static bool IsSupported () |
Checks if any coder can be created to match this combination of resource and configuration. | AVCoder.h | |
static bool IsSupported
(
TSharedRef< FAVDevice > const& NewDevice, |
Checks if any coder can be created to match this combination of resource and configuration. | AVCoder.h | |
static TFactory< TResource, TConfig > & Register
(
FIsCompatible const& IsCompatible |
Register a fully type-complete coder with the domain factory. | AVCoder.h | |
static TSharedPtr< TDomain< TResource, TConfig > > Wrap
(
TSharedPtr< TCoder > const& Child |
Wrap a fully typed child coder with a differently-typed outer encoder, to transform one resource/config type into another. | AVCoder.h |