unreal.EndpointSubmix

class unreal.EndpointSubmix(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: SoundSubmixBase

Sound Submix class meant for sending audio to an external endpoint, such as controller haptics or an additional audio device.

C++ Source:

  • Module: Engine

  • File: SoundSubmix.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_disable (bool): [Read-Write] Auto Disable: Auto-manage enabling and disabling the submix as a CPU optimization. It will be disabled if the submix and all child submixes are silent. It will re-enable if a sound is sent to the submix or a child submix is audible.

  • auto_disable_time (float): [Read-Write] Auto Disable Time: The minimum amount of time to wait before automatically disabling a submix if it is silent. Will immediately re-enable if source audio is sent to it.

  • child_submixes (Array[SoundSubmixBase]): [Read-Only] Child Submixes: Child submixes to this sound mix

  • endpoint_settings (AudioEndpointSettingsBase): [Read-Write] Endpoint Settings

  • endpoint_type (Name): [Read-Write] Endpoint Type: Currently used format.