unreal.VoiceSettings

class unreal.VoiceSettings(component_to_attach_to=None, attenuation_settings=None, source_effect_chain=None)

Bases: unreal.StructBase

Voice Settings

C++ Source:

  • Module: Engine

  • File: VoiceConfig.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attenuation_settings (SoundAttenuation): [Read-Write] Attenuation Settings: Optional attenuation settings to attach to this player’s voice. This should only be used when ComponentToAttachTo is set.

  • component_to_attach_to (SceneComponent): [Read-Write] Component to Attach To: Optionally attach the voice source to a Scene Component to give the appearance that the voice is coming from that scene component. If this is not set, the voice will not be spatialized.

  • source_effect_chain (SoundEffectSourcePresetChain): [Read-Write] Source Effect Chain: Optional audio effects to apply to this player’s voice.

property attenuation_settings

[Read-Write] Attenuation Settings: Optional attenuation settings to attach to this player’s voice. This should only be used when ComponentToAttachTo is set.

Type

(SoundAttenuation)

property component_to_attach_to

[Read-Write] Component to Attach To: Optionally attach the voice source to a Scene Component to give the appearance that the voice is coming from that scene component. If this is not set, the voice will not be spatialized.

Type

(SceneComponent)

property source_effect_chain

[Read-Write] Source Effect Chain: Optional audio effects to apply to this player’s voice.

Type

(SoundEffectSourcePresetChain)