Navigation
API > API/Plugins > API/Plugins/AudioModulation
Inheritance Hierarchy
- TSharedFromThis
- IAudioModulationManager
- FAudioModulationManager
References
| Module | AudioModulation |
| Header | /Engine/Plugins/Runtime/AudioModulation/Source/AudioModulation/Public/AudioModulation.h |
| Include | #include "AudioModulation.h" |
Syntax
class FAudioModulationManager : public IAudioModulationManager
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | ActivateBus
(
const USoundControlBus& InBus |
||
| void | ActivateBusMix
(
const USoundControlBusMix& InBusMix |
||
| void | ActivateGenerator
(
const USoundModulationGenerator& InGenerator |
||
| void | ClearAllGlobalBusMixValues
(
float InFadeTime |
||
| void | ClearGlobalBusMixValue
(
const USoundControlBus& InBus, |
||
| void | |||
| void | DeactivateBus
(
const USoundControlBus& InBus |
||
| void | DeactivateBusMix
(
const USoundControlBusMix& InBusMix |
||
| void | DeactivateGenerator
(
const USoundModulationGenerator& InGenerator |
||
| float | GetModulatorValueThreadSafe
(
uint32 ModulationID |
||
| FAudioModulationSystem & | GetSystem () |
||
| TArray< FSoundControlBusMixStage > | LoadMixFromProfile
(
const int32 InProfileIndex, |
||
| void | SaveMixToProfile
(
const USoundControlBusMix& InBusMix, |
||
| void | SetDebugBusFilter
(
const FString* InFilter |
||
| void | SetDebugGeneratorFilter
(
const FString* InFilter |
||
| void | SetDebugGeneratorsEnabled
(
bool bInIsEnabled |
||
| void | SetDebugGeneratorTypeFilter
(
const FString* InFilter, |
||
| void | SetDebugMatrixEnabled
(
bool bInIsEnabled |
||
| void | SetDebugMixFilter
(
const FString* InFilter |
||
| void | SetGlobalBusMixValue
(
USoundControlBus& InBus, |
||
| void | SoloBusMix
(
const USoundControlBusMix& InBusMix |
||
| void | UpdateMix
(
const USoundControlBusMix& InMix, |
||
| void | UpdateMix
(
const TArray< FSoundControlBusMixStage >& InStages, |
||
| void | UpdateMixByFilter
(
const FString& InAddressFilter, |
Overridden from IAudioModulationManager
| Type | Name | Description | |
|---|---|---|---|
| bool | GetModulatorValue
(
const Audio::FModulatorHandle& ModulatorHandle, |
Get the modulator value from the AudioRender Thread. | |
| bool | GetModulatorValueThreadSafe
(
const Audio::FModulatorHandle& ModulatorHandle, |
Get the modulator value from any thread. | |
| void | Initialize
(
const FAudioPluginInitializationParams& InitializationParams |
Initialize the modulation plugin with the same rate and number of sources | |
| void | |||
| bool | OnPostHelp
(
FCommonViewportClient* ViewportClient, |
Request to post help from active plugin (non-shipping builds only) | |
| int32 | OnRenderStat
(
FViewport* Viewport, |
Render stats pertaining to modulation (non-shipping builds only) | |
| bool | OnToggleStat
(
FCommonViewportClient* ViewportClient, |
Toggle showing render stats pertaining to modulation (non-shipping builds only) | |
| void | ProcessModulators
(
const double InElapsed |
UE_BUILD_SHIPPING. | |
| void | RegisterModulator
(
Audio::FModulatorHandleId InHandleId, |
||
| void | UnregisterModulator
(
const Audio::FModulatorHandle& InHandle |
||
| void | UpdateModulator
(
const USoundModulatorBase& InModulator |
Updates modulator definition on the AudioRender Thread with that provided by the UObject representation |