Module track_fx

Provide implementation for TrackFX functions.

Info:

  • License: MIT
  • Author: Nomad Monad

ReaWrap Custom Methods

TrackFX:new (track, fx_idx) Create new TrackFX instance.
TrackFX:log (...) Log messages with the TrackFX logger.
TrackFX:__tostring () String representation of the TrackFX instance.
TrackFX:delete () Delete this FX from the track.
TrackFX:get_param_values () Get param values from TrackFX.
TrackFX:iter_param_values () Iterate over TrackFX param values.
TrackFX:get_param_names () Get param names from TrackFX.
TrackFX:iter_param_names () Iterate over TrackFX param names.
TrackFX:create_param_link (source_fx, source_param_idx, target_param_idx, scale) Create a parameter modulation link from a source FX to this FX's parameter.
TrackFX:remove_param_link (target_param_idx) Remove a parameter modulation link from this FX's parameter.
TrackFX:get_param_link_info (target_param_idx) Get parameter modulation link information.

ReaScript Wrapped Methods

TrackFX:end_param_edit (param) End Param Edit.
TrackFX:format_param_value (param, val) Format Param Value.
TrackFX:format_param_value_normalized (param, value, buf) Format Param Value Normalized.
TrackFX:get_chain_visible () Get Chain Visible.
TrackFX:get_enabled () Get Enabled.
TrackFX:get_eq (instantiate) Get Eq.
TrackFX:get_eq_band_enabled (band_type, band_idx) Get Eq Band Enabled.
TrackFX:get_eq_param (param_idx) Get Eq Param.
TrackFX:get_floating_window () Get Floating Window.
TrackFX:get_formatted_param_value (param) Get Formatted Param Value.
TrackFX:get_guid () Get Guid.
TrackFX:get_name (fx_idx) Get Name.
TrackFX:get_instrument () Get Instrument.
TrackFX:get_io_size () Get Io Size.
TrackFX.NamedConfigParamConstants:create (params) Create a table of named configuration parameters constants.
TrackFX:get_named_config_param (param_name) Get Named Config Param.
TrackFX:get_num_params () Get Num Params.
TrackFX:get_offline () Get Offline.
TrackFX:get_open () Get Open.
TrackFX:get_param (param) Get Param.
TrackFX:get_parameter_step_sizes (param) Get Parameter Step Sizes.
TrackFX:get_param_ex (param) Get Param Ex.
TrackFX:get_param_from_ident (ident_str) Get Param From Ident.
TrackFX:get_param_ident (param) Get Param Ident.
TrackFX:get_param_name (param) Get Param Name.
TrackFX:get_param_normalized (param) Get Param Normalized.
TrackFX:get_pin_mappings (is_output, pin) Get Pin Mappings.
TrackFX:get_preset () Get Preset.
TrackFX:get_preset_index () Get Preset Index.
TrackFX:get_rec_chain_visible () Get Rec Chain Visible.
TrackFX:get_rec_count () Get Rec Count.
TrackFX:get_user_preset_filename () Get User Preset Filename.
TrackFX:navigate_presets (preset_move) Navigate Presets.
TrackFX:set_enabled (enabled) Set Enabled.
TrackFX:set_eq_band_enabled (band_type, band_idx, enable) Set Eq Band Enabled.
TrackFX:set_eq_param (band_type, band_idx, param_type, val, is_norm) Set Eq Param.
TrackFX:set_named_config_param (param_name, value) Set Named Config Parm.
TrackFX:set_offline (offline) Set Offline.
TrackFX:set_open (open) Set Open.
TrackFX:set_param (param, val) Set Param.
TrackFX:set_param_normalized (param, value) Set Param Normalized.
TrackFX:set_pin_mappings (is_output, pin, low32bits, hi32bits) Set Pin Mappings.
TrackFX:set_preset (preset_name) Set Preset.
TrackFX:set_preset_by_index (preset_idx) Set Preset By Index.
TrackFX:show (show_flag) Show.
TrackFX:get_chain () Get Chain.
TrackFX:get_chain_ex (want_input_chain) Get Chain Ex.
TrackFX:select () Select.

Constants

