rtvamp.Plugin

class rtvamp.Plugin

Plugin base class.

Must be instantiated by the load_plugin() function or via the PluginLibrary class.

__init__(self: rtvamp._bindings.Plugin, samplerate: float) → None

Methods

__init__(self, samplerate)
get_copyright(self)
get_current_program(self)
get_description(self)
get_identifier(self)
get_input_domain(self)
get_input_samplerate(self)
get_library_path(self)
get_maker(self)
get_name(self)
get_output_count(self)
get_output_descriptors(self)
get_parameter(self, id)
get_parameter_descriptors(self)
get_plugin_version(self)
get_preferred_blocksize(self)
get_preferred_stepsize(self)
get_programs(self)
get_vamp_api_version(self)
initialise(self, stepsize, blocksize)
process(self, array, nsec)
reset(self)
select_program(self, name)
set_parameter(self, id, value)

get_copyright(self: rtvamp._bindings.Plugin) → str

get_current_program(self: rtvamp._bindings.Plugin) → str | None

get_description(self: rtvamp._bindings.Plugin) → str

get_identifier(self: rtvamp._bindings.Plugin) → str

get_input_domain(self: rtvamp._bindings.Plugin) → str

get_input_samplerate(self: rtvamp._bindings.Plugin) → float

get_library_path(self: rtvamp._bindings.Plugin) → os.PathLike

get_maker(self: rtvamp._bindings.Plugin) → str

get_name(self: rtvamp._bindings.Plugin) → str

get_output_count(self: rtvamp._bindings.Plugin) → int

get_output_descriptors(self: rtvamp._bindings.Plugin) → List[dict]

get_parameter(self: rtvamp._bindings.Plugin, id: str) → float | None

get_parameter_descriptors(self: rtvamp._bindings.Plugin) → List[dict]

get_plugin_version(self: rtvamp._bindings.Plugin) → int

get_preferred_blocksize(self: rtvamp._bindings.Plugin) → int

get_preferred_stepsize(self: rtvamp._bindings.Plugin) → int

get_programs(self: rtvamp._bindings.Plugin) → List[str]

get_vamp_api_version(self: rtvamp._bindings.Plugin) → int

initialise(self: rtvamp._bindings.Plugin, stepsize: int, blocksize: int) → bool

process(self: rtvamp._bindings.Plugin, array: numpy.ndarray[numpy.float32] | numpy.ndarray[numpy.complex64], nsec: int) → List[List[float]]

reset(self: rtvamp._bindings.Plugin) → None

select_program(self: rtvamp._bindings.Plugin, name: str) → bool

set_parameter(self: rtvamp._bindings.Plugin, id: str, value: float) → bool