API Reference


Abstract

libbuzztrax-core is the main library for the buzztrax software system. This library contains all classes needed for the components of a song like machines, patterns, wires and so on. It further defines bases classes for common operations such as song input/output. The synthesis engine and the low-level parts of the sequencer are built into GStreamer. Please make sure you have read section conventions before reading further.

All data structures are encapsulated in objects based on GObject. Central starting points are BtApplication and BtSong. All the objects that belong to a song have their song-instance as their member. Likewise all objects that belong to the applications have their application instance as a member.

Table of Contents

Core Class Reference
libbtcore — core library of the buzztrax application framework
BtApplication — base class for a buzztrax based application
BtAudioSessionbin to be used by BtSinkMachine
BtSettings — class for buzztrax settings handling
BtChildProxy — Interface for multi child elements.
BtPersistence — object persistence interface
Song Class Reference
BtCmdPatternclass for an command pattern of a BtMachine instance
BtMachine — base class for signal processing machines
BtParameterGroup — a group of parameter
BtPatternclass for an event pattern of a BtMachine instance
BtPatternControlSourceCustom controlsource based on repeated event blocks (BtPatterns).
BtProcessorMachine — class for signal processing machines with inputs and outputs
BtSequenceclass for the event timeline of a BtSong instance
BtSetupclass with all machines and wires (BtMachine and BtWire) for a BtSong instance
BtSinkBinbin to be used by BtSinkMachine
BtSinkMachine — class for signal processing machines with inputs only
BtSongclass of a song project object (contains BtSongInfo, BtSetup, BtSequence and BtWavetable)
BtSongInfoclass that keeps the meta-data for a BtSong instance
BtSourceMachine — class for signal processing machines with outputs only
BtValueGroup — a GValue array of parameter values
BtWaveone BtWavetable entry that keeps a list of BtWavelevels
BtWavelevela single part of a BtWave item
BtWavetablethe list of BtWave items in a BtSong
BtWireclass for a connection of two BtMachines
Song IO Reference
BtSongIO — base class for song input and output
BtSongIONative — class for song input and output in builtin native format
BtSongIONativeBZT — class for song input and output in builtin native format
BtSongIONativeXML — class for song input and output in builtin native format
BtSongIOBuzz — class for song input in buzz bmx and bmw format