TrackFX.NamedConfigParamConstants.ReadOnly A table of configuration parameters for TrackFX:get_named_config_param.
TrackFX.NamedConfigParamConstants.ReadWrite A table of configuration parameters for TrackFX:get_named_config_param.
TrackFX.NamedConfigParamValues A table of values to be associated with configuration constants.

Container Methods

TrackFX:is_container () Check if this FX is a container.
TrackFX:get_container_child_count () Get the number of FX in this container.
TrackFX:get_container_children () Get child FX from this container.
TrackFX:iter_container_children () Iterate over child FX in this container.
TrackFX:get_parent_container () Get the parent container of this FX.
TrackFX:get_container_depth () Get the container hierarchy depth of this FX.
TrackFX:get_container_channels () Get the internal channel count of this container.
TrackFX:set_container_channels (channels) Set the internal channel count of this container.
TrackFX:get_container_input_pins () Get the input pin count of this container.
TrackFX:set_container_input_pins (pins) Set the input pin count of this container.
TrackFX:get_container_output_pins () Get the output pin count of this container.
TrackFX:set_container_output_pins (pins) Set the output pin count of this container.
TrackFX:refresh_pointer () Refresh this FX's pointer by finding it again using its GUID.
TrackFX:move_to_container (container, position) Move this FX into a container.
TrackFX:move_out_of_container (position) Move this FX out of its container to the main FX chain.
TrackFX:add_fx_to_container (fx, position) Move an FX into this container.
TrackFX:copy_fx_to_container (fx, position) Copy an FX into this container.


ReaWrap Custom Methods

TrackFX:new (track, fx_idx)
Create new TrackFX instance.

Parameters:

  • track table The Track object
  • fx_idx number The index of the FX

Returns:

    table TrackFX instance
TrackFX:log (...)
Log messages with the TrackFX logger.

Parameters:

  • ... (varargs) Messages to log.
TrackFX:__tostring ()
String representation of the TrackFX instance.

Returns:

    string
TrackFX:delete ()
Delete this FX from the track.

Returns:

    boolean Success
TrackFX:get_param_values ()
Get param values from TrackFX.

Returns:

    table array
TrackFX:iter_param_values ()
Iterate over TrackFX param values.

Returns:

    function iterator
TrackFX:get_param_names ()
Get param names from TrackFX.

Returns:

    table array
TrackFX:iter_param_names ()
Iterate over TrackFX param names.

Returns:

    function iterator
TrackFX:create_param_link (source_fx, source_param_idx, target_param_idx, scale)
Create a parameter modulation link from a source FX to this FX's parameter. Automatically handles local container indices when both FX are in the same container.

Parameters:

  • source_fx table The source FX (modulator) TrackFX object
  • source_param_idx number The parameter index of the source FX output
  • target_param_idx number The parameter index on this FX to modulate
  • scale number|nil Modulation scale (0.0-1.0), defaults to 1.0 (100%)

Returns:

    boolean Success
TrackFX:remove_param_link (target_param_idx)
Remove a parameter modulation link from this FX's parameter.

Parameters:

  • target_param_idx number The parameter index to remove modulation from

Returns:

    boolean Success
TrackFX:get_param_link_info (target_param_idx)
Get parameter modulation link information.

Parameters:

  • target_param_idx number The parameter index to query

Returns:

    table|nil Link info table with fields: active, effect, param, scale, offset, baseline, or nil if no link

ReaScript Wrapped Methods

TrackFX:end_param_edit (param)
End Param Edit. Wraps TrackFX_EndParamEdit.

Parameters:

  • param number

Returns:

    boolean
TrackFX:format_param_value (param, val)
Format Param Value. Wraps TrackFX_FormatParamValue. Note: only works with FX that support Cockos VST extensions.--- @within ReaScript Wrapped Methods param number--- @within ReaScript Wrapped Methods val number

Parameters:

  • param
  • val

Returns:

    string
TrackFX:format_param_value_normalized (param, value, buf)
Format Param Value Normalized. Wraps TrackFX_FormatParamValueNormalized. Note: only works with FX that support Cockos VST extensions.

Parameters:

  • param number
  • value number
  • buf string

