Navigation
API > API/Runtime > API/Runtime/AudioExtensions
Inheritance Hierarchy
- ILegacyParameterTransmitter
- IParameterTransmitter
- FParameterTransmitterBase
- FMetaSoundParameterTransmitter
- FSoundCueParameterTransmitter
References
| Module | AudioExtensions |
| Header | /Engine/Source/Runtime/AudioExtensions/Public/IAudioParameterTransmitter.h |
| Include | #include "IAudioParameterTransmitter.h" |
Syntax
class FParameterTransmitterBase : public Audio::IParameterTransmitter
Remarks
Base implementation for the parameter transmitter, which caches parameters and provides implementer to add additional logic to route parameter data accordingly.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FAudioParameter > | AudioParameters |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FParameterTransmitterBase
(
TArray< FAudioParameter >&& InDefaultParams |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Overridden from IParameterTransmitter
| Type | Name | Description | |
|---|---|---|---|
| bool | GetParameter
(
FName InName, |
Return the cached parameter with the given name if it exists | |
| const TArray< FAudioParameter > & | Return reference to the cached parameter array. | ||
| void | Reset parameters which stored on the transmitter. | ||
| bool | SetParameters
(
TArray< FAudioParameter >&& InParameters |
Parameter Setters. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | Reset () |
Use ResetParameters() or OnDeleteActiveSound() instead depending on use case. |