Navigation
API > API/Plugins > API/Plugins/AudioExperimentalRuntime
Base type for all "channel" based types.
| Name | FChannelTypeFamily |
| Type | class |
| Header File | /Engine/Plugins/Experimental/MetasoundExperimental/Source/AudioExperimentalRuntime/Public/TypeFamily/ChannelTypeFamily.h |
| Include Path | #include "TypeFamily/ChannelTypeFamily.h" |
Syntax
class FChannelTypeFamily : public Audio::FTypeFamily
Inheritance Hierarchy
- FTypeFamily → FChannelTypeFamily
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| TypeFamily/ChannelTypeFamily.h | |||
FChannelTypeFamily
(
const FChannelTypeFamily& |
TypeFamily/ChannelTypeFamily.h | ||
FChannelTypeFamily
(
const FName& InUniqueName, |
Constructor. | TypeFamily/ChannelTypeFamily.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FChannelTypeFamily() |
TypeFamily/ChannelTypeFamily.h |
Structs
| Name | Remarks |
|---|---|
| FChannelName | Returns the name of the channel. For discrete this would be what speaker its mapped to etc. |
| FGetTranscoderParams | Parameters to pass to GetTranscoder To be expanded. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FTranscoder | TFunction< void(TArrayView< const float * >, TArrayView< float * >, const int32 NumFrames)> | Transcoder function object. | TypeFamily/ChannelTypeFamily.h |
| Super | FTypeFamily | TypeFamily/ChannelTypeFamily.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsAbstract | bool | TypeFamily/ChannelTypeFamily.h | ||
| bIsParentsDefault | bool | TypeFamily/ChannelTypeFamily.h | ||
| DefaultChild | const FChannelTypeFamily * | TypeFamily/ChannelTypeFamily.h | ||
| FamilyType | FName | TypeFamily/ChannelTypeFamily.h | ||
| NumChannelsPrivate | int32 | TypeFamily/ChannelTypeFamily.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Accept
(
IChannelTypeVisitor& InVisitor |
TypeFamily/ChannelTypeFamily.h | ||
T * Cast () |
TypeFamily/ChannelTypeFamily.h | ||
const T * Cast () |
TypeFamily/ChannelTypeFamily.h | ||
virtual TOptional< FChannelName > GetChannelName
(
const int32 InChannelIndex |
TypeFamily/ChannelTypeFamily.h | ||
const FChannelTypeFamily * GetDefaultChild() |
Returns the default child if one exists. Example. "Stereo" would return "Stereo_2_0" | TypeFamily/ChannelTypeFamily.h | |
| Returns the family name (C++ type) of this ChannelType. | TypeFamily/ChannelTypeFamily.h | ||
FTranscoder GetTranscoder
(
const FGetTranscoderParams& InParam |
Get the function used for translating/transcoding between this and the "To" type. | TypeFamily/ChannelTypeFamily.h | |
bool IsAbstract() |
If this type can be instantiated or is just organisational. | TypeFamily/ChannelTypeFamily.h | |
bool IsParentsDefault() |
If this is marked as being the default on its parent | TypeFamily/ChannelTypeFamily.h | |
int32 NumChannels() |
Num of channels | TypeFamily/ChannelTypeFamily.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChannelTypeFamily & operator=
(
const FChannelTypeFamily& |
TypeFamily/ChannelTypeFamily.h | ||
| TypeFamily/ChannelTypeFamily.h |