Navigation
API > API/Runtime > API/Runtime/AudioExtensions
Interface for a audio instance transmitter.
An audio instance transmitter ushers control parameters to a single audio object instance.
| Name | IParameterTransmitter |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioExtensions/Public/IAudioParameterTransmitter.h |
| Include Path | #include "IAudioParameterTransmitter.h" |
Syntax
class IParameterTransmitter : public Audio::ILegacyParameterTransmitter
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IParameterTransmitter() |
IAudioParameterTransmitter.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| RouterName | const FName | IAudioParameterTransmitter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CopyParameters
(
TArray< FAudioParameter >& OutParameters |
IAudioParameterTransmitter.h | ||
bool GetParameter
(
FName InName, |
Return the cached parameter with the given name if it exists | IAudioParameterTransmitter.h | |
const TArray< FAudioParameter > & GetParameters() |
Return reference to the cached parameter array. | IAudioParameterTransmitter.h | |
virtual void OnDeleteActiveSound() |
Called when the active sound is deleted due to the sound finishing, being stopped, or being virtualized. | IAudioParameterTransmitter.h | |
virtual void OnRealizeVirtualizedActiveSound
(
TArray< FAudioParameter >&& InParameters |
Called when the virtualized active sound is realized | IAudioParameterTransmitter.h | |
virtual void OnVirtualizeActiveSound() |
Called when the active sound is virtualized | IAudioParameterTransmitter.h | |
virtual void ResetParameters() |
Reset parameters which stored on the transmitter. | IAudioParameterTransmitter.h | |
bool SetParameters
(
TArray< FAudioParameter >&& InParameters |
Parameter Setters. | IAudioParameterTransmitter.h |