Skip to contents

Returns detailed information about the configurable parameters for a given Vamp plugin. Parameters can be adjusted to customize plugin behavior.

Usage

vampPluginParams(key)

Arguments

key

Character string specifying the plugin key in "library:plugin" format (e.g., "vamp-aubio-plugins:aubionotes"). Use vampPlugins to get plugin IDs.

Value

A data frame with one row per parameter and columns including:

identifier

Parameter identifier

name

Human-readable parameter name

description

Parameter description

unit

Unit of measurement (if applicable)

min_value

Minimum allowed value

max_value

Maximum allowed value

default_value

Default value

quantized

Logical indicating if parameter is quantized to discrete values

Returns an empty data frame if the plugin has no configurable parameters.

See also

vampPlugins to list available plugins

Examples

if (FALSE) { # \dontrun{
# Get parameters for aubio onset detector
params <- vampPluginParams("vamp-aubio-plugins:aubioonset")
} # }