unreal.ModularSynthComponent

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

Bases: SynthComponent

UModularSynthComponent Implementation of a USynthComponent.

C++ Source:

  • Plugin: Synthesis

  • Module: Synthesis

  • File: EpicSynth1Component.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] Is this audio component allowed to be spatialized?

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

  • bus_sends (Array[SoundSourceBusSendInfo]): [Read-Write] This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.

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

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

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

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

  • enable_base_submix (bool): [Read-Write] If enabled, sound will route to the Master Submix by default or to the Base Submix if defined. If disabled, sound will route ONLY to the Submix Sends and/or Bus Sends

  • enable_bus_sends (bool): [Read-Write] Whether or not to enable sending this audio’s output to buses.

  • enable_submix_sends (bool): [Read-Write] Whether or not to enable Submix Sends other than the Base Submix.

  • 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. Only used in audio mixer.

  • 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. Only used in audio mixer.

  • 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

  • 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_envelope_value (OnSynthEnvelopeValue): [Read-Write]

  • 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] Should the Attenuation Settings asset be used (false) or should the properties set directly on the component be used for attenuation properties

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

  • pre_effect_bus_sends (Array[SoundSourceBusSendInfo]): [Read-Write] This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.

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

  • 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_class (SoundClass): [Read-Write] Sound class this sound belongs to

  • sound_submix (SoundSubmixBase): [Read-Write] Submix this sound belongs to

  • sound_submix_sends (Array[SoundSubmixSendInfo]): [Read-Write] An array of submix sends. Audio from this sound will send a portion of its audio to these effects.

  • source_effect_chain (SoundEffectSourcePresetChain): [Read-Write] The source effect chain to use for this sound.

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

  • voice_count (int32): [Read-Write] The voice count to use for the synthesizer. Cannot be changed

create_patch(patch_source, patch_cables, enable_by_default) → PatchId

Creates a new modular synth patch between a modulation source and a set of modulation destinations

Parameters:
Return type:

PatchId

note_off(note, all_notes_off=False, kill_all_notes=False) → None

Stop the note (will only do anything if a voice is playing with that note)

Parameters:

  • note (float) –

  • all_notes_off (bool) –

  • kill_all_notes (bool) –

note_on(note, velocity, duration=-1.000000) → None

Play a new note. Optionally pass in a duration to automatically turn off the note.

Parameters:

  • note (float) –

  • velocity (int32) –

  • duration (float) –

set_attack_time(attack_time_msec) → None

Sets the envelope attack time in msec.

Parameters:

attack_time_msec (float) –

set_chorus_depth(depth) → None

Sets the chorus depth

Parameters:

depth (float) –

set_chorus_enabled(enable_chorus) → None

Sets whether or not chorus is enabled.

Parameters:

enable_chorus (bool) –

set_chorus_feedback(feedback) → None

Sets the chorus feedback

Parameters:

feedback (float) –

set_chorus_frequency(frequency) → None

Sets the chorus frequency

Parameters:

frequency (float) –

set_decay_time(decay_time_msec) → None

Sets the envelope decay time in msec.

Parameters:

decay_time_msec (float) –

set_enable_legato(legato_enabled) → None

Sets whether or not to use legato for the synthesizer.

Parameters:

legato_enabled (bool) –

set_enable_patch(patch_id, is_enabled) → bool

Set Enable Patch

Parameters:
Return type:

bool

set_enable_polyphony(enable_polyphony) → None

Sets whether or not to use polyphony for the synthesizer.

Parameters:

enable_polyphony (bool) – Whether or not to enable polyphony for the synth.

set_enable_retrigger(retrigger_enabled) → None

Sets whether or not to retrigger envelope per note on.

Parameters:

retrigger_enabled (bool) –

set_enable_unison(enable_unison) → None

Sets whether or not the synth is in unison mode (i.e. no spread)

Parameters:

enable_unison (bool) –

set_filter_algorithm(filter_algorithm) → None

Sets the filter algorithm.

Parameters:

filter_algorithm (SynthFilterAlgorithm) –

set_filter_frequency(filter_frequency_hz) → None

Sets the filter cutoff frequency in hz.

Parameters:

filter_frequency_hz (float) –

set_filter_frequency_mod(filter_frequency_hz) → None

Sets the filter cutoff frequency in hz.

Parameters:

filter_frequency_hz (float) –

set_filter_q(filter_q) → None

Sets the filter Q (resonance)

Parameters:

filter_q (float) –

set_filter_q_mod(filter_q) → None

Sets a modulated filter Q (resonance)

Parameters:

filter_q (float) –

set_filter_type(filter_type) → None

Sets the filter type.

Parameters:

filter_type (SynthFilterType) –

set_gain_db(gain_db) → None

Sets the synth gain in decibels.

Parameters:

gain_db (float) –

set_lfo_frequency(lfo_index, frequency_hz) → None

Sets the LFO frequency in hz

Parameters:

  • lfo_index (int32) – Which LFO to set the frequency for.

  • frequency_hz (float) – The LFO frequency to use.

set_lfo_frequency_mod(lfo_index, frequency_mod_hz) → None

Sets the LFO frequency modulation in hz

Parameters:

  • lfo_index (int32) – Which LFO to set the frequency for.

  • frequency_mod_hz (float) – The LFO frequency to use.

set_lfo_gain(lfo_index, gain) → None

Sets the LFO gain factor

Parameters:

  • lfo_index (int32) – Which LFO to set the frequency for.

  • gain (float) – The gain factor to use for the LFO.

set_lfo_gain_mod(lfo_index, gain_mod) → None

Sets the LFO gain mod factor (external modulation)

Parameters:

  • lfo_index (int32) – Which LFO to set the frequency for.

  • gain_mod (float) –

set_lfo_mode(lfo_index, lfo_mode) → None

Sets the LFO type

Parameters:

  • lfo_index (int32) – Which LFO to set the frequency for.

  • lfo_mode (SynthLFOMode) – The LFO mode to use.

set_lfo_patch(lfo_index, lfo_patch_type) → None

Sets the LFO patch type. LFO patch determines what parameter is modulated by the LFO.

Parameters:

  • lfo_index (int32) – Which LFO to set the frequency for.

  • lfo_patch_type (SynthLFOPatchType) – The LFO patch type to use.

set_lfo_type(lfo_index, lfo_type) → None

Sets the LFO type

Parameters:

  • lfo_index (int32) – Which LFO to set the frequency for.

  • lfo_type (SynthLFOType) – The LFO type to use.

set_mod_env_attack_time(attack_time_msec) → None

Sets the envelope modulator attack time in msec

Parameters:

attack_time_msec (float) –

set_mod_env_bias_invert(invert) → None

Sets whether or not to invert the bias output of the envelope modulator.

Parameters:

invert (bool) –

set_mod_env_bias_patch(patch_type) → None

Sets whether or not to modulate a param based on the envelope. Uses bias envelope output (offset from sustain gain).

Parameters:

patch_type (SynthModEnvBiasPatch) –

set_mod_env_decay_time(decay_time_msec) → None

Sets the envelope modulator attack time in msec

Parameters:

decay_time_msec (float) –

set_mod_env_depth(depth) → None

Sets the envelope modulator depth (amount to apply the output modulation)

Parameters:

depth (float) –

set_mod_env_invert(invert) → None

Sets whether or not to invert the envelope modulator.

Parameters:

invert (bool) –

set_mod_env_patch(patch_type) → None

Sets whether or not to modulate a param based on the envelope. Uses bias envelope output (offset from sustain gain).

Parameters:

patch_type (SynthModEnvPatch) –

set_mod_env_release_time(release) → None

Sets the envelope modulator release

Parameters:

release (float) –

set_mod_env_sustain_gain(sustain_gain) → None

Sets the envelope modulator sustain gain

Parameters:

sustain_gain (float) –

set_osc_cents(osc_index, cents) → None

Sets the oscillator cents.

Parameters:

  • osc_index (int32) – Which oscillator to set the type for.

  • cents (float) – The amount of cents to set the oscillator to (relative to base frequency/pitch)..

set_osc_frequency_mod(osc_index, osc_freq_mod) → None

Set the oscillator frequency modulation

Parameters:

  • osc_index (int32) – Which oscillator to set the type for.

  • osc_freq_mod (float) – The oscillator frequency modulation to use.

set_osc_gain(osc_index, osc_gain) → None

Set the oscillator gain.

Parameters:

  • osc_index (int32) – Which oscillator to set the type for.

  • osc_gain (float) – The oscillator gain.

set_osc_gain_mod(osc_index, osc_gain_mod) → None

Set the oscillator gain modulation.

Parameters:

  • osc_index (int32) – Which oscillator to set the type for.

  • osc_gain_mod (float) – The oscillator gain modulation to use.

set_osc_octave(osc_index, octave) → None

Sets the oscillator octaves

Parameters:

  • osc_index (int32) – Which oscillator to set the type for.

  • octave (float) – Which octave to set the oscillator to (relative to base frequency/pitch).

set_osc_pulsewidth(osc_index, pulsewidth) → None

Sets the square wave pulsewidth [0.0, 1.0]

Parameters:

  • osc_index (int32) –

  • pulsewidth (float) –

set_osc_semitones(osc_index, semitones) → None

Sets the oscillator semitones.

Parameters:

  • osc_index (int32) – Which oscillator to set the type for.

  • semitones (float) – The amount of semitones to set the oscillator to (relative to base frequency/pitch).

set_osc_sync(is_synced) → None

Set whether or not to follow the phase of osc2 to osc1

Parameters:

is_synced (bool) –

set_osc_type(osc_index, osc_type) → None

Set the oscillator type.

Parameters:

  • osc_index (int32) – Which oscillator to set the type for.

  • osc_type (Synth1OscType) – The oscillator type to set.

set_pan(pan) → None

Sets the pan of the synth [-1.0, 1.0].

Parameters:

pan (float) –

set_pitch_bend(pitch_bend) → None

Sets the synth pitch bend amount.

Parameters:

pitch_bend (float) –

set_portamento(portamento) → None

Sets the synth portamento [0.0, 1.0]

Parameters:

portamento (float) –

set_release_time(release_time_msec) → None

Sets the envelope release time in msec.

Parameters:

release_time_msec (float) –

set_spread(spread) → None

Sets the amount of spread of the oscillators. [0.0, 1.0]

Parameters:

spread (float) –

set_stereo_delay_feedback(delay_feedback) → None

Sets the amount of stereo delay feedback [0.0, 1.0]

Parameters:

delay_feedback (float) –

set_stereo_delay_is_enabled(stereo_delay_enabled) → None

Sets whether not stereo delay is enabled.

Parameters:

stereo_delay_enabled (bool) –

set_stereo_delay_mode(stereo_delay_mode) → None

Sets whether not stereo delay is enabled.

Parameters:

stereo_delay_mode (SynthStereoDelayMode) –

set_stereo_delay_ratio(delay_ratio) → None

Sets the amount of stereo delay ratio between left and right delay lines [0.0, 1.0]

Parameters:

delay_ratio (float) –

set_stereo_delay_time(delay_time_msec) → None

Sets the amount of stereo delay time in msec.

Parameters:

delay_time_msec (float) –

set_stereo_delay_wetlevel(delay_wetlevel) → None

Sets the amount of stereo delay wetlevel [0.0, 1.0]

Parameters:

delay_wetlevel (float) –

set_sustain_gain(sustain_gain) → None

Sets the envelope sustain gain value.

Parameters:

sustain_gain (float) –

set_synth_preset(synth_preset) → None

Sets the preset struct for the synth

Parameters:

synth_preset (ModularSynthPreset) –

property voice_count: int

[Read-Only] The voice count to use for the synthesizer. Cannot be changed

Type:

(int32)