Module: ladspa

Module: ladspa ./ladspa.py

The high-level ladspa interface.

Imported modules

import _ladspa
import os
import sys
import types

Functions

find_plugin

find_plugin ( name,  ladspapath=None )

find_plugin(name, ladspapath=None) -> path

Given a name and ladspapath, returns a full path to a ladspa module or None.

name - A name string: can be a relative or absolute path, or the filename with the suffix removed. Examples: /usr/lib/ladspa/cmt.so or cmt.so or cmt The last is most platform independent.

ladspapath - The same format as for get_ladspa_path.

Return Value - Either a full path string, or None if no plugin could be found.

functions:

get_ladspa_path

get_ladspa_path ( ladspapath=None )

get_ladspa_path( ladspapath=None ) -> pathseq

ladspapath - Either, None, a string, or a sequence of strings. If None, the default path is used. The default path is the environment variable LADSPA_PATH if defined or a system default. If it is a string, it is considered to have the same format as the environment variable; that is directory paths separated by os.pathsep. If it is a sequence of strings, they should be directory paths to search, in order of priority. Bad paths are ignored.

Returns a list of path strings.

main

main ( argv=() )

The main procedure simply displays information about plugins on stdout. Run this module as a script with an argument of "--help" for command-line usage information.

The main procedure:

Exceptions
Exceptions	SystemExit( usage )

Classes

BadFlags	Raised when a descriptor has flags inconsistent with the LADSPA specification.
Descriptor	A Descriptor is the basic ladspa type, representing a set of parameters and a specific type of audio processing.
DescriptorMap	Maps UniqueID's and Label's to Descriptor instances for an entire set of directories.
Handle	A Handle is a specific instance of a Descriptor. It is what acts on audio data.
Plugin	A Plugin represents a shared object file which implements the ladspa interface.
PluginNotFound	Raised when a plugin cannot be found.
Port	A Port belongs to a particular Handle. It contains audio buffers or control data, which can change in realtime.
PortDescriptor	A PortDescriptor represents information about the type of a Port.
_AttributeForwarder	A private base-class which aids in wrapping lower-level types.

Table of Contents

This document was automatically generated on Sun Apr 14 04:00:09 2002 by HappyDoc version 2.0