unreal.SubmixEffectTapDelayPreset

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

Bases: unreal.SoundEffectSubmixPreset

UTapDelaySubmixPreset Class which processes audio streams and uses parameters defined in the preset class.

C++ Source:

  • Plugin: Synthesis

  • Module: Synthesis

  • File: SubmixEffectTapDelay.h

Editor Properties: (see get_editor_property/set_editor_property)

  • settings (SubmixEffectTapDelaySettings): [Read-Write] Settings

add_tap()int32

Adds a dynamic tap delay with the given settings. Returns the tap id.

Returns

tap_id (int32):

Return type

int32

get_max_delay_in_milliseconds()float

Get the maximum delay possible.

Returns

Return type

float

get_tap(tap_id)TapDelayInfo

Get the current info about a specific tap.

Parameters

tap_id (int32) –

Returns

tap_info (TapDelayInfo):

Return type

TapDelayInfo

get_tap_ids()

Retrieve an array of all tap ids for the submix effect.

Returns

tap_ids (Array(int32)):

Return type

Array(int32)

remove_tap(tap_id)None

Remove the tap from the preset.

Parameters

tap_id (int32) –

set_interpolation_time(time)None

Set the time it takes to interpolate between parameters, in milliseconds.

Parameters

time (float) –

set_settings(settings)None

Set all tap delay setting. This will replace any dynamically added or modified taps.

Parameters

settings (SubmixEffectTapDelaySettings) –

set_tap(tap_id, tap_info)None

Modify a specific tap.

Parameters
property settings

[Read-Write] Settings

Type

(SubmixEffectTapDelaySettings)