unreal.AudioComponent

class unreal.AudioComponent(outer: Object | None = None, name: Name | str = 'None')

Bases: SceneComponent

AudioComponent is used to play a Sound see: https://docs.unrealengine.com/WorkingWithAudio/Overview see: USoundBase

C++ Source:

  • Module: Engine

  • File: AudioComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] If RelativeScale3D should be considered relative to the world, rather than the parent

  • allow_spatialization (bool): [Read-Write] Overrides spatialization enablement in either the attenuation asset or on this audio component’s attenuation settings override.

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • attenuation_overrides (SoundAttenuationSettings): [Read-Write] If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

  • attenuation_settings (SoundAttenuation): [Read-Write] If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • auto_attach_location_rule (AttachmentRule): [Read-Write] Options for how we handle our location when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

  • auto_attach_parent (SceneComponent): [Read-Only] Component we automatically attach to when activated, if bAutoManageAttachment is true. If null during registration, we assign the existing AttachParent and defer attachment until we activate. see: bAutoManageAttachment

  • auto_attach_rotation_rule (AttachmentRule): [Read-Write] Options for how we handle our rotation when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

  • auto_attach_scale_rule (AttachmentRule): [Read-Write] Options for how we handle our scale when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

  • auto_attach_socket_name (Name): [Read-Write] Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment

  • auto_manage_attachment (bool): [Read-Write] True if we should automatically attach to AutoAttachParent when Played, and detach from our parent when playback is completed. This overrides any current attachment that may be present at the time of activation (deferring initial attachment until activation, if AutoAttachParent is null). If enabled, this AudioComponent’s WorldLocation will no longer be reliable when not currently playing audio, and any attach children will also be detached/attached along with it. When enabled, detachment occurs regardless of whether AutoAttachParent is assigned, and the relative transform from the time of activation is restored. This also disables attachment on dedicated servers, where we don’t actually activate even if bAutoActivate is true. see: AutoAttachParent, AutoAttachSocketName, AutoAttachLocationType

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • can_play_multiple_instances (bool): [Read-Write] If true, the Audio Component will play multiple sound instances at once. Switching sounds or calling play while already playing will not stop already active instances. Virtualization for all played sounds will be disabled. Disabling while sound(s) are playing will not take effect until the AudioComponent is stopped and restarted.

  • component_tags (Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • concurrency_set (Set[SoundConcurrency]): [Read-Write] What sound concurrency rules to use for sounds generated by this audio component

  • default_parameters (Array[AudioParameter]): [Read-Write] Array of parameters for this AudioComponent. Changes to this array directly will not be forwarded to the sound if the component is actively playing, and will be superseded by parameters set via the actor interface if set, or the instance parameters.

  • detail_mode (DetailMode): [Read-Write] If detail mode is >= system detail mode, primitive won’t be rendered.

  • disable_parameter_updates_while_playing (bool): [Read-Write] If true, the Audio Component will ignore parameter updates for already-playing sound(s).

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • enable_low_pass_filter (bool): [Read-Write] Whether or not to apply a low-pass filter to the sound that plays in this audio component.

  • envelope_follower_attack_time (int32): [Read-Write] The attack time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this audio component.

  • envelope_follower_release_time (int32): [Read-Write] The release time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this audio component.

  • hidden_in_game (bool): [Read-Write] Whether to hide the primitive in game, if the primitive is Visible.

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • is_ui_sound (bool): [Read-Write] Whether or not this sound plays when the game is paused in the UI

  • low_pass_filter_frequency (float): [Read-Write] If enabled, the frequency of the Lowpass Filter (in Hz) to apply to this voice. A frequency of 0.0 is the device sample rate and will bypass the filter.

  • mobility (ComponentMobility): [Read-Write] How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • modulation_routing (SoundModulationDefaultRoutingSettings): [Read-Write]

  • on_audio_finished (OnAudioFinished): [Read-Write] Called when we finish playing audio, either because it played to completion or because a Stop() call turned it off early

  • on_audio_multi_envelope_value (OnAudioMultiEnvelopeValue): [Read-Write]

  • on_audio_play_state_changed (OnAudioPlayStateChanged): [Read-Write] This function returns the Targeted Audio Component’s current Play State. Playing, if the sound is currently playing. Stopped, if the sound is stopped. Paused, if the sound is currently playing, but paused. Fading In, if the sound is in the process of Fading In. Fading Out, if the sound is in the process of Fading Out.

  • on_audio_playback_percent (OnAudioPlaybackPercent): [Read-Write] Called as a sound plays on the audio component to allow BP to perform actions based on playback percentage. Computed as samples played divided by total samples, taking into account pitch. Not currently implemented on all platforms.

  • on_audio_single_envelope_value (OnAudioSingleEnvelopeValue): [Read-Write]

  • on_audio_virtualization_changed (OnAudioVirtualizationChanged): [Read-Write] Called when virtualization state changes

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • override_attenuation (bool): [Read-Write] Allows defining attenuation settings directly on this audio component without using an attenuation settings asset.

  • override_priority (bool): [Read-Write] Whether or not to override the priority of the given sound with the value provided.

  • override_subtitle_priority (bool): [Read-Write] Whether or not to override the sound’s subtitle priority.

  • physics_volume_changed_delegate (PhysicsVolumeChanged): [Read-Write] Delegate that will be called when PhysicsVolume has been changed *

  • pitch_modulation_max (float): [Read-Write] The upper bound to use when randomly determining a pitch multiplier

  • pitch_modulation_min (float): [Read-Write] The lower bound to use when randomly determining a pitch multiplier

  • pitch_multiplier (float): [Read-Write] A pitch multiplier to apply to sounds generated by this component

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • priority (float): [Read-Write] If enabled, overrides the priority of the selected sound with the value provided.

  • relative_location (Vector): [Read-Write] Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • should_update_physics_volume (bool): [Read-Write] Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()

  • sound (SoundBase): [Read-Write] The sound to be played

  • sound_class_override (SoundClass): [Read-Write] SoundClass that overrides that set on the referenced SoundBase when component is played.

  • source_effect_chain (SoundEffectSourcePresetChain): [Read-Write] The chain of Source Effects to apply to the sounds playing on the Audio Component

  • subtitle_priority (float): [Read-Write] Used by the subtitle manager to prioritize subtitles wave instances spawned by this component.

  • suppress_subtitles (bool): [Read-Write] If true, subtitles in the sound data will be ignored.

  • use_attach_parent_bound (bool): [Read-Write] If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.

  • visible (bool): [Read-Write] Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

  • volume_modulation_max (float): [Read-Write] The upper bound to use when randomly determining a volume multiplier

  • volume_modulation_min (float): [Read-Write] The lower bound to use when randomly determining a volume multiplier

  • volume_multiplier (float): [Read-Write] A volume multiplier to apply to sounds generated by this component

adjust_attenuation(attenuation_settings) → None

This function is used to modify the Attenuation Settings on the targeted Audio Component instance. It is worth noting that Attenuation Settings are only passed to new Active Sounds on start, so modified Attenuation data should be set before sound playback.

Parameters:

attenuation_settings (SoundAttenuationSettings) –

adjust_volume(adjust_volume_duration, adjust_volume_level, fade_curve=AudioFaderCurve.LINEAR) → None

This function allows designers to trigger an adjustment to the sound instance’s playback Volume with options for smoothly applying a curve over time.

Parameters:

  • adjust_volume_duration (float) – The length of time in which to interpolate between the initial volume and the new volume.

  • adjust_volume_level (float) – The new volume to set the Audio Component to.

  • fade_curve (AudioFaderCurve) – The curve used when interpolating between the old and new volume.

property allow_spatialization: bool

[Read-Write] Overrides spatialization enablement in either the attenuation asset or on this audio component’s attenuation settings override.

Type:

(bool)

property attenuation_overrides: SoundAttenuationSettings

[Read-Write] If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

Type:

(SoundAttenuationSettings)

property attenuation_settings: SoundAttenuation

[Read-Write] If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

Type:

(SoundAttenuation)

property auto_attach_location_rule: AttachmentRule

[Read-Write] Options for how we handle our location when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

Type:

(AttachmentRule)

property auto_attach_parent: SceneComponent

[Read-Only] Component we automatically attach to when activated, if bAutoManageAttachment is true. If null during registration, we assign the existing AttachParent and defer attachment until we activate. see: bAutoManageAttachment

Type:

(SceneComponent)

property auto_attach_rotation_rule: AttachmentRule

[Read-Write] Options for how we handle our rotation when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

Type:

(AttachmentRule)

property auto_attach_scale_rule: AttachmentRule

[Read-Write] Options for how we handle our scale when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

Type:

(AttachmentRule)

property auto_attach_socket_name: Name

[Read-Write] Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment

Type:

(Name)

property auto_manage_attachment: bool

[Read-Only] True if we should automatically attach to AutoAttachParent when Played, and detach from our parent when playback is completed. This overrides any current attachment that may be present at the time of activation (deferring initial attachment until activation, if AutoAttachParent is null). If enabled, this AudioComponent’s WorldLocation will no longer be reliable when not currently playing audio, and any attach children will also be detached/attached along with it. When enabled, detachment occurs regardless of whether AutoAttachParent is assigned, and the relative transform from the time of activation is restored. This also disables attachment on dedicated servers, where we don’t actually activate even if bAutoActivate is true. see: AutoAttachParent, AutoAttachSocketName, AutoAttachLocationType

Type:

(bool)

property can_play_multiple_instances: bool

[Read-Write] If true, the Audio Component will play multiple sound instances at once. Switching sounds or calling play while already playing will not stop already active instances. Virtualization for all played sounds will be disabled. Disabling while sound(s) are playing will not take effect until the AudioComponent is stopped and restarted.

Type:

(bool)

property concurrency_set: None

[Read-Write] What sound concurrency rules to use for sounds generated by this audio component

Type:

(Set[SoundConcurrency])

property default_parameters: None

[Read-Write] Array of parameters for this AudioComponent. Changes to this array directly will not be forwarded to the sound if the component is actively playing, and will be superseded by parameters set via the actor interface if set, or the instance parameters.

Type:

(Array[AudioParameter])

property disable_parameter_updates_while_playing: bool

[Read-Write] If true, the Audio Component will ignore parameter updates for already-playing sound(s).

Type:

(bool)

property enable_low_pass_filter: bool

[Read-Write] Whether or not to apply a low-pass filter to the sound that plays in this audio component.

Type:

(bool)

property envelope_follower_attack_time: int

[Read-Write] The attack time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this audio component.

Type:

(int32)

property envelope_follower_release_time: int

[Read-Write] The release time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this audio component.

Type:

(int32)

fade_in(fade_in_duration, fade_volume_level=1.000000, start_time=0.000000, fade_curve=AudioFaderCurve.LINEAR) → None

This function allows designers to call Play on an Audio Component instance while applying a volume curve over time. Parameters allow designers to indicate the duration of the fade, the curve shape, and the start time if seeking into the sound.

Parameters:

  • fade_in_duration (float) – How long it should take to reach the FadeVolumeLevel

  • fade_volume_level (float) – The percentage of the AudioComponents’s calculated volume to fade to

  • start_time (float) –

  • fade_curve (AudioFaderCurve) – The curve to use when interpolating between the old and new volume

fade_out(fade_out_duration, fade_volume_level, fade_curve=AudioFaderCurve.LINEAR) → None

This function allows designers to call a delayed Stop on an Audio Component instance while applying a volume curve over time. Parameters allow designers to indicate the duration of the fade and the curve shape.

Parameters:

  • fade_out_duration (float) – how long it should take to reach the FadeVolumeLevel

  • fade_volume_level (float) – the percentage of the AudioComponents’s calculated volume in which to fade to

  • fade_curve (AudioFaderCurve) – The curve to use when interpolating between the old and new volume

get_attenuation_settings_to_apply() → SoundAttenuationSettings or None

Retrieves Attenuation Settings data on the targeted Audio Component. Returns FALSE if no settings were found. Because the Attenuation Settings data structure is copied, FALSE returns will return default values.

Returns:

out_attenuation_settings (SoundAttenuationSettings):

Return type:

SoundAttenuationSettings or None

get_cooked_envelope_data() → float or None

Retrieves Cooked Amplitude Envelope Data at the current playback time. If there are multiple SoundWaves playing, data is interpolated and averaged across all playing sound waves. Returns FALSE if no data was found.

Returns:

out_envelope_data (float):

Return type:

float or None

get_cooked_envelope_data_for_all_playing_sounds() → Array[SoundWaveEnvelopeDataPerSound] or None

Retrieves the current-time amplitude envelope data of the sounds playing on the audio component. Envelope data is not averaged or interpolated. Instead an array of data with all playing sound waves with cooked data is returned. Returns true if there is data and the audio component is playing.

Returns:

out_envelope_data (Array[SoundWaveEnvelopeDataPerSound]):

Return type:

Array[SoundWaveEnvelopeDataPerSound] or None

get_cooked_fft_data(frequencies_to_get) → Array[SoundWaveSpectralData] or None

Retrieves the current-time cooked spectral data of the sounds playing on the audio component. Spectral data is averaged and interpolated for all playing sounds on this audio component. Returns true if there is data and the audio component is playing.

Parameters:

frequencies_to_get (Array[float]) –

Returns:

out_sound_wave_spectral_data (Array[SoundWaveSpectralData]):

Return type:

Array[SoundWaveSpectralData] or None

get_cooked_fft_data_for_all_playing_sounds() → Array[SoundWaveSpectralDataPerSound] or None

Retrieves the current-time cooked spectral data of the sounds playing on the audio component. Spectral data is not averaged or interpolated. Instead an array of data with all playing sound waves with cooked data is returned. Returns true if there is data and the audio component is playing.

Returns:

out_sound_wave_spectral_data (Array[SoundWaveSpectralDataPerSound]):

Return type:

Array[SoundWaveSpectralDataPerSound] or None

get_modulators(destination) → Set[SoundModulatorBase]

Gets the set of currently active modulators for a given Modulation Destination.

Parameters:

destination (ModulationDestination) – The Destination to retrieve the Modulators from.

Returns:

The set of of Modulators applied to this component for the given Destination.

Return type:

Set[SoundModulatorBase]

get_play_state() → AudioComponentPlayState

Returns the enumerated play states of the audio component.

Return type:

AudioComponentPlayState

has_cooked_amplitude_envelope_data() → bool

Queries whether or not the targeted Audio Component instance’s sound has Amplitude Envelope Data, returns FALSE if none found.

Return type:

bool

has_cooked_fft_data() → bool

Queries if the sound wave playing in this audio component has cooked FFT data, returns FALSE if none found.

Return type:

bool

property instance_parameters: None

‘instance_parameters’ was renamed to ‘default_parameters’.

Type:

deprecated

is_playing() → bool

Returns TRUE if the targeted Audio Component’s sound is playing. Doesn’t indicate if the sound is paused or fading in/out. Use GetPlayState() to get the full play state.

Return type:

bool

property is_ui_sound: bool

[Read-Write] Whether or not this sound plays when the game is paused in the UI

Type:

(bool)

is_virtualized() → bool

Returns if the sound is virtualized.

Return type:

bool

property low_pass_filter_frequency: float

[Read-Write] If enabled, the frequency of the Lowpass Filter (in Hz) to apply to this voice. A frequency of 0.0 is the device sample rate and will bypass the filter.

Type:

(float)

property modulation_routing: SoundModulationDefaultRoutingSettings

[Read-Write]

Type:

(SoundModulationDefaultRoutingSettings)

property on_audio_finished: OnAudioFinished

[Read-Write] Called when we finish playing audio, either because it played to completion or because a Stop() call turned it off early

Type:

(OnAudioFinished)

property on_audio_multi_envelope_value: OnAudioMultiEnvelopeValue

[Read-Write]

Type:

(OnAudioMultiEnvelopeValue)

property on_audio_play_state_changed: OnAudioPlayStateChanged

[Read-Write] This function returns the Targeted Audio Component’s current Play State. Playing, if the sound is currently playing. Stopped, if the sound is stopped. Paused, if the sound is currently playing, but paused. Fading In, if the sound is in the process of Fading In. Fading Out, if the sound is in the process of Fading Out.

Type:

(OnAudioPlayStateChanged)

property on_audio_playback_percent: OnAudioPlaybackPercent

[Read-Write] Called as a sound plays on the audio component to allow BP to perform actions based on playback percentage. Computed as samples played divided by total samples, taking into account pitch. Not currently implemented on all platforms.

Type:

(OnAudioPlaybackPercent)

property on_audio_single_envelope_value: OnAudioSingleEnvelopeValue

[Read-Write]

Type:

(OnAudioSingleEnvelopeValue)

property on_audio_virtualization_changed: OnAudioVirtualizationChanged

[Read-Write] Called when virtualization state changes

Type:

(OnAudioVirtualizationChanged)

property override_attenuation: bool

[Read-Write] Allows defining attenuation settings directly on this audio component without using an attenuation settings asset.

Type:

(bool)

property override_priority: bool

[Read-Write] Whether or not to override the priority of the given sound with the value provided.

Type:

(bool)

property override_subtitle_priority: bool

[Read-Write] Whether or not to override the sound’s subtitle priority.

Type:

(bool)

property pitch_modulation_max: float

[Read-Write] The upper bound to use when randomly determining a pitch multiplier

Type:

(float)

property pitch_modulation_min: float

[Read-Write] The lower bound to use when randomly determining a pitch multiplier

Type:

(float)

property pitch_multiplier: float

[Read-Write] A pitch multiplier to apply to sounds generated by this component

Type:

(float)

property pitch_multiplier_max: float

‘pitch_multiplier_max’ was renamed to ‘pitch_modulation_max’.

Type:

deprecated

property pitch_multiplier_min: float

‘pitch_multiplier_min’ was renamed to ‘pitch_modulation_min’.

Type:

deprecated

play(start_time=0.000000) → None

Begins playing the targeted Audio Component’s sound at the designated Start Time, seeking into a sound.

Parameters:

start_time (float) – The offset, in seconds, to begin reading the sound at

play_quantized(world_context_object, clock_handle, quantization_boundary, delegate, start_time=0.000000, fade_in_duration=0.000000, fade_volume_level=1.000000, fade_curve=AudioFaderCurve.LINEAR) -> (clock_handle=QuartzClockHandle, quantization_boundary=QuartzQuantizationBoundary)

Start a sound playing on an audio component on a given quantization boundary with the handle to an existing clock

Parameters:
Returns:

clock_handle (QuartzClockHandle):

quantization_boundary (QuartzQuantizationBoundary):

Return type:

tuple

property priority: float

[Read-Write] If enabled, overrides the priority of the selected sound with the value provided.

Type:

(float)

reset_parameters() → None

Resets all parameters to their original values.

set_audio_bus_send_post_effect(audio_bus, audio_bus_send_level) → None

Sets how much audio the sound should send to the given Audio Bus (POST Source Effects). if the Audio Bus Send doesn’t already exist, it will be added to the overrides on the active sound.

Parameters:

  • audio_bus (AudioBus) – The Bus to send the signal to

  • audio_bus_send_level (float) – The scalar used to alter the volume of the copied signal

set_audio_bus_send_pre_effect(audio_bus, audio_bus_send_level) → None

Sets how much audio the sound should send to the given Audio Bus (PRE Source Effects). if the Bus Send doesn’t already exist, it will be added to the overrides on the active sound.

Parameters:

  • audio_bus (AudioBus) – The Bus to send the signal to

  • audio_bus_send_level (float) – The scalar used to alter the volume of the copied signal

set_bool_array_parameter(name, value) → None

Sets a named Boolean Array

Parameters:
set_bool_parameter(name, bool) → None

Sets a named Boolean

Parameters:
set_float_array_parameter(name, value) → None

Sets a named Float Array

Parameters:
set_float_parameter(name, float) → None

Sets a named Float

Parameters:
set_int_array_parameter(name, value) → None

Sets a named Int32 Array

Parameters:
set_int_parameter(name, int) → None

Sets a named Int32

Parameters:

  • name (Name) –

  • int (int32) –

set_low_pass_filter_enabled(low_pass_filter_enabled) → None

When set to TRUE, enables an additional Low Pass Filter Frequency to be calculated in with the sound instance’s LPF total, allowing designers to set filter settings for the targeted Audio Component’s sound instance.

Parameters:

low_pass_filter_enabled (bool) –

set_low_pass_filter_frequency(low_pass_filter_frequency) → None

Sets a cutoff frequency, in Hz, for the targeted Audio Component’s sound’s Low Pass Filter calculation. The lowest cutoff frequency from all of the sound instance’s possible LPF calculations wins.

Parameters:

low_pass_filter_frequency (float) –

set_modulation_routing(modulators, destination, routing_method=ModulationRouting.INHERIT) → None

Sets the routing for one of the given Audio component’s Modulation Destinations.

Parameters:
set_object_array_parameter(name, value) → None

Sets a named UObject Array

Parameters:
set_object_parameter(name, value) → None

Sets a named UObject

Parameters:
set_output_to_bus_only(output_to_bus_only) → None

Sets whether or not to output the audio to bus only.

Parameters:

output_to_bus_only (bool) –

set_parameters_blueprint(parameters) → None

Sets an array of parameters as a batch

Parameters:

parameters (Array[AudioParameter]) –

set_paused(pause) → None

Pause an audio component playing its sound cue, issue any delegates if needed

Parameters:

pause (bool) –

set_pitch_multiplier(new_pitch_multiplier) → None

Set a new pitch multiplier

Parameters:

new_pitch_multiplier (float) –

set_sound(new_sound) → None

Set what sound is played by this component

Parameters:

new_sound (SoundBase) –

set_source_bus_send_post_effect(sound_source_bus, source_bus_send_level) → None

Allows designers to target a specific Audio Component instance’s sound and set the send level (volume of sound copied) to the indicated Source Bus. If the Source Bus is not already part of the sound’s sends, the reference will be added to this instance’s Override sends. This particular send occurs after the Source Effect processing chain.

Parameters:

  • sound_source_bus (SoundSourceBus) – The Bus to send the signal to

  • source_bus_send_level (float) – The scalar used to alter the volume of the copied signal

set_source_bus_send_pre_effect(sound_source_bus, source_bus_send_level) → None

Allows designers to target a specific Audio Component instance’s sound and set the send level (volume of sound copied) to the indicated Source Bus. If the Source Bus is not already part of the sound’s sends, the reference will be added to this instance’s Override sends. This particular send occurs before the Source Effect processing chain.

Parameters:

  • sound_source_bus (SoundSourceBus) – The Bus to send the signal to.

  • source_bus_send_level (float) – The scalar used to alter the volume of the copied signal.

set_string_array_parameter(name, value) → None

Sets a named String Array

Parameters:
set_string_parameter(name, value) → None

Sets a named String

Parameters:
set_submix_send(submix, send_level) → None

Allows designers to target a specific Audio Component instance’s sound set the send level (volume of sound copied) to the indicated Submix.

Parameters:

  • submix (SoundSubmixBase) – The Submix to send the signal to.

  • send_level (float) – The scalar used to alter the volume of the copied signal.

set_trigger_parameter(name) → None

Executes a named trigger. Does not cache trigger value, so only executes if the sound is already playing. If the intent is for the trigger to execute immediately (if playing) and be called on initialization for all future instances, call ‘SetBoolParameter’ with the intended initial trigger behavior (true if trigger desired on initialization, false if not).

Parameters:

name (Name) –

set_ui_sound(ui_sound) → None

Set whether sounds generated by this audio component should be considered UI sounds

Parameters:

ui_sound (bool) –

set_volume_multiplier(new_volume_multiplier) → None

Set a new volume multiplier

Parameters:

new_volume_multiplier (float) –

set_wave_parameter(name, wave) → None

Sets the parameter matching the name indicated to the provided Wave. Provided for convenience/backward compatibility with SoundCues (The parameter interface supports any object and is up to the system querying it to determine whether it is a valid type).

Parameters:

  • name (Name) – The name of the parameter to assign the wave to.

  • wave (SoundWave) – The wave value to set.

property sound: SoundBase

[Read-Write] The sound to be played

Type:

(SoundBase)

property source_effect_chain: SoundEffectSourcePresetChain

[Read-Write] The chain of Source Effects to apply to the sounds playing on the Audio Component

Type:

(SoundEffectSourcePresetChain)

stop() → None

Stop an audio component’s sound, issue any delegates if needed

stop_delayed(delay_time) → None

Cues request to stop sound after the provided delay (in seconds), stopping immediately if delay is zero or negative

Parameters:

delay_time (float) –

property subtitle_priority: float

[Read-Write] Used by the subtitle manager to prioritize subtitles wave instances spawned by this component.

Type:

(float)

property suppress_subtitles: bool

[Read-Write] If true, subtitles in the sound data will be ignored.

Type:

(bool)

property volume_modulation_max: float

[Read-Write] The upper bound to use when randomly determining a volume multiplier

Type:

(float)

property volume_modulation_min: float

[Read-Write] The lower bound to use when randomly determining a volume multiplier

Type:

(float)

property volume_multiplier: float

[Read-Write] A volume multiplier to apply to sounds generated by this component

Type:

(float)

property volume_multiplier_max: float

‘volume_multiplier_max’ was renamed to ‘volume_modulation_max’.

Type:

deprecated

property volume_multiplier_min: float

‘volume_multiplier_min’ was renamed to ‘volume_modulation_min’.

Type:

deprecated