unreal.AudioModulationStatics?

class unreal.AudioModulationStatics(outer=None, name='None')?

Bases: unreal.BlueprintFunctionLibrary

namespace AudioModulation

C++ Source:

  • Plugin: AudioModulation
  • Module: AudioModulation
  • File: AudioModulationStatics.h
classmethod activate_bus(world_context_object, bus) → None?

Activates a bus. Does nothing if an instance of the provided bus is already active

Parameters:
classmethod activate_bus_mix(world_context_object, bus_mix) → None?

Activates a bus modulator mix. Does nothing if an instance of the provided bus mix is already active

Parameters:
classmethod activate_bus_modulator(world_context_object, modulator) → None?

Activates a bus modulator (eg. LFO). Does nothing if an instance of the provided modulator is already active

Parameters:
classmethod create_bus_mix(world_context_object, name, channels, activate) → SoundControlBusMix?

Creates a modulation bus mix and adds a bus channel set to the provided target value

Parameters:
Returns:

Return type:

SoundControlBusMix

classmethod create_bus_mix_channel(world_context_object, bus, value, attack_time=0.100000, release_time=0.100000) → SoundControlBusMixChannel?

Creates a channel used to mix a control bus.

Parameters:
Returns:

Return type:

SoundControlBusMixChannel

classmethod create_hpf_bus(world_context_object, name, default_value, activate=True) → SoundHPFControlBus?

Creates a high-pass filter (HPF) modulation bus with the provided default value.

Parameters:
  • world_context_object (Object) –
  • name (Name) – Name of bus
  • default_value (float) – Default value for created bus
  • activate (bool) – Whether or not to activate bus on creation.
Returns:

Return type:

SoundHPFControlBus

classmethod create_lfo(world_context_object, name, amplitude, frequency, offset, activate=True) → SoundBusModulatorLFO?

Creates an LFO modulator.

Parameters:
  • world_context_object (Object) –
  • name (Name) – Name of LFO
  • amplitude (float) – Amplitude of new LFO.
  • frequency (float) – Frequency of new LFO.
  • offset (float) – Offset of new LFO.
  • activate (bool) – Whether or not to activate lfo on creation.
Returns:

Return type:

SoundBusModulatorLFO

classmethod create_lpf_bus(world_context_object, name, default_value, activate=True) → SoundLPFControlBus?

Creates a low-pass filter (LPF) modulation bus with the provided default value.

Parameters:
  • world_context_object (Object) –
  • name (Name) – Name of bus
  • default_value (float) – Default value for created bus
  • activate (bool) – Whether or not to activate bus on creation.
Returns:

Return type:

SoundLPFControlBus

classmethod create_pitch_bus(world_context_object, name, default_value, activate=True) → SoundPitchControlBus?

Creates a pitch modulation bus with the provided default value.

Parameters:
  • world_context_object (Object) –
  • name (Name) – Name of bus
  • default_value (float) – Default value for created bus
  • activate (bool) – Whether or not to activate bus on creation.
Returns:

Return type:

SoundPitchControlBus

classmethod create_volume_bus(world_context_object, name, default_value, activate) → SoundVolumeControlBus?

Creates a volume modulation bus with the provided default value.

Parameters:
  • world_context_object (Object) –
  • name (Name) – Name of bus
  • default_value (float) – Default value for created bus
  • activate (bool) – Whether or not to activate bus on creation.
Returns:

Return type:

SoundVolumeControlBus

classmethod deactivate_bus(world_context_object, bus) → None?

Deactivates a bus. Does nothing if an instance of the provided bus is already inactive

Parameters:
classmethod deactivate_bus_mix(world_context_object, bus_mix) → None?

Deactivates a modulation bus mix. Does nothing if an instance of the provided bus mix is already inactive

Parameters:
classmethod deactivate_bus_modulator(world_context_object, modulator) → None?

Deactivates a bus modulator. Does nothing if an instance of the provided bus mix is already inactive

Parameters:
classmethod load_mix_from_profile(world_context_object, bus_mix, activate=True, profile_index=0) -> Array(SoundControlBusMixChannel)?

Loads control bus mix from a profile into UObject mix definition, deserialized from an ini file.

Parameters:
  • world_context_object (Object) –
  • bus_mix (SoundControlBusMix) – Mix object to deserialize profile .ini to.
  • activate (bool) – If true, activate mix upon loading from profile.
  • profile_index (int32) – Index of profile, allowing multiple profiles to be loaded to single mix object. If <= 0, loads from default profile (no suffix).
Returns:

Channels - Channel values loaded from profile (empty if profile did not exist or had no values serialized).

Return type:

Array(SoundControlBusMixChannel)

classmethod save_mix_to_profile(world_context_object, bus_mix, profile_index=0) → None?

Saves control bus mix to a profile, serialized to an ini file. If mix is loaded, uses current proxy’s state. If not, uses default UObject representation.

Parameters:
  • world_context_object (Object) –
  • bus_mix (SoundControlBusMix) – Mix object to serialize to profile .ini.
  • profile_index (int32) – Index of profile, allowing multiple profiles can be saved for single mix object. If 0, saves to default ini profile (no suffix).
classmethod update_mix(world_context_object, mix, channels) → None?

Sets a mix with the provided channel data if channels provided in active instance proxy of mix. Does not update UObject definition of mix.

Parameters:
classmethod update_mix_by_filter(world_context_object, mix, address_filter, bus_class_filter, value, attack_time=-1.000000, release_time=-1.000000) → None?

Sets filtered channels of a given class to a provided target value for active instance of mix. Does not update UObject definition of mix.

Parameters:
  • world_context_object (Object) –
  • mix (SoundControlBusMix) – Mix to modify
  • address_filter (str) – Address filter to apply to provided mix’s channels.
  • bus_class_filter (type(Class)) –
  • value (float) – Target value to mix filtered channels to.
  • attack_time (float) – If non-negative, updates the attack time for the resulting bus channels found matching the provided filter.
  • release_time (float) – If non-negative, updates the release time for the resulting bus channels found matching the provided filter.
classmethod update_modulator(world_context_object, modulator) → None?

Commits updates from a UObject definition of a modulator (e.g. Bus, Bus Mix, LFO) to active instance in audio thread (ignored if modulator type has not been activated).

Parameters: