www.linuxsampler.org/api/draft-linuxsampler-protocol.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en"><head><title>LinuxSampler Control Protocol</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="LinuxSampler Control Protocol">
<meta name="keywords" content="LSCP">
<meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
<style type='text/css'><!--
        body {
                font-family: verdana, charcoal, helvetica, arial, sans-serif;
                font-size: small; color: #000; background-color: #FFF;
                margin: 2em;
        }
        h1, h2, h3, h4, h5, h6 {
                font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
                font-weight: bold; font-style: normal;
        }
        h1 { color: #900; background-color: transparent; text-align: right; }
        h3 { color: #333; background-color: transparent; }

        td.RFCbug {
                font-size: x-small; text-decoration: none;
                width: 30px; height: 30px; padding-top: 2px;
                text-align: justify; vertical-align: middle;
                background-color: #000;
        }
        td.RFCbug span.RFC {
                font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
                font-weight: bold; color: #666;
        }
        td.RFCbug span.hotText {
                font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
                font-weight: normal; text-align: center; color: #FFF;
        }

        table.TOCbug { width: 30px; height: 15px; }
        td.TOCbug {
                text-align: center; width: 30px; height: 15px;
                color: #FFF; background-color: #900;
        }
        td.TOCbug a {
                font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
                font-weight: bold; font-size: x-small; text-decoration: none;
                color: #FFF; background-color: transparent;
        }

        td.header {
                font-family: arial, helvetica, sans-serif; font-size: x-small;
                vertical-align: top; width: 33%;
                color: #FFF; background-color: #666;
        }
        td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
        td.author-text { font-size: x-small; }

        /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
        a.info {
                /* This is the key. */
                position: relative;
                z-index: 24;
                text-decoration: none;
        }
        a.info:hover {
                z-index: 25;
                color: #FFF; background-color: #900;
        }
        a.info span { display: none; }
        a.info:hover span.info {
                /* The span will display just on :hover state. */
                display: block;
                position: absolute;
                font-size: smaller;
                top: 2em; left: -5em; width: 15em;
                padding: 2px; border: 1px solid #333;
                color: #900; background-color: #EEE;
                text-align: left;
        }

        a { font-weight: bold; }
        a:link    { color: #900; background-color: transparent; }
        a:visited { color: #633; background-color: transparent; }
        a:active  { color: #633; background-color: transparent; }

        p { margin-left: 2em; margin-right: 2em; }
        p.copyright { font-size: x-small; }
        p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
        table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
        td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }

        ol.text { margin-left: 2em; margin-right: 2em; }
        ul.text { margin-left: 2em; margin-right: 2em; }
        li      { margin-left: 3em; }

        /* RFC-2629 <spanx>s and <artwork>s. */
        em     { font-style: italic; }
        strong { font-weight: bold; }
        dfn    { font-weight: bold; font-style: normal; }
        cite   { font-weight: normal; font-style: normal; }
        tt     { color: #036; }
        tt, pre, pre dfn, pre em, pre cite, pre span {
                font-family: "Courier New", Courier, monospace; font-size: small;
        }
        pre {
                text-align: left; padding: 4px;
                color: #000; background-color: #CCC;
        }
        pre dfn  { color: #900; }
        pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
        pre .key { color: #33C; font-weight: bold; }
        pre .id  { color: #900; }
        pre .str { color: #000; background-color: #CFF; }
        pre .val { color: #066; }
        pre .rep { color: #909; }
        pre .oth { color: #000; background-color: #FCF; }
        pre .err { background-color: #FCC; }

        /* RFC-2629 <texttable>s. */
        table.all, table.full, table.headers, table.none {
                font-size: small; text-align: center; border-width: 2px;
                vertical-align: top; border-collapse: collapse;
        }
        table.all, table.full { border-style: solid; border-color: black; }
        table.headers, table.none { border-style: none; }
        th {
                font-weight: bold; border-color: black;
                border-width: 2px 2px 3px 2px;
        }
        table.all th, table.full th { border-style: solid; }
        table.headers th { border-style: none none solid none; }
        table.none th { border-style: none; }
        table.all td {
                border-style: solid; border-color: #333;
                border-width: 1px 2px;
        }
        table.full td, table.headers td, table.none td { border-style: none; }

        hr { height: 1px; }
        hr.insert {
                width: 80%; border-style: none; border-width: 0;
                color: #CCC; background-color: #CCC;
        }
--></style>
</head>
<body>
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
<tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
<tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
<tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
<tr><td class="header">Expires: June 7, 2008</td><td class="header">December 5, 2007</td></tr>
</table></td></tr></table>
<h1><br />LinuxSampler Control Protocol<br />LSCP 1.3</h1>

<h3>Status of this Memo</h3>
<p>
By submitting this Internet-Draft,
each author represents that any applicable patent or other IPR claims of which
he or she is aware have been or will be disclosed,
and any of which he or she becomes aware will be disclosed,
in accordance with Section&nbsp;6 of BCP&nbsp;79.</p>
<p>
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups.
Note that other groups may also distribute working documents as
Internet-Drafts.</p>
<p>
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any time.
It is inappropriate to use Internet-Drafts as reference material or to cite
them other than as &ldquo;work in progress.&rdquo;</p>
<p>
The list of current Internet-Drafts can be accessed at
<a href='http://www.ietf.org/ietf/1id-abstracts.txt'>http://www.ietf.org/ietf/1id-abstracts.txt</a>.</p>
<p>
The list of Internet-Draft Shadow Directories can be accessed at
<a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
<p>
This Internet-Draft will expire on June 7, 2008.</p>

<h3>Copyright Notice</h3>
<p>
Copyright &copy; The IETF Trust (2007).</p>

<h3>Abstract</h3>

<p>The LinuxSampler Control Protocol (LSCP) is an
            application-level protocol primarily intended for local and
            remote controlling the LinuxSampler backend application, which is a
            sophisticated server-like console application essentially playing
            back audio samples and manipulating the samples in real time to
            certain extent.
</p><a name="toc"></a><br /><hr />
<h3>Table of Contents</h3>
<p class="toc">
<a href="#anchor1">1.</a>&nbsp;
Requirements notation<br />
<a href="#LSCP versioning">2.</a>&nbsp;
Versioning of this specification<br />
<a href="#anchor2">3.</a>&nbsp;
Introduction<br />
<a href="#anchor3">4.</a>&nbsp;
Focus of this protocol<br />
<a href="#anchor4">5.</a>&nbsp;
Communication Overview<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor5">5.1.</a>&nbsp;
Request/response communication method<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor6">5.1.1.</a>&nbsp;
Result format<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor7">5.2.</a>&nbsp;
Subscribe/notify communication method<br />
<a href="#control_commands">6.</a>&nbsp;
Description for control commands<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor8">6.1.</a>&nbsp;
Ignored lines and comments<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor9">6.2.</a>&nbsp;
Configuring audio drivers<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.1.</a>&nbsp;
Getting amount of available audio output drivers<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.2.</a>&nbsp;
Getting all available audio output drivers<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER INFO">6.2.3.</a>&nbsp;
Getting information about a specific audio
                output driver<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">6.2.4.</a>&nbsp;
Getting information about specific audio
                output driver parameter<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE AUDIO_OUTPUT_DEVICE">6.2.5.</a>&nbsp;
Creating an audio output device<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY AUDIO_OUTPUT_DEVICE">6.2.6.</a>&nbsp;
Destroying an audio output device<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICES">6.2.7.</a>&nbsp;
Getting all created audio output device count<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AUDIO_OUTPUT_DEVICES">6.2.8.</a>&nbsp;
Getting all created audio output device list<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_DEVICE INFO">6.2.9.</a>&nbsp;
Getting current settings of an audio output device<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_DEVICE_PARAMETER">6.2.10.</a>&nbsp;
Changing settings of audio output devices<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL INFO">6.2.11.</a>&nbsp;
Getting information about an audio channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">6.2.12.</a>&nbsp;
Getting information about specific audio channel parameter<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET AUDIO_OUTPUT_CHANNEL_PARAMETER">6.2.13.</a>&nbsp;
Changing settings of audio output channels<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor10">6.3.</a>&nbsp;
Configuring MIDI input drivers<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_MIDI_INPUT_DRIVERS">6.3.1.</a>&nbsp;
Getting amount of available MIDI input drivers<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">6.3.2.</a>&nbsp;
Getting all available MIDI input drivers<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER INFO">6.3.3.</a>&nbsp;
Getting information about a specific MIDI input driver<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DRIVER_PARAMETER INFO">6.3.4.</a>&nbsp;
Getting information about specific MIDI input driver parameter<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE MIDI_INPUT_DEVICE">6.3.5.</a>&nbsp;
Creating a MIDI input device<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY MIDI_INPUT_DEVICE">6.3.6.</a>&nbsp;
Destroying a MIDI input device<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICES">6.3.7.</a>&nbsp;
Getting all created MIDI input device count<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INPUT_DEVICES">6.3.8.</a>&nbsp;
Getting all created MIDI input device list<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_DEVICE INFO">6.3.9.</a>&nbsp;
Getting current settings of a MIDI input device<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_DEVICE_PARAMETER">6.3.10.</a>&nbsp;
Changing settings of MIDI input devices<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT INFO">6.3.11.</a>&nbsp;
Getting information about a MIDI port<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INPUT_PORT_PARAMETER INFO">6.3.12.</a>&nbsp;
Getting information about specific MIDI port parameter<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INPUT_PORT_PARAMETER">6.3.13.</a>&nbsp;
Changing settings of MIDI input ports<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor11">6.4.</a>&nbsp;
Configuring sampler channels<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD INSTRUMENT">6.4.1.</a>&nbsp;
Loading an instrument<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LOAD ENGINE">6.4.2.</a>&nbsp;
Loading a sampler engine<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNELS">6.4.3.</a>&nbsp;
Getting all created sampler channel count<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST CHANNELS">6.4.4.</a>&nbsp;
Getting all created sampler channel list<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD CHANNEL">6.4.5.</a>&nbsp;
Adding a new sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE CHANNEL">6.4.6.</a>&nbsp;
Removing a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_ENGINES">6.4.7.</a>&nbsp;
Getting amount of available engines<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_ENGINES">6.4.8.</a>&nbsp;
Getting all available engines<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET ENGINE INFO">6.4.9.</a>&nbsp;
Getting information about an engine<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL INFO">6.4.10.</a>&nbsp;
Getting sampler channel information<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL VOICE_COUNT">6.4.11.</a>&nbsp;
Current number of active voices<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL STREAM_COUNT">6.4.12.</a>&nbsp;
Current number of active disk streams<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET CHANNEL BUFFER_FILL">6.4.13.</a>&nbsp;
Current fill state of disk stream buffers<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a>&nbsp;
Setting audio output device<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_TYPE">6.4.15.</a>&nbsp;
Setting audio output type<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a>&nbsp;
Setting audio output channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_DEVICE">6.4.17.</a>&nbsp;
Setting MIDI input device<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_TYPE">6.4.18.</a>&nbsp;
Setting MIDI input type<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_PORT">6.4.19.</a>&nbsp;
Setting MIDI input port<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INPUT_CHANNEL">6.4.20.</a>&nbsp;
Setting MIDI input channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL VOLUME">6.4.21.</a>&nbsp;
Setting channel volume<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MUTE">6.4.22.</a>&nbsp;
Muting a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL SOLO">6.4.23.</a>&nbsp;
Soloing a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET CHANNEL MIDI_INSTRUMENT_MAP">6.4.24.</a>&nbsp;
Assigning a MIDI instrument map to a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE FX_SEND">6.4.25.</a>&nbsp;
Adding an effect send to a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY FX_SEND">6.4.26.</a>&nbsp;
Removing an effect send from a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SENDS">6.4.27.</a>&nbsp;
Getting amount of effect sends on a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FX_SENDS">6.4.28.</a>&nbsp;
Listing all effect sends on a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;
Getting effect send information<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.30.</a>&nbsp;
Changing effect send's name<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
Altering effect send's audio routing<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;
Altering effect send's MIDI controller<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
Altering effect send's send level<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;
Resetting a sampler channel<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
Controlling connection<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE">6.5.1.</a>&nbsp;
Register front-end for receiving event messages<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNSUBSCRIBE">6.5.2.</a>&nbsp;
Unregister front-end for not receiving event messages<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET ECHO">6.5.3.</a>&nbsp;
Enable or disable echo of commands<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#QUIT">6.5.4.</a>&nbsp;
Close client connection<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor13">6.6.</a>&nbsp;
Global commands<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT">6.6.1.</a>&nbsp;
Current number of active voices<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a>&nbsp;
Maximum amount of active voices<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a>&nbsp;
Current number of active disk streams<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.4.</a>&nbsp;
Reset sampler<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.5.</a>&nbsp;
General sampler informations<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.6.</a>&nbsp;
Getting global volume attenuation<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.7.</a>&nbsp;
Setting global volume attenuation<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
MIDI Instrument Mapping<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a>&nbsp;
Create a new MIDI instrument map<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
Delete one particular or all MIDI instrument maps<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAPS">6.7.3.</a>&nbsp;
Get amount of existing MIDI instrument maps<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENT_MAPS">6.7.4.</a>&nbsp;
Getting all created MIDI instrument maps<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT_MAP INFO">6.7.5.</a>&nbsp;
Getting MIDI instrument map information<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET MIDI_INSTRUMENT_MAP NAME">6.7.6.</a>&nbsp;
Renaming a MIDI instrument map<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MAP MIDI_INSTRUMENT">6.7.7.</a>&nbsp;
Create or replace a MIDI instrument map entry<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENTS">6.7.8.</a>&nbsp;
Getting ammount of MIDI instrument map entries<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST MIDI_INSTRUMENTS">6.7.9.</a>&nbsp;
Getting indeces of all entries of a MIDI instrument map<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#UNMAP MIDI_INSTRUMENT">6.7.10.</a>&nbsp;
Remove an entry from the MIDI instrument map<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET MIDI_INSTRUMENT INFO">6.7.11.</a>&nbsp;
Get current settings of MIDI instrument map entry<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
Clear MIDI instrument map<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#Managing Instruments Database">6.8.</a>&nbsp;
Managing Instruments Database<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENT_DIRECTORY">6.8.1.</a>&nbsp;
Creating a new instrument directory<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT_DIRECTORY">6.8.2.</a>&nbsp;
Deleting an instrument directory<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORIES">6.8.3.</a>&nbsp;
Getting amount of instrument directories<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENT_DIRECTORIES">6.8.4.</a>&nbsp;
Listing all directories in specific directory<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORY INFO">6.8.5.</a>&nbsp;
Getting instrument directory information<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY NAME">6.8.6.</a>&nbsp;
Renaming an instrument directory<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT_DIRECTORY">6.8.7.</a>&nbsp;
Moving an instrument directory<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#COPY DB_INSTRUMENT_DIRECTORY">6.8.8.</a>&nbsp;
Copying instrument directories<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.9.</a>&nbsp;
Changing the description of directory<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENT_DIRECTORIES">6.8.10.</a>&nbsp;
Finding directories<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENTS">6.8.11.</a>&nbsp;
Adding instruments to the instruments database<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT">6.8.12.</a>&nbsp;
Removing an instrument<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS">6.8.13.</a>&nbsp;
Getting amount of instruments<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENTS">6.8.14.</a>&nbsp;
Listing all instruments in specific directory<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT INFO">6.8.15.</a>&nbsp;
Getting instrument information<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT NAME">6.8.16.</a>&nbsp;
Renaming an instrument<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT">6.8.17.</a>&nbsp;
Moving an instrument<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#COPY DB_INSTRUMENT">6.8.18.</a>&nbsp;
Copying instruments<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT DESCRIPTION">6.8.19.</a>&nbsp;
Changing the description of instrument<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENTS">6.8.20.</a>&nbsp;
Finding instruments<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a>&nbsp;
Getting job status information<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
Formatting the instruments database<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
Editing Instruments<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
Opening an appropriate instrument editor application<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#file_management">6.10.</a>&nbsp;
Managing Files<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENTS">6.10.1.</a>&nbsp;
Retrieving amount of instruments of a file<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FILE INSTRUMENTS">6.10.2.</a>&nbsp;
Retrieving all instruments of a file<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a>&nbsp;
Retrieving informations about one instrument in a file<br />
<a href="#command_syntax">7.</a>&nbsp;
Command Syntax<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;
Character Set and Escape Sequences<br />
<a href="#events">8.</a>&nbsp;
Events<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;
Number of audio output devices changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">8.2.</a>&nbsp;
Audio output device's settings changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">8.3.</a>&nbsp;
Number of MIDI input devices changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INPUT_DEVICE_INFO">8.4.</a>&nbsp;
MIDI input device's settings changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
Number of sampler channels changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a>&nbsp;
Number of active voices changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a>&nbsp;
Number of active disk streams changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a>&nbsp;
Disk stream buffer fill state changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a>&nbsp;
Channel information changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a>&nbsp;
Number of effect sends changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;
Effect send information changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;
Total number of active voices changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.13.</a>&nbsp;
Total number of active disk streams changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.14.</a>&nbsp;
Number of MIDI instrument maps changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.15.</a>&nbsp;
MIDI instrument map information changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.16.</a>&nbsp;
Number of MIDI instruments changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.17.</a>&nbsp;
MIDI instrument information changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.18.</a>&nbsp;
Global settings changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.19.</a>&nbsp;
Number of database instrument directories changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.20.</a>&nbsp;
Database instrument directory information changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.21.</a>&nbsp;
Number of database instruments changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.22.</a>&nbsp;
Database instrument information changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.23.</a>&nbsp;
Database job status information changed<br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.24.</a>&nbsp;
Miscellaneous and debugging events<br />
<a href="#anchor14">9.</a>&nbsp;
Security Considerations<br />
<a href="#anchor15">10.</a>&nbsp;
Acknowledgments<br />
<a href="#rfc.references1">11.</a>&nbsp;
References<br />
<a href="#rfc.authors">&#167;</a>&nbsp;
Author's Address<br />
<a href="#rfc.copyright">&#167;</a>&nbsp;
Intellectual Property and Copyright Statements<br />
</p>
<br clear="all" />

<a name="anchor1"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.1"></a><h3>1.&nbsp;
Requirements notation</h3>

<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
            "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
            and "OPTIONAL" in this document are to be interpreted as
            described in <a class='info' href='#RFC2119'>[RFC2119]<span> (</span><span class='info'>Bradner, S., &ldquo;Key words for use in RFCs to Indicate Requirement Levels,&rdquo; 1997.</span><span>)</span></a>.
</p>
<p>This protocol is always case-sensitive if not explicitly
            claimed the opposite.
</p>
<p>In examples, "C:" and "S:" indicate lines sent by the client
            (front-end) and server (LinuxSampler) respectively. Lines in
            examples must be interpreted as every line being CRLF
            terminated (carriage return character followed by line feed
            character as defined in the ASCII standard <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, &ldquo;ASCII format for Network Interchange,&rdquo; 1969.</span><span>)</span></a>),
            thus the following example:
</p>
<p>
                </p>
<blockquote class="text">
<p>C: "some line"
</p>
<p>&nbsp;&nbsp;&nbsp;"another line"
</p>
</blockquote><p>
            
</p>
<p>must actually be interpreted as client sending the following
            message:
</p>
<p>
                </p>
<blockquote class="text">
<p>"some line&lt;CR&gt;&lt;LF&gt;another
                    line&lt;CR&gt;&lt;LF&gt;"
</p>
</blockquote><p>
            
</p>
<p>where &lt;CR&gt; symbolizes the carriage return character and
            &lt;LF&gt; the line feed character as defined in the ASCII
            standard.
</p>
<p>Due to technical reasons, messages can arbitrary be
            fragmented, means the following example:
</p>
<p>
                </p>
<blockquote class="text">
<p>S: "abcd"
</p>
</blockquote><p>
            
</p>
<p>could also happen to be sent in three messages like in the
            following sequence scenario:
</p>
<p>
                </p>
<ul class="text">
<li>server sending message "a"
</li>
<li>followed by a delay (pause) with
                    arbitrary duration
</li>
<li>followed by server sending message
                    "bcd&lt;CR&gt;"
</li>
<li>again followed by a delay (pause) with arbitrary
                    duration
</li>
<li>followed by server sending the message
                    "&lt;LF&gt;"
</li>
</ul><p>
            
</p>
<p>where again &lt;CR&gt; and &lt;LF&gt; symbolize the carriage
            return and line feed characters respectively.
</p>
<a name="LSCP versioning"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.2"></a><h3>2.&nbsp;
Versioning of this specification</h3>

<p>LSCP will certainly be extended and enhanced by-and-by. Each official
            release of the LSCP specification will be tagged with a unique version
            tuple. The version tuple consists at least of a major and minor version
            number like:
            
</p>
<p>
                </p>
<blockquote class="text">
<p>"1.2"
</p>
</blockquote><p>
            
</p>
<p>
            In this example the major version number would be "1" and the minor
            version number would be "2". Note that the version tuple might also
            have more than two elements. The major version number defines a
            group of backward compatible versions. That means a frontend is
            compatible to the connected sampler if and only if the LSCP versions
            to which each of the two parties complies to, match both of the
            following rules:
            
</p>
<p>Compatibility:
</p>
<p>
                </p>
<ol class="text">
<li>The frontend's LSCP major version and the sampler's LSCP
                    major version are exactly equal.
</li>
<li>The frontend's LSCP minor version is less or equal than
                    the sampler's LSCP minor version.
</li>
</ol><p>
            
</p>
<p>
            Compatibility can only be claimed if both rules are true.
            The frontend can use the
            <a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a> command to
            get the version of the LSCP specification the sampler complies with.
            
</p>
<a name="anchor2"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.3"></a><h3>3.&nbsp;
Introduction</h3>

<p>LinuxSampler is a so called software sampler application
            capable to playback audio samples from a computer's Random
            Access Memory (RAM) as well as directly streaming it from disk.
            LinuxSampler is designed to be modular. It provides several so
            called "sampler engines" where each engine is specialized for a
            certain purpose. LinuxSampler has virtual channels which will be
            referred in this document as "sampler channels". The channels
            are in such way virtual as they can be connected to an
            arbitrary MIDI input method and arbitrary MIDI channel (e.g.
            sampler channel 17 could be connected to an ALSA sequencer
            device 64:0 and listening to MIDI channel 1 there). Each sampler
            channel will be associated with an instance of one of the available
            sampler engines (e.g. GigEngine, DLSEngine). The audio output of
            each sampler channel can be routed to an arbitrary audio output
            method (ALSA / JACK) and an arbitrary audio output channel
            there.
</p>
<a name="anchor3"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.4"></a><h3>4.&nbsp;
Focus of this protocol</h3>

<p>Main focus of this protocol is to provide a way to configure
            a running LinuxSampler instance and to retrieve information
            about it. The focus of this protocol is not to provide a way to
            control synthesis parameters or even to trigger or release
            notes. Or in other words; the focus are those functionalities
            which are not covered by MIDI or which may at most be handled
            via MIDI System Exclusive Messages.
</p>
<a name="anchor4"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.5"></a><h3>5.&nbsp;
Communication Overview</h3>

<p>There are two distinct methods of communication between a
            running instance of LinuxSampler and one or more control
            applications, so called "front-ends": a simple request/response
            communication method used by the clients to give commands to the
            server as well as to inquire about server's status and a
            subscribe/notify communication method used by the client to
            subscribe to and receive notifications of certain events as they
            happen on the server. The latter needs more effort to be
            implemented in the front-end application. The two communication
            methods will be described next.
</p>
<a name="anchor5"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.5.1"></a><h3>5.1.&nbsp;
Request/response communication method</h3>

<p>This simple communication method is based on
                <a class='info' href='#RFC793'>TCP<span> (</span><span class='info'>Defense Advanced Research Projects Agency, &ldquo;TRANSMISSION CONTROL PROTOCOL,&rdquo; 1981.</span><span>)</span></a> [RFC793]. The
                front-end application establishes a TCP connection to the
                LinuxSampler instance on a certain host system. Then the
                front-end application will send certain ASCII based commands
                as defined in this document (every command line must be CRLF
                terminated - see "Conventions used in this document" at the
                beginning of this document) and the LinuxSampler application
                will response after a certain process time with an
                appropriate ASCII based answer, also as defined in this
                document. So this TCP communication is simply based on query
                and answer paradigm. That way LinuxSampler is only able to
                answer on queries from front-ends, but not able to
                automatically send messages to the client if it's not asked
                to. The fronted should not reconnect to LinuxSampler for
                every single command, instead it should keep the connection
                established and simply resend message(s) for subsequent
                commands. To keep information in the front-end up-to-date
                the front-end has to periodically send new requests to get
                the current information from the LinuxSampler instance. This
                is often referred to as "polling". While polling is simple
                to implement and may be OK to use in some cases, there may
                be disadvantages to polling such as network traffic overhead
                and information being out of date.
                It is possible for a client or several clients to open more
                than one connection to the server at the same time. It is
                also possible to send more than one request to the server
                at the same time but if those requests are sent over the
                same connection server MUST execute them sequentially. Upon
                executing a request server will produce a result set and
                send it to the client. Each and every request made by the
                client MUST result in a result set being sent back to the
                client. No other data other than a result set may be sent by
                a server to a client. No result set may be sent to a client
                without the client sending request to the server first. On
                any particular connection, result sets MUST be sent in their
                entirety without being interrupted by other result sets. If
                several requests got queued up at the server they MUST be
                processed in the order they were received and result sets
                MUST be sent back in the same order.
</p>
<a name="anchor6"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.5.1.1"></a><h3>5.1.1.&nbsp;
Result format</h3>

<p>Result set could be one of the following types:
</p>
<p>
                        </p>
<ol class="text">
<li>Normal
</li>
<li>Warning
</li>
<li>Error
</li>
</ol><p>
                    
</p>
<p>Warning and Error result sets MUST be single line and
                    have the following format:
</p>
<p>
                        </p>
<ul class="text">
<li>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;"
</li>
<li>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"
</li>
</ul><p>
                    
</p>
<p>Where &lt;warning-code&gt; and &lt;error-code&gt; are
                    numeric unique identifiers of the warning or error and
                    &lt;warning-message&gt; and &lt;error-message&gt; are
                    human readable descriptions of the warning or error
                    respectively.
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
</p>
<p>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
</p>
<p>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
</p>
<p>S: "ERR:9:There is no audio output device with index 123456."
</p>
</blockquote><p>
                    
</p>
<p>Normal result sets could be:
</p>
<p>
                        </p>
<ol class="text">
<li>Empty
</li>
<li>Single line
</li>
<li>Multi-line
</li>
</ol><p>
                    
</p>
<p> Empty result set is issued when the server only
                    needed to acknowledge the fact that the request was
                    received and it was processed successfully and no
                    additional information is available. This result set has
                    the following format:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK"
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<p>Single line result sets are command specific. One
                    example of a single line result set is an empty line.
                    Multi-line result sets are command specific and may
                    include one or more lines of information. They MUST
                    always end with the following line:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"."
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
</p>
<p>S: "DRIVER: ALSA"
</p>
<p>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"
</p>
<p>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"
</p>
<p>&nbsp;&nbsp;&nbsp;"ACTIVE: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"
</p>
<p>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"
</p>
<p>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<p>In addition to above mentioned formats, warnings and
                    empty result sets MAY be indexed. In this case, they
                    have the following formats respectively:
</p>
<p>
                        </p>
<ul class="text">
<li>"WRN[&lt;index&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;"
</li>
<li>"OK[&lt;index&gt;]"
</li>
</ul><p>
                    
</p>
<p>where &lt;index&gt; is command specific and is used
                    to indicate channel number that the result set was
                    related to or other integer value.
</p>
<p>Each line of the result set MUST end with
                    &lt;CRLF&gt;.
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "ADD CHANNEL"
</p>
<p>S: "OK[12]"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
</p>
<p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
</p>
</blockquote><p>
                    
</p>
<a name="anchor7"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.5.2"></a><h3>5.2.&nbsp;
Subscribe/notify communication method</h3>

<p>This more sophisticated communication method is actually
                only an extension of the simple request/response
                communication method. The front-end still uses a TCP
                connection and sends the same commands on the TCP
                connection. Two extra commands are SUBSCRIBE and UNSUBSCRIBE
                commands that allow a client to tell the server that it is
                interested in receiving notifications about certain events
                as they happen on the server. The SUBSCRIBE command has the
                following syntax:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE &lt;event-id&gt;
</p>
</blockquote><p>
                
</p>
<p>where &lt;event-id&gt; will be replaced by the respective
                event that client wants to subscribe to. Upon receiving such
                request, server SHOULD respond with OK and start sending
                EVENT notifications when a given even has occurred to the
                front-end when an event has occurred. It MAY be possible
                certain events may be sent before OK response during real
                time nature of their generation. Event messages have the
                following format:
</p>
<p>
                    </p>
<blockquote class="text">
<p>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;
</p>
</blockquote><p>
                
</p>
<p>where &lt;event-id&gt; uniquely identifies the event that
                has occurred and &lt;custom-event-data&gt; is event
                specific.
</p>
<p>Several rules must be followed by the server when
                generating events:
</p>
<p>
                    </p>
<ol class="text">
<li>Events MUST NOT be sent to any client who has not
                        issued an appropriate SUBSCRIBE command.
</li>
<li>Events MUST only be sent using the same
                        connection that was used to subscribe to them.
</li>
<li>When response is being sent to the client, event
                        MUST be inserted in the stream before or after the
                        response, but NOT in the middle. Same is true about
                        the response. It should never be inserted in the
                        middle of the event message as well as any other
                        response.
</li>
</ol><p>
                
</p>
<p>If the client is not interested in a particular event
                anymore it MAY issue UNSUBSCRIBE command using the following
                syntax:
</p>
<p>
                    </p>
<blockquote class="text">
<p>UNSUBSCRIBE &lt;event-id&gt;
</p>
</blockquote><p>
                
</p>
<p>where &lt;event-id&gt; will be replace by the respective
                event that client is no longer interested in receiving. For
                a list of supported events see <a class='info' href='#events'>Section&nbsp;8<span> (</span><span class='info'>Events</span><span>)</span></a>.
</p>
<p>Example: the fill states of disk stream buffers have
                changed on sampler channel 4 and the LinuxSampler instance
                will react by sending the following message to all clients
                who subscribed to this event:
</p>
<p>
                    </p>
<blockquote class="text">
<p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%
</p>
</blockquote><p>
                
</p>
<p>Which means there are currently three active streams on
                sampler channel 4, where the stream with ID "35" is filled
                by 62%, stream with ID 33 is filled by 80% and stream with
                ID 37 is filled by 98%.
</p>
<p>Clients may choose to open more than one connection to
                the server and use some connections to receive notifications
                while using other connections to issue commands to the
                back-end. This is entirely legal and up to the
                implementation. This does not change the protocol in any way
                and no special restrictions exist on the server to allow or
                disallow this or to track what connections belong to what
                front-ends. Server will listen on a single port, accept
                multiple connections and support protocol described in this
                specification in it's entirety on this single port on each
                connection that it accepted.
</p>
<p>Due to the fact that TCP is used for this communication,
                dead peers will be detected automatically by the OS TCP
                stack. While it may take a while to detect dead peers if no
                traffic is being sent from server to client (TCP keep-alive
                timer is set to 2 hours on many OSes) it will not be an
                issue here as when notifications are sent by the server,
                dead client will be detected quickly.
</p>
<p>When connection is closed for any reason server MUST
                forget all subscriptions that were made on this connection.
                If client reconnects it MUST resubscribe to all events that
                it wants to receive.
</p>
<a name="control_commands"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6"></a><h3>6.&nbsp;
Description for control commands</h3>

<p>This chapter will describe the available control commands
            that can be sent on the TCP connection in detail. Some certain
            commands (e.g. <a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
            or <a class='info' href='#GET ENGINE INFO'>"GET ENGINE INFO"<span> (</span><span class='info'>Getting information about an engine</span><span>)</span></a>) lead to
            multiple-line responses. In this case LinuxSampler signals the
            end of the response by a "." (single dot) line.
</p>
<a name="anchor8"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.1"></a><h3>6.1.&nbsp;
Ignored lines and comments</h3>

<p>White lines, that is lines which only contain space and
                tabulator characters, and lines that start with a "#"
                character are ignored, thus it's possible for example to
                group commands and to place comments in a LSCP script
                file.
</p>
<a name="anchor9"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2"></a><h3>6.2.&nbsp;
Configuring audio drivers</h3>

<p>Instances of drivers in LinuxSampler are called devices.
                You can use multiple audio devices simultaneously, e.g. to
                output the sound of one sampler channel using the ALSA audio
                output driver, and on another sampler channel you might want
                to use the JACK audio output driver. For particular audio
                output systems it's also possible to create several devices
                of the same audio output driver, e.g. two separate ALSA
                audio output devices for using two different sound cards at
                the same time. This chapter describes all commands to
                configure LinuxSampler's audio output devices and their
                parameters.
</p>
<p>Instead of defining commands and parameters for each
                driver individually, all possible parameters, their meanings
                and possible values have to be obtained at runtime. This
                makes the protocol a bit abstract, but has the advantage,
                that front-ends can be written independently of what drivers
                are currently implemented and what parameters these drivers
                are actually offering. This means front-ends can even handle
                drivers which are implemented somewhere in future without
                modifying the front-end at all.
</p>
<p>Note: examples in this chapter showing particular
                parameters of drivers are not meant as specification of the
                drivers' parameters. Driver implementations in LinuxSampler
                might have complete different parameter names and meanings
                than shown in these examples or might change in future, so
                these examples are only meant for showing how to retrieve
                what parameters drivers are offering, how to retrieve their
                possible values, etc.
</p>
<a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.1"></a><h3>6.2.1.&nbsp;
Getting amount of available audio output drivers</h3>

<p>Use the following command to get the number of
                    audio output drivers currently available for the
                    LinuxSampler instance:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending the
                            number of audio output drivers.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
</p>
<p>S: "2"
</p>
</blockquote><p>
                    
</p>
<a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.2"></a><h3>6.2.2.&nbsp;
Getting all available audio output drivers</h3>

<p>Use the following command to list all audio output
                    drivers currently available for the LinuxSampler
                    instance:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending comma
                            separated character strings, each symbolizing an
                            audio output driver.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"
</p>
<p>S: "ALSA,JACK"
</p>
</blockquote><p>
                    
</p>
<a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.3"></a><h3>6.2.3.&nbsp;
Getting information about a specific audio
                output driver</h3>

<p>Use the following command to get detailed information
                    about a specific audio output driver:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AUDIO_OUTPUT_DRIVER INFO
                             &lt;audio-output-driver&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;audio-output-driver&gt; is the name of the
                    audio output driver, returned by the
                    <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a
                            &lt;CRLF&gt; separated list. Each answer line
                            begins with the information category name
                            followed by a colon and then a space character
                            &lt;SP&gt; and finally the info character string
                            to that info category. At the moment the
                            following information categories are
                            defined:
</p>
<p>
                              </p>
<blockquote class="text">
<p>DESCRIPTION -
                                    </p>
<blockquote class="text">
<p> character string describing the
                                      audio output driver
</p>
</blockquote>
                                  

<p>VERSION -
                                    </p>
<blockquote class="text">
<p>character string reflecting the
                                      driver's version
</p>
</blockquote>
                                  

<p>PARAMETERS -
                                    </p>
<blockquote class="text">
<p>comma separated list of all
                                      parameters available for the given
                                      audio output driver, at least
                                      parameters 'channels', 'samplerate'
                                      and 'active' are offered by all audio
                                      output drivers
</p>
</blockquote>
                                  

</blockquote>
                            

<p>The mentioned fields above don't have to be
                            in particular order.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                      </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"
</p>
<p>S: "DESCRIPTION: Advanced Linux Sound
                          Architecture"
</p>
<p>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"
</p>
<p>&nbsp;&nbsp;&nbsp;"PARAMETERS:
                          DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
                          FRAGMENTSIZE,CARD"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.4"></a><h3>6.2.4.&nbsp;
Getting information about specific audio
                output driver parameter</h3>

<p>Use the following command to get detailed information
                    about a  specific audio output driver parameter:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO &lt;audio&gt; &lt;prm&gt; [&lt;deplist&gt;]
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;audio&gt; is the name of the audio output
                    driver as returned by the <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a> command,
                    &lt;prm&gt; a specific parameter name for which information should be
                    obtained (as returned by the
                    <a class='info' href='#GET AUDIO_OUTPUT_DRIVER INFO'>"GET AUDIO_OUTPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific audio                 output driver</span><span>)</span></a> command) and
                    &lt;deplist&gt; is an optional list of parameters on which the sought
                    parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value
                    pairs in form of "key1=val1 key2=val2 ...", where character string values
                    are encapsulated into apostrophes ('). Arguments given with &lt;deplist&gt;
                    which are not dependency parameters of &lt;prm&gt; will be ignored, means
                    the front-end application can simply put all parameters into &lt;deplist&gt;
                    with the values already selected by the user.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a
                            &lt;CRLF&gt; separated list.
                            Each answer line begins with the information category name
                            followed by a colon and then a space character &lt;SP&gt; and
                            finally
                            the info character string to that info category. There are
                            information which is always returned, independently of the
                            given driver parameter and there are optional information
                            which is only shown dependently to given driver parameter. At
                            the moment the following information categories are defined:
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>TYPE -
                              </p>
<blockquote class="text">
<p>either "BOOL" for boolean value(s) or
                                "INT" for integer
                                value(s) or "FLOAT" for dotted number(s) or "STRING" for
                                character string(s)
                                (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>DESCRIPTION -
                              </p>
<blockquote class="text">
<p>arbitrary text describing the purpose of the parameter
                                (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>MANDATORY -
                              </p>
<blockquote class="text">
<p>either true or false, defines if this parameter must be
                                given when the device is to be created with the
                                <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
                                command (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>FIX -
                              </p>
<blockquote class="text">
<p>either true or false, if false then this parameter can
                                be changed at any time, once the device is created by
                                the <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
                                command (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>MULTIPLICITY -
                              </p>
<blockquote class="text">
<p>either true or false, defines if this parameter allows
                                only one value or a list of values, where true means
                                multiple values and false only a single value allowed
                                (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>DEPENDS -
                              </p>
<blockquote class="text">
<p>comma separated list of parameters this parameter depends
                                on, means the values for fields 'DEFAULT', 'RANGE_MIN',
                                'RANGE_MAX' and 'POSSIBILITIES' might depend on these
                                listed parameters, for example assuming that an audio
                                driver (like the ALSA driver) offers parameters 'card'
                                and 'samplerate' then parameter 'samplerate' would
                                depend on 'card' because the possible values for
                                'samplerate' depends on the sound card which can be
                                chosen by the 'card' parameter
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

<p>DEFAULT -
                              </p>
<blockquote class="text">
<p>reflects the default value for this parameter which is
                                used when the device is created and not explicitly
                                given with the <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>'CREATE AUDIO_OUTPUT_DEVICE'<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a> command,
                                in case of MULTIPLCITY=true, this is a comma separated
                                list, that's why character strings are encapsulated into
                                apostrophes (')
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

<p>RANGE_MIN -
                              </p>
<blockquote class="text">
<p>defines lower limit of the allowed value range for this
                                parameter, can be an integer value as well as a dotted
                                number, this parameter is often used in conjunction
                                with RANGE_MAX, but may also appear without
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

<p>RANGE_MAX -
                              </p>
<blockquote class="text">
<p>defines upper limit of the allowed value range for this
                                parameter, can be an integer value as well as a dotted
                                number, this parameter is often used in conjunction with
                                RANGE_MIN, but may also appear without
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

<p>POSSIBILITIES -
                              </p>
<blockquote class="text">
<p>comma separated list of possible values for this
                                parameter, character strings are encapsulated into
                                apostrophes
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"
</p>
<p>S: "DESCRIPTION: sound card to be used"
</p>
<p>&nbsp;&nbsp;&nbsp;"TYPE: STRING"
</p>
<p>&nbsp;&nbsp;&nbsp;"MANDATORY: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"FIX: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"
</p>
<p>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '0,0','1,0','2,0'"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"
</p>
<p>S: "DESCRIPTION: output sample rate in Hz"
</p>
<p>&nbsp;&nbsp;&nbsp;"TYPE: INT"
</p>
<p>&nbsp;&nbsp;&nbsp;"MANDATORY: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"FIX: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"DEPENDS: card"
</p>
<p>&nbsp;&nbsp;&nbsp;"DEFAULT: 44100"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"
</p>
<p>S: "DESCRIPTION: output sample rate in Hz"
</p>
<p>&nbsp;&nbsp;&nbsp;"TYPE: INT"
</p>
<p>&nbsp;&nbsp;&nbsp;"MANDATORY: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"FIX: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"DEPENDS: card"
</p>
<p>&nbsp;&nbsp;&nbsp;"DEFAULT: 44100"
</p>
<p>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 22050"
</p>
<p>&nbsp;&nbsp;&nbsp;"RANGE_MAX: 96000"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.5"></a><h3>6.2.5.&nbsp;
Creating an audio output device</h3>

<p>Use the following command to create a new audio output device for  the desired audio output system:
</p>
<p>
                        </p>
<blockquote class="text">
<p>CREATE AUDIO_OUTPUT_DEVICE &lt;audio-output-driver&gt; [&lt;param-list&gt;]
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
                    output system as returned by the
                    <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a>
                    command and &lt;param-list&gt; by an optional list of driver
                    specific parameters in form of "key1=val1 key2=val2 ...", where
                    character string values should be encapsulated into apostrophes (').
                    Note that there might be drivers which require parameter(s) to be
                    given with this command. Use the previously described commands in
                    this chapter to get this information.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK[&lt;device-id&gt;]" -
                                </p>
<blockquote class="text">
<p>in case the device was successfully created, where
                                    &lt;device-id&gt; is the numerical ID of the new device
</p>
</blockquote>
                            

<p>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the device was created successfully, where
                                    &lt;device-id&gt; is the numerical ID of the new device, but there
                                    are noteworthy issue(s) related (e.g. sound card doesn't
                                    support given hardware parameters and the driver is using
                                    fall-back values), providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"
</p>
<p>S: "OK[0]"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"
</p>
<p>S: "OK[1]"
</p>
</blockquote><p>
                    
</p>
<a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.6"></a><h3>6.2.6.&nbsp;
Destroying an audio output device</h3>

<p>Use the following command to destroy a created output device:
</p>
<p>
                        </p>
<blockquote class="text">
<p>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
                    audio output device as given by the
                    <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
                    or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
                    command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case the device was successfully destroyed
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the device was destroyed successfully, but there are
                                    noteworthy issue(s) related (e.g. an audio over ethernet
                                    driver was unloaded but the other host might not be
                                    informed about this situation), providing an appropriate
                                    warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.7"></a><h3>6.2.7.&nbsp;
Getting all created audio output device count</h3>

<p>Use the following command to count all created audio output devices:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AUDIO_OUTPUT_DEVICES
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending the current number of all
                            audio output devices.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DEVICES"
</p>
<p>S: "4"
</p>
</blockquote><p>
                    
</p>
<a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.8"></a><h3>6.2.8.&nbsp;
Getting all created audio output device list</h3>

<p>Use the following command to list all created audio output devices:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST AUDIO_OUTPUT_DEVICES
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a comma separated list with
                            the numerical IDs of all audio output devices.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST AUDIO_OUTPUT_DEVICES"
</p>
<p>S: "0,1,4,5"
</p>
</blockquote><p>
                    
</p>
<a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.9"></a><h3>6.2.9.&nbsp;
Getting current settings of an audio output device</h3>

<p>Use the following command to get current settings of a specific, created audio output device:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; should be replaced by numerical ID
                    of the audio output device as e.g. returned by the
                    <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                    Each answer line begins with the information category name
                    followed by a colon and then a space character &lt;SP&gt; and finally
                    the info character string to that info category. As some
                    parameters might allow multiple values, character strings are
                    encapsulated into apostrophes ('). At the moment the following
                    information categories are defined (independently of device):
</p>
<p>
                        </p>
<blockquote class="text">
<p>DRIVER -
                                </p>
<blockquote class="text">
<p>identifier of the used audio output driver, as also
                                    returned by the
                                    <a class='info' href='#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS'>"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"<span> (</span><span class='info'>Getting all available audio output drivers</span><span>)</span></a>
                                    command
</p>
</blockquote>
                            

<p>CHANNELS -
                                </p>
<blockquote class="text">
<p>amount of audio output channels this device currently
                                    offers
</p>
</blockquote>
                            

<p>SAMPLERATE -
                                </p>
<blockquote class="text">
<p>playback sample rate the device uses
</p>
</blockquote>
                            

<p>ACTIVE -
                                </p>
<blockquote class="text">
<p>either true or false, if false then the audio device is
                                    inactive and doesn't output any sound, nor do the
                                    sampler channels connected to this audio device render
                                    any audio
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular
                    order. The fields above are only those fields which are
                    returned by all audio output devices. Every audio output driver
                    might have its own, additional driver specific parameters (see
                    <a class='info' href='#GET AUDIO_OUTPUT_DRIVER INFO'>Section&nbsp;6.2.3<span> (</span><span class='info'>Getting information about a specific audio                 output driver</span><span>)</span></a>)
                    which are also returned by this command.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
</p>
<p>S: "DRIVER: ALSA"
</p>
<p>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"
</p>
<p>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"
</p>
<p>&nbsp;&nbsp;&nbsp;"ACTIVE: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"
</p>
<p>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"
</p>
<p>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.10"></a><h3>6.2.10.&nbsp;
Changing settings of audio output devices</h3>

<p>Use the following command to alter a specific setting of a created audio output device:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET AUDIO_OUTPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
                    audio output device as given by the
                    <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
                    or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
                    command, &lt;key&gt; by the name of the parameter to change
                    and &lt;value&gt; by the new value for this parameter.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case setting was successfully changed
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case setting was changed successfully, but there are
                                    noteworthy issue(s) related, providing an appropriate
                                    warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.11"></a><h3>6.2.11.&nbsp;
Getting information about an audio channel</h3>

<p>Use the following command to get information about an audio channel:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
                    <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
                    or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
                    command and &lt;audio-chan&gt; the audio channel number.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the information category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that info category. At the moment
                            the following information categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>NAME -
                                        </p>
<blockquote class="text">
<p>arbitrary character string naming the channel, which
                                            doesn't have to be unique (always returned by all audio channels)
</p>
</blockquote>
                                    

<p>IS_MIX_CHANNEL -
                                        </p>
<blockquote class="text">
<p>either true or false, a mix-channel is not a real,
                                            independent audio channel, but a virtual channel which
                                            is mixed to another real channel, this mechanism is
                                            needed for sampler engines which need more audio
                                            channels than the used audio system might be able to offer
                                            (always returned by all audio channels)
</p>
</blockquote>
                                    

<p>MIX_CHANNEL_DESTINATION -
                                        </p>
<blockquote class="text">
<p>numerical ID (positive integer including 0)
                                            which reflects the real audio channel (of the same audio
                                            output device) this mix channel refers to, means where
                                            the audio signal actually will be routed / added to
                                            (only returned in case the audio channel is mix channel)
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular
                    order. The fields above are only those fields which are
                    generally returned for the described cases by all audio
                    channels regardless of the audio driver. Every audio channel
                    might have its own, additional driver and channel specific
                    parameters.
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
</p>
<p>S: "NAME: studio monitor left"
</p>
<p>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
</p>
<p>S: "NAME: studio monitor right"
</p>
<p>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
</p>
<p>S: "NAME: studio monitor left"
</p>
<p>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"MIX_CHANNEL_DESTINATION: 1"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"
</p>
<p>S: "NAME: 'ardour (left)'"
</p>
<p>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"JACK_BINDINGS: 'ardour:0'"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.12"></a><h3>6.2.12.&nbsp;
Getting information about specific audio channel parameter</h3>

<p>Use the following command to get detailed information about specific audio channel parameter:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO &lt;dev-id&gt; &lt;chan&gt; &lt;param&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
                    <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
                    or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
                    command, &lt;chan&gt; the audio channel number
                    and &lt;param&gt; a specific channel parameter name for which information should
                    be obtained (as returned by the <a class='info' href='#GET AUDIO_OUTPUT_CHANNEL INFO'>"GET AUDIO_OUTPUT_CHANNEL INFO"<span> (</span><span class='info'>Getting information about an audio channel</span><span>)</span></a> command).
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the information category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that info category. There are
                            information which is always returned, independently of the
                            given channel parameter and there is optional information
                            which is only shown dependently to the given audio channel. At
                            the moment the following information categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>TYPE -
                                        </p>
<blockquote class="text">
<p>either "BOOL" for boolean value(s) or "INT" for integer
                                            value(s) or "FLOAT" for dotted number(s) or "STRING" for
                                            character string(s)
                                            (always returned)
</p>
</blockquote>
                                    

<p>DESCRIPTION -
                                        </p>
<blockquote class="text">
<p>arbitrary text describing the purpose of the parameter (always returned)
</p>
</blockquote>
                                    

<p>FIX -
                                        </p>
<blockquote class="text">
<p>either true or false, if true then this parameter is
                                            read only, thus cannot be altered
                                            (always returned)
</p>
</blockquote>
                                    

<p>MULTIPLICITY -
                                        </p>
<blockquote class="text">
<p>either true or false, defines if this parameter allows
                                            only one value or a list of values, where true means
                                            multiple values and false only a single value allowed
                                            (always returned)
</p>
</blockquote>
                                    

<p>RANGE_MIN -
                                        </p>
<blockquote class="text">
<p>defines lower limit of the allowed value range for this
                                            parameter, can be an integer value as well as a dotted
                                            number, usually used in conjunction with 'RANGE_MAX',
                                            but may also appear without
                                            (optionally returned, dependent to driver and channel
                                            parameter)
</p>
</blockquote>
                                    

<p>RANGE_MAX -
                                        </p>
<blockquote class="text">
<p>defines upper limit of the allowed value range for this
                                            parameter, can be an integer value as well as a dotted
                                            number, usually used in conjunction with 'RANGE_MIN',
                                            but may also appear without
                                            (optionally returned, dependent to driver and channel
                                            parameter)
</p>
</blockquote>
                                    

<p>POSSIBILITIES -
                                        </p>
<blockquote class="text">
<p>comma separated list of possible values for this
                                            parameter, character strings are encapsulated into
                                            apostrophes
                                            (optionally returned, dependent to driver and channel
                                            parameter)
</p>
</blockquote>
                                    

</blockquote>
                            

<p>The mentioned fields above don't have to be in particular order.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"
</p>
<p>S: "DESCRIPTION: bindings to other JACK clients"
</p>
<p>&nbsp;&nbsp;&nbsp;"TYPE: STRING"
</p>
<p>&nbsp;&nbsp;&nbsp;"FIX: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.2.13"></a><h3>6.2.13.&nbsp;
Changing settings of audio output channels</h3>

<p>Use the following command to alter a specific setting of an audio output channel:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
                    <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
                    or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
                    command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
                    parameter to change and &lt;value&gt; by the new value for this parameter.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case setting was successfully changed
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case setting was changed successfully, but there are
                                   noteworthy issue(s) related, providing an appropriate
                                   warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                   error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="anchor10"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3"></a><h3>6.3.&nbsp;
Configuring MIDI input drivers</h3>

<p>Instances of drivers in LinuxSampler are called devices. You can use
                multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as
                MIDI input on one sampler channel and ALSA as MIDI input on another sampler
                channel. For particular MIDI input systems it's also possible to create
                several devices of the same MIDI input type. This chapter describes all
                commands to configure LinuxSampler's MIDI input devices and their parameters.
</p>
<p>Instead of defining commands and parameters for each driver individually,
                all possible parameters, their meanings and possible values have to be obtained
                at runtime. This makes the protocol a bit abstract, but has the advantage, that
                front-ends can be written independently of what drivers are currently implemented
                and what parameters these drivers are actually offering. This means front-ends can
                even handle drivers which are implemented somewhere in future without modifying
                the front-end at all.
</p>
<p>Commands for configuring MIDI input devices are pretty much the same as the
                commands for configuring audio output drivers, already described in the last
                chapter.
</p>
<p>Note: examples in this chapter showing particular parameters of drivers are
                not meant as specification of the drivers' parameters. Driver implementations in
                LinuxSampler might have complete different parameter names and meanings than shown
                in these examples or might change in future, so these examples are only meant for
                showing how to retrieve what parameters drivers are offering, how to retrieve their
                possible values, etc.
</p>
<a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.1"></a><h3>6.3.1.&nbsp;
Getting amount of available MIDI input drivers</h3>

<p>Use the following command to get the number of
                    MIDI input drivers currently available for the
                    LinuxSampler instance:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AVAILABLE_MIDI_INPUT_DRIVERS
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending the
                            number of available MIDI input drivers.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"
</p>
<p>S: "2"
</p>
</blockquote><p>
                    
</p>
<a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.2"></a><h3>6.3.2.&nbsp;
Getting all available MIDI input drivers</h3>

<p>Use the following command to list all MIDI input drivers currently available
                    for the LinuxSampler instance:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST AVAILABLE_MIDI_INPUT_DRIVERS
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending comma separated character
                            strings, each symbolizing a MIDI input driver.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
</p>
<p>S: "ALSA,JACK"
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.3"></a><h3>6.3.3.&nbsp;
Getting information about a specific MIDI input driver</h3>

<p>Use the following command to get detailed information about a specific MIDI input driver:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
                    by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the information category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that info category. At the moment
                            the following information categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>DESCRIPTION -
                                        </p>
<blockquote class="text">
<p>arbitrary description text about the MIDI input driver
</p>
</blockquote>
                                    

<p>VERSION -
                                        </p>
<blockquote class="text">
<p>arbitrary character string regarding the driver's version
</p>
</blockquote>
                                    

<p>PARAMETERS -
                                        </p>
<blockquote class="text">
<p>comma separated list of all parameters available for the given MIDI input driver
</p>
</blockquote>
                                    

</blockquote>
                            

<p>The mentioned fields above don't have to be in particular order.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INPUT_DRIVER INFO ALSA"
</p>
<p>S: "DESCRIPTION: Advanced Linux Sound Architecture"
</p>
<p>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"
</p>
<p>&nbsp;&nbsp;&nbsp;"PARAMETERS: DRIVER,ACTIVE"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.4"></a><h3>6.3.4.&nbsp;
Getting information about specific MIDI input driver parameter</h3>

<p>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INPUT_DRIVER_PARAMETER INFO &lt;midit&gt; &lt;param&gt; [&lt;deplist&gt;]
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;midit&gt; is the name of the MIDI input driver as returned
                    by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command, &lt;param&gt; a specific
                    parameter name for which information should be obtained (as returned by the
                    <a class='info' href='#GET MIDI_INPUT_DRIVER INFO'>"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific MIDI input driver</span><span>)</span></a> command) and &lt;deplist&gt; is an optional list
                    of parameters on which the sought parameter &lt;param&gt; depends on,
                    &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",
                    where character string values are encapsulated into apostrophes ('). Arguments
                    given with &lt;deplist&gt; which are not dependency parameters of &lt;param&gt;
                    will be ignored, means the front-end application can simply put all parameters
                    in &lt;deplist&gt; with the values selected by the user.
</p>
<p>Possible Answers:
</p>
<p>LinuxSampler will answer by sending a &lt;CRLF> separated list.
                    Each answer line begins with the information category name
                    followed by a colon and then a space character &lt;SP> and finally
                    the info character string to that info category. There is
                    information which is always returned, independent of the
                    given driver parameter and there is optional information
                    which is only shown dependent to given driver parameter. At
                    the moment the following information categories are defined:
</p>
<p>
                        </p>
<blockquote class="text">
<p>TYPE -
                              </p>
<blockquote class="text">
<p>either "BOOL" for boolean value(s) or "INT" for integer
                                value(s) or "FLOAT" for dotted number(s) or "STRING" for
                                character string(s)
                                (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>DESCRIPTION -
                              </p>
<blockquote class="text">
<p>arbitrary text describing the purpose of the parameter
                                (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>MANDATORY -
                              </p>
<blockquote class="text">
<p>either true or false, defines if this parameter must be
                                given when the device is to be created with the
                                <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command
                                (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>FIX -
                              </p>
<blockquote class="text">
<p>either true or false, if false then this parameter can
                                be changed at any time, once the device is created by
                                the <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command
                                (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>MULTIPLICITY -
                              </p>
<blockquote class="text">
<p>either true or false, defines if this parameter allows
                                only one value or a list of values, where true means
                                multiple values and false only a single value allowed
                                (always returned, no matter which driver parameter)
</p>
</blockquote>
                            

<p>DEPENDS -
                              </p>
<blockquote class="text">
<p>comma separated list of parameters this parameter depends
                                on, means the values for fields 'DEFAULT', 'RANGE_MIN',
                                'RANGE_MAX' and 'POSSIBILITIES' might depend on these
                                listed parameters, for example assuming that an audio
                                driver (like the ALSA driver) offers parameters 'card'
                                and 'samplerate' then parameter 'samplerate' would
                                depend on 'card' because the possible values for
                                'samplerate' depends on the sound card which can be
                                chosen by the 'card' parameter
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

<p>DEFAULT -
                              </p>
<blockquote class="text">
<p>reflects the default value for this parameter which is
                                used when the device is created and not explicitly
                                given with the <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>'CREATE MIDI_INPUT_DEVICE'<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a> command,
                                in case of MULTIPLCITY=true, this is a comma separated
                                list, that's why character strings are encapsulated into
                                apostrophes (')
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

<p>RANGE_MIN -
                              </p>
<blockquote class="text">
<p>defines lower limit of the allowed value range for this
                                parameter, can be an integer value as well as a dotted
                                number, this parameter is often used in conjunction
                                with RANGE_MAX, but may also appear without
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

<p>RANGE_MAX -
                              </p>
<blockquote class="text">
<p>defines upper limit of the allowed value range for this
                                parameter, can be an integer value as well as a dotted
                                number, this parameter is often used in conjunction with
                                RANGE_MIN, but may also appear without
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

<p>POSSIBILITIES -
                              </p>
<blockquote class="text">
<p>comma separated list of possible values for this
                                parameter, character strings are encapsulated into
                                apostrophes
                                (optionally returned, dependent to driver parameter)
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"
</p>
<p>S: "DESCRIPTION: Whether device is enabled"
</p>
<p>&nbsp;&nbsp;&nbsp;"TYPE: BOOL"
</p>
<p>&nbsp;&nbsp;&nbsp;"MANDATORY: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"FIX: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.5"></a><h3>6.3.5.&nbsp;
Creating a MIDI input device</h3>

<p>Use the following command to create a new MIDI input device for  the desired MIDI input system:
</p>
<p>
                        </p>
<blockquote class="text">
<p>CREATE MIDI_INPUT_DEVICE &lt;midi-input-driver&gt; [&lt;param-list&gt;]
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
                    by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a> command and &lt;param-list&gt; by an
                    optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
                    character string values should be encapsulated into apostrophes (').
                    Note that there might be drivers which require parameter(s) to be
                    given with this command. Use the previously described commands in
                    this chapter to get that information.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK[&lt;device-id&gt;]" -
                                </p>
<blockquote class="text">
<p>in case the device was successfully created, where
                                    &lt;device-id&gt; is the numerical ID of the new device
</p>
</blockquote>
                            

<p>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the driver was loaded successfully, where
                                    &lt;device-id&gt; is the numerical ID of the new device, but
                                    there are noteworthy issue(s) related, providing an
                                    appropriate warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "CREATE MIDI_INPUT_DEVICE ALSA"
</p>
<p>S: "OK[0]"
</p>
</blockquote><p>
                    
</p>
<a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.6"></a><h3>6.3.6.&nbsp;
Destroying a MIDI input device</h3>

<p>Use the following command to destroy a created MIDI input device:
</p>
<p>
                        </p>
<blockquote class="text">
<p>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
                    <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
                    or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
                    command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case the device was successfully destroyed
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the device was destroyed, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "DESTROY MIDI_INPUT_DEVICE 0"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INPUT_DEVICES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.7"></a><h3>6.3.7.&nbsp;
Getting all created MIDI input device count</h3>

<p>Use the following command to count all created MIDI input devices:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INPUT_DEVICES
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending the current number of all
                            MIDI input devices.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INPUT_DEVICES"
</p>
<p>S: "3"
</p>
</blockquote><p>
                    
</p>
<a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.8"></a><h3>6.3.8.&nbsp;
Getting all created MIDI input device list</h3>

<p>Use the following command to list all created MIDI input devices:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST MIDI_INPUT_DEVICES
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a comma separated list
                            with the numerical Ids of all created MIDI input devices.
</p>
</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST MIDI_INPUT_DEVICES"
</p>
<p>S: "0,1,2"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST MIDI_INPUT_DEVICES"
</p>
<p>S: "1,3"
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.9"></a><h3>6.3.9.&nbsp;
Getting current settings of a MIDI input device</h3>

<p>Use the following command to get current settings of a specific, created MIDI input device:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
                    <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
                    or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
                    command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the information category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that info category. As some
                            parameters might allow multiple values, character strings are
                            encapsulated into apostrophes ('). At the moment the following
                            information categories are defined (independent of driver):
</p>
<p>
                                </p>
<blockquote class="text">
<p>DRIVER -
                                        </p>
<blockquote class="text">
<p>identifier of the used MIDI input driver, as e.g.
                                            returned by the <a class='info' href='#LIST AVAILABLE_MIDI_INPUT_DRIVERS'>"LIST AVAILABLE_MIDI_INPUT_DRIVERS"<span> (</span><span class='info'>Getting all available MIDI input drivers</span><span>)</span></a>
                                            command
</p>
</blockquote>
                                    

</blockquote>
                                
<blockquote class="text">
<p>ACTIVE -
                                        </p>
<blockquote class="text">
<p>either true or false, if false then the MIDI device is
                                            inactive and doesn't listen to any incoming MIDI events
                                            and thus doesn't forward them to connected sampler
                                            channels
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular
                    order. The fields above are only those fields which are
                    returned by all MIDI input devices. Every MIDI input driver
                    might have its own, additional driver specific parameters (see
                    <a class='info' href='#GET MIDI_INPUT_DRIVER INFO'>"GET MIDI_INPUT_DRIVER INFO"<span> (</span><span class='info'>Getting information about a specific MIDI input driver</span><span>)</span></a> command) which are also returned
                    by this command.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INPUT_DEVICE INFO 0"
</p>
<p>S: "DRIVER: ALSA"
</p>
<p>&nbsp;&nbsp;&nbsp;"ACTIVE: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.10"></a><h3>6.3.10.&nbsp;
Changing settings of MIDI input devices</h3>

<p>Use the following command to alter a specific setting of a created MIDI input device:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET MIDI_INPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
                    MIDI input device as returned by the
                    <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
                    or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
                    command, &lt;key&gt; by the name of the parameter to change and
                    &lt;value&gt; by the new value for this parameter.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case setting was successfully changed
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case setting was changed successfully, but there are
                                    noteworthy issue(s) related, providing an appropriate
                                    warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.11"></a><h3>6.3.11.&nbsp;
Getting information about a MIDI port</h3>

<p>Use the following command to get information about a MIDI port:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
                    <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
                    or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
                    command and &lt;midi-port&gt; the MIDI input port number.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the information category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that info category. At the moment
                            the following information categories are defined:
</p>
<p>NAME -
                                </p>
<blockquote class="text">
<p>arbitrary character string naming the port
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The field above is only the one which is returned by all MIDI
                    ports regardless of the MIDI driver and port. Every MIDI port
                    might have its own, additional driver and port specific
                    parameters.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INPUT_PORT INFO 0 0"
</p>
<p>S: "NAME: 'Masterkeyboard'"
</p>
<p>&nbsp;&nbsp;&nbsp;"ALSA_SEQ_BINDINGS: '64:0'"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.12"></a><h3>6.3.12.&nbsp;
Getting information about specific MIDI port parameter</h3>

<p>Use the following command to get detailed information about specific MIDI port parameter:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INPUT_PORT_PARAMETER INFO &lt;dev-id&gt; &lt;port&gt; &lt;param&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
                    <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
                    or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
                    command, &lt;port&gt; the MIDI port number and
                    &lt;param&gt; a specific port parameter name for which information should be
                    obtained (as returned by the <a class='info' href='#GET MIDI_INPUT_PORT INFO'>"GET MIDI_INPUT_PORT INFO"<span> (</span><span class='info'>Getting information about a MIDI port</span><span>)</span></a> command).
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the information category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that info category. There is
                            information which is always returned, independently of the
                            given channel parameter and there is optional information
                            which are only shown dependently to the given MIDI port. At the
                            moment the following information categories are defined:
</p>
<p>TYPE -
                                </p>
<blockquote class="text">
<p>either "BOOL" for boolean value(s) or "INT" for integer
                                    value(s) or "FLOAT" for dotted number(s) or "STRING" for
                                    character string(s)
                                    (always returned)
</p>
</blockquote>
                            

<p>DESCRIPTION -
                                </p>
<blockquote class="text">
<p>arbitrary text describing the purpose of the parameter
                                    (always returned)
</p>
</blockquote>
                            

<p>FIX -
                                </p>
<blockquote class="text">
<p>either true or false, if true then this parameter is
                                    read only, thus cannot be altered
                                    (always returned)
</p>
</blockquote>
                            

<p>MULTIPLICITY -
                                </p>
<blockquote class="text">
<p>either true or false, defines if this parameter allows
                                    only one value or a list of values, where true means
                                    multiple values and false only a single value allowed
                                    (always returned)
</p>
</blockquote>
                            

<p>RANGE_MIN -
                                </p>
<blockquote class="text">
<p>defines lower limit of the allowed value range for this
                                    parameter, can be an integer value as well as a dotted
                                    number, this parameter is usually used in conjunction
                                    with 'RANGE_MAX' but may also appear without
                                    (optionally returned, dependent to driver and port
                                    parameter)
</p>
</blockquote>
                            

<p>RANGE_MAX -
                                </p>
<blockquote class="text">
<p>defines upper limit of the allowed value range for this
                                    parameter, can be an integer value as well as a dotted
                                    number, this parameter is usually used in conjunction
                                    with 'RANGE_MIN' but may also appear without
                                    (optionally returned, dependent to driver and port
                                    parameter)
</p>
</blockquote>
                            

<p>POSSIBILITIES -
                                </p>
<blockquote class="text">
<p>comma separated list of possible values for this
                                    parameter, character strings are encapsulated into
                                    apostrophes
                                    (optionally returned, dependent to device and port
                                    parameter)
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
</p>
<p>S: "DESCRIPTION: bindings to other ALSA sequencer clients"
</p>
<p>&nbsp;&nbsp;&nbsp;"TYPE: STRING"
</p>
<p>&nbsp;&nbsp;&nbsp;"FIX: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '64:0','68:0','68:1'"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.3.13"></a><h3>6.3.13.&nbsp;
Changing settings of MIDI input ports</h3>

<p>Use the following command to alter a specific setting of a MIDI input port:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET MIDI_INPUT_PORT_PARAMETER &lt;device-id&gt; &lt;port&gt; &lt;key&gt;=&lt;value&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;device-id&gt; should be replaced by the numerical ID of the
                    MIDI device as returned by the
                    <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
                    or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
                    command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
                    the parameter to change and &lt;value&gt; by the new value for this
                    parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
                    for specifying no value for parameters allowing a list of values.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case setting was successfully changed
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case setting was changed successfully, but there are
                                    noteworthy issue(s) related, providing an appropriate
                                    warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="anchor11"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4"></a><h3>6.4.&nbsp;
Configuring sampler channels</h3>

<p>The following commands describe how to add and remove sampler channels, associate a
                sampler channel with a sampler engine, load instruments and connect sampler channels to
                MIDI and audio devices.
</p>
<a name="LOAD INSTRUMENT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.1"></a><h3>6.4.1.&nbsp;
Loading an instrument</h3>

<p>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LOAD INSTRUMENT [NON_MODAL] '&lt;filename&gt;' &lt;instr-index&gt; &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;filename&gt; is the name of the instrument file on the
                    LinuxSampler instance's host system, &lt;instr-index&gt; the index of the
                    instrument in the instrument file and &lt;sampler-channel> is the
                    number of the sampler channel the instrument should be assigned to.
                    Each sampler channel can only have one instrument.
</p>
<p>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
                    escape characters for special characters (see chapter
                    "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"
                    for details) and accordingly backslash characters in the filename
                    MUST now be escaped as well!
</p>
<p>The difference between regular and NON_MODAL versions of the command
                    is that the regular command returns OK only after the instrument has been
                    fully loaded and the channel is ready to be used while NON_MODAL version
                    returns immediately and a background process is launched to load the instrument
                    on the channel. The <a class='info' href='#GET CHANNEL INFO'>GET CHANNEL INFO<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
                    command can be used to obtain loading
                    progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
                    such as making sure that the file could be read and it is of a proper format
                    and SHOULD return ERR and SHOULD not launch the background process should any
                    errors be detected at that point.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case the instrument was successfully loaded
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the instrument was loaded successfully, but there
                                    are noteworthy issue(s) related (e.g. Engine doesn't support
                                    one or more patch parameters provided by the loaded
                                    instrument file), providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example (Unix):
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
</p>
<p>S: OK
</p>
</blockquote><p>
                    
</p>
<p>Example (Windows):
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
</p>
<p>S: OK
</p>
</blockquote><p>
                    
</p>
<a name="LOAD ENGINE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.2"></a><h3>6.4.2.&nbsp;
Loading a sampler engine</h3>

<p>A sampler engine type can be associated to a specific sampler
                    channel by the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;engine-name&gt; is an engine name as obtained by the
                    <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a> command and &lt;sampler-channel&gt;
                    the sampler channel as returned by the
                    <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a> or
                    <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command where
                    the engine type should be assigned to. This command should be issued
                    after adding a new sampler channel and before any other control
                    commands on the new sampler channel. It can also be used to change
                    the engine type of a sampler channel. This command has (currently) no
                    way to define or force if a new engine instance should be created and
                    assigned to the given sampler channel or if an already existing
                    instance of that engine type, shared with other sampler channels,
                    should be used.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case the engine was successfully deployed
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the engine was deployed successfully, but there
                                    are noteworthy issue(s) related, providing an appropriate
                                    warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="GET CHANNELS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.3"></a><h3>6.4.3.&nbsp;
Getting all created sampler channel count</h3>

<p>The number of sampler channels can change on runtime. To get the
                    current amount of sampler channels, the front-end can send the
                    following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET CHANNELS
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by returning the current number of sampler channels.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET CHANNELS"
</p>
<p>S: "12"
</p>
</blockquote><p>
                    
</p>
<a name="LIST CHANNELS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.4"></a><h3>6.4.4.&nbsp;
Getting all created sampler channel list</h3>

<p>The number of sampler channels can change on runtime. To get the
                    current list of sampler channels, the front-end can send the
                    following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST CHANNELS
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by returning a comma separated list
                            with all sampler channels numerical IDs.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST CHANNELS"
</p>
<p>S: "0,1,2,3,4,5,6,9,10,11,15,20"
</p>
</blockquote><p>
                    
</p>
<a name="ADD CHANNEL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.5"></a><h3>6.4.5.&nbsp;
Adding a new sampler channel</h3>

<p>A new sampler channel can be added to the end of the sampler
                    channel list by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>ADD CHANNEL
</p>
</blockquote><p>
                    
</p>
<p>This will increment the sampler channel count by one and the new
                    sampler channel will be appended to the end of the sampler channel
                    list. The front-end should send the respective, related commands
                    right after to e.g. load an engine, load an instrument and setting
                    input, output method and eventually other commands to initialize
                    the new channel. The front-end should use the sampler channel
                    returned by the answer of this command to perform the previously
                    recommended commands, to avoid race conditions e.g. with other
                    front-ends that might also have sent an "ADD CHANNEL" command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK[&lt;sampler-channel&gt;]" -
                                </p>
<blockquote class="text">
<p>in case a new sampler channel could be added, where
                                    &lt;sampler-channel&gt; reflects the channel number of the new
                                    created sampler channel which should be used to set up
                                    the sampler channel by sending subsequent initialization
                                    commands
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case a new channel was added successfully, but there are
                                    noteworthy issue(s) related, providing an appropriate
                                    warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="REMOVE CHANNEL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.6"></a><h3>6.4.6.&nbsp;
Removing a sampler channel</h3>

<p>A sampler channel can be removed by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>REMOVE CHANNEL &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; should be replaced by the
                    number of the sampler channel as given by the
                    <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
                    command. The channel numbers of all subsequent sampler channels
                    remain the same.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case the given sampler channel could be removed
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the given channel was removed, but there are
                                    noteworthy issue(s) related, providing an appropriate
                                    warning code and warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="GET AVAILABLE_ENGINES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.7"></a><h3>6.4.7.&nbsp;
Getting amount of available engines</h3>

<p>The front-end can ask for the number of available engines by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET AVAILABLE_ENGINES
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending the number of available engines.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET AVAILABLE_ENGINES"
</p>
<p>S: "4"
</p>
</blockquote><p>
                    
</p>
<a name="LIST AVAILABLE_ENGINES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.8"></a><h3>6.4.8.&nbsp;
Getting all available engines</h3>

<p>The front-end can ask for a list of all available engines by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST AVAILABLE_ENGINES
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a comma separated list
                            of the engines' names encapsulated into apostrophes (').
                            Engine names can consist of lower and upper cases,
                            digits and underlines ("_" character).
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST AVAILABLE_ENGINES"
</p>
<p>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
</p>
</blockquote><p>
                    
</p>
<a name="GET ENGINE INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.9"></a><h3>6.4.9.&nbsp;
Getting information about an engine</h3>

<p>The front-end can ask for information about a specific engine by
                    sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET ENGINE INFO &lt;engine-name&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;engine-name&gt; is an engine name as obtained by the
                    <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the information category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that info category. At the moment
                            the following categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>DESCRIPTION -
                                        </p>
<blockquote class="text">
<p>arbitrary description text about the engine
                                            (note that the character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
</p>
</blockquote>
                                    

<p>VERSION -
                                        </p>
<blockquote class="text">
<p>arbitrary character string regarding the engine's version
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET ENGINE INFO JoesCustomEngine"
</p>
<p>S: "DESCRIPTION: this is Joe's custom sampler engine"
</p>
<p>&nbsp;&nbsp;&nbsp;"VERSION: testing-1.0"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="GET CHANNEL INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.10"></a><h3>6.4.10.&nbsp;
Getting sampler channel information</h3>

<p>The front-end can ask for the current settings of a sampler channel
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET CHANNEL INFO &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the settings category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that setting category. At the
                            moment the following categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>ENGINE_NAME -
                                        </p>
<blockquote class="text">
<p>name of the engine that is associated with the sampler
                                            channel, "NONE" if there's no engine associated yet for
                                            this sampler channel
</p>
</blockquote>
                                    

<p>AUDIO_OUTPUT_DEVICE -
                                        </p>
<blockquote class="text">
<p>numerical ID of the audio output device which is
                                            currently connected to this sampler channel to output
                                            the audio signal, "NONE" if there's no device
                                            connected to this sampler channel
</p>
</blockquote>
                                    

<p>AUDIO_OUTPUT_CHANNELS -
                                        </p>
<blockquote class="text">
<p>number of output channels the sampler channel offers
                                            (dependent to used sampler engine and loaded instrument)
</p>
</blockquote>
                                    

<p>AUDIO_OUTPUT_ROUTING -
                                        </p>
<blockquote class="text">
<p>comma separated list which reflects to which audio
                                            channel of the selected audio output device each
                                            sampler output channel is routed to, e.g. "0,3" would
                                            mean the engine's output channel 0 is routed to channel
                                            0 of the audio output device and the engine's output
                                            channel 1 is routed to the channel 3 of the audio
                                            output device
</p>
</blockquote>
                                    

<p>INSTRUMENT_FILE -
                                        </p>
<blockquote class="text">
<p>the file name of the loaded instrument, "NONE" if
                                            there's no instrument yet loaded for this sampler
                                            channel (note: since LSCP 1.2 this path may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
</p>
</blockquote>
                                    

<p>INSTRUMENT_NR -
                                        </p>
<blockquote class="text">
<p>the instrument index number of the loaded instrument
</p>
</blockquote>
                                    

<p>INSTRUMENT_NAME -
                                        </p>
<blockquote class="text">
<p>the instrument name of the loaded instrument
                                            (note: since LSCP 1.2 this character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
</p>
</blockquote>
                                    

<p>INSTRUMENT_STATUS -
                                        </p>
<blockquote class="text">
<p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative
                                            value indicates a loading exception. Value of 100 indicates that the instrument is fully
                                            loaded.
</p>
</blockquote>
                                    

<p>MIDI_INPUT_DEVICE -
                                        </p>
<blockquote class="text">
<p>numerical ID of the MIDI input device which is
                                            currently connected to this sampler channel to deliver
                                            MIDI input commands, "NONE" if there's no device
                                            connected to this sampler channel
</p>
</blockquote>
                                    

<p>MIDI_INPUT_PORT -
                                        </p>
<blockquote class="text">
<p>port number of the MIDI input device
</p>
</blockquote>
                                    

<p>MIDI_INPUT_CHANNEL -
                                        </p>
<blockquote class="text">
<p>the MIDI input channel number this sampler channel
                                            should listen to or "ALL" to listen on all MIDI channels
</p>
</blockquote>
                                    

<p>VOLUME -
                                        </p>
<blockquote class="text">
<p>optionally dotted number for the channel volume factor
                                            (where a value &lt; 1.0 means attenuation and a value >
                                            1.0 means amplification)
</p>
</blockquote>
                                    

<p>MUTE -
                                        </p>
<blockquote class="text">
<p>Determines whether the channel is muted, "true" if the
                                            channel is muted, "false" if the channel is not muted, and
                                            "MUTED_BY_SOLO" if the channel is muted because of the
                                            presence of a solo channel and will be unmuted when
                                            there are no solo channels left
</p>
</blockquote>
                                    

<p>SOLO -
                                        </p>
<blockquote class="text">
<p>Determines whether this is a solo channel, "true" if
                                            the channel is a solo channel; "false" otherwise
</p>
</blockquote>
                                    

<p>MIDI_INSTRUMENT_MAP -
                                        </p>
<blockquote class="text">
<p>Determines to which MIDI instrument map this sampler
                                            channel is assigned to. Read chapter
                                            <a class='info' href='#SET CHANNEL MIDI_INSTRUMENT_MAP'>"SET CHANNEL MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Assigning a MIDI instrument map to a sampler channel</span><span>)</span></a>
                                            for a list of possible values.
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET CHANNEL INFO 34"
</p>
<p>S: "ENGINE_NAME: GigEngine"
</p>
<p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
</p>
<p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_DEVICE: 0"
</p>
<p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_CHANNELS: 2"
</p>
<p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 0,1"
</p>
<p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
</p>
<p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
</p>
<p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Fazioli Piano"
</p>
<p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_STATUS: 100"
</p>
<p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"
</p>
<p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"
</p>
<p>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"
</p>
<p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
</p>
<p>&nbsp;&nbsp;&nbsp;"MUTE: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"SOLO: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="GET CHANNEL VOICE_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.11"></a><h3>6.4.11.&nbsp;
Current number of active voices</h3>

<p>The front-end can ask for the current number of active voices on a
                    sampler channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by returning the number of active
                            voices on that channel.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="GET CHANNEL STREAM_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.12"></a><h3>6.4.12.&nbsp;
Current number of active disk streams</h3>

<p>The front-end can ask for the current number of active disk streams
                    on a sampler channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by returning the number of active
                            disk streams on that channel in case the engine supports disk
                            streaming, if the engine doesn't support disk streaming it will
                            return "NA" for not available.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="GET CHANNEL BUFFER_FILL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.13"></a><h3>6.4.13.&nbsp;
Current fill state of disk stream buffers</h3>

<p>The front-end can ask for the current fill state of all disk streams
                    on a sampler channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>to get the fill state in bytes or
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>to get the fill state in percent, where &lt;sampler-channel&gt; is the
                    sampler channel number the front-end is interested in
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will either answer by returning a comma separated
                            string with the fill state of all disk stream buffers on that
                            channel or an empty line if there are no active disk streams or
                            "NA" for *not available* in case the engine which is deployed
                            doesn't support disk streaming. Each entry in the answer list
                            will begin with the stream's ID in brackets followed by the
                            numerical representation of the fill size (either in bytes or
                            percentage). Note: due to efficiency reasons the fill states in
                            the response are not in particular order, thus the front-end has
                            to sort them by itself if necessary.
</p>
</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET CHANNEL BUFFER_FILL BYTES 4"
</p>
<p>S: "[115]420500,[116]510300,[75]110000,[120]230700"
</p>
</blockquote><p>

                        </p>
<blockquote class="text">
<p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
</p>
<p>S: "[115]90%,[116]98%,[75]40%,[120]62%"
</p>
</blockquote><p>

                        </p>
<blockquote class="text">
<p>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
</p>
<p>S: ""
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL AUDIO_OUTPUT_DEVICE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.14"></a><h3>6.4.14.&nbsp;
Setting audio output device</h3>

<p>The front-end can set the audio output device on a specific sampler
                    channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the respective sampler channel
                    number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
                    &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
                    <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
                    or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
                    command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if audio output device was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL AUDIO_OUTPUT_TYPE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.15"></a><h3>6.4.15.&nbsp;
Setting audio output type</h3>

<p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
</p>
<p>The front-end can alter the audio output type on a specific sampler
                    channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL AUDIO_OUTPUT_TYPE &lt;sampler-channel&gt; &lt;audio-output-type&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;audio-output-type&gt; is currently either "ALSA" or "JACK" and
                    &lt;sampler-channel&gt; is the respective sampler channel number.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if audio output type was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.16"></a><h3>6.4.16.&nbsp;
Setting audio output channel</h3>

<p>The front-end can alter the audio output channel on a specific
                    sampler channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-chan&gt; is the sampler channel number
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command, &lt;audio-out&gt; is the
                    numerical ID of the sampler channel's audio output channel which should be
                    rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
                    output device where &lt;audio-out&gt; should be routed to.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if audio output channel was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL MIDI_INPUT_DEVICE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.17"></a><h3>6.4.17.&nbsp;
Setting MIDI input device</h3>

<p>The front-end can set the MIDI input device on a specific sampler
                    channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the sampler channel number
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command
                    and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
                    <a class='info' href='#CREATE MIDI_INPUT_DEVICE'>"CREATE MIDI_INPUT_DEVICE"<span> (</span><span class='info'>Creating a MIDI input device</span><span>)</span></a>
                    or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if MIDI input device was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL MIDI_INPUT_TYPE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.18"></a><h3>6.4.18.&nbsp;
Setting MIDI input type</h3>

<p>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
</p>
<p>The front-end can alter the MIDI input type on a specific sampler
                    channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL MIDI_INPUT_TYPE &lt;sampler-channel&gt; &lt;midi-input-type&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;midi-input-type&gt; is currently only "ALSA" and
                    &lt;sampler-channel&gt; is the respective sampler channel number.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if MIDI input type was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL MIDI_INPUT_PORT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.19"></a><h3>6.4.19.&nbsp;
Setting MIDI input port</h3>

<p>The front-end can alter the MIDI input port on a specific sampler
                    channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL MIDI_INPUT_PORT &lt;sampler-channel&gt; &lt;midi-input-port&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;midi-input-port&gt; is a MIDI input port number of the
                    MIDI input device connected to the sampler channel given by
                    &lt;sampler-channel&gt;.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if MIDI input port was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL MIDI_INPUT_CHANNEL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.20"></a><h3>6.4.20.&nbsp;
Setting MIDI input channel</h3>

<p>The front-end can alter the MIDI channel a sampler channel should
                    listen to by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where
                    &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI
                    channels.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if MIDI input channel was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL VOLUME"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.21"></a><h3>6.4.21.&nbsp;
Setting channel volume</h3>

<p>The front-end can alter the volume of a sampler channel by sending
                    the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;volume&gt; is an optionally dotted positive number (a value
                    smaller than 1.0 means attenuation, whereas a value greater than
                    1.0 means amplification) and &lt;sampler-channel&gt; defines the sampler
                    channel where this volume factor should be set.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if channel volume was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL MUTE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.22"></a><h3>6.4.22.&nbsp;
Muting a sampler channel</h3>

<p>The front-end can mute/unmute a specific sampler
                    channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the respective sampler channel
                    number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
                    &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
                    to unmute the channel.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the channel was muted/unmuted, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL SOLO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.23"></a><h3>6.4.23.&nbsp;
Soloing a sampler channel</h3>

<p>The front-end can solo/unsolo a specific sampler channel
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the respective sampler channel
                    number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
                    &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
                    to unsolo the channel.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the channel was soloed/unsoloed, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET CHANNEL MIDI_INSTRUMENT_MAP"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.24"></a><h3>6.4.24.&nbsp;
Assigning a MIDI instrument map to a sampler channel</h3>

<p>The front-end can assign a MIDI instrument map to a specific sampler channel
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the respective sampler channel
                    number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
                    &lt;map&gt; can have the following possibilites:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"NONE" -
                                </p>
<blockquote class="text">
<p>This is the default setting. In this case
                                    the sampler channel is not assigned any MIDI
                                    instrument map and thus will ignore all MIDI
                                    program change messages.
</p>
</blockquote>
                            

<p>"DEFAULT" -
                                </p>
<blockquote class="text">
<p>The sampler channel will always use the
                                    default MIDI instrument map to handle MIDI
                                    program change messages.
</p>
</blockquote>
                            

<p>numeric ID -
                                </p>
<blockquote class="text">
<p>You can assign a specific MIDI instrument map
                                    by replacing &lt;map&gt; with the respective numeric
                                    ID of the MIDI instrument map as returned by the
                                    <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
                                    command. Once that map will be deleted, the sampler
                                    channel would fall back to "NONE".
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Read chapter <a class='info' href='#MIDI Instrument Mapping'>"MIDI Instrument Mapping"<span> (</span><span class='info'>MIDI Instrument Mapping</span><span>)</span></a>
                    for details regarding MIDI instrument mapping.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="CREATE FX_SEND"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.25"></a><h3>6.4.25.&nbsp;
Adding an effect send to a sampler channel</h3>

<p>The front-end can create an additional effect send on a specific sampler channel
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the respective sampler channel
                    number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command, that is the
                    sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
                    is a number between 0..127 defining the MIDI controller which can alter the
                    effect send level and &lt;name&gt; is an optional argument defining a name
                    for the effect send entity. The name does not have to be unique, but MUST be
                    encapsulated into apostrophes and supports escape sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
</p>
<p>By default, that is as initial routing, the effect send's audio channels
                    are automatically routed to the last audio channels of the sampler channel's
                    audio output device, that way you can i.e. first increase the amount of audio
                    channels on the audio output device for having dedicated effect send output
                    channels and when "CREATE FX_SEND" is called, those channels will automatically
                    be picked. You can alter the destination channels however with
                    <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>.
                    
</p>
<p>Note: Create effect sends on a sampler channel only when needed, because having effect
                    sends on a sampler channel will decrease runtime performance, because for implementing channel
                    effect sends, separate (sampler channel local) audio buffers are needed to render and mix
                    the voices and route the audio signal afterwards to the master outputs and effect send
                    outputs (along with their respective effect send levels). A sampler channel without effect
                    sends however can mix its voices directly into the audio output devices's audio buffers
                    and is thus faster.
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK[&lt;fx-send-id&gt;]" -
                                </p>
<blockquote class="text">
<p>in case a new effect send could be added to the
                                    sampler channel, where &lt;fx-send-id&gt; reflects the
                                    unique ID of the newly created effect send entity
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>when a new effect send could not be added, i.e.
                                    due to invalid parameters
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "CREATE FX_SEND 0 91 'Reverb Send'"
</p>
<p>S: "OK[0]"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "CREATE FX_SEND 0 93"
</p>
<p>S: "OK[1]"
</p>
</blockquote><p>
                    
</p>
<a name="DESTROY FX_SEND"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.26"></a><h3>6.4.26.&nbsp;
Removing an effect send from a sampler channel</h3>

<p>The front-end can remove an existing effect send on a specific sampler channel
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the respective sampler channel
                    number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command, that is the
                    sampler channel from which the effect send should be removed from and
                    &lt;fx-send-id&gt; is the respective effect send number as returned by the
                    <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "DESTROY FX_SEND 0 0"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET FX_SENDS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.27"></a><h3>6.4.27.&nbsp;
Getting amount of effect sends on a sampler channel</h3>

<p>The front-end can ask for the amount of effect sends on a specific sampler channel
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET FX_SENDS &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the respective sampler channel
                    number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The sampler will answer by returning the number of effect
                            sends on the given sampler channel.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET FX_SENDS 0"
</p>
<p>S: "2"
</p>
</blockquote><p>
                    
</p>
<a name="LIST FX_SENDS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.28"></a><h3>6.4.28.&nbsp;
Listing all effect sends on a sampler channel</h3>

<p>The front-end can ask for a list of effect sends on a specific sampler channel
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST FX_SENDS &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the respective sampler channel
                    number as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The sampler will answer by returning a comma separated list
                            with all effect sends' numerical IDs on the given sampler
                            channel.
</p>
</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST FX_SENDS 0"
</p>
<p>S: "0,1"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST FX_SENDS 1"
</p>
<p>S: ""
</p>
</blockquote><p>
                    
</p>
<a name="GET FX_SEND INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.29"></a><h3>6.4.29.&nbsp;
Getting effect send information</h3>

<p>The front-end can ask for the current settings of an effect send entity
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; is the sampler channel number
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command and
                    &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
                    as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command.
                   
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The sampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the settings category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that setting category. At the
                            moment the following categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>NAME -
                                        </p>
<blockquote class="text">
<p>name of the effect send entity
                                            (note that this character string may contain
                                             <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
</p>
</blockquote>
                                    

<p>MIDI_CONTROLLER -
                                        </p>
<blockquote class="text">
<p>a value between 0 and 127 reflecting the MIDI controller
                                            which is able to modify the effect send's send level
</p>
</blockquote>
                                    

<p>LEVEL -
                                        </p>
<blockquote class="text">
<p>optionally dotted number reflecting the effect send's
                                            current send level (where a value &lt; 1.0 means attenuation
                                            and a value > 1.0 means amplification)
</p>
</blockquote>
                                    

<p>AUDIO_OUTPUT_ROUTING -
                                        </p>
<blockquote class="text">
<p>comma separated list which reflects to which audio
                                            channel of the selected audio output device each
                                            effect send output channel is routed to, e.g. "0,3" would
                                            mean the effect send's output channel 0 is routed to channel
                                            0 of the audio output device and the effect send's output
                                            channel 1 is routed to the channel 3 of the audio
                                            output device (see
                                            <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>
                                            for details)
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET FX_SEND INFO 0 0"
</p>
<p>S: "NAME: Reverb Send"
</p>
<p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
</p>
<p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
</p>
<p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="SET FX_SEND NAME"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
Changing effect send's name</h3>

<p>The front-end can alter the current name of an effect
                    send entity by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-chan&gt; is the sampler channel number
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
                    &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
                    as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
                    &lt;name&gt; is the new name of the effect send entity, which
                    does not have to be unique (name MUST be encapsulated into apostrophes
                    and supports escape sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
Altering effect send's audio routing</h3>

<p>The front-end can alter the destination of an effect send's audio channel on a specific
                    sampler channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-chan&gt; is the sampler channel number
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
                    &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
                    as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command,
                    &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
                    which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
                    the audio channel of the selected audio output device where &lt;audio-src&gt;
                    should be routed to.
</p>
<p>Note that effect sends can only route audio to the same audio output
                    device as assigned to the effect send's sampler channel. Also note that an
                    effect send entity does always have exactly as much audio channels as its
                    sampler channel. So if the sampler channel is stereo, the effect send does
                    have two audio channels as well. Also keep in mind that the amount of audio
                    channels on a sampler channel might be dependant not only to the deployed
                    sampler engine on the sampler channel, but also dependant to the instrument
                    currently loaded. However you can (effectively) turn an i.e. stereo effect
                    send into a mono one by simply altering its audio routing appropriately.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if audio output channel was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
Altering effect send's MIDI controller</h3>

<p>The front-end can alter the MIDI controller of an effect
                    send entity by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-chan&gt; is the sampler channel number
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
                    &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
                    as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
                    &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
                    able to modify the effect send's send level.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if MIDI controller was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="SET FX_SEND LEVEL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
Altering effect send's send level</h3>

<p>The front-end can alter the current send level of an effect
                    send entity by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-chan&gt; is the sampler channel number
                    as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
                    &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
                    as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
                    &lt;volume&gt; is an optionally dotted positive number (a value
                    smaller than 1.0 means attenuation, whereas a value greater than
                    1.0 means amplification) reflecting the new send level.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if new send level was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET FX_SEND LEVEL 0 0 0.15"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="RESET CHANNEL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
Resetting a sampler channel</h3>

<p>The front-end can reset a particular sampler channel by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>RESET CHANNEL &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>
                    Where &lt;sampler-channel&gt; defines the sampler channel to be reset.
                    This will cause the engine on that sampler channel, its voices and
                    eventually disk streams and all control and status variables to be
                    reset.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if channel was reset, but there are noteworthy issue(s)
                                    related, providing an appropriate warning code and warning
                                    message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="anchor12"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.5"></a><h3>6.5.&nbsp;
Controlling connection</h3>

<p>The following commands are used to control the connection to LinuxSampler.
</p>
<a name="SUBSCRIBE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.5.1"></a><h3>6.5.1.&nbsp;
Register front-end for receiving event messages</h3>

<p>The front-end can register itself to the LinuxSampler application to
                    be informed about noteworthy events by sending this command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SUBSCRIBE &lt;event-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>where &lt;event-id&gt; will be replaced by the respective event that
                    client wants to subscribe to.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if registration succeeded, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="UNSUBSCRIBE"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.5.2"></a><h3>6.5.2.&nbsp;
Unregister front-end for not receiving event messages</h3>

<p>The front-end can unregister itself if it doesn't want to receive event
                    messages anymore by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>UNSUBSCRIBE &lt;event-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;event-id&gt; will be replaced by the respective event that
                    client doesn't want to receive anymore.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if unregistration succeeded, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and
                                    error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="SET ECHO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.5.3"></a><h3>6.5.3.&nbsp;
Enable or disable echo of commands</h3>

<p>To enable or disable back sending of commands to the client the following command can be used:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET ECHO &lt;value&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;value&gt; should be replaced either by "1" to enable echo mode
                    or "0" to disable echo mode. When echo mode is enabled, all
                    commands send to LinuxSampler will be immediately send back and
                    after this echo the actual response to the command will be
                    returned. Echo mode will only be altered for the client connection
                    that issued the "SET ECHO" command, not globally for all client
                    connections.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>usually
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>on syntax error, e.g. non boolean value
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="QUIT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.5.4"></a><h3>6.5.4.&nbsp;
Close client connection</h3>

<p>The client can close its network connection to LinuxSampler by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>QUIT
</p>
</blockquote><p>
                    
</p>
<p>This is probably more interesting for manual telnet connections to
                    LinuxSampler than really useful for a front-end implementation.
</p>
<a name="anchor13"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.6"></a><h3>6.6.&nbsp;
Global commands</h3>

<p>The following commands have global impact on the sampler.
</p>
<a name="GET TOTAL_VOICE_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.6.1"></a><h3>6.6.1.&nbsp;
Current number of active voices</h3>

<p>The front-end can ask for the current number of active voices on
                    the sampler by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET TOTAL_VOICE_COUNT
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by returning the number of all active
                            voices on the sampler.
</p>
</blockquote><p>
                    
</p>
<a name="GET TOTAL_VOICE_COUNT_MAX"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.6.2"></a><h3>6.6.2.&nbsp;
Maximum amount of active voices</h3>

<p>The front-end can ask for the maximum number of active voices
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET TOTAL_VOICE_COUNT_MAX
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by returning the maximum number
                            of active voices.
</p>
</blockquote><p>
                    
</p>
<a name="GET TOTAL_STREAM_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.6.3"></a><h3>6.6.3.&nbsp;
Current number of active disk streams</h3>

<p>The front-end can ask for the current number of active disk streams on
                    the sampler by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET TOTAL_STREAM_COUNT
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by returning the number of all active
                            disk streams on the sampler.
</p>
</blockquote><p>
                    
</p>
<a name="RESET"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.6.4"></a><h3>6.6.4.&nbsp;
Reset sampler</h3>

<p>The front-end can reset the whole sampler by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>RESET
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>always
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>
</p>
</blockquote><p>
                    
</p>
<a name="GET SERVER INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
General sampler informations</h3>

<p>The client can ask for general informations about the LinuxSampler
                       instance by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET SERVER INFO
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                               Each answer line begins with the information category name
                               followed by a colon and then a space character &lt;SP&gt; and finally
                               the info character string to that information category. At the
                               moment the following categories are defined:
                            
</p>
<p>
                                </p>
<blockquote class="text">
<p>DESCRIPTION -
                                        </p>
<blockquote class="text">
<p>arbitrary textual description about the sampler
                                            (note that the character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
</p>
</blockquote>
                                    

<p>VERSION -
                                        </p>
<blockquote class="text">
<p>version of the sampler
</p>
</blockquote>
                                    

<p>PROTOCOL_VERSION -
                                        </p>
<blockquote class="text">
<p>version of the LSCP specification the sampler
                                            complies with (see <a class='info' href='#LSCP versioning'>Section&nbsp;2<span> (</span><span class='info'>Versioning of this specification</span><span>)</span></a> for details)
</p>
</blockquote>
                                    

<p>INSTRUMENTS_DB_SUPPORT -
                                        </p>
<blockquote class="text">
<p>either yes or no, specifies whether the
                                            sampler is build with instruments database support.
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
                    Other fields might be added in future.
</p>
<a name="GET VOLUME"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
Getting global volume attenuation</h3>

<p>The client can ask for the current global sampler-wide volume
                    attenuation by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET VOLUME
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The sampler will always answer by returning the optional
                            dotted floating point coefficient, reflecting the current
                            global volume attenuation.
                            
</p>
</blockquote><p>
                    
</p>
<p>Note: it is up to the respective sampler engine whether to obey
                    that global volume parameter or not, but in general all engines SHOULD
                    use this parameter.
</p>
<a name="SET VOLUME"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.6.7"></a><h3>6.6.7.&nbsp;
Setting global volume attenuation</h3>

<p>The client can alter the current global sampler-wide volume
                    attenuation by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET VOLUME &lt;volume&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;volume&gt; should be replaced by the optional dotted
                   floating point value, reflecting the new global volume parameter.
                   This value might usually be in the range between 0.0 and 1.0, that
                   is for attenuating the overall volume.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the global volume was set, but there are noteworthy
                                    issue(s) related, providing an appropriate warning code and
                                    warning message
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case it failed, providing an appropriate error code and error message
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<a name="MIDI Instrument Mapping"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
MIDI Instrument Mapping</h3>

<p>The MIDI protocol provides a way to switch between instruments
                by sending so called MIDI bank select and MIDI program change
                messages which are essentially just numbers. The following commands
                allow to actually map arbitrary MIDI bank select / program change
                numbers with real instruments.
</p>
<p>The sampler allows to manage an arbitrary amount of MIDI
                instrument maps which define which instrument to load on
                which MIDI program change message.
</p>
<p>By default, that is when the sampler is launched, there is no
                map, thus the sampler will simply ignore all program change
                messages. The front-end has to explicitly create at least one
                map, add entries to the map and tell the respective sampler
                channel(s) which MIDI instrument map to use, so the sampler
                knows how to react on a given program change message on the
                respective sampler channel, that is by switching to the
                respectively defined engine type and loading the respective
                instrument. See command
                <a class='info' href='#SET CHANNEL MIDI_INSTRUMENT_MAP'>"SET CHANNEL MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Assigning a MIDI instrument map to a sampler channel</span><span>)</span></a>
                for how to assign a MIDI instrument map to a sampler channel.
</p>
<p>Also note per MIDI specification a bank select message does not
                cause to switch to another instrument. Instead when receiving a
                bank select message the bank value will be stored and a subsequent
                program change message (which may occur at any time) will finally
                cause the sampler to switch to the respective instrument as
                reflected by the current MIDI instrument map.
</p>
<a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
Create a new MIDI instrument map</h3>

<p>The front-end can add a new MIDI instrument map by sending
                    the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;name&gt; is an optional argument allowing to
                    assign a custom name to the new map. MIDI instrument Map
                    names do not have to be unique, but MUST be encapsulated
                    into apostrophes and support escape sequences as described
                    in chapter "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK[&lt;map&gt;]" -
                                </p>
<blockquote class="text">
<p>in case a new MIDI instrument map could
                                    be added, where &lt;map&gt; reflects the
                                    unique ID of the newly created MIDI
                                    instrument map
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>when a new map could not be created, which
                                    might never occur in practice
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
</p>
<p>S: "OK[0]"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
</p>
<p>S: "OK[1]"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "ADD MIDI_INSTRUMENT_MAP"
</p>
<p>S: "OK[5]"
</p>
</blockquote><p>
                    
</p>
<a name="REMOVE MIDI_INSTRUMENT_MAP"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.2"></a><h3>6.7.2.&nbsp;
Delete one particular or all MIDI instrument maps</h3>

<p>The front-end can delete a particular MIDI instrument map
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;map&gt; reflects the unique ID of the map to delete
                    as returned by the <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
                    command.
</p>
<p>The front-end can delete all MIDI instrument maps by
                    sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>REMOVE MIDI_INSTRUMENT_MAP ALL
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>in case the map(s) could be deleted
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>when the given map does not exist
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "REMOVE MIDI_INSTRUMENT_MAP 0"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INSTRUMENT_MAPS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.3"></a><h3>6.7.3.&nbsp;
Get amount of existing MIDI instrument maps</h3>

<p>The front-end can retrieve the current amount of MIDI
                    instrument maps by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INSTRUMENT_MAPS
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The sampler will answer by returning the current
                            number of MIDI instrument maps.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INSTRUMENT_MAPS"
</p>
<p>S: "2"
</p>
</blockquote><p>
                    
</p>
<a name="LIST MIDI_INSTRUMENT_MAPS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.4"></a><h3>6.7.4.&nbsp;
Getting all created MIDI instrument maps</h3>

<p>The number of MIDI instrument maps can change on runtime. To get the
                    current list of MIDI instrument maps, the front-end can send the
                    following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST MIDI_INSTRUMENT_MAPS
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The sampler will answer by returning a comma separated list
                            with all MIDI instrument maps' numerical IDs.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST MIDI_INSTRUMENT_MAPS"
</p>
<p>S: "0,1,5,12"
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INSTRUMENT_MAP INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.5"></a><h3>6.7.5.&nbsp;
Getting MIDI instrument map information</h3>

<p>The front-end can ask for the current settings of a MIDI
                    instrument map by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;map&gt; is the numerical ID of the map the
                    front-end is interested in as returned by the
                    <a class='info' href='#LIST MIDI_INSTRUMENT_MAPS'>"LIST MIDI_INSTRUMENT_MAPS"<span> (</span><span class='info'>Getting all created MIDI instrument maps</span><span>)</span></a>
                    command.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the settings category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that setting category. At the
                            moment the following categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>NAME -
                                        </p>
<blockquote class="text">
<p>custom name of the given map,
                                            which does not have to be unique
                                            (note that this character string may contain
                                             <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
</p>
</blockquote>
                                    

<p>DEFAULT -
                                        </p>
<blockquote class="text">
<p>either true or false,
                                            defines whether this map is the default map
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INSTRUMENT_MAP INFO 0"
</p>
<p>S: "NAME: Standard Map"
</p>
<p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="SET MIDI_INSTRUMENT_MAP NAME"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.6"></a><h3>6.7.6.&nbsp;
Renaming a MIDI instrument map</h3>

<p>The front-end can alter the custom name of a MIDI
                    instrument map by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;map&gt; is the numerical ID of the map and
                    &lt;name&gt; the new custom name of the map, which does not
                    have to be unique (name MUST be encapsulated into apostrophes
                    and supports escape sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the given map does not exist
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="MAP MIDI_INSTRUMENT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.7"></a><h3>6.7.7.&nbsp;
Create or replace a MIDI instrument map entry</h3>

<p>The front-end can create a new or replace an existing entry
                    in a sampler's MIDI instrument map by sending the following
                    command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
                            &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
                            &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
                            [&lt;instr_load_mode&gt;] [&lt;name&gt;]
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;map&gt; is the numeric ID of the map to alter,
                    &lt;midi_bank&gt; is an integer value between
                    0..16383 reflecting the MIDI bank select index,
                    &lt;midi_prog&gt; an
                    integer value between 0..127 reflecting the MIDI program change
                    index, &lt;engine_name&gt; a sampler engine name as returned by
                    the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
                    command (not encapsulated into apostrophes), &lt;filename&gt; the name
                    of the instrument's file to be deployed (encapsulated into apostrophes,
                    supporting escape sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"),
                    &lt;instrument_index&gt; the index (integer value) of the instrument
                    within the given file, &lt;volume_value&gt; reflects the master
                    volume of the instrument as optionally dotted number (where a
                    value &lt; 1.0 means attenuation and a value > 1.0 means
                    amplification). This parameter easily allows to adjust the
                    volume of all intruments within a custom instrument map
                    without having to adjust their instrument files. The
                    OPTIONAL &lt;instr_load_mode&gt; argument defines the life
                    time of the instrument, that is when the instrument should
                    be loaded, when freed and has exactly the following
                    possibilities:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"ON_DEMAND" -
                                </p>
<blockquote class="text">
<p>The instrument will be loaded when needed,
                                    that is when demanded by at least one sampler
                                    channel. It will immediately be freed from memory
                                    when not needed by any sampler channel anymore.
</p>
</blockquote>
                            

<p>"ON_DEMAND_HOLD" -
                                </p>
<blockquote class="text">
<p>The instrument will be loaded when needed,
                                    that is when demanded by at least one sampler
                                    channel. It will be kept in memory even when
                                    not needed by any sampler channel anymore.
                                    Instruments with this mode are only freed
                                    when the sampler is reset or all mapping
                                    entries with this mode (and respective
                                    instrument) are explicitly changed to
                                    "ON_DEMAND" and no sampler channel is using
                                    the instrument anymore.
</p>
</blockquote>
                            

<p>"PERSISTENT" -
                                </p>
<blockquote class="text">
<p>The instrument will immediately be loaded
                                    into memory when this mapping
                                    command is sent and the instrument is kept all
                                    the time. Instruments with this mode are
                                    only freed when the sampler is reset or all
                                    mapping entries with this mode (and
                                    respective instrument) are explicitly
                                    changed to "ON_DEMAND" and no sampler
                                    channel is using the instrument anymore.
</p>
</blockquote>
                            

<p>not supplied -
                                </p>
<blockquote class="text">
<p>In case there is no &lt;instr_load_mode&gt;
                                    argument given, it will be up to the
                                    InstrumentManager to decide which mode to use.
                                    Usually it will use "ON_DEMAND" if an entry
                                    for the given instrument does not exist in
                                    the InstrumentManager's list yet, otherwise
                                    if an entry already exists, it will simply
                                    stick with the mode currently reflected by
                                    the already existing entry, that is it will
                                    not change the mode.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>
                    The &lt;instr_load_mode&gt; argument thus allows to define an
                    appropriate strategy (low memory consumption vs. fast
                    instrument switching) for each instrument individually. Note, the
                    following restrictions apply to this argument: "ON_DEMAND_HOLD" and
                    "PERSISTENT" have to be supported by the respective sampler engine
                    (which is technically the case when the engine provides an
                    InstrumentManager for its format). If this is not the case the
                    argument will automatically fall back to the default value
                    "ON_DEMAND". Also the load mode of one instrument may
                    automatically change the laod mode of other instrument(s), i.e.
                    because the instruments are part of the same file and the
                    engine does not allow a way to manage load modes for them
                    individually. Due to this, in case the frontend shows the
                    load modes of entries, the frontend should retrieve the actual
                    mode by i.e. sending
                    <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
                    command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
                    (encapsulated into apostrophes, supporting escape sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") for the
                    mapping entry, useful for frontends for displaying an appropriate name for
                    mapped instruments (using
                    <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).
                    
</p>
<p>
                    By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
                    completely established in the sampler. The OPTIONAL "NON_MODAL" argument
                    however causes the respective "MAP MIDI_INSTRUMENT" command to return
                    immediately, that is to let the sampler establish the mapping in the
                    background. So this argument might be especially useful for mappings with
                    a "PERSISTENT" type, because these have to load the respective instruments
                    immediately and might thus block for a very long time. It is recommended
                    however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
                    because it has the following drawbacks: as "NON_MODAL" instructions return
                    immediately, they may not necessarily return an error i.e. when the given
                    instrument file turns out to be corrupt, beside that subsequent commands
                    in a LSCP instruction sequence might fail, because mandatory mappings are
                    not yet completed.
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>usually
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>when the given map or engine does not exist or a value
                                    is out of range
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"
</p>
<p>S: "OK"
</p>
<p>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.8"></a><h3>6.7.8.&nbsp;
Getting ammount of MIDI instrument map entries</h3>

<p>The front-end can query the amount of currently existing
                    entries in a MIDI instrument map by sending the following
                    command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INSTRUMENTS &lt;map&gt;
</p>
</blockquote><p>
                    
</p>
<p>The front-end can query the amount of currently existing
                    entries in all MIDI instrument maps by sending the following
                    command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INSTRUMENTS ALL
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The sampler will answer by sending the current number of
                            entries in the MIDI instrument map(s).
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INSTRUMENTS 0"
</p>
<p>S: "234"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INSTRUMENTS ALL"
</p>
<p>S: "954"
</p>
</blockquote><p>
                    
</p>
<a name="LIST MIDI_INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.9"></a><h3>6.7.9.&nbsp;
Getting indeces of all entries of a MIDI instrument map</h3>

<p>The front-end can query a list of all currently existing
                    entries in a certain MIDI instrument map by sending the following
                    command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST MIDI_INSTRUMENTS &lt;map&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.
</p>
<p>The front-end can query a list of all currently existing
                    entries of all MIDI instrument maps by sending the following
                    command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST MIDI_INSTRUMENTS ALL
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The sampler will answer by sending a comma separated
                            list of map ID - MIDI bank - MIDI program triples, where
                            each triple is encapsulated into curly braces. The
                            list is returned in one single line. Each triple
                            just reflects the key of the respective map entry,
                            thus subsequent
                            <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
                            command(s) are necessary to retrieve detailed informations
                            about each entry.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST MIDI_INSTRUMENTS 0"
</p>
<p>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
</p>
</blockquote><p>
                    
</p>
<a name="UNMAP MIDI_INSTRUMENT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.10"></a><h3>6.7.10.&nbsp;
Remove an entry from the MIDI instrument map</h3>

<p>The front-end can delete an entry from a MIDI instrument
                    map by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
</p>
</blockquote><p>
                    
</p>
<p>
                    Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
                    &lt;midi_bank&gt; is an integer value between 0..16383
                    reflecting the MIDI bank value and
                    &lt;midi_prog&gt; an integer value between
                    0..127 reflecting the MIDI program value of the map's entrie's key
                    index triple.
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>usually
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>when index out of bounds
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "UNMAP MIDI_INSTRUMENT 0 2 127"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET MIDI_INSTRUMENT INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.11"></a><h3>6.7.11.&nbsp;
Get current settings of MIDI instrument map entry</h3>

<p>The front-end can retrieve the current settings of a certain
                    instrument map entry by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;
</p>
</blockquote><p>
                    
</p>
<p>
                    Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
                    &lt;midi_bank&gt; is an integer value between 0..16383
                    reflecting the MIDI bank value, &lt;midi_bank&gt;
                    and &lt;midi_prog&gt; an integer value between
                    0..127 reflecting the MIDI program value of the map's entrie's key
                    index triple.
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt;
                            separated list. Each answer line begins with the
                            information category name followed by a colon and then
                            a space character &lt;SP&gt; and finally the info
                            character string to that info category. At the moment
                            the following categories are defined:
</p>
<p>"NAME" -
                                </p>
<blockquote class="text">
<p>Name for this MIDI instrument map entry (if defined).
                                    This name shall be used by frontends for displaying a
                                    name for this mapped instrument. It can be set and
                                    changed with the
                                    <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
                                    command and does not have to be unique.
                                    (note that this character string may contain
                                    <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
</p>
</blockquote>
                            

<p>"ENGINE_NAME" -
                                </p>
<blockquote class="text">
<p>Name of the engine to be deployed for this
                                    instrument.
</p>
</blockquote>
                            

<p>"INSTRUMENT_FILE" -
                                </p>
<blockquote class="text">
<p>File name of the instrument
                                    (note that this path may contain
                                    <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
</p>
</blockquote>
                            

<p>"INSTRUMENT_NR" -
                                </p>
<blockquote class="text">
<p>Index of the instrument within the file.
</p>
</blockquote>
                            

<p>"INSTRUMENT_NAME" -
                                </p>
<blockquote class="text">
<p>Name of the loaded instrument as reflected by its file.
                                    In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
                                    cannot be changed (note that this character string may contain
                                    <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
</p>
</blockquote>
                            

<p>"LOAD_MODE" -
                                </p>
<blockquote class="text">
<p>Life time of instrument
                                    (see <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a> for details about this setting).
</p>
</blockquote>
                            

<p>"VOLUME" -
                                </p>
<blockquote class="text">
<p>master volume of the instrument as optionally
                                    dotted number (where a value &lt; 1.0 means attenuation
                                    and a value > 1.0 means amplification)
</p>
</blockquote>
                            

<p>The mentioned fields above don't have to be in particular order.
</p>
</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET MIDI_INSTRUMENT INFO 1 45 120"
</p>
<p>S: "NAME: Drums for Foo Song"
</p>
<p>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"
</p>
<p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
</p>
<p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
</p>
<p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"
</p>
<p>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"
</p>
<p>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="CLEAR MIDI_INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.7.12"></a><h3>6.7.12.&nbsp;
Clear MIDI instrument map</h3>

<p>The front-end can clear a whole MIDI instrument map, that
                    is delete all its entries by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>CLEAR MIDI_INSTRUMENTS &lt;map&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;map&gt; is the numeric ID of the map to clear.
</p>
<p>The front-end can clear all MIDI instrument maps, that
                    is delete all entries of all maps by sending the following
                    command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>CLEAR MIDI_INSTRUMENTS ALL
</p>
</blockquote><p>
                    
</p>
<p>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
                    maps, only their entries, thus the map's settings like
                    custom name will be preservevd.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>always
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                       </p>
<blockquote class="text">
<p>C: "CLEAR MIDI_INSTRUMENTS 0"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<p>
                       </p>
<blockquote class="text">
<p>C: "CLEAR MIDI_INSTRUMENTS ALL"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="Managing Instruments Database"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8"></a><h3>6.8.&nbsp;
Managing Instruments Database</h3>

<p>The following commands describe how to use and manage
                the instruments database.
</p>
<p>Notice:
</p>
<p>
                        </p>
<blockquote class="text">
<p>All command arguments representing a path or
                            instrument/directory name support escape sequences as described in chapter
                            "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
                            
</p>
<p>All occurrences of a forward slash in instrument and directory
                               names are escaped with its hex (\x2f) or octal (\057) escape sequence.
                            
</p>
</blockquote><p>
                    
</p>
<a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
Creating a new instrument directory</h3>

<p>The front-end can add a new instrument directory to the
                    instruments database by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; is the absolute path name of the directory
                    to be created (encapsulated into apostrophes).
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>when the directory could not be created, which
                                    can happen if the directory already exists or the
                                    name contains not allowed symbols
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="REMOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.2"></a><h3>6.8.2.&nbsp;
Deleting an instrument directory</h3>

<p>The front-end can delete a particular instrument directory
                    from the instruments database by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; is the absolute path name of the directory
                    to delete. The optional FORCE argument can be used to
                    force the deletion of a non-empty directory and all its content.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>if the directory is deleted successfully
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the given directory does not exist, or
                                    if trying to delete a non-empty directory,
                                    without using the FORCE argument.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.3"></a><h3>6.8.3.&nbsp;
Getting amount of instrument directories</h3>

<p>The front-end can retrieve the current amount of
                    directories in a specific directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; should be replaced by the absolute path
                    name of the directory. If RECURSIVE is specified, the number of
                    all directories, including those located in subdirectories of the
                    specified directory, will be returned.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The current number of instrument directories
                            in the specified directory.
</p>
<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the given directory does not exist.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
</p>
<p>S: "2"
</p>
</blockquote><p>
                    
</p>
<a name="LIST DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.4"></a><h3>6.8.4.&nbsp;
Listing all directories in specific directory</h3>

<p>The front-end can retrieve the current list of directories
                    in specific directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; should be replaced by the absolute path
                    name of the directory. If RECURSIVE is specified, the absolute path names
                    of all directories, including those located in subdirectories of the
                    specified directory, will be returned.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>A comma separated list of all instrument directories
                            (encapsulated into apostrophes) in the specified directory.
</p>
<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the given directory does not exist.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
</p>
<p>S: "'Piano Collection','Percussion Collection'"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
</p>
<p>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"
</p>
</blockquote><p>
                    
</p>
<a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.5"></a><h3>6.8.5.&nbsp;
Getting instrument directory information</h3>

<p>The front-end can ask for the current settings of an
                    instrument directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; should be replaced by the absolute path
                    name of the directory the front-end is interested in.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the settings category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that setting category. At the
                            moment the following categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>DESCRIPTION -
                                        </p>
<blockquote class="text">
<p>A brief description of the directory content.
                                            Note that the character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
</p>
</blockquote>
                                    

<p>CREATED -
                                        </p>
<blockquote class="text">
<p>The creation date and time of the directory,
                                            represented in "YYYY-MM-DD HH:MM:SS" format
</p>
</blockquote>
                                    

<p>MODIFIED -
                                        </p>
<blockquote class="text">
<p>The date and time of the last modification of the
                                            directory, represented in "YYYY-MM-DD HH:MM:SS" format
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
</p>
<p>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."
</p>
<p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
</p>
<p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="SET DB_INSTRUMENT_DIRECTORY NAME"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.6"></a><h3>6.8.6.&nbsp;
Renaming an instrument directory</h3>

<p>The front-end can alter the name of a specific
                    instrument directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; is the absolute path name of the directory and
                    &lt;name&gt; is the new name for that directory.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the given directory does not exists,
                                    or if a directory with name equal to the new
                                    name already exists.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="MOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.7"></a><h3>6.8.7.&nbsp;
Moving an instrument directory</h3>

<p>The front-end can move a specific
                    instrument directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; is the absolute path name of the directory
                    to move and &lt;dst&gt; is the location where the directory will
                    be moved to.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case a given directory does not exists,
                                    or if a directory with name equal to the name
                                    of the specified directory already exists in
                                    the destination directory. Error is also thrown
                                    when trying to move a directory to a subdirectory
                                    of itself.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="COPY DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.8"></a><h3>6.8.8.&nbsp;
Copying instrument directories</h3>

<p>The front-end can copy a specific
                    instrument directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; is the absolute path name of the directory
                    to copy and &lt;dst&gt; is the location where the directory will
                    be copied to.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case a given directory does not exists,
                                    or if a directory with name equal to the name
                                    of the specified directory already exists in
                                    the destination directory. Error is also thrown
                                    when trying to copy a directory to a subdirectory
                                    of itself.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.9"></a><h3>6.8.9.&nbsp;
Changing the description of directory</h3>

<p>The front-end can alter the description of a specific
                    instrument directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; is the absolute path name of the directory and
                    &lt;desc&gt; is the new description for the directory
                    (encapsulated into apostrophes, supporting escape sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the given directory does not exists.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="FIND DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.10"></a><h3>6.8.10.&nbsp;
Finding directories</h3>

<p>The front-end can search for directories
                    in specific directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; should be replaced by the absolute path
                    name of the directory to search in. If NON_RECURSIVE is specified, the
                    directories located in subdirectories of the specified directory will not
                    be searched. &lt;criteria-list&gt; is a list of search criterias
                    in form of "key1=val1 key2=val2 ...". The following criterias are
                    allowed:
</p>
<p>
                      
<p>NAME='&lt;search-string&gt;'
                          </p>
<blockquote class="text">
<p>Restricts the search to directories, which names
                              satisfy the supplied search string (encapsulated into apostrophes,
                              supporting escape sequences as described in chapter
                              "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
</blockquote><p>
                      
</p>

                      
<p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
                          </p>
<blockquote class="text">
<p>Restricts the search to directories, which creation
                              date satisfies the specified period, where &lt;date-after&gt;
                              and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
                              If &lt;date-after&gt; is omitted the search is restricted to
                              directories created before &lt;date-before&gt;. If
                              &lt;date-before&gt; is omitted, the search is restricted
                              to directories created after &lt;date-after&gt;.
</p>
</blockquote><p>
                      
</p>

                      
<p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
                          </p>
<blockquote class="text">
<p>Restricts the search to directories, which
                              date of last modification satisfies the specified period, where
                              &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
                              format. If &lt;date-after&gt; is omitted the search is restricted to
                              directories, which are last modified before &lt;date-before&gt;. If
                              &lt;date-before&gt; is omitted, the search is restricted to directories,
                              which are last modified after &lt;date-after&gt;.
</p>
</blockquote><p>
                      
</p>

                      
<p>DESCRIPTION='&lt;search-string&gt;'
                          </p>
<blockquote class="text">
<p>Restricts the search to directories with description
                              that satisfies the supplied search string
                              (encapsulated into apostrophes, supporting escape
                              sequences as described in chapter
                              "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
</blockquote><p>
                      
</p>
                    

<p>Where &lt;search-string&gt; is either a regular expression, or a
                    word list separated with spaces for OR search and with '+' for AND search.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>A comma separated list with the absolute path names (encapsulated into
                            apostrophes) of all directories in the specified directory that satisfy
                            the supplied search criterias.
</p>
<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the given directory does not exist.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
</p>
<p>S: "'/Piano Collection'"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"
</p>
<p>S: "'/Piano Collection','/Percussions'"
</p>
</blockquote><p>
                    
</p>
<a name="ADD DB_INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.11"></a><h3>6.8.11.&nbsp;
Adding instruments to the instruments database</h3>

<p>The front-end can add one or more instruments
                    to the instruments database by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;db_dir&gt; is the absolute path name of a directory
                    (encapsulated into apostrophes) in the instruments database in which
                    only the new instruments (that are not already in the database) will
                    be added, &lt;file_path&gt; is the absolute path name of a file or
                    directory in the file system (encapsulated into apostrophes). In case
                    an instrument file is supplied, only the instruments in the specified
                    file will be added to the instruments database. If the optional
                    &lt;instr_index&gt; (the index of the instrument within the given file)
                    is supplied too, then only the specified instrument will be added.
                    In case a directory is supplied, the instruments in that directory
                    will be added. The OPTIONAL &lt;mode&gt; argument is only applied
                    when a directory is provided as &lt;file_path&gt; and specifies how the
                    scanning will be done and has exactly the following possibilities:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"RECURSIVE" -
                                </p>
<blockquote class="text">
<p>All instruments will be processed, including those
                                    in the subdirectories, and the respective subdirectory
                                    tree structure will be recreated in the instruments
                                    database
</p>
</blockquote>
                            

<p>"NON_RECURSIVE" -
                                </p>
<blockquote class="text">
<p>Only the instruments in the specified directory
                                    will be added, the instruments in the subdirectories
                                    will not be processed.
</p>
</blockquote>
                            

<p>"FLAT" -
                                </p>
<blockquote class="text">
<p>All instruments will be processed, including those
                                    in the subdirectories, but the respective subdirectory
                                    structure will not be recreated in the instruments
                                    database. All instruments will be added directly in
                                    the specified database directory.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The difference between regular and NON_MODAL versions of the command
                    is that the regular command returns when the scanning is finished
                    while NON_MODAL version returns immediately and a background process is launched.
                    The <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a>
                    command can be used to monitor the scanning progress.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success when NON_MODAL is not supplied
</p>
</blockquote>
                            

<p>"OK[&lt;job-id&gt;]" -
                                </p>
<blockquote class="text">
<p>on success when NON_MODAL is supplied, where &lt;job-id&gt;
                                    is a numerical ID used to obtain status information about the job progress.
                                    See <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a>
                                    
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if an invalid path is specified.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="REMOVE DB_INSTRUMENT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.12"></a><h3>6.8.12.&nbsp;
Removing an instrument</h3>

<p>The front-end can remove a particular instrument
                    from the instruments database by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>REMOVE DB_INSTRUMENT &lt;instr_path&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;instr_path&gt; is the absolute path name
                    (in the instruments database) of the instrument to remove.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>if the instrument is removed successfully
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the given path does not exist or
                                    is a directory.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="GET DB_INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.13"></a><h3>6.8.13.&nbsp;
Getting amount of instruments</h3>

<p>The front-end can retrieve the current amount of
                    instruments in a specific directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; should be replaced by the absolute path name
                    of the directory. If RECURSIVE is specified, the number of all
                    instruments, including those located in subdirectories of the
                    specified directory, will be returned.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>The current number of instruments
                            in the specified directory.
</p>
<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the given directory does not exist.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET DB_INSTRUMENTS '/Piano Collection'"
</p>
<p>S: "2"
</p>
</blockquote><p>
                    
</p>
<a name="LIST DB_INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.14"></a><h3>6.8.14.&nbsp;
Listing all instruments in specific directory</h3>

<p>The front-end can retrieve the current list of instruments
                    in specific directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; should be replaced by the absolute path
                    name of the directory. If RECURSIVE is specified, the absolute path
                    names of all instruments, including those located in subdirectories
                    of the specified directory, will be returned.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>A comma separated list of all instruments
                            (encapsulated into apostrophes) in the specified directory.
</p>
<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the given directory does not exist.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST DB_INSTRUMENTS '/Piano Collection'"
</p>
<p>S: "'Bosendorfer 290','Steinway D'"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
</p>
<p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"
</p>
</blockquote><p>
                    
</p>
<a name="GET DB_INSTRUMENT INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.15"></a><h3>6.8.15.&nbsp;
Getting instrument information</h3>

<p>The front-end can ask for the current settings of an
                    instrument by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET DB_INSTRUMENT INFO &lt;instr_path&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;instr_path&gt; should be replaced by the absolute path
                    name of the instrument the front-end is interested in.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the settings category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that setting category. At the
                            moment the following categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>INSTRUMENT_FILE -
                                        </p>
<blockquote class="text">
<p>File name of the instrument.
                                            Note that the character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
</p>
</blockquote>
                                    

<p>INSTRUMENT_NR -
                                        </p>
<blockquote class="text">
<p>Index of the instrument within the file.
</p>
</blockquote>
                                    

<p>FORMAT_FAMILY -
                                        </p>
<blockquote class="text">
<p>The format family of the instrument.
</p>
</blockquote>
                                    

<p>FORMAT_VERSION -
                                        </p>
<blockquote class="text">
<p>The format version of the instrument.
</p>
</blockquote>
                                    

<p>SIZE -
                                        </p>
<blockquote class="text">
<p>The size of the instrument in bytes.
</p>
</blockquote>
                                    

<p>CREATED -
                                        </p>
<blockquote class="text">
<p>The date and time when the instrument is added
                                            in the instruments database, represented in
                                           "YYYY-MM-DD HH:MM:SS" format
</p>
</blockquote>
                                    

<p>MODIFIED -
                                        </p>
<blockquote class="text">
<p>The date and time of the last modification of the
                                            instrument's database settings, represented in
                                            "YYYY-MM-DD HH:MM:SS" format
</p>
</blockquote>
                                    

<p>DESCRIPTION -
                                        </p>
<blockquote class="text">
<p>A brief description of the instrument.
                                            Note that the character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
</p>
</blockquote>
                                    

<p>IS_DRUM -
                                        </p>
<blockquote class="text">
<p>either true or false, determines whether the
                                            instrument is a drumkit or a chromatic instrument
</p>
</blockquote>
                                    

<p>PRODUCT -
                                        </p>
<blockquote class="text">
<p>The product title of the instrument.
                                            Note that the character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
</p>
</blockquote>
                                    

<p>ARTISTS -
                                        </p>
<blockquote class="text">
<p>Lists the artist names.
                                            Note that the character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
</p>
</blockquote>
                                    

<p>KEYWORDS -
                                        </p>
<blockquote class="text">
<p>Provides a list of keywords that refer to the instrument.
                                            Keywords are separated with semicolon and blank.
                                            Note that the character string may contain
                                            <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
</p>
<p>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
</p>
<p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
</p>
<p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
</p>
<p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"
</p>
<p>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"
</p>
<p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
</p>
<p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
</p>
<p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "
</p>
<p>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"
</p>
<p>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"
</p>
<p>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"
</p>
<p>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="SET DB_INSTRUMENT NAME"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.16"></a><h3>6.8.16.&nbsp;
Renaming an instrument</h3>

<p>The front-end can alter the name of a specific
                    instrument by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;instr&gt; is the absolute path name of the instrument and
                    &lt;name&gt; is the new name for that instrument.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the given instrument does not exists,
                                    or if an instrument with name equal to the new
                                    name already exists.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="MOVE DB_INSTRUMENT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.17"></a><h3>6.8.17.&nbsp;
Moving an instrument</h3>

<p>The front-end can move a specific instrument to another directory by
                    sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;instr&gt; is the absolute path name of the instrument
                    to move and &lt;dst&gt; is the directory where the instrument will
                    be moved to.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the given instrument does not exists,
                                    or if an instrument with name equal to the name of the
                                    specified instrument already exists in the destination
                                    directory.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="COPY DB_INSTRUMENT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.18"></a><h3>6.8.18.&nbsp;
Copying instruments</h3>

<p>The front-end can copy a specific instrument to another directory by
                    sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;instr&gt; is the absolute path name of the instrument
                    to copy and &lt;dst&gt; is the directory where the instrument will
                    be copied to.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the given instrument does not exists,
                                    or if an instrument with name equal to the name of the
                                    specified instrument already exists in the destination
                                    directory.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.19"></a><h3>6.8.19.&nbsp;
Changing the description of instrument</h3>

<p>The front-end can alter the description of a specific
                    instrument by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;instr&gt; is the absolute path name of the instrument and
                    &lt;desc&gt; is the new description for the instrument
                    (encapsulated into apostrophes, supporting escape sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>in case the given instrument does not exists.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="FIND DB_INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.20"></a><h3>6.8.20.&nbsp;
Finding instruments</h3>

<p>The front-end can search for instruments
                    in specific directory by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;dir&gt; should be replaced by the absolute path
                    name of the directory to search in. If NON_RECURSIVE is specified, the
                    directories located in subdirectories of the specified directory will not
                    be searched. &lt;criteria-list&gt; is a list of search criterias
                    in form of "key1=val1 key2=val2 ...". The following criterias are
                    allowed:
</p>
<p>
                      
<p>NAME='&lt;search-string&gt;'
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments, which names
                              satisfy the supplied search string (encapsulated into apostrophes,
                              supporting escape sequences as described in chapter
                              "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
</blockquote><p>
                      
</p>

                      
<p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments, which
                              size is in the specified range. If &lt;min&gt; is omitted,
                              the search results are restricted to instruments with size less then
                              or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
                              search is restricted to instruments with size greater then
                              or equal to &lt;min&gt;.
</p>
</blockquote><p>
                      
</p>

                      
<p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments, which creation
                              date satisfies the specified period, where &lt;date-after&gt;
                              and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
                              If &lt;date-after&gt; is omitted the search is restricted to
                              instruments created before &lt;date-before&gt;. If
                              &lt;date-before&gt; is omitted, the search is restricted
                              to instruments created after &lt;date-after&gt;.
</p>
</blockquote><p>
                      
</p>

                      
<p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments, which
                              date of last modification satisfies the specified period, where
                              &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
                              format. If &lt;date-after&gt; is omitted the search is restricted to
                              instruments, which are last modified before &lt;date-before&gt;. If
                              &lt;date-before&gt; is omitted, the search is restricted to instruments,
                              which are last modified after &lt;date-after&gt;.
</p>
</blockquote><p>
                      
</p>

                      
<p>DESCRIPTION='&lt;search-string&gt;'
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments with description
                              that satisfies the supplied search string (encapsulated into apostrophes,
                              supporting escape sequences as described in chapter
                              "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
</blockquote><p>
                      
</p>

                      
<p>PRODUCT='&lt;search-string&gt;'
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments with product info
                              that satisfies the supplied search string (encapsulated into apostrophes,
                              supporting escape sequences as described in chapter
                              "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
</blockquote><p>
                      
</p>

                      
<p>ARTISTS='&lt;search-string&gt;'
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments with artists info
                              that satisfies the supplied search string (encapsulated into apostrophes,
                              supporting escape sequences as described in chapter
                              "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
</blockquote><p>
                      
</p>

                      
<p>KEYWORDS='&lt;search-string&gt;'
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments with keyword list
                              that satisfies the supplied search string (encapsulated into apostrophes,
                              supporting escape sequences as described in chapter
                              "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
</blockquote><p>
                      
</p>

                      
<p>IS_DRUM=true | false
                          </p>
<blockquote class="text">
<p>Either true or false. Restricts the search to
                              drum kits or chromatic instruments.
</p>
</blockquote><p>
                      
</p>

                      
<p>FORMAT_FAMILIES='&lt;format-list&gt;'
                          </p>
<blockquote class="text">
<p>Restricts the search to instruments of the supplied format families,
                              where &lt;format-list&gt; is a comma separated list of format families.
</p>
</blockquote><p>
                      
</p>
                    

<p>Where &lt;search-string&gt; is either a regular expression, or a
                    word list separated with spaces for OR search and with '+' for AND search.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>A comma separated list with the absolute path names (encapsulated into
                            apostrophes) of all instruments in the specified directory that satisfy
                            the supplied search criterias.
</p>
<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the given directory does not exist.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"
</p>
<p>S: "'/Piano Collection/Bosendorfer 290'"
</p>
</blockquote><p>
                    
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"
</p>
<p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"
</p>
</blockquote><p>
                    
</p>
<a name="GET DB_INSTRUMENTS_JOB INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.21"></a><h3>6.8.21.&nbsp;
Getting job status information</h3>

<p>The front-end can ask for the current status of a
                    particular database instruments job by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;job-id&gt; should be replaced by the numerical ID
                    of the job the front-end is interested in.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the settings category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that setting category. At the
                            moment the following categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>FILES_TOTAL -
                                        </p>
<blockquote class="text">
<p>The total number of files scheduled for scanning
</p>
</blockquote>
                                    

<p>FILES_SCANNED -
                                        </p>
<blockquote class="text">
<p>The current number of scanned files
</p>
</blockquote>
                                    

<p>SCANNING -
                                        </p>
<blockquote class="text">
<p>The absolute path name of the file which is currently
                                            being scanned
</p>
</blockquote>
                                    

<p>STATUS -
                                        </p>
<blockquote class="text">
<p>An integer value between 0 and 100 indicating the
                                            scanning progress percentage of the file which is
                                            currently being scanned
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET DB_INSTRUMENTS_JOB INFO 2"
</p>
<p>S: "FILES_TOTAL: 12"
</p>
<p>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"
</p>
<p>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"
</p>
<p>&nbsp;&nbsp;&nbsp;"STATUS: 42"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="FORMAT INSTRUMENTS_DB"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.8.22"></a><h3>6.8.22.&nbsp;
Formatting the instruments database</h3>

<p>The front-end can remove all instruments and directories and re-create
                    the instruments database structure (e.g., in case of a database corruption)
                    by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>FORMAT INSTRUMENTS_DB
</p>
</blockquote><p>
                    
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>on success
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>If the formatting of the instruments database
                                    failed.
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<a name="editing_instruments"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
Editing Instruments</h3>

<p>The sampler allows to edit instruments while playing with the
                sampler by spawning an external (3rd party) instrument editor
                application for a given instrument. The 3rd party instrument
                editor applications have to place a respective plugin DLL file
                into the sampler's plugins directory. The sampler will
                automatically try to load all plugin DLLs in that directory on
                startup and only on startup!
</p>
<p>At the moment there is only one command for this feature set,
                but this will most probably change in future.
</p>
<a name="EDIT INSTRUMENT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.9.1"></a><h3>6.9.1.&nbsp;
Opening an appropriate instrument editor application</h3>

<p>The front-end can request to open an appropriate instrument
                    editor application by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;sampler-channel&gt; should be replaced by the
                    number of the sampler channel as given by the
                    <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
                    or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
                    command.
</p>
<p>The sampler will try to ask all registered instrument
                    editors (or to be more specific: their sampler plugins)
                    whether they are capable to handle the instrument on the
                    given sampler channel. The sampler will simply use the first
                    instrument editor application which replied with a positive
                    answer and spawn that instrument editor application within
                    the sampler's process and provide that application access
                    to the instrument's data structures, so both applications
                    can share and access the same instruments data at the same
                    time, thus allowing to immediately hear changes with the
                    sampler made by the instrument editor.
</p>
<p>Note: consequently instrument editors are always spawned
                    locally on the same machine where the sampler is running
                    on!
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>"OK" -
                                </p>
<blockquote class="text">
<p>when an appropriate instrument editor was
                                    launched
</p>
</blockquote>
                            

<p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
                                </p>
<blockquote class="text">
<p>when an appropriate instrument editor was
                                    launched, but there are noteworthy issues
</p>
</blockquote>
                            

<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>when an appropriate instrument editor
                                    could not be launched
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "EDIT CHANNEL INSTRUMENT 0"
</p>
<p>S: "OK"
</p>
</blockquote><p>
                    
</p>
<a name="file_management"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.10"></a><h3>6.10.&nbsp;
Managing Files</h3>

<p>You can query detailed informations about files located
                at the same system where the sampler instance is running on.
                Using this command set allows to retrieve file informations
                even remotely from another machine.
</p>
<a name="GET FILE INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.10.1"></a><h3>6.10.1.&nbsp;
Retrieving amount of instruments of a file</h3>

<p>The front-end can retrieve the amount of instruments
                    within a given instrument file by sending the
                    following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET FILE INSTRUMENTS &lt;filename&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;filename&gt; is the name of the instrument
                    file (encapsulated into apostrophes, supporting escape
                    sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape
                        Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
<p>The sampler will try to ask all sampler engines,
                    whether they support the given file and ask the first
                    engine with a positive answer for the amount of
                    instruments.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>On success, the sampler will answer by
                               returning the amount of instruments.
                            
</p>
<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the file could not be handled
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
</p>
<p>S: "10"
</p>
</blockquote><p>
                    
</p>
<a name="LIST FILE INSTRUMENTS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.10.2"></a><h3>6.10.2.&nbsp;
Retrieving all instruments of a file</h3>

<p>The front-end can retrieve a list of all instruments
                    within a given instrument file by sending the
                    following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LIST FILE INSTRUMENTS &lt;filename&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;filename&gt; is the name of the instrument
                    file (encapsulated into apostrophes, supporting escape
                    sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape
                        Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
</p>
<p>The sampler will try to ask all sampler engines,
                    whether they support the given file and ask the first
                    engine with a positive answer for a list of IDs for the
                    instruments in the given file.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>On success, the sampler will answer by
                               returning a comma separated list of
                               instrument IDs.
                            
</p>
<p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                </p>
<blockquote class="text">
<p>if the file could not be handled
</p>
</blockquote>
                            

</blockquote><p>
                    
</p>
<p>Examples:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
</p>
<p>S: "0,1,2,3,4,5,6,7,8,9"
</p>
</blockquote><p>
                    
</p>
<a name="GET FILE INSTRUMENT INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.6.10.3"></a><h3>6.10.3.&nbsp;
Retrieving informations about one instrument in a file</h3>

<p>The front-end can retrieve detailed informations
                    about a specific instrument within a given instrument
                    file by sending the following command:
</p>
<p>
                        </p>
<blockquote class="text">
<p>GET FILE INSTRUMENT INFO &lt;filename&gt;
                            &lt;instr-id&gt;
</p>
</blockquote><p>
                    
</p>
<p>Where &lt;filename&gt; is the name of the instrument
                    file (encapsulated into apostrophes, supporting escape
                    sequences as described in chapter
                    "<a class='info' href='#character_set'>Character Set and Escape
                        Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") and &lt;instr-id&gt; is the numeric
                    instrument ID as returned by the
                    <a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a> command.
</p>
<p>The sampler will try to ask all sampler engines,
                    whether they support the given file and ask the first
                    engine with a positive answer for informations about the
                    specific instrument in the given file.
</p>
<p>Possible Answers:
</p>
<p>
                        </p>
<blockquote class="text">
<p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
                            Each answer line begins with the settings category name
                            followed by a colon and then a space character &lt;SP&gt; and finally
                            the info character string to that setting category. At the
                            moment the following categories are defined:
</p>
<p>
                                </p>
<blockquote class="text">
<p>NAME -
                                        </p>
<blockquote class="text">
<p>name of the instrument as
                                            stored in the instrument file
</p>
</blockquote>
                                    

<p>FORMAT_FAMILY -
                                        </p>
<blockquote class="text">
<p>name of the sampler format
                                            of the given instrument
</p>
</blockquote>
                                    

<p>FORMAT_VERSION -
                                        </p>
<blockquote class="text">
<p>version of the sampler format
                                            the instrumen is stored as
</p>
</blockquote>
                                    

<p>PRODUCT -
                                        </p>
<blockquote class="text">
<p>official product name of the
                                            instrument as stored in the file
                                            
</p>
</blockquote>
                                    

<p>ARTISTS -
                                        </p>
<blockquote class="text">
<p>artists / sample library
                                            vendor of the instrument
</p>
</blockquote>
                                    

</blockquote>
                            

</blockquote><p>
                    
</p>
<p>The mentioned fields above don't have to be in particular order.
</p>
<p>Example:
</p>
<p>
                        </p>
<blockquote class="text">
<p>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
</p>
<p>S: "NAME: Lunatic Loops"
</p>
<p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
</p>
<p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"
</p>
<p>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"
</p>
<p>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"
</p>
<p>&nbsp;&nbsp;&nbsp;"."
</p>
</blockquote><p>
                    
</p>
<a name="command_syntax"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.7"></a><h3>7.&nbsp;
Command Syntax</h3>

<p>The grammar of the control protocol as descibed in <a class='info' href='#control_commands'>Section&nbsp;6<span> (</span><span class='info'>Description for control commands</span><span>)</span></a>
            is defined below using Backus-Naur Form (BNF as described in <a class='info' href='#RFC2234'>[RFC2234]<span> (</span><span class='info'>Crocker, D. and P. Overell, &ldquo;Augmented BNF for Syntax Specifications,&rdquo; 1997.</span><span>)</span></a>)
            where applicable.
            
</p>
<p>input =
        </p>
<blockquote class="text">
<p>line LF
                
</p>
<p>/ line CR LF
                
</p>
</blockquote><p>

</p>
<p>line =
        </p>
<blockquote class="text">
<p>/* epsilon (empty line ignored) */
                
</p>
<p>/ comment
                
</p>
<p>/ command
                
</p>
<p>/ error
                
</p>
</blockquote><p>

</p>
<p>comment =
        </p>
<blockquote class="text">
<p>'#'
                
</p>
<p>/ comment '#'
                
</p>
<p>/ comment SP
                
</p>
<p>/ comment number
                
</p>
<p>/ comment string
                
</p>
</blockquote><p>

</p>
<p>command =
        </p>
<blockquote class="text">
<p>ADD SP add_instruction
                
</p>
<p>/ MAP SP map_instruction
                
</p>
<p>/ UNMAP SP unmap_instruction
                
</p>
<p>/ GET SP get_instruction
                
</p>
<p>/ CREATE SP create_instruction
                
</p>
<p>/ DESTROY SP destroy_instruction
                
</p>
<p>/ LIST SP list_instruction
                
</p>
<p>/ LOAD SP load_instruction
                
</p>
<p>/ REMOVE SP remove_instruction
                
</p>
<p>/ SET SP set_instruction
                
</p>
<p>/ SUBSCRIBE SP subscribe_event
                
</p>
<p>/ UNSUBSCRIBE SP unsubscribe_event
                
</p>
<p>/ RESET SP reset_instruction
                
</p>
<p>/ CLEAR SP clear_instruction
                
</p>
<p>/ FIND SP find_instruction
                
</p>
<p>/ MOVE SP move_instruction
                
</p>
<p>/ COPY SP copy_instruction
                
</p>
<p>/ EDIT SP edit_instruction
                
</p>
<p>/ FORMAT SP format_instruction
                
</p>
<p>/ RESET
                
</p>
<p>/ QUIT
                
</p>
</blockquote><p>

</p>
<p>add_instruction =
        </p>
<blockquote class="text">
<p>CHANNEL
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY SP db_path
                
</p>
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
                
</p>
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
                
</p>
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
                
</p>
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
                
</p>
<p>/ DB_INSTRUMENTS SP db_path SP filename
                
</p>
<p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
                
</p>
<p>/ MIDI_INSTRUMENT_MAP
                
</p>
<p>/ MIDI_INSTRUMENT_MAP SP map_name
                
</p>
</blockquote><p>

</p>
<p>subscribe_event =
        </p>
<blockquote class="text">
<p>AUDIO_OUTPUT_DEVICE_COUNT
                
</p>
<p>/ AUDIO_OUTPUT_DEVICE_INFO
                
</p>
<p>/ MIDI_INPUT_DEVICE_COUNT
                
</p>
<p>/ MIDI_INPUT_DEVICE_INFO
                
</p>
<p>/ CHANNEL_COUNT
                
</p>
<p>/ VOICE_COUNT
                
</p>
<p>/ STREAM_COUNT
                
</p>
<p>/ BUFFER_FILL
                
</p>
<p>/ CHANNEL_INFO
                
</p>
<p>/ FX_SEND_COUNT
                
</p>
<p>/ FX_SEND_INFO
                
</p>
<p>/ MIDI_INSTRUMENT_MAP_COUNT
                
</p>
<p>/ MIDI_INSTRUMENT_MAP_INFO
                
</p>
<p>/ MIDI_INSTRUMENT_COUNT
                
</p>
<p>/ MIDI_INSTRUMENT_INFO
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY_COUNT
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY_INFO
                
</p>
<p>/ DB_INSTRUMENT_COUNT
                
</p>
<p>/ DB_INSTRUMENT_INFO
                
</p>
<p>/ DB_INSTRUMENTS_JOB_INFO
                
</p>
<p>/ MISCELLANEOUS
                
</p>
<p>/ TOTAL_STREAM_COUNT
                
</p>
<p>/ TOTAL_VOICE_COUNT
                
</p>
<p>/ GLOBAL_INFO
                
</p>
</blockquote><p>

</p>
<p>unsubscribe_event =
        </p>
<blockquote class="text">
<p>AUDIO_OUTPUT_DEVICE_COUNT
                
</p>
<p>/ AUDIO_OUTPUT_DEVICE_INFO
                
</p>
<p>/ MIDI_INPUT_DEVICE_COUNT
                
</p>
<p>/ MIDI_INPUT_DEVICE_INFO
                
</p>
<p>/ CHANNEL_COUNT
                
</p>
<p>/ VOICE_COUNT
                
</p>
<p>/ STREAM_COUNT
                
</p>
<p>/ BUFFER_FILL
                
</p>
<p>/ CHANNEL_INFO
                
</p>
<p>/ FX_SEND_COUNT
                
</p>
<p>/ FX_SEND_INFO
                
</p>
<p>/ MIDI_INSTRUMENT_MAP_COUNT
                
</p>
<p>/ MIDI_INSTRUMENT_MAP_INFO
                
</p>
<p>/ MIDI_INSTRUMENT_COUNT
                
</p>
<p>/ MIDI_INSTRUMENT_INFO
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY_COUNT
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY_INFO
                
</p>
<p>/ DB_INSTRUMENT_COUNT
                
</p>
<p>/ DB_INSTRUMENT_INFO
                
</p>
<p>/ DB_INSTRUMENTS_JOB_INFO
                
</p>
<p>/ MISCELLANEOUS
                
</p>
<p>/ TOTAL_STREAM_COUNT
                
</p>
<p>/ TOTAL_VOICE_COUNT
                
</p>
<p>/ GLOBAL_INFO
                
</p>
</blockquote><p>

</p>
<p>map_instruction =
        </p>
<blockquote class="text">
<p>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
                
</p>
<p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
                
</p>
<p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
                
</p>
<p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
                
</p>
</blockquote><p>

</p>
<p>unmap_instruction =
        </p>
<blockquote class="text">
<p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
                
</p>
</blockquote><p>

</p>
<p>remove_instruction =
        </p>
<blockquote class="text">
<p>CHANNEL SP sampler_channel
                
</p>
<p>/ MIDI_INSTRUMENT_MAP SP midi_map
                
</p>
<p>/ MIDI_INSTRUMENT_MAP SP ALL
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY SP db_path
                
</p>
<p>/ DB_INSTRUMENT SP db_path
                
</p>
</blockquote><p>

</p>
<p>get_instruction =
        </p>
<blockquote class="text">
<p>AVAILABLE_ENGINES
                
</p>
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS
                
</p>
<p>/ MIDI_INPUT_DRIVER SP INFO SP string
                
</p>
<p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
                
</p>
<p>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
                
</p>
<p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
                
</p>
<p>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
                
</p>
<p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
                
</p>
<p>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
                
</p>
<p>/ AUDIO_OUTPUT_DEVICES
                
</p>
<p>/ MIDI_INPUT_DEVICES
                
</p>
<p>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
                
</p>
<p>/ MIDI_INPUT_DEVICE SP INFO SP number
                
</p>
<p>/ MIDI_INPUT_PORT SP INFO SP number SP number
                
</p>
<p>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
                
</p>
<p>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
                
</p>
<p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
                
</p>
<p>/ CHANNELS
                
</p>
<p>/ CHANNEL SP INFO SP sampler_channel
                
</p>
<p>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
                
</p>
<p>/ CHANNEL SP STREAM_COUNT SP sampler_channel
                
</p>
<p>/ CHANNEL SP VOICE_COUNT SP sampler_channel
                
</p>
<p>/ ENGINE SP INFO SP engine_name
                
</p>
<p>/ SERVER SP INFO
                
</p>
<p>/ TOTAL_STREAM_COUNT
                
</p>
<p>/ TOTAL_VOICE_COUNT
                
</p>
<p>/ TOTAL_VOICE_COUNT_MAX
                
</p>
<p>/ MIDI_INSTRUMENTS SP midi_map
                
</p>
<p>/ MIDI_INSTRUMENTS SP ALL
                
</p>
<p>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
                
</p>
<p>/ MIDI_INSTRUMENT_MAPS
                
</p>
<p>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
                
</p>
<p>/ FX_SENDS SP sampler_channel
                
</p>
<p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
                
</p>
<p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
                
</p>
<p>/ DB_INSTRUMENTS SP db_path
                
</p>
<p>/ DB_INSTRUMENT SP INFO SP db_path
                
</p>
<p>/ DB_INSTRUMENTS_JOB SP INFO SP number
                
</p>
<p>/ VOLUME
                
</p>
<p>/ FILE SP INSTRUMENTS SP filename
                
</p>
<p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
                
</p>
</blockquote><p>

</p>
<p>set_instruction =
        </p>
<blockquote class="text">
<p>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
                
</p>
<p>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
                
</p>
<p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
                
</p>
<p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
                
</p>
<p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
                
</p>
<p>/ CHANNEL SP set_chan_instruction
                
</p>
<p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
                
</p>
<p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
                
</p>
<p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
                
</p>
<p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
                
</p>
<p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
                
</p>
<p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
                
</p>
<p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
                
</p>
<p>/ ECHO SP boolean
                
</p>
<p>/ VOLUME SP volume_value
                
</p>
</blockquote><p>

</p>
<p>create_instruction =
        </p>
<blockquote class="text">
<p>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
                
</p>
<p>/ AUDIO_OUTPUT_DEVICE SP string
                
</p>
<p>/ MIDI_INPUT_DEVICE SP string SP key_val_list
                
</p>
<p>/ MIDI_INPUT_DEVICE SP string
                
</p>
<p>/ FX_SEND SP sampler_channel SP midi_ctrl
                
</p>
<p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
                
</p>
</blockquote><p>

</p>
<p>reset_instruction =
        </p>
<blockquote class="text">
<p>CHANNEL SP sampler_channel
                
</p>
</blockquote><p>

</p>
<p>clear_instruction =
        </p>
<blockquote class="text">
<p>MIDI_INSTRUMENTS SP midi_map
                
</p>
<p>/ MIDI_INSTRUMENTS SP ALL
                
</p>
</blockquote><p>

</p>
<p>find_instruction =
        </p>
<blockquote class="text">
<p>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
                
</p>
<p>/ DB_INSTRUMENTS SP db_path SP query_val_list
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
                
</p>
</blockquote><p>

</p>
<p>move_instruction =
        </p>
<blockquote class="text">
<p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
                
</p>
<p>/ DB_INSTRUMENT SP db_path SP db_path
                
</p>
</blockquote><p>

</p>
<p>copy_instruction =
        </p>
<blockquote class="text">
<p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
                
</p>
<p>/ DB_INSTRUMENT SP db_path SP db_path
                
</p>
</blockquote><p>

</p>
<p>destroy_instruction =
        </p>
<blockquote class="text">
<p>AUDIO_OUTPUT_DEVICE SP number
                
</p>
<p>/ MIDI_INPUT_DEVICE SP number
                
</p>
<p>/ FX_SEND SP sampler_channel SP fx_send_id
                
</p>
</blockquote><p>

</p>
<p>load_instruction =
        </p>
<blockquote class="text">
<p>INSTRUMENT SP load_instr_args
                
</p>
<p>/ ENGINE SP load_engine_args
                
</p>
</blockquote><p>

</p>
<p>set_chan_instruction =
        </p>
<blockquote class="text">
<p>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
                
</p>
<p>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
                
</p>
<p>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
                
</p>
<p>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
                
</p>
<p>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
                
</p>
<p>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
                
</p>
<p>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
                
</p>
<p>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
                
</p>
<p>/ VOLUME SP sampler_channel SP volume_value
                
</p>
<p>/ MUTE SP sampler_channel SP boolean
                
</p>
<p>/ SOLO SP sampler_channel SP boolean
                
</p>
<p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
                
</p>
<p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
                
</p>
<p>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
                
</p>
</blockquote><p>

</p>
<p>edit_instruction =
        </p>
<blockquote class="text">
<p>CHANNEL SP INSTRUMENT SP sampler_channel
                
</p>
</blockquote><p>

</p>
<p>format_instruction =
        </p>
<blockquote class="text">
<p>INSTRUMENTS_DB
                
</p>
</blockquote><p>

</p>
<p>modal_arg =
        </p>
<blockquote class="text">
<p>/* epsilon (empty argument) */
                
</p>
<p>/ NON_MODAL SP
                
</p>
</blockquote><p>

</p>
<p>key_val_list =
        </p>
<blockquote class="text">
<p>string '=' param_val_list
                
</p>
<p>/ key_val_list SP string '=' param_val_list
                
</p>
</blockquote><p>

</p>
<p>buffer_size_type =
        </p>
<blockquote class="text">
<p>BYTES
                
</p>
<p>/ PERCENTAGE
                
</p>
</blockquote><p>

</p>
<p>list_instruction =
        </p>
<blockquote class="text">
<p>AUDIO_OUTPUT_DEVICES
                
</p>
<p>/ MIDI_INPUT_DEVICES
                
</p>
<p>/ CHANNELS
                
</p>
<p>/ AVAILABLE_ENGINES
                
</p>
<p>/ AVAILABLE_MIDI_INPUT_DRIVERS
                
</p>
<p>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
                
</p>
<p>/ MIDI_INSTRUMENTS SP midi_map
                
</p>
<p>/ MIDI_INSTRUMENTS SP ALL
                
</p>
<p>/ MIDI_INSTRUMENT_MAPS
                
</p>
<p>/ FX_SENDS SP sampler_channel
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
                
</p>
<p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
                
</p>
<p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
                
</p>
<p>/ DB_INSTRUMENTS SP db_path
                
</p>
<p>/ FILE SP INSTRUMENTS SP filename
                
</p>
</blockquote><p>

</p>
<p>load_instr_args =
        </p>
<blockquote class="text">
<p>filename SP instrument_index SP sampler_channel
                
</p>
<p>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
                
</p>
</blockquote><p>

</p>
<p>load_engine_args =
        </p>
<blockquote class="text">
<p>engine_name SP sampler_channel
                
</p>
</blockquote><p>

</p>
<p>instr_load_mode =
        </p>
<blockquote class="text">
<p>ON_DEMAND
                
</p>
<p>/ ON_DEMAND_HOLD
                
</p>
<p>/ PERSISTENT
                
</p>
</blockquote><p>

</p>
<p>device_index =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>audio_channel_index =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>audio_output_type_name =
        </p>
<blockquote class="text">
<p>string
                
</p>
</blockquote><p>

</p>
<p>midi_input_port_index =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>midi_input_channel_index =
        </p>
<blockquote class="text">
<p>number
                
</p>
<p>/ ALL
                
</p>
</blockquote><p>

</p>
<p>midi_input_type_name =
        </p>
<blockquote class="text">
<p>string
                
</p>
</blockquote><p>

</p>
<p>midi_map =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>midi_bank =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>midi_prog =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>midi_ctrl =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>volume_value =
        </p>
<blockquote class="text">
<p>dotnum
                
</p>
<p>/ number
                
</p>
</blockquote><p>

</p>
<p>sampler_channel =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>instrument_index =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>fx_send_id =
        </p>
<blockquote class="text">
<p>number
                
</p>
</blockquote><p>

</p>
<p>engine_name =
        </p>
<blockquote class="text">
<p>string
                
</p>
</blockquote><p>

</p>
<p>filename =
        </p>
<blockquote class="text">
<p>path
                
</p>
</blockquote><p>

</p>
<p>db_path =
        </p>
<blockquote class="text">
<p>path
                
</p>
</blockquote><p>

</p>
<p>map_name =
        </p>
<blockquote class="text">
<p>stringval_escaped
                
</p>
</blockquote><p>

</p>
<p>entry_name =
        </p>
<blockquote class="text">
<p>stringval_escaped
                
</p>
</blockquote><p>

</p>
<p>fx_send_name =
        </p>
<blockquote class="text">
<p>stringval_escaped
                
</p>
</blockquote><p>

</p>
<p>param_val_list =
        </p>
<blockquote class="text">
<p>param_val
                
</p>
<p>/ param_val_list','param_val
                
</p>
</blockquote><p>

</p>
<p>param_val =
        </p>
<blockquote class="text">
<p>string
                
</p>
<p>/ stringval
                
</p>
<p>/ number
                
</p>
<p>/ dotnum
                
</p>
</blockquote><p>

</p>
<p>query_val_list =
        </p>
<blockquote class="text">
<p>string '=' query_val
                
</p>
<p>/ query_val_list SP string '=' query_val
                
</p>
</blockquote><p>

</p>
<p>query_val =
        </p>
<blockquote class="text">
<p>text_escaped
                
</p>
<p>/ stringval_escaped
                
</p>
</blockquote><p>

</p>
<p>scan_mode =
        </p>
<blockquote class="text">
<p>RECURSIVE
                
</p>
<p>/ NON_RECURSIVE
                
</p>
<p>/ FLAT
                
</p>
</blockquote><p>

</p>
<a name="character_set"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.7.1"></a><h3>7.1.&nbsp;
Character Set and Escape Sequences</h3>

<p>Older versions of this protocol up to and including v1.1 only
                supported the standard ASCII character set (ASCII code 0 - 127)
                <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, &ldquo;ASCII format for Network Interchange,&rdquo; 1969.</span><span>)</span></a>, all younger versions of this protocol
                however support the Extended ASCII character set (ASCII code
                0 - 255). The same group of younger protocols also support
                escape sequences, but only for certain, explicitly declared
                parts of the protocol. The supported escape sequences are
                defined as follows:
</p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2">
<col align="left"><col align="left">
<tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr>
<tr>
<td align="left">\n</td>
<td align="left">new line</td>
</tr>
<tr>
<td align="left">\r</td>
<td align="left">carriage return</td>
</tr>
<tr>
<td align="left">\f</td>
<td align="left">form feed</td>
</tr>
<tr>
<td align="left">\t</td>
<td align="left">horizontal tab</td>
</tr>
<tr>
<td align="left">\v</td>
<td align="left">vertical tab</td>
</tr>
<tr>
<td align="left">\'</td>
<td align="left">apostrophe</td>
</tr>
<tr>
<td align="left">\"</td>
<td align="left">quotation mark</td>
</tr>
<tr>
<td align="left">\\</td>
<td align="left">backslash</td>
</tr>
<tr>
<td align="left">\OOO</td>
<td align="left">three digit octal ASCII code of the character</td>
</tr>
<tr>
<td align="left">\xHH</td>
<td align="left">two digit hex ASCII code of the character</td>
</tr>
</table>

<p>Notice: due to the transition of certain parts of the
                protocol which now support escape sequences, a slight backward
                incompatibility to protocols version v1.1 and younger has been
                introduced. The only difference is that in parts of the protocol
                where escape characters are now supported, a backslash characters
                MUST be escaped as well (that is as double backslash), whereas
                in the old versions a single backslash was sufficient.
</p>
<p>The following LSCP commands support escape sequences as part
                of their filename / path based arguments and / or may contain
                a filename / path with escape sequences in their response:
                </p>
<blockquote class="text">
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>
</p>
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
</p>
<p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
</p>
<p><a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
</p>
<p><a class='info' href='#ADD DB_INSTRUMENT_DIRECTORY'>"ADD DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Creating a new instrument directory</span><span>)</span></a>
</p>
<p><a class='info' href='#ADD DB_INSTRUMENTS'>"ADD DB_INSTRUMENTS"<span> (</span><span class='info'>Adding instruments to the instruments database</span><span>)</span></a>
</p>
<p><a class='info' href='#REMOVE DB_INSTRUMENT_DIRECTORY'>"REMOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Deleting an instrument directory</span><span>)</span></a>
</p>
<p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a>
</p>
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORIES'>"GET DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Getting amount of instrument directories</span><span>)</span></a>
</p>
<p><a class='info' href='#LIST DB_INSTRUMENT_DIRECTORIES'>"LIST DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Listing all directories in specific directory</span><span>)</span></a>
</p>
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a>
</p>
<p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a>
</p>
<p><a class='info' href='#LIST DB_INSTRUMENTS'>"LIST DB_INSTRUMENTS"<span> (</span><span class='info'>Listing all instruments in specific directory</span><span>)</span></a>
</p>
<p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a>
</p>
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a>
</p>
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a>
</p>
<p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a>
</p>
<p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a>
</p>
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
</p>
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
</p>
<p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a>
</p>
<p><a class='info' href='#MOVE DB_INSTRUMENT_DIRECTORY'>"MOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Moving an instrument directory</span><span>)</span></a>
</p>
<p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a>
</p>
<p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a>
</p>
<p><a class='info' href='#GET FILE INSTRUMENTS'>"GET FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving amount of instruments of a file</span><span>)</span></a>
</p>
<p><a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a>
</p>
<p><a class='info' href='#GET FILE INSTRUMENT INFO'>"GET FILE INSTRUMENT INFO"<span> (</span><span class='info'>Retrieving informations about one instrument in a file</span><span>)</span></a>
</p>
</blockquote><p>
                Note that the forward slash character ('/') has a special meaning in
                filename / path based arguments: it acts as separator of the nodes in
                the path, thus if a directory- or filename includes a forward slash
                (not intended as path node separator), you MUST escape that slash
                either with the respective hex escape sequence ("\x2f") or with the
                respective octal escape sequence ("\057").
                
</p>
<p>
                Note for Windows: file path arguments in LSCP are expected
                to use forward slashes as directory node separator similar
                to Unix based operating systems. In contrast to Unix however
                a Windows typical drive character is expected to be
                prefixed to the path. That is an original Windows file path
                like "D:\Sounds\My.gig" would become in LSCP:
                "D:/Sounds/My.gig".
                
</p>
<p>
                The following LSCP commands even support escape sequences as
                part of at least one of their text-based arguments (i.e. entity name,
                description) and / or may contain escape sequences in at least one of
                their text-based fields in their response:
                </p>
<blockquote class="text">
<p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a>
</p>
<p><a class='info' href='#GET ENGINE INFO'>"GET ENGINE INFO"<span> (</span><span class='info'>Getting information about an engine</span><span>)</span></a>
</p>
<p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
</p>
<p><a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
</p>
<p><a class='info' href='#GET FX_SEND INFO'>"GET FX_SEND INFO"<span> (</span><span class='info'>Getting effect send information</span><span>)</span></a>
</p>
<p><a class='info' href='#SET FX_SEND NAME'>"SET FX_SEND NAME"<span> (</span><span class='info'>Changing effect send's name</span><span>)</span></a>
</p>
<p><a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
</p>
<p><a class='info' href='#GET MIDI_INSTRUMENT_MAP INFO'>"GET MIDI_INSTRUMENT_MAP INFO"<span> (</span><span class='info'>Getting MIDI instrument map information</span><span>)</span></a>
</p>
<p><a class='info' href='#ADD MIDI_INSTRUMENT_MAP'>"ADD MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Create a new MIDI instrument map</span><span>)</span></a>
</p>
<p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
</p>
<p><a class='info' href='#SET MIDI_INSTRUMENT_MAP NAME'>"SET MIDI_INSTRUMENT_MAP NAME"<span> (</span><span class='info'>Renaming a MIDI instrument map</span><span>)</span></a>
</p>
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a>
</p>
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a>
</p>
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a>
</p>
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
</p>
<p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a>
</p>
<p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a>
</p>
<p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a>
</p>
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
</p>
</blockquote><p>
                Please note that these lists are manually maintained. If you
                find a command that also supports escape sequences we forgot to
                mention here, please report it!
                
</p>
<a name="events"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8"></a><h3>8.&nbsp;
Events</h3>

<p>This chapter will describe all currently defined events supported by LinuxSampler.
</p>
<a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.1"></a><h3>8.1.&nbsp;
Number of audio output devices changed</h3>

<p>Client may want to be notified when the total number of audio output devices on the
                back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;devices&gt; will be replaced by the new number
                of audio output devices.
</p>
<a name="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.2"></a><h3>8.2.&nbsp;
Audio output device's settings changed</h3>

<p>Client may want to be notified when changes were made to audio output devices on the
                back-end by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
                which settings has been changed. The front-end will have to send
                the respective command to actually get the audio output device info. Because these messages
                will be triggered by LSCP commands issued by other clients rather than real
                time events happening on the server, it is believed that an empty notification
                message is sufficient here.
</p>
<a name="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.3"></a><h3>8.3.&nbsp;
Number of MIDI input devices changed</h3>

<p>Client may want to be notified when the total number of MIDI input devices on the
                back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;devices&gt; will be replaced by the new number
                of MIDI input devices.
</p>
<a name="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.4"></a><h3>8.4.&nbsp;
MIDI input device's settings changed</h3>

<p>Client may want to be notified when changes were made to MIDI input devices on the
                back-end by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE MIDI_INPUT_DEVICE_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
                which settings has been changed. The front-end will have to send
                the respective command to actually get the MIDI input device info. Because these messages
                will be triggered by LSCP commands issued by other clients rather than real
                time events happening on the server, it is believed that an empty notification
                message is sufficient here.
</p>
<a name="SUBSCRIBE CHANNEL_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.5"></a><h3>8.5.&nbsp;
Number of sampler channels changed</h3>

<p>Client may want to be notified when the total number of channels on the
                back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE CHANNEL_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;channels&gt; will be replaced by the new number
                of sampler channels.
</p>
<a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.6"></a><h3>8.6.&nbsp;
Number of active voices changed</h3>

<p>Client may want to be notified when the number of voices on the
                back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE VOICE_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
                voice count change occurred and &lt;voices&gt; by the new number of
                active voices on that channel.
</p>
<a name="SUBSCRIBE STREAM_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.7"></a><h3>8.7.&nbsp;
Number of active disk streams changed</h3>

<p>Client may want to be notified when the number of streams on the back-end
                changes by issuing the following command: SUBSCRIBE STREAM_COUNT
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE STREAM_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
                stream count change occurred and &lt;streams&gt; by the new number of
                active disk streams on that channel.
</p>
<a name="SUBSCRIBE BUFFER_FILL"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
Disk stream buffer fill state changed</h3>

<p>Client may want to be notified when the buffer fill state of a disk stream
                on the back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE BUFFER_FILL
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
                buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the
                buffer fill data for this channel as described in <a class='info' href='#GET CHANNEL BUFFER_FILL'>Section&nbsp;6.4.13<span> (</span><span class='info'>Current fill state of disk stream buffers</span><span>)</span></a>
                as if the <a class='info' href='#GET CHANNEL BUFFER_FILL'>"GET CHANNEL BUFFER_FILL PERCENTAGE"<span> (</span><span class='info'>Current fill state of disk stream buffers</span><span>)</span></a> command was issued on this channel.
</p>
<a name="SUBSCRIBE CHANNEL_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
Channel information changed</h3>

<p>Client may want to be notified when changes were made to sampler channels on the
                back-end by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE CHANNEL_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
                channel info change occurred. The front-end will have to send
                the respective command to actually get the channel info. Because these messages
                will be triggered by LSCP commands issued by other clients rather than real
                time events happening on the server, it is believed that an empty notification
                message is sufficient here.
</p>
<a name="SUBSCRIBE FX_SEND_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
Number of effect sends changed</h3>

<p>Client may want to be notified when the number of effect sends on
                a particular sampler channel is changed by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE FX_SEND_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
                channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
                be replaced by the new number of effect sends on that channel.
</p>
<a name="SUBSCRIBE FX_SEND_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.11"></a><h3>8.11.&nbsp;
Effect send information changed</h3>

<p>Client may want to be notified when changes were made to effect sends on a
                a particular sampler channel by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE FX_SEND_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
                channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
                be replaced by the numerical ID of the changed effect send.
</p>
<a name="SUBSCRIBE TOTAL_VOICE_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
Total number of active voices changed</h3>

<p>Client may want to be notified when the total number of voices on the
                back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE TOTAL_VOICE_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;voices&gt; will be replaced by the new number of
                all currently active voices.
</p>
<a name="SUBSCRIBE TOTAL_STREAM_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
Total number of active disk streams changed</h3>

<p>Client may want to be notified when the total number of disk streams on the
                back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE TOTAL_STREAM_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;streams&gt; will be replaced by the new number of
                all currently active disk streams.
</p>
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
Number of MIDI instrument maps changed</h3>

<p>Client may want to be notified when the number of MIDI instrument maps on the
                back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;maps&gt; will be replaced by the new number
                of MIDI instrument maps.
</p>
<a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
MIDI instrument map information changed</h3>

<p>Client may want to be notified when changes were made to MIDI instrument maps on the
                back-end by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
                for which information changes occurred. The front-end will have to send
                the respective command to actually get the MIDI instrument map info. Because these messages
                will be triggered by LSCP commands issued by other clients rather than real
                time events happening on the server, it is believed that an empty notification
                message is sufficient here.
</p>
<a name="SUBSCRIBE MIDI_INSTRUMENT_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
Number of MIDI instruments changed</h3>

<p>Client may want to be notified when the number of MIDI instrument maps on the
                back-end changes by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE MIDI_INSTRUMENT_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
                the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
                the new number of MIDI instruments in the specified map.
</p>
<a name="SUBSCRIBE MIDI_INSTRUMENT_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
MIDI instrument information changed</h3>

<p>Client may want to be notified when changes were made to MIDI instruments on the
                back-end by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE MIDI_INSTRUMENT_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
                in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
                the location of the changed MIDI instrument in the map. The front-end will have to send
                the respective command to actually get the MIDI instrument info. Because these messages
                will be triggered by LSCP commands issued by other clients rather than real
                time events happening on the server, it is believed that an empty notification
                message is sufficient here.
</p>
<a name="SUBSCRIBE GLOBAL_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
Global settings changed</h3>

<p>Client may want to be notified when changes to the global settings
                of the sampler were made by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE GLOBAL_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following types of notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
                        golbal volume of the sampler is changed, where &lt;volume&gt; will be
                        replaced by the optional dotted floating point value, reflecting the
                        new global volume parameter.
</p>
</blockquote><p>
                
</p>
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
Number of database instrument directories changed</h3>

<p>Client may want to be notified when the number of instrument
                directories in a particular directory in the instruments database
                is changed by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;dir-path&gt; will be replaced by the absolute path
                name of the directory in the instruments database,
                in which the number of directories is changed.
</p>
<p>Note that when a non-empty directory is removed, this event
                is not sent for the subdirectories in that directory.
</p>
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
Database instrument directory information changed</h3>

<p>Client may want to be notified when changes were made to directories
                in the instruments database by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;dir-path&gt; will be replaced by the absolute path name
                of the directory, for which information changes occurred. The front-end will have to send
                the respective command to actually get the updated directory info. Because these messages
                will be triggered by LSCP commands issued by other clients rather than real
                time events happening on the server, it is believed that an empty notification
                message is sufficient here.
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;old-dir-path&gt; is the old absolute path name of the directory
                (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
                the new name of the directory, encapsulated into apostrophes.
</p>
<a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
Number of database instruments changed</h3>

<p>Client may want to be notified when the number of instruments
                in a particular directory in the instruments database
                is changed by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE DB_INSTRUMENT_COUNT
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;dir-path&gt; will be replaced by the absolute path
                name of the directory in the instruments database,
                in which the number of instruments is changed.
</p>
<p>Note that when a non-empty directory is removed, this event
                is not sent for the instruments in that directory.
</p>
<a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
Database instrument information changed</h3>

<p>Client may want to be notified when changes were made to instruments
                in the instruments database by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE DB_INSTRUMENT_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;instr-path&gt; will be replaced by the absolute path name
                of the instrument, which settings are changed. The front-end will have to send
                the respective command to actually get the updated directory info. Because these messages
                will be triggered by LSCP commands issued by other clients rather than real
                time events happening on the server, it is believed that an empty notification
                message is sufficient here.
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
                (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
                the new name of the instrument, encapsulated into apostrophes.
</p>
<a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
Database job status information changed</h3>

<p>Client may want to be notified when the status of particular database
                instruments job is changed by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
                which status is changed. The front-end will have to send the respective
                command to actually get the status info. Because these messages
                will be triggered by LSCP commands issued by other clients rather than real
                time events happening on the server, it is believed that an empty notification
                message is sufficient here.
</p>
<a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.8.24"></a><h3>8.24.&nbsp;
Miscellaneous and debugging events</h3>

<p>Client may want to be notified of miscellaneous and debugging events occurring at
                the server by issuing the following command:
</p>
<p>
                    </p>
<blockquote class="text">
<p>SUBSCRIBE MISCELLANEOUS
</p>
</blockquote><p>
                
</p>
<p>Server will start sending the following notification messages:
</p>
<p>
                    </p>
<blockquote class="text">
<p>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"
</p>
</blockquote><p>
                
</p>
<p>where &lt;string&gt; will be replaced by whatever data server
                wants to send to the client. Client MAY display this data to the
                user AS IS to facilitate debugging.
</p>
<a name="anchor14"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.9"></a><h3>9.&nbsp;
Security Considerations</h3>

<p>As there is so far no method of authentication and authorization
            defined and so not required for a client applications to succeed to
            connect, running LinuxSampler might be a security risk for the host
            system the LinuxSampler instance is running on.
</p>
<a name="anchor15"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<a name="rfc.section.10"></a><h3>10.&nbsp;
Acknowledgments</h3>

<p>This document has benefited greatly from the comments of the
            following people, discussed on the LinuxSampler developer's mailing
            list:
</p>
<p>
                </p>
<blockquote class="text">
<p>Rui Nuno Capela
</p>
<p>Vladimir Senkov
</p>
<p>Mark Knecht
</p>
<p>Grigor Iliev
</p>
</blockquote><p>
            
</p>
<a name="rfc.references1"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<h3>11.&nbsp;References</h3>
<table width="99%" border="0">
<tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
<td class="author-text">UCLA, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,&rdquo; RFC&nbsp;20, 1969.</td></tr>
<tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
<td class="author-text">Bradner, S., &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>
<tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>
<td class="author-text">Crocker, D. and P. Overell, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">Augmented BNF for Syntax Specifications</a>,&rdquo; RFC&nbsp;2234, 1997.</td></tr>
<tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td>
<td class="author-text">Defense Advanced Research Projects Agency, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc793.txt">TRANSMISSION CONTROL PROTOCOL</a>,&rdquo; RFC&nbsp;793, 1981.</td></tr>
</table>

<a name="rfc.authors"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<h3>Author's Address</h3>
<table width="99%" border="0" cellpadding="0" cellspacing="0">
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">C.
Schoenebeck</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Interessengemeinschaft Software Engineering e. V.</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Max-Planck-Str. 39</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">74081 Heilbronn</td></tr>
<tr><td class="author-text">&nbsp;</td>
<td class="author-text">Germany</td></tr>
<tr><td class="author" align="right">Email:&nbsp;</td>
<td class="author-text"><a href="mailto:schoenebeck at software minus engineering dot org">schoenebeck at software minus engineering dot org</a></td></tr>
</table>
<a name="rfc.copyright"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
<h3>Full Copyright Statement</h3>
<p class='copyright'>
Copyright &copy; The IETF Trust (2007).</p>
<p class='copyright'>
This document is subject to the rights,
licenses and restrictions contained in BCP&nbsp;78,
and except as set forth therein,
the authors retain all their rights.</p>
<p class='copyright'>
This document and the information contained herein are provided
on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE.</p>
<h3>Intellectual Property</h3>
<p class='copyright'>
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed
to pertain to the implementation or use of the technology
described in this document or the extent to which any license
under such rights might or might not be available; nor does it
represent that it has made any independent effort to identify any
such rights.
Information on the procedures with respect to
rights in RFC documents can be found in BCP&nbsp;78 and BCP&nbsp;79.</p>
<p class='copyright'>
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available,
or the result of an attempt made to obtain a general license or
permission for the use of such proprietary rights by implementers or
users of this specification can be obtained from the IETF on-line IPR
repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
<p class='copyright'>
The IETF invites any interested party to bring to its attention
any copyrights,
patents or patent applications,
or other
proprietary rights that may cover technology that may be required
to implement this standard.
Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
<h3>Acknowledgment</h3>
<p class='copyright'>
Funding for the RFC Editor function is provided by
the IETF Administrative Support Activity (IASA).</p>
</body></html>
