unreal.SubmixSendVolumeComponent
¶
- class unreal.SubmixSendVolumeComponent(outer: Optional[Object] = None, name: Union[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] Asset User Data: Array of user data stored with the componentauto_activate
(bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.can_ever_affect_navigation
(bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigationcomponent_tags
(Array[Name]): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.editable_when_inherited
(bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor classis_editor_only
(bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor buildson_component_activated
(ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivatedprimary_component_tick
(ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Componentpriority
(int32): [Read-Write] Priority: 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] Replicate Using Registered Sub Object List: 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] Replicates: 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: 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: Array[AudioVolumeSubmixSendSettings]¶
[Read-Only] Submix Send Settings: 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: