Get or set render parameters for a specific module

Source: R/controls.R

Each individual module has its own set of render parameters. Use these functions to obtain or set the state of these parameters.

render_param(mod, key, ...)

render_param(mod, key, ...) <- value

Arguments

mod

A tracker module object of class openmpt.

key

One of "MASTERGAIN", "STEREOSEPARATION", "INTERPOLATION", or "VOLUMERAMPING". details copied from libopenmpt documentation

Master Gain

The related value represents a relative gain in milliBel. The default value is 0. The supported value range is unlimited.

Stereo Separation

The related value represents the stereo separation generated by the libopenmpt mixer in percent. The default value is 100. The supported value range is from 0 up to 200.

Interpolation Filter

The related value represents the interpolation filter length used by the libopenmpt mixer. The default value is 0, which indicates a recommended default value. The supported value range is from 0 up to infinity. Values greater than the implementation limit are clamped to the maximum supported value. Currently supported values:

  • 0: internal default

  • 1: no interpolation (zero order hold)

  • 2: linear interpolation

  • 4: cubic interpolation

  • 8: windowed sinc with 8 taps

Volume Ramping Strength

The related value represents the amount of volume ramping done by the libopenmpt mixer. The default value is -1, which indicates a recommended default value. The meaningful value range is from -1 up to 10. A value of 0 completely disables volume ramping. This might cause clicks in sound output. Higher values imply slower/softer volume ramps.

...

Ignored.

value

An integer replacement value for the render parameter selected with key

Value

Returns the current integer render parameter for the specified key and mod. In case of an assign operator (<-) mod with an updated set of render parameters is returned.

Examples

mod <- demo_mod()

render_param(mod, "STEREOSEPARATION") <- 50
render_param(mod, "STEREOSEPARATION")
#> [1] 50
render_param(mod, "MASTERGAIN")
#> [1] 0
render_param(mod, "INTERPOLATION")
#> [1] 8
render_param(mod, "VOLUMERAMPING")
#> [1] -1