package lilv

  1. Overview
  2. Docs

Plugins.

type t

A plugin.

val uri : t -> string

URI of a plugin.

val name : t -> string

Name of a plugin.

val author_name : t -> string

Author's name of a plugin.

val author_email : t -> string

Author's email of a plugin.

val author_homepage : t -> string

Author's homepage of a plugin.

module Class : sig ... end

Classes of plugins.

val plugin_class : t -> Class.t

Class of a plugin.

val is_replaced : t -> bool
val supported_features : t -> Node.t list
val required_features : t -> Node.t list
val optional_features : t -> Node.t list
val num_ports : t -> int

Number of ports of a plugin.

val port_by_index : t -> int -> Port.t

Retrieve a port by its index.

val port_by_symbol : t -> string -> Port.t

Retrieve a port by its symbol.

val has_latency : t -> bool

Whether or not the plugin introduces (and reports) latency.

val latency_port_index : t -> int

Index of the plugin's latency port. It is a fatal error to call this on a plugin without checking if the port exists by first calling has_latency. Any plugin that introduces unwanted latency that should be compensated for (by hosts with the ability/need) must provide this port, which is a control rate output port that reports the latency for each cycle in frames.

module Instance : sig ... end

Instances of plugins.

val instantiate : t -> float -> Instance.t

Create an instance of a plugin.