Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Audio
Inheritance Hierarchy
- IInterface
- IAudioParameterControllerInterface
- ISoundParameterControllerInterface
- UAudioComponent
- UAudioCurveSourceComponent
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/Audio/SoundParameterControllerInterface.h |
| Include | #include "Audio/SoundParameterControllerInterface.h" |
Syntax
class ISoundParameterControllerInterface : public IAudioParameterControllerInterface
Remarks
UObject interface for all object types that are controlling parameter values sent to sound instances (i.e. sources)
Functions
| Type | Name | Description | |
|---|---|---|---|
| FAudioDevice * | Returns the active audio device to use for this component based on whether or not the component is playing in a world. | ||
| bool | |||
| uint64 | Returns the id of the sound owner's instance associated with the parameter interface. | ||
| TArray< FAudioParameter > & | Returns the Game Thread copy of parameters to modify in place. | ||
| USoundBase * | GetSound () |
Returns the USoundBase used to initialize instance parameters to update. | |
| bool | IsPlaying () |
Overridden from IAudioParameterControllerInterface
| Type | Name | Description | |
|---|---|---|---|
| void | Resets all parameters to their original values. | ||
| void | SetBoolArrayParameter
(
FName InName, |
Sets a named Boolean Array. | |
| void | SetBoolParameter
(
FName InName, |
Sets a named Boolean. | |
| void | SetFloatArrayParameter
(
FName InName, |
Sets a named Float Array. | |
| void | SetFloatParameter
(
FName InName, |
Sets a named Float. | |
| void | SetIntArrayParameter
(
FName InName, |
Sets a named Int32 Array. | |
| void | SetIntParameter
(
FName InName, |
Sets a named Int32. | |
| void | SetObjectArrayParameter
(
FName InName, |
Sets a named UObject Array. | |
| void | SetObjectParameter
(
FName InName, |
Sets a named UObject. | |
| void | SetParameter
(
FAudioParameter&& InValue |
Sets a named parameter to the given parameter structure value. | |
| void | SetParameters
(
TArray< FAudioParameter >&& InValues |
Sets an array of parameters as a batch. | |
| void | SetParameters_Blueprint
(
const TArray< FAudioParameter >& InParameters |
Sets an array of parameters as a batch. | |
| void | SetStringArrayParameter
(
FName InName, |
Sets a named String Array. | |
| void | SetStringParameter
(
FName InName, |
Sets a named String. | |
| void | SetTriggerParameter
(
FName InName |
Executes a named trigger. |