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 IParameterTransmitter : public Audio::ILegacyParameterTransmitter
Remarks
Interface for a audio instance transmitter.
An audio instance transmitter ushers control parameters to a single audio object instance.
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| 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 | Called when the active sound is deleted due to the sound finishing, being stopped, or being virtualized. | ||
| void | OnRealizeVirtualizedActiveSound
(
TArray< FAudioParameter >&& InParameters |
Called when the virtualized active sound is realized | |
| void | Called when the active sound is virtualized | ||
| bool | Reset () |
||
| void | Reset parameters which stored on the transmitter. | ||
| bool | SetParameters
(
TArray< FAudioParameter >&& InParameters |
Parameter Setters. |
Constants
| Name | Description |
|---|---|
| RouterName |