unreal.SubmixSendVolumeComponent

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

Bases: AudioGameplayVolumeMutator

USubmixSendVolumeComponent - Audio Gameplay Volume component for submix sends

C++ Source:

  • Plugin: AudioGameplayVolume

  • Module: AudioGameplayVolume

  • File: SubmixSendVolumeComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

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

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

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

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

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

  • 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

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

  • priority (int32): [Read-Write] The priority of this component. In the case of overlapping volumes or multiple affecting components, the highest priority is chosen.

  • 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!

  • submix_send_settings (Array[AudioVolumeSubmixSendSettings]): [Read-Write] Submix send settings to use for this component. Allows audio to dynamically send to submixes based on source and listener locations (relative to parent volume.)

set_submix_send_settings(new_submix_send_settings) → None

Set Submix Send Settings

Parameters:

new_submix_send_settings (Array[AudioVolumeSubmixSendSettings]) –

property submix_send_settings: None

[Read-Only] Submix send settings to use for this component. Allows audio to dynamically send to submixes based on source and listener locations (relative to parent volume.)

Type:

(Array[AudioVolumeSubmixSendSettings])