Module xAudioDevice

Static methods for dealing with Audio Devices.

Functions

get_param_index (device, param)
resolve_device (device, track_idx) [Static] Resolve the device/parameter indices based on a parameter
resolve_parameter (param, track_idx, device_idx) [Static] Resolve the device/parameter indices based on a parameter (TODO: API5 makes a much more efficient implementation possible)
get_device_routings (device) [Static] Determine if a device is linked to different fx-chains/tracks (detection not solid if the destination is automated - rare case!)
is_send_device (device) [Static] Check if provided device is a send device
get_mixer_parameters (device) [Static] Get parameters that are visible in the mixer
is_automated (device) check whether one or more device parameters are automated (AutoMate) why is this not working in headless/passive mode?
get_parameter_by_name (device, param_name)
copy_automation (track_idx, device_idx, seq_range, yield_at) copy automation from the specified device
clear_automation (track_idx, device, seq_range)
cut_automation (track_idx, device_idx, seq_range) cut automation from the specified device
swap_automation (source_track_index, source_device_index, dest_track_index, dest_device_index, seq_range) swap all automated parameters in the specified devices
paste_automation (device_auto, track_idx, device_idx, seq_range, apply_mode, yield_at)


Functions

get_param_index (device, param)

Parameters:

  • device (AudioDevice)
  • param (DeviceParameter)

Returns:

    number or nil
resolve_device (device, track_idx)
[Static] Resolve the device/parameter indices based on a parameter

Parameters:

  • device , renoise.AudioDevice
  • track_idx , restrict search to this track (optional)

Returns:

    int, device index
resolve_parameter (param, track_idx, device_idx)
[Static] Resolve the device/parameter indices based on a parameter (TODO: API5 makes a much more efficient implementation possible)

Parameters:

  • param , renoise.DeviceParameter
  • track_idx , restrict search to this track (optional)
  • device_idx , restrict search to this device (optional)

Returns:

  1. int, parameter index
  2. int, device index
  3. int, track index
get_device_routings (device)
[Static] Determine if a device is linked to different fx-chains/tracks (detection not solid if the destination is automated - rare case!)

Parameters:

  • device (renoise.AudioDevice)

Returns:

    table (linked fx-chains/tracks)
is_send_device (device)
[Static] Check if provided device is a send device

Parameters:

  • device (renoise.AudioDevice)

Returns:

    bool
get_mixer_parameters (device)
[Static] Get parameters that are visible in the mixer

Parameters:

  • device (renoise.AudioDevice)

Returns:

    table
is_automated (device)
check whether one or more device parameters are automated (AutoMate) why is this not working in headless/passive mode?

Parameters:

  • device (renoise.AudioDevice)

Returns:

  1. boolean
  2. renoise.DeviceParameter or nil
  3. number (parameter index) or nil
get_parameter_by_name (device, param_name)

Parameters:

  • device (renoise.AudioDevice)
  • param_name (string)

Returns:

  1. renoise.DeviceParameter or nil
  2. number (parameter index) or nil
copy_automation (track_idx, device_idx, seq_range, yield_at)
copy automation from the specified device

Parameters:

  • track_idx (number, track index
  • device_idx (number), device index
  • seq_range (xSequencerSelection), restrict to range - use full range if undefined
  • yield_at (xLib.YIELD_AT), for sliced processing
clear_automation (track_idx, device, seq_range)

Parameters:

  • track_idx (number)
  • device (renoise.AudioDevice)
  • seq_range (xSequencerSelection) range that should be cleared
cut_automation (track_idx, device_idx, seq_range)
cut automation from the specified device

Parameters:

  • track_idx (number, track index
  • device_idx (number), device index
  • seq_range (xSequencerSelection), restrict to range - use full range if undefined
swap_automation (source_track_index, source_device_index, dest_track_index, dest_device_index, seq_range)
swap all automated parameters in the specified devices

Parameters:

  • source_track_index
  • source_device_index
  • dest_track_index
  • dest_device_index
  • seq_range TODO

Returns:

  1. boolean, false when failed
  2. string, error message when failed
paste_automation (device_auto, track_idx, device_idx, seq_range, apply_mode, yield_at)

Parameters:

  • device_auto (instance of xAudioDeviceAutomation)
  • track_idx (number)
  • device_idx (number)
  • seq_range (xSequencerSelection), output range
  • apply_mode ] (xParameterAutomation.APPLY_MODE)
  • yield_at ] (xLib.YIELD_AT), for sliced processing

Returns:

  1. boolean, false when failed
  2. string, error message when failed
generated by LDoc 1.4.2