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, mix)None

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

Parameters
classmethod activate_generator(world_context_object, generator)None

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

Parameters
classmethod create_bus(world_context_object, name, parameter, activate=True)SoundControlBus

Creates a modulation bus with the provided default value.

Parameters
Returns

Return type

SoundControlBus

classmethod create_bus_mix(world_context_object, name, stages, activate)SoundControlBusMix

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

Parameters
Returns

Return type

SoundControlBusMix

classmethod create_bus_mix_stage(world_context_object, bus, value, attack_time=0.1, release_time=0.1)SoundControlBusMixStage

Creates a stage used to mix a control bus.

Parameters
Returns

Return type

SoundControlBusMixStage

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, mix)None

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

Parameters
classmethod deactivate_generator(world_context_object, generator)None

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

Parameters
classmethod load_mix_from_profile(world_context_object, mix, activate=True, profile_index=0)

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

Parameters
  • world_context_object (Object) –

  • mix (SoundControlBusMix) –

  • 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

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

Return type

Array(SoundControlBusMixStage)

classmethod save_mix_to_profile(world_context_object, 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) –

  • mix (SoundControlBusMix) –

  • 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, stages, fade_time=- 1.0)None

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

Parameters
  • world_context_object (Object) –

  • mix (SoundControlBusMix) – Mix to update

  • stages (Array(SoundControlBusMixStage)) – Stages to set. If stage’s bus is not referenced by mix, stage’s update request is ignored.

  • fade_time (float) – Fade time to user when interpolating between current value and new values. If negative, falls back to last fade time set on stage. If fade time never set on stage, uses attack time set on stage in mix asset.

classmethod update_mix_by_filter(world_context_object, mix, address_filter, param_class_filter, param_filter, value=1.0, fade_time=- 1.0)None

Sets filtered stages 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) – (Optional) Address filter to apply to provided mix’s stages.

  • param_class_filter (type(Class)) – (Optional) Filters buses by parameter class.

  • param_filter (SoundModulationParameter) – (Optional) Filters buses by parameter.

  • value (float) – Target value to mix filtered stages to.

  • fade_time (float) – If non-negative, updates the fade time for the resulting bus stages found matching the provided filter.

classmethod update_mix_from_object(world_context_object, mix, fade_time=- 1.0)None

Commits updates from a UObject definition of a bus mix to active instance in audio thread (ignored if mix has not been activated).

Parameters
  • world_context_object (Object) –

  • mix (SoundControlBusMix) – Mix to update

  • fade_time (float) – Fade time to user when interpolating between current value and new values. If negative, falls back to last fade time set on stage. If fade time never set on stage, uses attack time set on stage in mix asset.

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