Returns:

    string
TrackFX:get_chain_visible ()
Get Chain Visible. Wraps TrackFX_GetChainVisible. returns index of effect visible in chain, or -1 for chain hidden, or -2 for chain visible but no effect selected

Returns:

    number
TrackFX:get_enabled ()
Get Enabled. Wraps TrackFX_GetEnabled.

Returns:

    boolean
TrackFX:get_eq (instantiate)
Get Eq. Wraps TrackFX_GetEQ. Get the index of ReaEQ in the track FX chain. If ReaEQ is not in the chain and instantiate is true, it will be inserted.

Parameters:

  • instantiate boolean Optional.

Returns:

    number

See also:

TrackFX:get_eq_band_enabled (band_type, band_idx)
Get Eq Band Enabled. Wraps TrackFX_GetEQBandEnabled. Returns true if the EQ band is enabled. Returns false if the band is disabled, or if track/fx_idx is not ReaEQ.

Parameters:

  • band_type number TrackFX.BandTypeConstants.
  • band_idx number TrackFX.BandIndexConstants.

Returns:

    boolean
TrackFX:get_eq_param (param_idx)
Get Eq Param. Wraps TrackFX_GetEQParam. Returns false if track/fx_idx is not ReaEQ. bandpass.

Parameters:

  • param_idx number

Returns:

  1. number band_type. See TrackFX.BandTypeConstants.
  2. number band_idx See TrackFX.BandIndexConstants.
  3. number param_type
  4. number norm_val
TrackFX:get_floating_window ()
Get Floating Window. Wraps TrackFX_GetFloatingWindow. returns HWND of floating window for effect index, if any. and container_item.X.

Returns:

    userdata HWND
TrackFX:get_formatted_param_value (param)
Get Formatted Param Value. Wraps TrackFX_GetFormattedParamValue.

Parameters:

  • param number

Returns:

    string
TrackFX:get_guid ()
Get Guid. Wraps TrackFX_GetFXGUID.

Returns:

    string
TrackFX:get_name (fx_idx)
Get Name. Wraps TrackFX_GetFXName.

Parameters:

  • fx_idx number Optional. If not provided, the current FX index will be used.

Returns:

    string
TrackFX:get_instrument ()
Get Instrument. Wraps TrackFX_GetInstrument. Get the index of the first track FX insert that is a virtual instrument, or -1 if none.

Returns:

    number

See also:

TrackFX:get_io_size ()
Get Io Size. Wraps TrackFX_GetIOSize. Gets the number of input/output pins for FX if available, returns plug-in type or -1 on error.

Returns:

  1. number input_pins
  2. number output_pins
TrackFX.NamedConfigParamConstants:create (params)
Create a table of named configuration parameters constants.

Parameters:

  • params Optional. A table containing values that need to be associated to a constant, e.g. CONTAINER_ITEM_X.

Returns:

    table. A populated table of configuration constants.

See also:

Usage:

    -- For config params that require a value to be associated with a constant, e.g. CONTAINER_ITEM_X
local constants = TrackFX.NamedConfigParamConstants:create({container_idx = 0})
-- For config params that don't require a value
local constants = TrackFX.NamedConfigParamConstants:create()
TrackFX:get_named_config_param (param_name)
Get Named Config Param. Wraps TrackFX_GetNamedConfigParm. Gets plug-in specific named configuration value.

