Navigation
API > API/Runtime > API/Runtime/AudioExtensions
References
| Module | AudioExtensions |
| Header | /Engine/Source/Runtime/AudioExtensions/Public/IAudioParameterInterfaceRegistry.h |
| Include | #include "IAudioParameterInterfaceRegistry.h" |
Syntax
struct FParameterInterface
Remarks
Interface for parameterizing data provided to or coming from an executable audio unit (ex. Sound like a MetaSoundSource, arbitrary DSP graph like a MetaSoundPatch, etc.). Can be used generically for processing either logically at a control or Game Thread tick rate (ex. SoundCues), or by an underlying DSP operation via the Audio Render Thread or delegated task (ex. MetaSounds, custom SoundGenerator, etc.)
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TArray< FEnvironmentVariable > | Environment | |
 |
TArray< FInput > | Inputs | |
 |
TArray< FOutput > | Outputs | |
 |
TArray< FClassOptions > | UClassOptions |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
FParameterInterface
(
FName InName, |
Constructor used for parameter interface not limited to any particular UClass types. | |
 |
FParameterInterface
(
FName InName, |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
TArray< const UClass * > | ||
  |
const TArray< FEnvironmentVariable > & | Returns read-only array of environment variables. | |
  |
const TArray< FInput > & | GetInputs () |
Returns read-only array of inputs. |
  |
FName | GetName () |
|
  |
const TArray< FOutput > & | GetOutputs () |
Returns read-only array of outputs. |
  |
const UClass & | GetType () |
|
  |
const TArray< FClassOptions > & | If specified, options used to restrict a corresponding UClass that interface may be applied to. | |
  |
const FVersion & | GetVersion () |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FClassOptions | Options used to restrict a corresponding UClass that interface may be applied to. | |
 |
FEnvironmentVariable | Read-only variable that cannot be modified by the sound instance, and maybe shared amongst instances. | |
 |
FInput | ||
 |
FOutput | ||
 |
FVersion | Version of interface (higher numbers are more recent) |