Module take_fx
Provide implementation for TakeFX functions.
Info:
- License: MIT
- Author: Nomad Monad
ReaWrap Custom Methods
| TakeFX:new (take, fx_idx) | Create new TakeFX instance. |
| TakeFX:log (...) | Log messages with the TakeFX logger. |
| TakeFX:__tostring () | String representation of the TakeFX instance. |
| TakeFX:get_param_values () | Get param values from TakeFX. |
| TakeFX:iter_param_values () | Iterate over TakeFX param values. |
| TakeFX:get_param_names () | Get param names from TakeFX. |
| TakeFX:iter_param_names () | Iterate over TakeFX param names. |
ReaScript Wrapped Methods
ReaWrap Custom Methods
- TakeFX:new (take, fx_idx)
-
Create new TakeFX instance.
Parameters:
- take Take. The Take object.
- fx_idx number. The index of the FX.
Returns:
-
TakeFX table.
- TakeFX:log (...)
-
Log messages with the TakeFX logger.
Parameters:
- ... (varargs) Messages to log.
- TakeFX:__tostring ()
-
String representation of the TakeFX instance.
Returns:
-
string
- TakeFX:get_param_values ()
-
Get param values from TakeFX.
Returns:
-
table array of param values (min_val, max_val)
- TakeFX:iter_param_values ()
-
Iterate over TakeFX param values.
Returns:
-
function iterator
- TakeFX:get_param_names ()
-
Get param names from TakeFX.
Returns:
-
table array of param names
- TakeFX:iter_param_names ()
-
Iterate over TakeFX param names.
Returns:
-
function iterator
ReaScript Wrapped Methods
- TakeFX:add_by_name (fx_name, instantiate)
-
Add By Name. Wraps TakeFX_AddByName.
Parameters:
- fx_name string
- instantiate number
Returns:
-
number
- TakeFX:copy_to_take (dest_take, dest_fx, is_move)
-
Copy To Take. Wraps TakeFX_CopyToTake.
Parameters:
- dest_take Take table
- dest_fx number
- is_move boolean
- TakeFX:copy_to_track (dest_track, dest_fx, is_move)
-
Copy To Track. Wraps TakeFX_CopyToTrack.
Parameters:
- dest_track Track table
- dest_fx number
- is_move boolean
- TakeFX:end_param_edit (param)
-
End Param Edit. Wraps TakeFX_EndParamEdit.
Parameters:
- param number
Returns:
-
boolean
- TakeFX:format_param_value (param, val)
-
Format Param Value. Wraps TakeFX_FormatParamValue.
Note: only works with FX that support Cockos VST extensions.
Parameters:
- param number
- val number
Returns:
-
buf string
- TakeFX:format_param_value_normalized (param, value, buf)
-
Format Param Value Normalized. Wraps TakeFX_FormatParamValueNormalized.
Parameters:
- param number
- value number
- buf string
Returns:
-
buf string
- TakeFX:get_chain_visible ()
-
Get Chain Visible. Wraps TakeFX_GetChainVisible.
returns index of effect visible in chain, or -1 for chain hidden, or -2 for
chain visible but no effect selected
Returns:
-
number
- TakeFX:get_enabled ()
-
Get Enabled. Wraps TakeFX_GetEnabled.
Returns:
-
boolean
- TakeFX:get_envelope (param_idx, create)
-
Get Envelope. Wraps TakeFX_GetEnvelope.
Parameters:
- param_idx number
- create boolean Optional. Default false.
Returns:
-
Envelope table
- TakeFX:get_floating_window ()
-
Get Floating Window. Wraps TakeFX_GetFloatingWindow.
Returns:
-
userdata HWND
- TakeFX:get_formatted_param_value (param)
-
Get Formatted Param Value. Wraps TakeFX_GetFormattedParamValue.
Parameters:
- param number
Returns:
-
buf string
- TakeFX:get_guid ()
-
Get Guid. Wraps TakeFX_GetFXGUID.
Returns:
-
guid string
- TakeFX:get_name ()
-
Get Name. Wraps TakeFX_GetFXName.
Returns:
-
buf string
- TakeFX:get_io_size ()
-
Get Io Size. Wraps TakeFX_GetIOSize.
Returns:
- input_pins number
- output_pins number
- TakeFX:get_named_config_parm (param_name)
-
Get Named Config Parm. Wraps TakeFX_GetNamedConfigParm.
Parameters:
- param_name string
Returns:
-
buf string
- TakeFX:get_num_params ()
-
Get Num Params. Wraps TakeFX_GetNumParams.
Returns:
-
number
- TakeFX:get_offline ()
-
Get Offline. Wraps TakeFX_GetOffline.
Returns:
-
boolean
- TakeFX:get_open ()
-
Get Open. Wraps TakeFX_GetOpen.
Returns:
-
boolean
- TakeFX:get_param (param)
-
Get Param. Wraps TakeFX_GetParam.
Parameters:
- param number
Returns:
- min_val number
- max_val number
- TakeFX:get_parameter_step_sizes (param)
-
Get Parameter Step Sizes. Wraps TakeFX_GetParameterStepSizes.
Parameters:
- param number
Returns:
- step number
- small_step number
- large_step number
- is_toggle boolean
- TakeFX:get_param_ex (param)
-
Get Param Ex. Wraps TakeFX_GetParamEx.
Parameters:
- param number
Returns:
- min_val number
- max_val number
- mid_val number
- TakeFX:get_param_from_ident (ident_str)
-
Get Param From Ident. Wraps TakeFX_GetParamFromIdent.
Parameters:
- ident_str string
Returns:
-
number
- TakeFX:get_param_ident (param)
-
Get Param Ident. Wraps TakeFX_GetParamIdent.
Parameters:
- param number
Returns:
-
buf string
- TakeFX:get_param_name (param)
-
Get Param Name. Wraps TakeFX_GetParamName.
Parameters:
- param number
Returns:
-
buf string
- TakeFX:get_param_normalized (param)
-
Get Param Normalized. Wraps TakeFX_GetParamNormalized.
Parameters:
- param number
Returns:
-
number
- TakeFX:get_pin_mappings (is_output, pin)
-
Get Pin Mappings. Wraps TakeFX_GetPinMappings.
Parameters:
- is_output number
- pin number
Returns:
-
high32 number
- TakeFX:get_preset ()
-
Get Preset. Wraps TakeFX_GetPreset.
Returns:
-
preset_name string
- TakeFX:get_preset_index ()
-
Get Preset Index. Wraps TakeFX_GetPresetIndex.
Returns:
-
number_of_presets number
- TakeFX:get_user_preset_filename ()
-
Get User Preset Filename. Wraps TakeFX_GetUserPresetFilename.
Returns:
-
fn string
- TakeFX:navigate_presets (preset_move)
-
Navigate Presets. Wraps TakeFX_NavigatePresets.
preset_move==1 activates the next preset, preset_move==-1 activates the previous
preset, etc.
Parameters:
- preset_move number
Returns:
-
boolean
- TakeFX:set_enabled (enabled)
-
Set Enabled. Wraps TakeFX_SetEnabled.
Parameters:
- enabled boolean
- TakeFX:set_named_config_parm (param_name, value)
-
Set Named Config Parm. Wraps TakeFX_SetNamedConfigParm.
Parameters:
- param_name string
- value string
Returns:
-
boolean
- TakeFX:set_offline (offline)
-
Set Offline. Wraps TakeFX_SetOffline.
Parameters:
- offline boolean
- TakeFX:set_open (open)
-
Set Open. Wraps TakeFX_SetOpen.
Parameters:
- open boolean Optional. Default true.
- TakeFX:set_param (param, val)
-
Set Param. Wraps TakeFX_SetParam.
Parameters:
- param number
- val number
Returns:
-
boolean
- TakeFX:set_param_normalized (param, value)
-
Set Param Normalized.
Parameters:
- param number
- value number
Returns:
-
boolean
- TakeFX:set_pin_mappings (is_output, pin, low32bits, hi32bits)
-
Set Pin Mappings. Wraps TakeFX_SetPinMappings.
Parameters:
- is_output number
- pin number
- low32bits number
- hi32bits number
Returns:
-
boolean
- TakeFX:set_preset (preset_name)
-
Set Preset. Wraps TakeFX_SetPreset.
Parameters:
- preset_name string
Returns:
-
boolean
- TakeFX:set_preset_by_index (preset_idx)
-
Set Preset By Index. Wraps TakeFX_SetPresetByIndex.
Parameters:
- preset_idx number The index of the preset
Returns:
-
boolean
- TakeFX:show (show_flag)
-
Show. Wraps TakeFX_Show.
Parameters:
- show_flag number
- TakeFX:get_fx_count ()
-
Get Fx Count. Wraps BR_GetTakeFXCount.
[BR] Returns FX count for supplied tak.
Returns:
-
number
- TakeFX:get_chain ()
-
Get Chain. Wraps CF_GetTakeFXChain.
Return a handle to the given take FX chain window. HACK: This temporarily
renames the take in order to disambiguate the take FX chain window from
similarly named takes.
Returns:
-
FxChain
- TakeFX:select ()
-
Select. Wraps CF_SelectTakeFX.
Set which take effect is active in the take's FX chain. The FX chain window does
not have to be open.
Returns:
-
boolean