soir
OVERVIEW
The errors module contains exceptions raised by the Soir engine to
signal errors at runtime.
CLASS
ConfigurationError
Raised when there is a configuration error.
This exception is raised when required configuration is missing, such as the SOIR_DIR environment variable not being set.
ControlNotFoundException
Raised when trying to use an unknown control.
In Soir, controls are used to change settings in real-time and are orchestrated by the engine. This exception is raised if an undefined control is used.
InLoopException
Raised when trying to execute code inside a live context.
In Soir, some of the code is expected to be used from the global scope as it affects everything, for example, setting the BPM. This exception is raised if such code is called from a loop.
NotInControlLoopException
Raised when trying to use a control outside of a control loop.
In Soir, controls are used to change settings in real-time and are orchestrated by the engine. This exception is raised if a control is instrumented from outside of the Soir control loop.
NotInLoopException
Raised when trying to execute code outside of a live context.
In Soir, some of the code is expected to be used from within a loop or a live function, for instance sleeping between two instructions. This exception is raised if such code is called from the global scope.
SamplePackNotFoundException
Raised when trying to load a non-existing sample pack.
Sample packs are loaded once at the initialization of the session, trying to refer to a non-loaded pack triggers this exception. Configure your session to include the desired sample packs.
SoirException
Base class for Soir exceptions.
TrackNotFoundException
Raised when trying to access a non-existing track.
This exception is raised when trying to get levels or other information for a track that doesn't exist.
UnknownMidiTrackException
Raised when trying to use an invalid MIDI track.
In Soir, MIDI tracks are used to send MIDI events to the external synthesizer. This exception is raised if an invalid MIDI track is used.