Parameters:

  • param_name string. Use TrackFX.NamedConfigParamConstants:create(params --[[optional]) for valid constants.

Returns:

  1. buf string
  2. string|nil value The parameter value, or nil if not found

See also:

Usage:

    -- For config params that don't require a value
local constants = TrackFX.NamedConfigParamConstants:create()
TrackFX:get_named_config_param(constants.PDC)
-- For config params that require a value
local constants = TrackFX.NamedConfigParamConstants:create({container_idx = 0})
TrackFX:get_named_config_param(constants.CONTAINER_ITEM_X)
TrackFX:get_num_params ()
Get Num Params. Wraps TrackFX_GetNumParams.

Returns:

    number
TrackFX:get_offline ()
Get Offline. Wraps TrackFX_GetOffline.

Returns:

    boolean
TrackFX:get_open ()
Get Open. Wraps TrackFX_GetOpen.

Returns:

    boolean
TrackFX:get_param (param)
Get Param. Wraps TrackFX_GetParam.

Parameters:

  • param number

Returns:

  1. number param_value The current parameter value
  2. number min_val The minimum parameter value
  3. number max_val The maximum parameter value
TrackFX:get_parameter_step_sizes (param)
Get Parameter Step Sizes. Wraps TrackFX_GetParameterStepSizes.

Parameters:

  • param number

Returns:

  1. number step
  2. number small_step
  3. number large_step
  4. boolean is_toggle
TrackFX:get_param_ex (param)
Get Param Ex. Wraps TrackFX_GetParamEx.

Parameters:

  • param number

Returns:

  1. number min_val
  2. number max_val
  3. number mid_val
TrackFX:get_param_from_ident (ident_str)
Get Param From Ident. Wraps TrackFX_GetParamFromIdent. gets the parameter index from an identifying string (:wet, :bypass, :delta, or a string returned from GetParamIdent), or -1 if unknown.

Parameters:

  • ident_str string

Returns:

    number
TrackFX:get_param_ident (param)
Get Param Ident. Wraps TrackFX_GetParamIdent.

Parameters:

  • param number

Returns:

    string
TrackFX:get_param_name (param)
Get Param Name. Wraps TrackFX_GetParamName.

Parameters:

  • param number

Returns:

    string
TrackFX:get_param_normalized (param)
Get Param Normalized. Wraps TrackFX_GetParamNormalized.

Parameters:

  • param number

Returns:

    number
TrackFX:get_pin_mappings (is_output, pin)
Get Pin Mappings. Wraps TrackFX_GetPinMappings. gets the effective channel mapping bitmask for a particular pin. high32Out will be set to the high 32 bits. Add 0x1000000 to pin index in order to access the second 64 bits of mappings independent of the first 64 bits. FX indices for tracks can have 0x1000000 added to them in order to reference record input FX (normal tracks) or hardware output FX (master track).

Parameters:

  • is_output number
  • pin number

Returns:

    number high32
TrackFX:get_preset ()
Get Preset. Wraps TrackFX_GetPreset. Get the name of the preset currently showing in the REAPER dropdown, or the full path to a factory preset file for VST3 plug-ins (.vstpreset).

See also:

TrackFX:get_preset_index ()
Get Preset Index. Wraps TrackFX_GetPresetIndex.

Returns:

    number
TrackFX:get_rec_chain_visible ()
Get Rec Chain Visible. Wraps TrackFX_GetRecChainVisible. returns index of effect visible in record input chain, or -1 for chain hidden, or -2 for chain visible but no effect selected

Returns:

    number
TrackFX:get_rec_count ()
Get Rec Count. Wraps TrackFX_GetRecCount. returns count of record input FX. To access record input FX, use a FX indices [0x1000000..0x1000000+n). On the master track, this accesses monitoring FX rather than record input FX.

Returns:

    number
TrackFX:get_user_preset_filename ()
Get User Preset Filename. Wraps TrackFX_GetUserPresetFilename.

Returns:

    string
TrackFX:navigate_presets (preset_move)
Navigate Presets. Wraps TrackFX_NavigatePresets. preset_move==1 activates the next preset, preset_move==-1 activates the previous preset, etc.

Parameters:

  • preset_move number

Returns:

    boolean
TrackFX:set_enabled (enabled)
Set Enabled. Wraps TrackFX_SetEnabled. See TrackFX:get_enabled. FX indices for tracks can have 0x1000000 added to them in order to reference record input FX (normal tracks) or hardware output FX (master track).

Parameters:

  • enabled boolean

See also:

TrackFX:set_eq_band_enabled (band_type, band_idx, enable)
Set Eq Band Enabled. Wraps TrackFX_SetEQBandEnabled.

Parameters:

  • band_type number TrackFX.BandTypeConstants.
  • band_idx number TrackFX.BandIndexConstants.
  • enable boolean

Returns:

    boolean
TrackFX:set_eq_param (band_type, band_idx, param_type, val, is_norm)
Set Eq Param. Wraps TrackFX_SetEQParam. Returns false if track/fxidx is not ReaEQ.

Parameters:

  • band_type number TrackFX.BandTypeConstants.
  • band_idx number TrackFX.BandIndexConstants.
  • param_type number
  • val number
  • is_norm boolean

Returns:

    boolean
TrackFX:set_named_config_param (param_name, value)
Set Named Config Parm. Wraps TrackFX_SetNamedConfigParm. sets plug-in specific named configuration value (returns true on success).

Parameters:

  • param_name string
  • value string

Returns:

    boolean
TrackFX:set_offline (offline)
Set Offline. Wraps TrackFX_SetOffline.

Parameters:

  • offline boolean

See also:

TrackFX:set_open (open)
Set Open. Wraps TrackFX_SetOpen. Open this FX UI.

Parameters:

  • open boolean

See also:

TrackFX:set_param (param, val)
Set Param. Wraps TrackFX_SetParam.

Parameters:

  • param number
  • val number

Returns:

    boolean
TrackFX:set_param_normalized (param, value)
Set Param Normalized. Wraps TrackFX_SetParamNormalized.

Parameters:

  • param number
  • value number

Returns:

    boolean
TrackFX:set_pin_mappings (is_output, pin, low32bits, hi32bits)
Set Pin Mappings. Wraps TrackFX_SetPinMappings. sets the channel mapping bitmask for a particular pin. returns false if unsupported (not all types of plug-ins support this capability). Add 0x1000000 to pin index in order to access the second 64 bits of mappings independent of the first 64 bits.

Parameters:

  • is_output number
  • pin number
  • low32bits number
  • hi32bits number

Returns:

    boolean
TrackFX:set_preset (preset_name)
Set Preset. Wraps TrackFX_SetPreset. Activate a preset with the name shown in the REAPER dropdown. Full paths to .vst preset files are also supported for VST3 plug-ins.

Parameters:

  • preset_name string

Returns:

    boolean

See also:

TrackFX:set_preset_by_index (preset_idx)
Set Preset By Index. Wraps TrackFX_SetPresetByIndex. Sets the preset idx, or the factory preset (idx==-2), or the default user preset (idx==-1). Returns true on success.

Parameters:

  • preset_idx number The index of the preset

Returns:

    boolean

See also:

TrackFX:show (show_flag)
Show. Wraps TrackFX_Show.

Parameters:

  • show_flag number TrackFX.ShowFlagsConstants.
TrackFX:get_chain ()
Get Chain. Wraps CF_GetTrackFXChain. Return a handle to the given track FX chain window.

Returns:

    FxChain
TrackFX:get_chain_ex (want_input_chain)
Get Chain Ex. Wraps CF_GetTrackFXChainEx. Return a handle to the given track FX chain window. Set wantInputChain to get the track's input/monitoring FX chain.

Parameters:

  • want_input_chain boolean

Returns:

    userdata FxChain TODO move this to Project
TrackFX:select ()
Select. Wraps CF_SelectTrackFX. Set which track effect is active in the track's FX chain. The FX chain window does not have to be open.

Returns:

    boolean

Constants

TrackFX.NamedConfigParamConstants.ReadOnly
A table of configuration parameters for TrackFX:get_named_config_param. Read Only.

Fields:

  • PDC string PDC latency
  • IN_PIN_X string name of input pin X
  • OUT_PIN_X string name of output pin X
  • FX_TYPE string type string
  • FX_IDENT string type-specific identifier
  • FX_NAME string name of FX (also supported as original_name)
  • GAINREDUCTION_DB string [ReaComp + other supported compressors]
  • PARENT_CONTAINER string FX ID of parent container, if any (v7.06+)
  • CONTAINER_COUNT string [Container] number of FX in container
  • CONTAINER_ITEM_X string FX ID of item in container (first item is container_item.0) (v7.06+)
  • PARAM_X_CONTAINER_MAP_HINT_ID string unique ID of mapping (preserved if mapping order changes)
  • PARAM_X_CONTAINER_MAP_DELETE string read this value in order to remove the mapping for this parameter
  • CONTAINER_MAP_ADD string read from this value to add a new container parameter mapping -- will return new parameter index (accessed via param.X.container_map.*)
  • CONTAINER_MAP_ADD_FXID_PARMIDX string read from this value to add/get container parameter mapping for FXID/PARMIDX -- will return the parameter index (accessed via param.X.container_map.*). FXID can be a full address (must be a child of the container) or a 0-based sub-index (v7.06+).
  • CONTAINER_MAP_GET_FXID_PARMIDX string read from this value to get container parameter mapping for FXID/PARMIDX -- will return the parameter index (accessed via param.X.container_map.*). FXID can be a full address (must be a child of the container) or a 0-based sub-index (v7.06+).
  • CHAIN_PDC_ACTUAL string returns the actual chain latency in samples, only valid after playback has commenced, may be rounded up to block size.
  • CHAIN_PDC_REPORTING string returns the reported chain latency, always valid, not rounded to block size.
TrackFX.NamedConfigParamConstants.ReadWrite
A table of configuration parameters for TrackFX:get_named_config_param. Read Write.

Fields:

  • VST_CHUNK_PROGRAM string base64-encoded VST-specific chunk.
  • CLAP_CHUNK string base64-encoded CLAP-specific chunk.
  • PARAM_X_LFO string parameter modulation LFO state
  • PARAM_X_ACS string parameter modulation ACS state
  • PARAM_X_PLINK string parameter link/MIDI link: set effect=-100 to support midi_*
  • PARAM_X_MOD string parameter module global settings
  • PARAM_X_LEARN string first two bytes of MIDI message, or OSC string if set
  • PARAM_X_LEARN_MODE string absolution/relative mode flag (0: Absolute, 1: 127=-1,1=+1, 2: 63=-1, 65=+1, 3: 65=-1, 1=+1, 4: toggle if nonzero)
  • PARAM_X_LEARN_FLAGS string &1=selected track only, &2=soft takeover, &4=focused FX only, &8=LFO retrigger, &16=visible FX only
  • PARAM_X_CONTAINER_MAP_FX_INDEX string index of FX contained in container
  • PARAM_X_CONTAINER_MAP_FX_PARM string parameter index of parameter of FX contained in container
  • PARAM_X_CONTAINER_MAP_ALIASED_NAME string name of parameter (if user-renamed, otherwise fails)
  • BANDTYPE_X string band configuration [ReaEQ]
  • BANDENABLED_X string band configuration [ReaEQ]
  • THRESHOLD string [ReaLimit]
  • CEILING string [ReaLimit]
  • TRUEPEAK string [ReaLimit]
  • NUMCHANNELS string [ReaSurroundPan]
  • NUMSPEAKERS string [ReaSurroundPan]
  • RESETCHANNELS string [ReaSurroundPan]
  • ITEM_X string [ReaVerb] state configuration line, when writing should be followed by a write of DONE
  • FILE string [RS5k] file list, -/+ prefixes are write-only, when writing any, should be followed by a write of DONE
  • FILE_X string [RS5k] file list, -/+ prefixes are write-only, when writing any, should be followed by a write of DONE
  • MINUS_FILE_X string [RS5k] file list, -/+ prefixes are write-only, when writing any, should be followed by a write of DONE
  • PLUS_FILE_X string [RS5k] file list, -/+ prefixes are write-only, when writing any, should be followed by a write of DONE
  • MINUS_FILE_STAR string [RS5k] file list, -/+ prefixes are write-only, when writing any, should be followed by a write of DONE
  • MODE string [RS5k] general mode, resample mode
  • RSMODE string [RS5k] general mode, resample mode
  • VIDEO_CODE string [video processor] code
  • FORCE_AUTO_BYPASS string 0 or 1 - force auto-bypass plug-in on silence
  • PARALLEL string 0, 1 or 2 - 1=process plug-in in parallel with previous, 2=process plug-in parallel and merge MIDI
  • INSTANCE_OVERSAMPLE_SHIFT string instance oversampling shift amount, 0=none, 1=~96k, 2=~192k, etc. When setting requires playback stop/start to take effect
  • CHAIN_OVERSAMPLE_SHIFT string chain oversampling shift amount, 0=none, 1=~96k, 2=~192k, etc. When setting requires playback stop/start to take effect
  • CHAIN_PDC_MODE string chain PDC mode (0=classic, 1=new-default, 2=ignore PDC, 3=hwcomp-master)
  • CHAIN_SEL string selected/visible FX in chain
  • RENAMED_NAME string renamed FX instance name (empty string = not renamed)
  • CONTAINER_NCH string number of internal channels for container
  • CONTAINER_NCH_IN string number of input pins for container
  • CONTAINER_NCH_OUT string number of output pins for container
  • CONTAINER_NCH_FEEDBACK string number of internal feedback channels enabled in container
  • FOCUSED string reading returns 1 if focused. Writing a positive value to this sets the FX UI as `last focused.`
  • LAST_TOUCHED string reading returns two integers, one indicates whether FX is the last-touched FX, the second indicates which parameter was last touched. Writing a negative value ensures this plug-in is not set as last touched, otherwise the FX is set "last touched," and last touched parameter index is set to the value in the string (if valid).
TrackFX.NamedConfigParamValues
A table of values to be associated with configuration constants.

Fields:

  • container_idx number Index of the container.
  • input_pin_idx number Index of the input pin.
  • output_pin_idx number Index of the output pin.
  • fx_idx number Index of the FX.
  • param_idx number Index of the parameter.
  • param_value string Value of the parameter.

See also:

Container Methods

TrackFX:is_container ()
Check if this FX is a container.

Returns:

    boolean True if this FX is a container
TrackFX:get_container_child_count ()
Get the number of FX in this container.

Returns:

    number Number of child FX (0 if not a container)
TrackFX:get_container_children ()
Get child FX from this container.

Returns:

    table Array of TrackFX objects
TrackFX:iter_container_children ()
Iterate over child FX in this container.

Returns:

    function Iterator yielding TrackFX objects
TrackFX:get_parent_container ()
Get the parent container of this FX.

Returns:

    TrackFX|nil Parent container, or nil if top-level
TrackFX:get_container_depth ()
Get the container hierarchy depth of this FX.

Returns:

    number Depth (0 = top-level)
TrackFX:get_container_channels ()
Get the internal channel count of this container.

Returns:

    number Channel count (default 2)
TrackFX:set_container_channels (channels)
Set the internal channel count of this container.

Parameters:

  • channels number Channel count (2, 4, 6, 8, etc.)

Returns:

    boolean Success
TrackFX:get_container_input_pins ()
Get the input pin count of this container.

Returns:

    number Input pin count
TrackFX:set_container_input_pins (pins)
Set the input pin count of this container.

Parameters:

  • pins number Input pin count

Returns:

    boolean Success
TrackFX:get_container_output_pins ()
Get the output pin count of this container.

Returns:

    number Output pin count
TrackFX:set_container_output_pins (pins)
Set the output pin count of this container.

Parameters:

  • pins number Output pin count

Returns:

    boolean Success
TrackFX:refresh_pointer ()
Refresh this FX's pointer by finding it again using its GUID. This is useful when the pointer might have become stale due to container operations.

Returns:

    boolean True if pointer was refreshed successfully
TrackFX:move_to_container (container, position)
Move this FX into a container.

Parameters:

  • container TrackFX Container to move this FX into
  • position number|nil Position within container (nil = end)

Returns:

    boolean Success
TrackFX:move_out_of_container (position)
Move this FX out of its container to the main FX chain.

Parameters:

  • position number|nil 0-based position in main chain (nil = end)

Returns:

    boolean Success
TrackFX:add_fx_to_container (fx, position)
Move an FX into this container.

Parameters:

  • fx TrackFX FX to move into this container
  • position number|nil 0-based position within container (nil = end)

Returns:

    boolean Success
TrackFX:copy_fx_to_container (fx, position)
Copy an FX into this container.

Parameters:

  • fx TrackFX FX to copy into this container
  • position number|nil Position within container (nil = end)

Returns:

    boolean Success
generated by LDoc 1.5.0 Last updated 2026-01-17 13:27:25