unreal.SynthComponentMonoWaveTable

class unreal.SynthComponentMonoWaveTable(outer=None, name='None')

Bases: unreal.SynthComponent

Synth Component Mono Wave Table

C++ Source:

  • Plugin: Synthesis

  • Module: Synthesis

  • File: SynthComponentMonoWaveTable.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] Absolute Location: If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] Absolute Rotation: If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] Absolute Scale: If RelativeScale3D should be considered relative to the world, rather than the parent

  • allow_spatialization (bool): [Read-Write] Allow Spatialization: Is this audio component allowed to be spatialized?

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

  • attenuation_overrides (SoundAttenuationSettings): [Read-Write] Attenuation Overrides: If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

  • attenuation_settings (SoundAttenuation): [Read-Write] Attenuation Settings: If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

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

  • bus_sends (Array(SoundSourceBusSendInfo)): [Read-Write] Bus Sends: 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] Can Ever Affect Navigation: Whether this component can potentially influence navigation

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

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

  • current_preset (MonoWaveTableSynthPreset): [Read-Write] Current Preset: The settings asset to use for this synth

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

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

  • enable_base_submix (bool): [Read-Write] Enable Base Submix: 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] Enable Bus Sends: Whether or not to enable sending this audio’s output to buses.

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

  • envelope_follower_attack_time (int32): [Read-Write] Envelope Follower Attack Time: 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] Envelope Follower Release Time: 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] Hidden in Game: Whether to hide the primitive in game, if the primitive is Visible.

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

  • is_ui_sound (bool): [Read-Write] Is UISound: Whether or not this sound plays when the game is paused in the UI

  • mobility (ComponentMobility): [Read-Write] Mobility: How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • on_audio_envelope_value (OnSynthEnvelopeValue): [Read-Write] On Audio Envelope Value

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

  • on_num_tables_changed (NumTablesChanged): [Read-Write] On Num Tables Changed: Curve array altered

  • on_table_altered (OnTableAltered): [Read-Write] On Table Altered: Wave Table curve was edited

  • override_attenuation (bool): [Read-Write] Override Attenuation: 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] Physics Volume Changed Delegate: Delegate that will be called when PhysicsVolume has been changed *

  • pre_effect_bus_sends (Array(SoundSourceBusSendInfo)): [Read-Write] Pre Effect Bus Sends: 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] Primary Component Tick: Main tick function for the Component

  • relative_location (Vector): [Read-Write] Relative Location: Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Relative Rotation: Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Relative Scale 3D: Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

  • replicates (bool): [Read-Write] Replicates: 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] Should Update Physics Volume: 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: Sound class this sound belongs to

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

  • sound_submix_sends (Array(SoundSubmixSendInfo)): [Read-Write] Sound Submix Sends: 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] Source Effect Chain: The source effect chain to use for this sound.

  • use_attach_parent_bound (bool): [Read-Write] Use Attach Parent Bound: 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] Visible: Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

get_curve_tangent(table_index) → float

Get the curve interpolation type (What the curve is doing between keyframes)

Parameters

table_index (int32) –

Return type

float

get_key_frame_values_for_table(table_index)

Get an array of floats that represent the key frames in the requested curve

Parameters

table_index (float) –

Return type

Array(float)

get_max_table_index() → int32

Get the number of curves in the wave table. (returns -1 if there is no asset)

Return type

int32

get_num_table_entries() → int32

Start BP functionality // Get the number of table elements from Blueprint

Return type

int32

note_off(midi_note) → None

Starts a new note (retrigs modulators, etc.)

Parameters

midi_note (float) –

note_on(midi_note, velocity) → None

Starts a new note (retrigs modulators, etc.)

Parameters
property on_num_tables_changed

[Read-Write] On Num Tables Changed: Curve array altered

Type

(NumTablesChanged)

property on_table_altered

[Read-Write] On Table Altered: Wave Table curve was edited

Type

(OnTableAltered)

refresh_all_wave_tables() → None

Refresh all wavetables (from Game Thread data)

refresh_wave_table(index) → None

Refresh a particular wavetable (from Game Thread data)

Parameters

index (int32) –

set_amp_envelope_attack_time(attack_time_msec) → None

Set Amp envelope attack time (msec)

Parameters

attack_time_msec (float) –

set_amp_envelope_bias_depth(depth) → None

Set the bias depth of the the Amp envelope

Parameters

depth (float) –

set_amp_envelope_bias_invert(bias_invert) → None

Set whether or not the Amp envelope’s bias is inverted

Parameters

bias_invert (bool) –

set_amp_envelope_decay_time(decay_time_msec) → None

Set Amp envelope decay time (msec)

Parameters

decay_time_msec (float) –

set_amp_envelope_depth(depth) → None

Set the overall depth of the Amp envelope

Parameters

depth (float) –

set_amp_envelope_invert(invert) → None

Set whether or not the Amp envelope is inverted

Parameters

invert (bool) –

set_amp_envelope_release_time(release_time_msec) → None

Set Amp envelope release time (msec)

Parameters

release_time_msec (float) –

set_amp_envelope_sustain_gain(sustain_gain) → None

Set Amp envelope sustain gain [0.0, 1.0]

Parameters

sustain_gain (float) –

set_curve_interpolation_type(interpolation_type, table_index) → bool

Set the curve interpolation type (What the curve is doing between keyframes) This should only be used for live-editing features! (changing the curves at runtime is expensive)

Parameters
Return type

bool

set_curve_tangent(table_index, new_tangent) → bool

Set the curve tangent (“Curve depth” between keyframes) This should only be used for live-editing features! (changing the curves at runtime is expensive)

Parameters

  • table_index (int32) –

  • new_tangent (float) –

Return type

bool

set_curve_value(table_index, keyframe_index, new_value) → bool
Set a Keyframe value given a Table number and Keyframe number.

Returns false if the request was invalid. NewValue will be clamped from +/- 1.0

Parameters

  • table_index (int32) –

  • keyframe_index (int32) –

  • new_value (float) –

Return type

bool

set_filter_envelope_attack_time(attack_time_msec) → None

Set Low-Pass Filter envelope attack time (msec)

Parameters

attack_time_msec (float) –

set_filter_envelope_bias_depth(depth) → None

Set Low-Pass Filter envelope bias depth

Parameters

depth (float) –

set_filter_envelope_bias_invert(bias_invert) → None

Set Low-Pass Filter envelope bias inversion

Parameters

bias_invert (bool) –

set_filter_envelope_depth(depth) → None

Set Low-Pass Filter envelope depth

Parameters

depth (float) –

set_filter_envelope_invert(invert) → None

Set Low-Pass Filter envelope inversion

Parameters

invert (bool) –

set_filter_envelope_release_time(release_time_msec) → None

Set Low-Pass Filter envelope release time (msec)

Parameters

release_time_msec (float) –

set_filter_envelope_sustain_gain(sustain_gain) → None

Set Low-Pass Filter envelope sustain gain

Parameters

sustain_gain (float) –

set_filter_envelopen_decay_time(decay_time_msec) → None

Set Low-Pass Filter envelope decay time (msec)

Parameters

decay_time_msec (float) –

set_frequency(frequency_hz) → None

Sets the oscillator’s frequency

Parameters

frequency_hz (float) –

set_frequency_pitch_bend(frequency_offset_cents) → None

Set a frequency offset in cents (for pitch modulation such as the Pitch Bend Wheel)

Parameters

frequency_offset_cents (float) –

set_frequency_with_midi_note(midi_note) → None

Set the oscillator’s frequency via midi note number

Parameters

midi_note (float) –

set_low_pass_filter_resonance(new_q) → None

Set the Cut-off frequency of the low-pass filter

Parameters

new_q (float) –

set_pos_lfo_depth(lfo_depth) → None
Set the Modulation depth of the Lfo controlling the Table Position around the current position value

0.0 = no modulation, 1.0 = current position +/- 0.5 (Lfo + Position result will clamp [0.0, 1.0])

Parameters

lfo_depth (float) –

set_pos_lfo_frequency(lfo_frequency) → None

Set frequency of LFO controlling Table Position (in Hz)

Parameters

lfo_frequency (float) –

set_pos_lfo_type(lfo_type) → None

Set the shape of the Lfo controlling the position

Parameters

lfo_type (SynthLFOType) –

set_position_envelope_attack_time(attack_time_msec) → None

Set Position envelope attack time (msec)

Parameters

attack_time_msec (float) –

set_position_envelope_bias_depth(depth) → None

Set Position envelope bias depth

Parameters

depth (float) –

set_position_envelope_bias_invert(bias_invert) → None

Set Position envelope bias inversion

Parameters

bias_invert (bool) –

set_position_envelope_decay_time(decay_time_msec) → None

Set Position envelope decay time (msec)

Parameters

decay_time_msec (float) –

set_position_envelope_depth(depth) → None

Set Position envelope envelope depth

Parameters

depth (float) –

set_position_envelope_invert(invert) → None

Set Position envelope envelope inversion

Parameters

invert (bool) –

set_position_envelope_release_time(release_time_msec) → None

Set Position envelope release time (msec)

Parameters

release_time_msec (float) –

set_position_envelope_sustain_gain(sustain_gain) → None

Set Position envelope sustain gain

Parameters

sustain_gain (float) –

set_sustain_pedal_state(sustain_pedal_state) → None

Inform the synth if the sustain pedal is pressed or not

Parameters

sustain_pedal_state (bool) –

set_wave_table_position(position) → None

Sets the wavetable position. Expects a percentage between 0.0 and 1.0

Parameters

position (float) –