Parent Directory
| 
Revision Log
| 
Patch
| revision 939 by schoenebeck, Thu Jul 21 09:36:52 2005 UTC | revision 940 by schoenebeck, Sat Nov 25 17:18:12 2006 UTC | |
|---|---|---|
| # | Line 3 | Line 3 |
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| 4 | <meta name="description" content="LinuxSampler Control Protocol"> | <meta name="description" content="LinuxSampler Control Protocol"> |
| 5 | <meta name="keywords" content="LSCP"> | <meta name="keywords" content="LSCP"> |
| 6 | <meta name="generator" content="xml2rfc v1.29 (http://xml.resource.org/)"> | <meta name="generator" content="xml2rfc v1.30 (http://xml.resource.org/)"> |
| 7 | <style type='text/css'> | <style type='text/css'> |
| 8 | <!-- | <!-- |
| 9 | body { | body { |
| # | Line 28 | Line 28 |
| 28 | text-align: center ; | text-align: center ; |
| 29 | font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; | font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif; |
| 30 | font-size: x-small ; background-color: #000000; } | font-size: x-small ; background-color: #000000; } |
| 31 | /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */ | /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */ |
| 32 | div#counter{margin-top: 100px} | div#counter{margin-top: 100px} |
| 33 | ||
| 34 | a.info{ | a.info{ |
| # | Line 58 | Line 58 |
| 58 | p { margin-left: 2em; margin-right: 2em; } | p { margin-left: 2em; margin-right: 2em; } |
| 59 | p.copyright { font-size: x-small ; } | p.copyright { font-size: x-small ; } |
| 60 | p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;} | p.toc { font-size: small ; font-weight: bold ; margin-left: 3em ;} |
| 61 | table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; } | |
| 62 | td.toc { font-size: small; font-weight: bold; vertical-align: text-top; } | |
| 63 | ||
| 64 | span.emph { font-style: italic; } | span.emph { font-style: italic; } |
| 65 | span.strong { font-weight: bold; } | span.strong { font-weight: bold; } |
| # | Line 95 | Line 97 |
| 97 | background-color: #666666 ; width: 33% ; } | background-color: #666666 ; width: 33% ; } |
| 98 | td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; } | td.author { font-weight: bold; margin-left: 4em; font-size: x-small ; } |
| 99 | td.author-text { font-size: x-small; } | td.author-text { font-size: x-small; } |
| 100 | table.data { vertical-align: top ; border-collapse: collapse ; | table.full { vertical-align: top ; border-collapse: collapse ; |
| 101 | border-style: solid solid solid solid ; | border-style: solid solid solid solid ; |
| 102 | border-color: black black black black ; | border-color: black black black black ; |
| 103 | font-size: small ; text-align: center ; } | font-size: small ; text-align: center ; } |
| 104 | table.data th { font-weight: bold ; | table.headers, table.none { vertical-align: top ; border-collapse: collapse ; |
| 105 | border-style: solid solid solid solid ; | border-style: none; |
| 106 | font-size: small ; text-align: center ; } | |
| 107 | table.full th { font-weight: bold ; | |
| 108 | border-style: solid ; | |
| 109 | border-color: black black black black ; } | border-color: black black black black ; } |
| 110 | table.data td { | table.headers th { font-weight: bold ; |
| 111 | border-style: none none solid none; | |
| 112 | border-color: black black black black ; } | |
| 113 | table.none th { font-weight: bold ; | |
| 114 | border-style: none; } | |
| 115 | table.full td { | |
| 116 | border-style: solid solid solid solid ; | border-style: solid solid solid solid ; |
| 117 | border-color: #333333 #333333 #333333 #333333 ; } | border-color: #333333 #333333 #333333 #333333 ; } |
| 118 | table.headers td, table.none td { border-style: none; } | |
| 119 | ||
| 120 | hr { height: 1px } | hr { height: 1px } |
| 121 | --> | --> |
| # | Line 115 | Line 126 |
| 126 | <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1"> | <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1"> |
| 127 | <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr> | <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr> |
| 128 | <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr> | <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr> |
| 129 | <tr><td class="header">Expires: January 22, 2006</td><td class="header">Engineering e. V.</td></tr> | <tr><td class="header">Expires: May 29, 2007</td><td class="header">Engineering e. V.</td></tr> |
| 130 | <tr><td class="header"> </td><td class="header">July 21, 2005</td></tr> | <tr><td class="header"> </td><td class="header">November 25, 2006</td></tr> |
| 131 | </table></td></tr></table> | </table></td></tr></table> |
| 132 | <div align="right"><span class="title"><br />LinuxSampler Control Protocol</span></div> | <div align="right"><span class="title"><br />LinuxSampler Control Protocol</span></div> |
| 133 | <div align="right"><span class="title"><br />LSCP 1.1</span></div> | <div align="right"><span class="title"><br />LSCP 1.1</span></div> |
| # | Line 142 The list of current Internet-Drafts can | Line 153 The list of current Internet-Drafts can |
| 153 | The list of Internet-Draft Shadow Directories can be accessed at | The list of Internet-Draft Shadow Directories can be accessed at |
| 154 | <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p> | <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p> |
| 155 | <p> | <p> |
| 156 | This Internet-Draft will expire on January 22, 2006.</p> | This Internet-Draft will expire on May 29, 2007.</p> |
| 157 | ||
| 158 | <h3>Copyright Notice</h3> | <h3>Copyright Notice</h3> |
| 159 | <p> | <p> |
| 160 | Copyright © The Internet Society (2005). All Rights Reserved.</p> | Copyright © The Internet Society (2006). All Rights Reserved.</p> |
| 161 | ||
| 162 | <h3>Abstract</h3> | <h3>Abstract</h3> |
| 163 | ||
| # | Line 169 Introduction<br /> | Line 180 Introduction<br /> |
| 180 | Focus of this protocol<br /> | Focus of this protocol<br /> |
| 181 | <a href="#anchor4">5.</a> | <a href="#anchor4">5.</a> |
| 182 | Communication Overview<br /> | Communication Overview<br /> |
| 183 | <a href="#anchor5">5.1</a> | <a href="#anchor5">5.1.</a> |
| 184 | Request/response communication method<br /> | Request/response communication method<br /> |
| 185 | <a href="#anchor6">5.1.1</a> | <a href="#anchor6">5.1.1.</a> |
| 186 | Result format<br /> | Result format<br /> |
| 187 | <a href="#anchor7">5.2</a> | <a href="#anchor7">5.2.</a> |
| 188 | Subscribe/notify communication method<br /> | Subscribe/notify communication method<br /> |
| 189 | <a href="#control_commands">6.</a> | <a href="#control_commands">6.</a> |
| 190 | Description for control commands<br /> | Description for control commands<br /> |
| 191 | <a href="#anchor8">6.1</a> | <a href="#anchor8">6.1.</a> |
| 192 | Ignored lines and comments<br /> | Ignored lines and comments<br /> |
| 193 | <a href="#anchor9">6.2</a> | <a href="#anchor9">6.2.</a> |
| 194 | Configuring audio drivers<br /> | Configuring audio drivers<br /> |
| 195 | <a href="#GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.1</a> | <a href="#GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.1.</a> |
| 196 | Getting amount of available audio output drivers<br /> | Getting amount of available audio output drivers<br /> |
| 197 | <a href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.2</a> | <a href="#LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.2.</a> |
| 198 | Getting all available audio output drivers<br /> | Getting all available audio output drivers<br /> |
| 199 | <a href="#GET AUDIO_OUTPUT_DRIVER INFO">6.2.3</a> | <a href="#GET AUDIO_OUTPUT_DRIVER INFO">6.2.3.</a> |
| 200 | Getting information about a specific audio | Getting information about a specific audio |
| 201 | output driver<br /> | output driver<br /> |
| 202 | <a href="#GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">6.2.4</a> | <a href="#GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">6.2.4.</a> |
| 203 | Getting information about specific audio | Getting information about specific audio |
| 204 | output driver parameter<br /> | output driver parameter<br /> |
| 205 | <a href="#CREATE AUDIO_OUTPUT_DEVICE">6.2.5</a> | <a href="#CREATE AUDIO_OUTPUT_DEVICE">6.2.5.</a> |
| 206 | Creating an audio output device<br /> | Creating an audio output device<br /> |
| 207 | <a href="#DESTROY AUDIO_OUTPUT_DEVICE">6.2.6</a> | <a href="#DESTROY AUDIO_OUTPUT_DEVICE">6.2.6.</a> |
| 208 | Destroying an audio output device<br /> | Destroying an audio output device<br /> |
| 209 | <a href="#GET AUDIO_OUTPUT_DEVICES">6.2.7</a> | <a href="#GET AUDIO_OUTPUT_DEVICES">6.2.7.</a> |
| 210 | Getting all created audio output device count<br /> | Getting all created audio output device count<br /> |
| 211 | <a href="#LIST AUDIO_OUTPUT_DEVICES">6.2.8</a> | <a href="#LIST AUDIO_OUTPUT_DEVICES">6.2.8.</a> |
| 212 | Getting all created audio output device list<br /> | Getting all created audio output device list<br /> |
| 213 | <a href="#GET AUDIO_OUTPUT_DEVICE INFO">6.2.9</a> | <a href="#GET AUDIO_OUTPUT_DEVICE INFO">6.2.9.</a> |
| 214 | Getting current settings of an audio output device<br /> | Getting current settings of an audio output device<br /> |
| 215 | <a href="#SET AUDIO_OUTPUT_DEVICE_PARAMETER">6.2.10</a> | <a href="#SET AUDIO_OUTPUT_DEVICE_PARAMETER">6.2.10.</a> |
| 216 | Changing settings of audio output devices<br /> | Changing settings of audio output devices<br /> |
| 217 | <a href="#GET AUDIO_OUTPUT_CHANNEL INFO">6.2.11</a> | <a href="#GET AUDIO_OUTPUT_CHANNEL INFO">6.2.11.</a> |
| 218 | Getting information about an audio channel<br /> | Getting information about an audio channel<br /> |
| 219 | <a href="#GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">6.2.12</a> | <a href="#GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">6.2.12.</a> |
| 220 | Getting information about specific audio channel parameter<br /> | Getting information about specific audio channel parameter<br /> |
| 221 | <a href="#SET AUDIO_OUTPUT_CHANNEL_PARAMETER">6.2.13</a> | <a href="#SET AUDIO_OUTPUT_CHANNEL_PARAMETER">6.2.13.</a> |
| 222 | Changing settings of audio output channels<br /> | Changing settings of audio output channels<br /> |
| 223 | <a href="#anchor10">6.3</a> | <a href="#anchor10">6.3.</a> |
| 224 | Configuring MIDI input drivers<br /> | Configuring MIDI input drivers<br /> |
| 225 | <a href="#GET AVAILABLE_MIDI_INPUT_DRIVERS">6.3.1</a> | <a href="#GET AVAILABLE_MIDI_INPUT_DRIVERS">6.3.1.</a> |
| 226 | Getting amount of available MIDI input drivers<br /> | Getting amount of available MIDI input drivers<br /> |
| 227 | <a href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">6.3.2</a> | <a href="#LIST AVAILABLE_MIDI_INPUT_DRIVERS">6.3.2.</a> |
| 228 | Getting all available MIDI input drivers<br /> | Getting all available MIDI input drivers<br /> |
| 229 | <a href="#GET MIDI_INPUT_DRIVER INFO">6.3.3</a> | <a href="#GET MIDI_INPUT_DRIVER INFO">6.3.3.</a> |
| 230 | Getting information about a specific MIDI input driver<br /> | Getting information about a specific MIDI input driver<br /> |
| 231 | <a href="#GET MIDI_INPUT_DRIVER_PARAMETER INFO">6.3.4</a> | <a href="#GET MIDI_INPUT_DRIVER_PARAMETER INFO">6.3.4.</a> |
| 232 | Getting information about specific MIDI input driver parameter<br /> | Getting information about specific MIDI input driver parameter<br /> |
| 233 | <a href="#CREATE MIDI_INPUT_DEVICE">6.3.5</a> | <a href="#CREATE MIDI_INPUT_DEVICE">6.3.5.</a> |
| 234 | Creating a MIDI input device<br /> | Creating a MIDI input device<br /> |
| 235 | <a href="#DESTROY MIDI_INPUT_DEVICE">6.3.6</a> | <a href="#DESTROY MIDI_INPUT_DEVICE">6.3.6.</a> |
| 236 | Destroying a MIDI input device<br /> | Destroying a MIDI input device<br /> |
| 237 | <a href="#GET MIDI_INPUT_DEVICES">6.3.7</a> | <a href="#GET MIDI_INPUT_DEVICES">6.3.7.</a> |
| 238 | Getting all created MIDI input device count<br /> | Getting all created MIDI input device count<br /> |
| 239 | <a href="#LIST MIDI_INPUT_DEVICES">6.3.8</a> | <a href="#LIST MIDI_INPUT_DEVICES">6.3.8.</a> |
| 240 | Getting all created MIDI input device list<br /> | Getting all created MIDI input device list<br /> |
| 241 | <a href="#GET MIDI_INPUT_DEVICE INFO">6.3.9</a> | <a href="#GET MIDI_INPUT_DEVICE INFO">6.3.9.</a> |
| 242 | Getting current settings of a MIDI input device<br /> | Getting current settings of a MIDI input device<br /> |
| 243 | <a href="#SET MIDI_INPUT_DEVICE_PARAMETER">6.3.10</a> | <a href="#SET MIDI_INPUT_DEVICE_PARAMETER">6.3.10.</a> |
| 244 | Changing settings of MIDI input devices<br /> | Changing settings of MIDI input devices<br /> |
| 245 | <a href="#GET MIDI_INPUT_PORT INFO">6.3.11</a> | <a href="#GET MIDI_INPUT_PORT INFO">6.3.11.</a> |
| 246 | Getting information about a MIDI port<br /> | Getting information about a MIDI port<br /> |
| 247 | <a href="#GET MIDI_INPUT_PORT_PARAMETER INFO">6.3.12</a> | <a href="#GET MIDI_INPUT_PORT_PARAMETER INFO">6.3.12.</a> |
| 248 | Getting information about specific MIDI port parameter<br /> | Getting information about specific MIDI port parameter<br /> |
| 249 | <a href="#SET MIDI_INPUT_PORT_PARAMETER">6.3.13</a> | <a href="#SET MIDI_INPUT_PORT_PARAMETER">6.3.13.</a> |
| 250 | Changing settings of MIDI input ports<br /> | Changing settings of MIDI input ports<br /> |
| 251 | <a href="#anchor11">6.4</a> | <a href="#anchor11">6.4.</a> |
| 252 | Configuring sampler channels<br /> | Configuring sampler channels<br /> |
| 253 | <a href="#LOAD INSTRUMENT">6.4.1</a> | <a href="#LOAD INSTRUMENT">6.4.1.</a> |
| 254 | Loading an instrument<br /> | Loading an instrument<br /> |
| 255 | <a href="#LOAD ENGINE">6.4.2</a> | <a href="#LOAD ENGINE">6.4.2.</a> |
| 256 | Loading a sampler engine<br /> | Loading a sampler engine<br /> |
| 257 | <a href="#GET CHANNELS">6.4.3</a> | <a href="#GET CHANNELS">6.4.3.</a> |
| 258 | Getting all created sampler channel count<br /> | Getting all created sampler channel count<br /> |
| 259 | <a href="#LIST CHANNELS">6.4.4</a> | <a href="#LIST CHANNELS">6.4.4.</a> |
| 260 | Getting all created sampler channel list<br /> | Getting all created sampler channel list<br /> |
| 261 | <a href="#ADD CHANNEL">6.4.5</a> | <a href="#ADD CHANNEL">6.4.5.</a> |
| 262 | Adding a new sampler channel<br /> | Adding a new sampler channel<br /> |
| 263 | <a href="#REMOVE CHANNEL">6.4.6</a> | <a href="#REMOVE CHANNEL">6.4.6.</a> |
| 264 | Removing a sampler channel<br /> | Removing a sampler channel<br /> |
| 265 | <a href="#GET AVAILABLE_ENGINES">6.4.7</a> | <a href="#GET AVAILABLE_ENGINES">6.4.7.</a> |
| 266 | Getting amount of available engines<br /> | Getting amount of available engines<br /> |
| 267 | <a href="#LIST AVAILABLE_ENGINES">6.4.8</a> | <a href="#LIST AVAILABLE_ENGINES">6.4.8.</a> |
| 268 | Getting all available engines<br /> | Getting all available engines<br /> |
| 269 | <a href="#GET ENGINE INFO">6.4.9</a> | <a href="#GET ENGINE INFO">6.4.9.</a> |
| 270 | Getting information about an engine<br /> | Getting information about an engine<br /> |
| 271 | <a href="#GET CHANNEL INFO">6.4.10</a> | <a href="#GET CHANNEL INFO">6.4.10.</a> |
| 272 | Getting sampler channel information<br /> | Getting sampler channel information<br /> |
| 273 | <a href="#GET CHANNEL VOICE_COUNT">6.4.11</a> | <a href="#GET CHANNEL VOICE_COUNT">6.4.11.</a> |
| 274 | Current number of active voices<br /> | Current number of active voices<br /> |
| 275 | <a href="#GET CHANNEL STREAM_COUNT">6.4.12</a> | <a href="#GET CHANNEL STREAM_COUNT">6.4.12.</a> |
| 276 | Current number of active disk streams<br /> | Current number of active disk streams<br /> |
| 277 | <a href="#GET CHANNEL BUFFER_FILL">6.4.13</a> | <a href="#GET CHANNEL BUFFER_FILL">6.4.13.</a> |
| 278 | Current fill state of disk stream buffers<br /> | Current fill state of disk stream buffers<br /> |
| 279 | <a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14</a> | <a href="#SET CHANNEL AUDIO_OUTPUT_DEVICE">6.4.14.</a> |
| 280 | Setting audio output device<br /> | Setting audio output device<br /> |
| 281 | <a href="#SET CHANNEL AUDIO_OUTPUT_TYP">6.4.15</a> | <a href="#SET CHANNEL AUDIO_OUTPUT_TYP">6.4.15.</a> |
| 282 | Setting audio output type<br /> | Setting audio output type<br /> |
| 283 | <a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16</a> | <a href="#SET CHANNEL AUDIO_OUTPUT_CHANNEL">6.4.16.</a> |
| 284 | Setting audio output channel<br /> | Setting audio output channel<br /> |
| 285 | <a href="#SET CHANNEL MIDI_INPUT_DEVICE">6.4.17</a> | <a href="#SET CHANNEL MIDI_INPUT_DEVICE">6.4.17.</a> |
| 286 | Setting MIDI input device<br /> | Setting MIDI input device<br /> |
| 287 | <a href="#SET CHANNEL MIDI_INPUT_TYPE">6.4.18</a> | <a href="#SET CHANNEL MIDI_INPUT_TYPE">6.4.18.</a> |
| 288 | Setting MIDI input type<br /> | Setting MIDI input type<br /> |
| 289 | <a href="#SET CHANNEL MIDI_INPUT_PORT">6.4.19</a> | <a href="#SET CHANNEL MIDI_INPUT_PORT">6.4.19.</a> |
| 290 | Setting MIDI input port<br /> | Setting MIDI input port<br /> |
| 291 | <a href="#SET CHANNEL MIDI_INPUT_CHANNEL">6.4.20</a> | <a href="#SET CHANNEL MIDI_INPUT_CHANNEL">6.4.20.</a> |
| 292 | Setting MIDI input channel<br /> | Setting MIDI input channel<br /> |
| 293 | <a href="#SET CHANNEL VOLUME">6.4.21</a> | <a href="#SET CHANNEL VOLUME">6.4.21.</a> |
| 294 | Setting channel volume<br /> | Setting channel volume<br /> |
| 295 | <a href="#SET CHANNEL MUTE">6.4.22</a> | <a href="#SET CHANNEL MUTE">6.4.22.</a> |
| 296 | Muting a sampler channel<br /> | Muting a sampler channel<br /> |
| 297 | <a href="#SET CHANNEL SOLO">6.4.23</a> | <a href="#SET CHANNEL SOLO">6.4.23.</a> |
| 298 | Soloing a sampler channel<br /> | Soloing a sampler channel<br /> |
| 299 | <a href="#RESET CHANNEL">6.4.24</a> | <a href="#RESET CHANNEL">6.4.24.</a> |
| 300 | Resetting a sampler channel<br /> | Resetting a sampler channel<br /> |
| 301 | <a href="#anchor12">6.5</a> | <a href="#anchor12">6.5.</a> |
| 302 | Controlling connection<br /> | Controlling connection<br /> |
| 303 | <a href="#SUBSCRIBE">6.5.1</a> | <a href="#SUBSCRIBE">6.5.1.</a> |
| 304 | Register front-end for receiving event messages<br /> | Register front-end for receiving event messages<br /> |
| 305 | <a href="#UNSUBSCRIBE">6.5.2</a> | <a href="#UNSUBSCRIBE">6.5.2.</a> |
| 306 | Unregister front-end for not receiving event messages<br /> | Unregister front-end for not receiving event messages<br /> |
| 307 | <a href="#SET ECHO">6.5.3</a> | <a href="#SET ECHO">6.5.3.</a> |
| 308 | Enable or disable echo of commands<br /> | Enable or disable echo of commands<br /> |
| 309 | <a href="#QUIT">6.5.4</a> | <a href="#QUIT">6.5.4.</a> |
| 310 | Close client connection<br /> | Close client connection<br /> |
| 311 | <a href="#anchor13">6.6</a> | <a href="#anchor13">6.6.</a> |
| 312 | Global commands<br /> | Global commands<br /> |
| 313 | <a href="#RESET">6.6.1</a> | <a href="#GET TOTAL_VOICE_COUNT">6.6.1.</a> |
| 314 | Current number of active voices<br /> | |
| 315 | <a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a> | |
| 316 | Maximum amount of active voices<br /> | |
| 317 | <a href="#RESET">6.6.3.</a> | |
| 318 | Reset sampler<br /> | Reset sampler<br /> |
| 319 | <a href="#GET SERVER INFO">6.6.2</a> | <a href="#GET SERVER INFO">6.6.4.</a> |
| 320 | General sampler informations<br /> | General sampler informations<br /> |
| 321 | <a href="#command_syntax">7.</a> | <a href="#command_syntax">7.</a> |
| 322 | Command Syntax<br /> | Command Syntax<br /> |
| 323 | <a href="#events">8.</a> | <a href="#events">8.</a> |
| 324 | Events<br /> | Events<br /> |
| 325 | <a href="#SUBSCRIBE CHANNEL">8.1</a> | <a href="#SUBSCRIBE CHANNEL">8.1.</a> |
| 326 | Number of sampler channels changed<br /> | Number of sampler channels changed<br /> |
| 327 | <a href="#SUBSCRIBE VOICE_COUNT">8.2</a> | <a href="#SUBSCRIBE VOICE_COUNT">8.2.</a> |
| 328 | Number of active voices changed<br /> | Number of active voices changed<br /> |
| 329 | <a href="#SUBSCRIBE STREAM_COUNT">8.3</a> | <a href="#SUBSCRIBE STREAM_COUNT">8.3.</a> |
| 330 | Number of active disk streams changed<br /> | Number of active disk streams changed<br /> |
| 331 | <a href="#SUBSCRIBE BUFFER_FILL">8.4</a> | <a href="#SUBSCRIBE BUFFER_FILL">8.4.</a> |
| 332 | Disk stream buffer fill state changed<br /> | Disk stream buffer fill state changed<br /> |
| 333 | <a href="#SUBSCRIBE INFO">8.5</a> | <a href="#SUBSCRIBE INFO">8.5.</a> |
| 334 | Channel information changed<br /> | Channel information changed<br /> |
| 335 | <a href="#SUBSCRIBE MISCELLANEOUS">8.6</a> | <a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.6.</a> |
| 336 | Total number of active voices changed<br /> | |
| 337 | <a href="#SUBSCRIBE MISCELLANEOUS">8.7.</a> | |
| 338 | Miscellaneous and debugging events<br /> | Miscellaneous and debugging events<br /> |
| 339 | <a href="#anchor14">9.</a> | <a href="#anchor14">9.</a> |
| 340 | Security Considerations<br /> | Security Considerations<br /> |
| # | Line 359 Intellectual Property and Copyright Stat | Line 376 Intellectual Property and Copyright Stat |
| 376 | <p> "another line" | <p> "another line" |
| 377 | </p> | </p> |
| 378 | </blockquote><p> | </blockquote><p> |
| 379 | ||
| 380 | </p> | </p> |
| 381 | <p>must actually be interpreted as client sending the following | <p>must actually be interpreted as client sending the following |
| 382 | message: | message: |
| # | Line 371 Intellectual Property and Copyright Stat | Line 388 Intellectual Property and Copyright Stat |
| 388 | line<CR><LF>" | line<CR><LF>" |
| 389 | </p> | </p> |
| 390 | </blockquote><p> | </blockquote><p> |
| 391 | ||
| 392 | </p> | </p> |
| 393 | <p>where <CR> symbolizes the carriage return character and | <p>where <CR> symbolizes the carriage return character and |
| 394 | <LF> the line feed character as defined in the ASCII | <LF> the line feed character as defined in the ASCII |
| # | Line 386 Intellectual Property and Copyright Stat | Line 403 Intellectual Property and Copyright Stat |
| 403 | <p>S: "abcd" | <p>S: "abcd" |
| 404 | </p> | </p> |
| 405 | </blockquote><p> | </blockquote><p> |
| 406 | ||
| 407 | </p> | </p> |
| 408 | <p>could also happen to be sent in three messages like in the | <p>could also happen to be sent in three messages like in the |
| 409 | following sequence scenario: | following sequence scenario: |
| # | Line 409 Intellectual Property and Copyright Stat | Line 426 Intellectual Property and Copyright Stat |
| 426 | "<LF>" | "<LF>" |
| 427 | </li> | </li> |
| 428 | </ul><p> | </ul><p> |
| 429 | ||
| 430 | </p> | </p> |
| 431 | <p>where again <CR> and <LF> symbolize the carriage | <p>where again <CR> and <LF> symbolize the carriage |
| 432 | return and line feed characters respectively. | return and line feed characters respectively. |
| # | Line 422 Intellectual Property and Copyright Stat | Line 439 Intellectual Property and Copyright Stat |
| 439 | release of the LSCP specification will be tagged with a unique version | release of the LSCP specification will be tagged with a unique version |
| 440 | tuple. The version tuple consists at least of a major and minor version | tuple. The version tuple consists at least of a major and minor version |
| 441 | number like: | number like: |
| 442 | ||
| 443 | </p> | </p> |
| 444 | <p> | <p> |
| 445 | </p> | </p> |
| # | Line 430 Intellectual Property and Copyright Stat | Line 447 Intellectual Property and Copyright Stat |
| 447 | <p>"1.2" | <p>"1.2" |
| 448 | </p> | </p> |
| 449 | </blockquote><p> | </blockquote><p> |
| 450 | ||
| 451 | </p> | </p> |
| 452 | <p> | <p> |
| 453 | In this example the major version number would be "1" and the minor | In this example the major version number would be "1" and the minor |
| # | Line 440 Intellectual Property and Copyright Stat | Line 457 Intellectual Property and Copyright Stat |
| 457 | compatible to the connected sampler if and only if the LSCP versions | compatible to the connected sampler if and only if the LSCP versions |
| 458 | to which each of the two parties complies to, match both of the | to which each of the two parties complies to, match both of the |
| 459 | following rules: | following rules: |
| 460 | ||
| 461 | </p> | </p> |
| 462 | <p>Compatibility: | <p>Compatibility: |
| 463 | </p> | </p> |
| # | Line 454 Intellectual Property and Copyright Stat | Line 471 Intellectual Property and Copyright Stat |
| 471 | the sampler's LSCP minor version. | the sampler's LSCP minor version. |
| 472 | </li> | </li> |
| 473 | </ol><p> | </ol><p> |
| 474 | ||
| 475 | </p> | </p> |
| 476 | <p> | <p> |
| 477 | Compatibility can only be claimed if both rules are true. | Compatibility can only be claimed if both rules are true. |
| 478 | The frontend can use the | The frontend can use the |
| 479 | <a class="info" href="#GET SERVER INFO">"GET SERVER INFO"<span> (</span><span class="info">General sampler informations</span><span>)</span></a> command to | <a class="info" href="#GET SERVER INFO">"GET SERVER INFO"<span> (</span><span class="info">General sampler informations</span><span>)</span></a> command to |
| 480 | get the version of the LSCP specification the sampler complies with. | get the version of the LSCP specification the sampler complies with. |
| 481 | ||
| 482 | </p> | </p> |
| 483 | <a name="anchor2"></a><br /><hr /> | <a name="anchor2"></a><br /><hr /> |
| 484 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
| # | Line 511 Intellectual Property and Copyright Stat | Line 528 Intellectual Property and Copyright Stat |
| 528 | implemented in the front-end application. The two communication | implemented in the front-end application. The two communication |
| 529 | methods will be described next. | methods will be described next. |
| 530 | </p> | </p> |
| 531 | <a name="rfc.section.5.1"></a><h4><a name="anchor5">5.1</a> Request/response communication method</h4> | <a name="anchor5"></a><br /><hr /> |
| 532 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 533 | <a name="rfc.section.5.1"></a><h3>5.1. Request/response communication method</h3> | |
| 534 | ||
| 535 | <p>This simple communication method is based on | <p>This simple communication method is based on |
| 536 | <a class="info" href="#RFC793">TCP<span> (</span><span class="info">Defense Advanced Research Projects Agency, “TRANSMISSION CONTROL PROTOCOL,” 1981.</span><span>)</span></a>[RFC793]. The | <a class="info" href="#RFC793">TCP<span> (</span><span class="info">Defense Advanced Research Projects Agency, “TRANSMISSION CONTROL PROTOCOL,” 1981.</span><span>)</span></a> [RFC793]. The |
| 537 | front-end application establishes a TCP connection to the | front-end application establishes a TCP connection to the |
| 538 | LinuxSampler instance on a certain host system. Then the | LinuxSampler instance on a certain host system. Then the |
| 539 | front-end application will send certain ASCII based commands | front-end application will send certain ASCII based commands |
| # | Line 554 Intellectual Property and Copyright Stat | Line 573 Intellectual Property and Copyright Stat |
| 573 | processed in the order they were received and result sets | processed in the order they were received and result sets |
| 574 | MUST be sent back in the same order. | MUST be sent back in the same order. |
| 575 | </p> | </p> |
| 576 | <a name="rfc.section.5.1.1"></a><h4><a name="anchor6">5.1.1</a> Result format</h4> | <a name="anchor6"></a><br /><hr /> |
| 577 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 578 | <a name="rfc.section.5.1.1"></a><h3>5.1.1. Result format</h3> | |
| 579 | ||
| 580 | <p>Result set could be one of the following types: | <p>Result set could be one of the following types: |
| 581 | </p> | </p> |
| # | Line 568 Intellectual Property and Copyright Stat | Line 589 Intellectual Property and Copyright Stat |
| 589 | <li>Error | <li>Error |
| 590 | </li> | </li> |
| 591 | </ol><p> | </ol><p> |
| 592 | ||
| 593 | </p> | </p> |
| 594 | <p>Warning and Error result sets MUST be single line and | <p>Warning and Error result sets MUST be single line and |
| 595 | have the following format: | have the following format: |
| # | Line 581 Intellectual Property and Copyright Stat | Line 602 Intellectual Property and Copyright Stat |
| 602 | <li>"ERR:<error-code>:<error-message>" | <li>"ERR:<error-code>:<error-message>" |
| 603 | </li> | </li> |
| 604 | </ul><p> | </ul><p> |
| 605 | ||
| 606 | </p> | </p> |
| 607 | <p>Where <warning-code> and <error-code> are | <p>Where <warning-code> and <error-code> are |
| 608 | numeric unique identifiers of the warning or error and | numeric unique identifiers of the warning or error and |
| # | Line 599 Intellectual Property and Copyright Stat | Line 620 Intellectual Property and Copyright Stat |
| 620 | <p>S: "WRN:32:This is a 24 bit patch which is not supported natively yet." | <p>S: "WRN:32:This is a 24 bit patch which is not supported natively yet." |
| 621 | </p> | </p> |
| 622 | </blockquote><p> | </blockquote><p> |
| 623 | ||
| 624 | </p> | </p> |
| 625 | <p> | <p> |
| 626 | </p> | </p> |
| # | Line 609 Intellectual Property and Copyright Stat | Line 630 Intellectual Property and Copyright Stat |
| 630 | <p>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'." | <p>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'." |
| 631 | </p> | </p> |
| 632 | </blockquote><p> | </blockquote><p> |
| 633 | ||
| 634 | </p> | </p> |
| 635 | <p> | <p> |
| 636 | </p> | </p> |
| # | Line 619 Intellectual Property and Copyright Stat | Line 640 Intellectual Property and Copyright Stat |
| 640 | <p>S: "ERR:9:There is no audio output device with index 123456." | <p>S: "ERR:9:There is no audio output device with index 123456." |
| 641 | </p> | </p> |
| 642 | </blockquote><p> | </blockquote><p> |
| 643 | ||
| 644 | </p> | </p> |
| 645 | <p>Normal result sets could be: | <p>Normal result sets could be: |
| 646 | </p> | </p> |
| # | Line 633 Intellectual Property and Copyright Stat | Line 654 Intellectual Property and Copyright Stat |
| 654 | <li>Multi-line | <li>Multi-line |
| 655 | </li> | </li> |
| 656 | </ol><p> | </ol><p> |
| 657 | ||
| 658 | </p> | </p> |
| 659 | <p> Empty result set is issued when the server only | <p> Empty result set is issued when the server only |
| 660 | needed to acknowledge the fact that the request was | needed to acknowledge the fact that the request was |
| # | Line 647 Intellectual Property and Copyright Stat | Line 668 Intellectual Property and Copyright Stat |
| 668 | <p>"OK" | <p>"OK" |
| 669 | </p> | </p> |
| 670 | </blockquote><p> | </blockquote><p> |
| 671 | ||
| 672 | </p> | </p> |
| 673 | <p>Example: | <p>Example: |
| 674 | </p> | </p> |
| # | Line 659 Intellectual Property and Copyright Stat | Line 680 Intellectual Property and Copyright Stat |
| 680 | <p>S: "OK" | <p>S: "OK" |
| 681 | </p> | </p> |
| 682 | </blockquote><p> | </blockquote><p> |
| 683 | ||
| 684 | </p> | </p> |
| 685 | <p>Single line result sets are command specific. One | <p>Single line result sets are command specific. One |
| 686 | example of a single line result set is an empty line. | example of a single line result set is an empty line. |
| # | Line 673 Intellectual Property and Copyright Stat | Line 694 Intellectual Property and Copyright Stat |
| 694 | <p>"." | <p>"." |
| 695 | </p> | </p> |
| 696 | </blockquote><p> | </blockquote><p> |
| 697 | ||
| 698 | </p> | </p> |
| 699 | <p>Example: | <p>Example: |
| 700 | </p> | </p> |
| # | Line 699 Intellectual Property and Copyright Stat | Line 720 Intellectual Property and Copyright Stat |
| 720 | <p> "." | <p> "." |
| 721 | </p> | </p> |
| 722 | </blockquote><p> | </blockquote><p> |
| 723 | ||
| 724 | </p> | </p> |
| 725 | <p>In addition to above mentioned formats, warnings and | <p>In addition to above mentioned formats, warnings and |
| 726 | empty result sets MAY be indexed. In this case, they | empty result sets MAY be indexed. In this case, they |
| # | Line 713 Intellectual Property and Copyright Stat | Line 734 Intellectual Property and Copyright Stat |
| 734 | <li>"OK[<index>]" | <li>"OK[<index>]" |
| 735 | </li> | </li> |
| 736 | </ul><p> | </ul><p> |
| 737 | ||
| 738 | </p> | </p> |
| 739 | <p>where <index> is command specific and is used | <p>where <index> is command specific and is used |
| 740 | to indicate channel number that the result set was | to indicate channel number that the result set was |
| # | Line 732 Intellectual Property and Copyright Stat | Line 753 Intellectual Property and Copyright Stat |
| 753 | <p>S: "OK[12]" | <p>S: "OK[12]" |
| 754 | </p> | </p> |
| 755 | </blockquote><p> | </blockquote><p> |
| 756 | ||
| 757 | </p> | </p> |
| 758 | <p> | <p> |
| 759 | </p> | </p> |
| # | Line 742 Intellectual Property and Copyright Stat | Line 763 Intellectual Property and Copyright Stat |
| 763 | <p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead." | <p>S: "WRN[0]:32:Sample rate not supported, using 44100 instead." |
| 764 | </p> | </p> |
| 765 | </blockquote><p> | </blockquote><p> |
| 766 | ||
| 767 | </p> | </p> |
| 768 | <a name="rfc.section.5.2"></a><h4><a name="anchor7">5.2</a> Subscribe/notify communication method</h4> | <a name="anchor7"></a><br /><hr /> |
| 769 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 770 | <a name="rfc.section.5.2"></a><h3>5.2. Subscribe/notify communication method</h3> | |
| 771 | ||
| 772 | <p>This more sophisticated communication method is actually | <p>This more sophisticated communication method is actually |
| 773 | only an extension of the simple request/response | only an extension of the simple request/response |
| # | Line 762 Intellectual Property and Copyright Stat | Line 785 Intellectual Property and Copyright Stat |
| 785 | <p>SUBSCRIBE <event-id> | <p>SUBSCRIBE <event-id> |
| 786 | </p> | </p> |
| 787 | </blockquote><p> | </blockquote><p> |
| 788 | ||
| 789 | </p> | </p> |
| 790 | <p>where <event-id> will be replaced by the respective | <p>where <event-id> will be replaced by the respective |
| 791 | event that client wants to subscribe to. Upon receiving such | event that client wants to subscribe to. Upon receiving such |
| # | Line 779 Intellectual Property and Copyright Stat | Line 802 Intellectual Property and Copyright Stat |
| 802 | <p>NOTIFY:<event-id>:<custom-event-data> | <p>NOTIFY:<event-id>:<custom-event-data> |
| 803 | </p> | </p> |
| 804 | </blockquote><p> | </blockquote><p> |
| 805 | ||
| 806 | </p> | </p> |
| 807 | <p>where <event-id> uniquely identifies the event that | <p>where <event-id> uniquely identifies the event that |
| 808 | has occurred and <custom-event-data> is event | has occurred and <custom-event-data> is event |
| # | Line 805 Intellectual Property and Copyright Stat | Line 828 Intellectual Property and Copyright Stat |
| 828 | response. | response. |
| 829 | </li> | </li> |
| 830 | </ol><p> | </ol><p> |
| 831 | ||
| 832 | </p> | </p> |
| 833 | <p>If the client is not interested in a particular event | <p>If the client is not interested in a particular event |
| 834 | anymore it MAY issue UNSUBSCRIBE command using the following | anymore it MAY issue UNSUBSCRIBE command using the following |
| # | Line 817 Intellectual Property and Copyright Stat | Line 840 Intellectual Property and Copyright Stat |
| 840 | <p>UNSUBSCRIBE <event-id> | <p>UNSUBSCRIBE <event-id> |
| 841 | </p> | </p> |
| 842 | </blockquote><p> | </blockquote><p> |
| 843 | ||
| 844 | </p> | </p> |
| 845 | <p>where <event-id> will be replace by the respective | <p>where <event-id> will be replace by the respective |
| 846 | event that client is no longer interested in receiving. For | event that client is no longer interested in receiving. For |
| # | Line 834 Intellectual Property and Copyright Stat | Line 857 Intellectual Property and Copyright Stat |
| 857 | <p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98% | <p>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98% |
| 858 | </p> | </p> |
| 859 | </blockquote><p> | </blockquote><p> |
| 860 | ||
| 861 | </p> | </p> |
| 862 | <p>Which means there are currently three active streams on | <p>Which means there are currently three active streams on |
| 863 | sampler channel 4, where the stream with ID "35" is filled | sampler channel 4, where the stream with ID "35" is filled |
| # | Line 877 Intellectual Property and Copyright Stat | Line 900 Intellectual Property and Copyright Stat |
| 900 | multiple-line responses. In this case LinuxSampler signals the | multiple-line responses. In this case LinuxSampler signals the |
| 901 | end of the response by a "." (single dot) line. | end of the response by a "." (single dot) line. |
| 902 | </p> | </p> |
| 903 | <a name="rfc.section.6.1"></a><h4><a name="anchor8">6.1</a> Ignored lines and comments</h4> | <a name="anchor8"></a><br /><hr /> |
| 904 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 905 | <a name="rfc.section.6.1"></a><h3>6.1. Ignored lines and comments</h3> | |
| 906 | ||
| 907 | <p>White lines, that is lines which only contain space and | <p>White lines, that is lines which only contain space and |
| 908 | tabulator characters, and lines that start with a "#" | tabulator characters, and lines that start with a "#" |
| # | Line 885 Intellectual Property and Copyright Stat | Line 910 Intellectual Property and Copyright Stat |
| 910 | group commands and to place comments in a LSCP script | group commands and to place comments in a LSCP script |
| 911 | file. | file. |
| 912 | </p> | </p> |
| 913 | <a name="rfc.section.6.2"></a><h4><a name="anchor9">6.2</a> Configuring audio drivers</h4> | <a name="anchor9"></a><br /><hr /> |
| 914 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 915 | <a name="rfc.section.6.2"></a><h3>6.2. Configuring audio drivers</h3> | |
| 916 | ||
| 917 | <p>Instances of drivers in LinuxSampler are called devices. | <p>Instances of drivers in LinuxSampler are called devices. |
| 918 | You can use multiple audio devices simultaneously, e.g. to | You can use multiple audio devices simultaneously, e.g. to |
| # | Line 918 Intellectual Property and Copyright Stat | Line 945 Intellectual Property and Copyright Stat |
| 945 | what parameters drivers are offering, how to retrieve their | what parameters drivers are offering, how to retrieve their |
| 946 | possible values, etc. | possible values, etc. |
| 947 | </p> | </p> |
| 948 | <a name="rfc.section.6.2.1"></a><h4><a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.1</a> Getting amount of available audio output drivers</h4> | <a name="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr /> |
| 949 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 950 | <a name="rfc.section.6.2.1"></a><h3>6.2.1. Getting amount of available audio output drivers</h3> | |
| 951 | ||
| 952 | <p>Use the following command to get the number of | <p>Use the following command to get the number of |
| 953 | audio output drivers currently available for the | audio output drivers currently available for the |
| # | Line 930 Intellectual Property and Copyright Stat | Line 959 Intellectual Property and Copyright Stat |
| 959 | <p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS | <p>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS |
| 960 | </p> | </p> |
| 961 | </blockquote><p> | </blockquote><p> |
| 962 | ||
| 963 | </p> | </p> |
| 964 | <p>Possible Answers: | <p>Possible Answers: |
| 965 | </p> | </p> |
| # | Line 941 Intellectual Property and Copyright Stat | Line 970 Intellectual Property and Copyright Stat |
| 970 | number of audio output drivers. | number of audio output drivers. |
| 971 | </p> | </p> |
| 972 | </blockquote><p> | </blockquote><p> |
| 973 | ||
| 974 | </p> | </p> |
| 975 | <p>Example: | <p>Example: |
| 976 | </p> | </p> |
| # | Line 953 Intellectual Property and Copyright Stat | Line 982 Intellectual Property and Copyright Stat |
| 982 | <p>S: "2" | <p>S: "2" |
| 983 | </p> | </p> |
| 984 | </blockquote><p> | </blockquote><p> |
| 985 | ||
| 986 | </p> | </p> |
| 987 | <a name="rfc.section.6.2.2"></a><h4><a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">6.2.2</a> Getting all available audio output drivers</h4> | <a name="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"></a><br /><hr /> |
| 988 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 989 | <a name="rfc.section.6.2.2"></a><h3>6.2.2. Getting all available audio output drivers</h3> | |
| 990 | ||
| 991 | <p>Use the following command to list all audio output | <p>Use the following command to list all audio output |
| 992 | drivers currently available for the LinuxSampler | drivers currently available for the LinuxSampler |
| # | Line 967 Intellectual Property and Copyright Stat | Line 998 Intellectual Property and Copyright Stat |
| 998 | <p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS | <p>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS |
| 999 | </p> | </p> |
| 1000 | </blockquote><p> | </blockquote><p> |
| 1001 | ||
| 1002 | </p> | </p> |
| 1003 | <p>Possible Answers: | <p>Possible Answers: |
| 1004 | </p> | </p> |
| # | Line 979 Intellectual Property and Copyright Stat | Line 1010 Intellectual Property and Copyright Stat |
| 1010 | audio output driver. | audio output driver. |
| 1011 | </p> | </p> |
| 1012 | </blockquote><p> | </blockquote><p> |
| 1013 | ||
| 1014 | </p> | </p> |
| 1015 | <p>Example: | <p>Example: |
| 1016 | </p> | </p> |
| # | Line 991 Intellectual Property and Copyright Stat | Line 1022 Intellectual Property and Copyright Stat |
| 1022 | <p>S: "ALSA,JACK" | <p>S: "ALSA,JACK" |
| 1023 | </p> | </p> |
| 1024 | </blockquote><p> | </blockquote><p> |
| 1025 | ||
| 1026 | </p> | </p> |
| 1027 | <a name="rfc.section.6.2.3"></a><h4><a name="GET AUDIO_OUTPUT_DRIVER INFO">6.2.3</a> Getting information about a specific audio | <a name="GET AUDIO_OUTPUT_DRIVER INFO"></a><br /><hr /> |
| 1028 | output driver</h4> | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
| 1029 | <a name="rfc.section.6.2.3"></a><h3>6.2.3. Getting information about a specific audio | |
| 1030 | output driver</h3> | |
| 1031 | ||
| 1032 | <p>Use the following command to get detailed information | <p>Use the following command to get detailed information |
| 1033 | about a specific audio output driver: | about a specific audio output driver: |
| # | Line 1006 Intellectual Property and Copyright Stat | Line 1039 Intellectual Property and Copyright Stat |
| 1039 | <audio-output-driver> | <audio-output-driver> |
| 1040 | </p> | </p> |
| 1041 | </blockquote><p> | </blockquote><p> |
| 1042 | ||
| 1043 | </p> | </p> |
| 1044 | <p>Where <audio-output-driver> is the name of the | <p>Where <audio-output-driver> is the name of the |
| 1045 | audio output driver, returned by the | audio output driver, returned by the |
| # | Line 1035 Intellectual Property and Copyright Stat | Line 1068 Intellectual Property and Copyright Stat |
| 1068 | <p> character string describing the | <p> character string describing the |
| 1069 | audio output driver | audio output driver |
| 1070 | </p> | </p> |
| 1071 | </blockquote><p> | </blockquote> |
| 1072 | ||
| 1073 | ||
| </p> | ||
| 1074 | <p>VERSION - | <p>VERSION - |
| 1075 | </p> | </p> |
| 1076 | <blockquote class="text"> | <blockquote class="text"> |
| 1077 | <p>character string reflecting the | <p>character string reflecting the |
| 1078 | driver's version | driver's version |
| 1079 | </p> | </p> |
| 1080 | </blockquote><p> | </blockquote> |
| 1081 | ||
| 1082 | ||
| </p> | ||
| 1083 | <p>PARAMETERS - | <p>PARAMETERS - |
| 1084 | </p> | </p> |
| 1085 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1057 Intellectual Property and Copyright Stat | Line 1090 Intellectual Property and Copyright Stat |
| 1090 | and 'active' are offered by all audio | and 'active' are offered by all audio |
| 1091 | output drivers | output drivers |
| 1092 | </p> | </p> |
| 1093 | </blockquote><p> | </blockquote> |
| 1094 | ||
| 1095 | ||
| 1096 | </p> | </blockquote> |
| 1097 | </blockquote><p> | |
| 1098 | ||
| </p> | ||
| 1099 | <p>The mentioned fields above don't have to be | <p>The mentioned fields above don't have to be |
| 1100 | in particular order. | in particular order. |
| 1101 | </p> | </p> |
| 1102 | </blockquote><p> | </blockquote><p> |
| 1103 | ||
| 1104 | </p> | </p> |
| 1105 | <p>Example: | <p>Example: |
| 1106 | </p> | </p> |
| # | Line 1088 Intellectual Property and Copyright Stat | Line 1121 Intellectual Property and Copyright Stat |
| 1121 | <p> "." | <p> "." |
| 1122 | </p> | </p> |
| 1123 | </blockquote><p> | </blockquote><p> |
| 1124 | ||
| 1125 | </p> | </p> |
| 1126 | <a name="rfc.section.6.2.4"></a><h4><a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">6.2.4</a> Getting information about specific audio | <a name="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"></a><br /><hr /> |
| 1127 | output driver parameter</h4> | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> |
| 1128 | <a name="rfc.section.6.2.4"></a><h3>6.2.4. Getting information about specific audio | |
| 1129 | output driver parameter</h3> | |
| 1130 | ||
| 1131 | <p>Use the following command to get detailed information | <p>Use the following command to get detailed information |
| 1132 | about a specific audio output driver parameter: | about a specific audio output driver parameter: |
| # | Line 1102 Intellectual Property and Copyright Stat | Line 1137 Intellectual Property and Copyright Stat |
| 1137 | <p>GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO <audio> <prm> [<deplist>] | <p>GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO <audio> <prm> [<deplist>] |
| 1138 | </p> | </p> |
| 1139 | </blockquote><p> | </blockquote><p> |
| 1140 | ||
| 1141 | </p> | </p> |
| 1142 | <p>Where <audio> is the name of the audio output | <p>Where <audio> is the name of the audio output |
| 1143 | 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, | 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, |
| # | Line 1134 Intellectual Property and Copyright Stat | Line 1169 Intellectual Property and Copyright Stat |
| 1169 | the moment the following information categories are defined: | the moment the following information categories are defined: |
| 1170 | </p> | </p> |
| 1171 | </blockquote><p> | </blockquote><p> |
| 1172 | ||
| 1173 | </p> | </p> |
| 1174 | <p> | <p> |
| 1175 | </p> | </p> |
| # | Line 1148 Intellectual Property and Copyright Stat | Line 1183 Intellectual Property and Copyright Stat |
| 1183 | character string(s) | character string(s) |
| 1184 | (always returned, no matter which driver parameter) | (always returned, no matter which driver parameter) |
| 1185 | </p> | </p> |
| 1186 | </blockquote><p> | </blockquote> |
| 1187 | ||
| 1188 | ||
| </p> | ||
| 1189 | <p>DESCRIPTION - | <p>DESCRIPTION - |
| 1190 | </p> | </p> |
| 1191 | <blockquote class="text"> | <blockquote class="text"> |
| 1192 | <p>arbitrary text describing the purpose of the parameter | <p>arbitrary text describing the purpose of the parameter |
| 1193 | (always returned, no matter which driver parameter) | (always returned, no matter which driver parameter) |
| 1194 | </p> | </p> |
| 1195 | </blockquote><p> | </blockquote> |
| 1196 | ||
| 1197 | ||
| </p> | ||
| 1198 | <p>MANDATORY - | <p>MANDATORY - |
| 1199 | </p> | </p> |
| 1200 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1168 Intellectual Property and Copyright Stat | Line 1203 Intellectual Property and Copyright Stat |
| 1203 | <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> | <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> |
| 1204 | command (always returned, no matter which driver parameter) | command (always returned, no matter which driver parameter) |
| 1205 | </p> | </p> |
| 1206 | </blockquote><p> | </blockquote> |
| 1207 | ||
| 1208 | ||
| </p> | ||
| 1209 | <p>FIX - | <p>FIX - |
| 1210 | </p> | </p> |
| 1211 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1179 Intellectual Property and Copyright Stat | Line 1214 Intellectual Property and Copyright Stat |
| 1214 | 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> | 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> |
| 1215 | command (always returned, no matter which driver parameter) | command (always returned, no matter which driver parameter) |
| 1216 | </p> | </p> |
| 1217 | </blockquote><p> | </blockquote> |
| 1218 | ||
| 1219 | ||
| </p> | ||
| 1220 | <p>MULTIPLICITY - | <p>MULTIPLICITY - |
| 1221 | </p> | </p> |
| 1222 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1190 Intellectual Property and Copyright Stat | Line 1225 Intellectual Property and Copyright Stat |
| 1225 | multiple values and false only a single value allowed | multiple values and false only a single value allowed |
| 1226 | (always returned, no matter which driver parameter) | (always returned, no matter which driver parameter) |
| 1227 | </p> | </p> |
| 1228 | </blockquote><p> | </blockquote> |
| 1229 | ||
| 1230 | ||
| </p> | ||
| 1231 | <p>DEPENDS - | <p>DEPENDS - |
| 1232 | </p> | </p> |
| 1233 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1207 Intellectual Property and Copyright Stat | Line 1242 Intellectual Property and Copyright Stat |
| 1242 | chosen by the 'card' parameter | chosen by the 'card' parameter |
| 1243 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 1244 | </p> | </p> |
| 1245 | </blockquote><p> | </blockquote> |
| 1246 | ||
| 1247 | ||
| </p> | ||
| 1248 | <p>DEFAULT - | <p>DEFAULT - |
| 1249 | </p> | </p> |
| 1250 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1221 Intellectual Property and Copyright Stat | Line 1256 Intellectual Property and Copyright Stat |
| 1256 | apostrophes (') | apostrophes (') |
| 1257 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 1258 | </p> | </p> |
| 1259 | </blockquote><p> | </blockquote> |
| 1260 | ||
| 1261 | ||
| </p> | ||
| 1262 | <p>RANGE_MIN - | <p>RANGE_MIN - |
| 1263 | </p> | </p> |
| 1264 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1233 Intellectual Property and Copyright Stat | Line 1268 Intellectual Property and Copyright Stat |
| 1268 | with RANGE_MAX, but may also appear without | with RANGE_MAX, but may also appear without |
| 1269 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 1270 | </p> | </p> |
| 1271 | </blockquote><p> | </blockquote> |
| 1272 | ||
| 1273 | ||
| </p> | ||
| 1274 | <p>RANGE_MAX - | <p>RANGE_MAX - |
| 1275 | </p> | </p> |
| 1276 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1245 Intellectual Property and Copyright Stat | Line 1280 Intellectual Property and Copyright Stat |
| 1280 | RANGE_MIN, but may also appear without | RANGE_MIN, but may also appear without |
| 1281 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 1282 | </p> | </p> |
| 1283 | </blockquote><p> | </blockquote> |
| 1284 | ||
| 1285 | ||
| </p> | ||
| 1286 | <p>POSSIBILITIES - | <p>POSSIBILITIES - |
| 1287 | </p> | </p> |
| 1288 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1256 Intellectual Property and Copyright Stat | Line 1291 Intellectual Property and Copyright Stat |
| 1291 | apostrophes | apostrophes |
| 1292 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 1293 | </p> | </p> |
| 1294 | </blockquote><p> | </blockquote> |
| 1295 | ||
| 1296 | ||
| </p> | ||
| 1297 | </blockquote><p> | </blockquote><p> |
| 1298 | ||
| 1299 | </p> | </p> |
| 1300 | <p>The mentioned fields above don't have to be in particular order. | <p>The mentioned fields above don't have to be in particular order. |
| 1301 | </p> | </p> |
| # | Line 1288 Intellectual Property and Copyright Stat | Line 1323 Intellectual Property and Copyright Stat |
| 1323 | <p> "." | <p> "." |
| 1324 | </p> | </p> |
| 1325 | </blockquote><p> | </blockquote><p> |
| 1326 | ||
| 1327 | </p> | </p> |
| 1328 | <p> | <p> |
| 1329 | </p> | </p> |
| # | Line 1312 Intellectual Property and Copyright Stat | Line 1347 Intellectual Property and Copyright Stat |
| 1347 | <p> "." | <p> "." |
| 1348 | </p> | </p> |
| 1349 | </blockquote><p> | </blockquote><p> |
| 1350 | ||
| 1351 | </p> | </p> |
| 1352 | <p> | <p> |
| 1353 | </p> | </p> |
| # | Line 1340 Intellectual Property and Copyright Stat | Line 1375 Intellectual Property and Copyright Stat |
| 1375 | <p> "." | <p> "." |
| 1376 | </p> | </p> |
| 1377 | </blockquote><p> | </blockquote><p> |
| 1378 | ||
| 1379 | </p> | </p> |
| 1380 | <a name="rfc.section.6.2.5"></a><h4><a name="CREATE AUDIO_OUTPUT_DEVICE">6.2.5</a> Creating an audio output device</h4> | <a name="CREATE AUDIO_OUTPUT_DEVICE"></a><br /><hr /> |
| 1381 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 1382 | <a name="rfc.section.6.2.5"></a><h3>6.2.5. Creating an audio output device</h3> | |
| 1383 | ||
| 1384 | <p>Use the following command to create a new audio output device for the desired audio output system: | <p>Use the following command to create a new audio output device for the desired audio output system: |
| 1385 | </p> | </p> |
| # | Line 1352 Intellectual Property and Copyright Stat | Line 1389 Intellectual Property and Copyright Stat |
| 1389 | <p>CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>] | <p>CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>] |
| 1390 | </p> | </p> |
| 1391 | </blockquote><p> | </blockquote><p> |
| 1392 | ||
| 1393 | </p> | </p> |
| 1394 | <p>Where <audio-output-driver> should be replaced by the desired audio | <p>Where <audio-output-driver> should be replaced by the desired audio |
| 1395 | output system as returned by the | output system as returned by the |
| # | Line 1375 Intellectual Property and Copyright Stat | Line 1412 Intellectual Property and Copyright Stat |
| 1412 | <p>in case the device was successfully created, where | <p>in case the device was successfully created, where |
| 1413 | <device-id> is the numerical ID of the new device | <device-id> is the numerical ID of the new device |
| 1414 | </p> | </p> |
| 1415 | </blockquote><p> | </blockquote> |
| 1416 | ||
| 1417 | ||
| </p> | ||
| 1418 | <p>"WRN[<device-id>]:<warning-code>:<warning-message>" - | <p>"WRN[<device-id>]:<warning-code>:<warning-message>" - |
| 1419 | </p> | </p> |
| 1420 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1388 Intellectual Property and Copyright Stat | Line 1425 Intellectual Property and Copyright Stat |
| 1425 | fall-back values), providing an appropriate warning code and | fall-back values), providing an appropriate warning code and |
| 1426 | warning message | warning message |
| 1427 | </p> | </p> |
| 1428 | </blockquote><p> | </blockquote> |
| 1429 | ||
| 1430 | ||
| </p> | ||
| 1431 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 1432 | </p> | </p> |
| 1433 | <blockquote class="text"> | <blockquote class="text"> |
| 1434 | <p>in case it failed, providing an appropriate error code and error message | <p>in case it failed, providing an appropriate error code and error message |
| 1435 | </p> | </p> |
| 1436 | </blockquote><p> | </blockquote> |
| 1437 | ||
| 1438 | ||
| </p> | ||
| 1439 | </blockquote><p> | </blockquote><p> |
| 1440 | ||
| 1441 | </p> | </p> |
| 1442 | <p>Examples: | <p>Examples: |
| 1443 | </p> | </p> |
| # | Line 1412 Intellectual Property and Copyright Stat | Line 1449 Intellectual Property and Copyright Stat |
| 1449 | <p>S: "OK[0]" | <p>S: "OK[0]" |
| 1450 | </p> | </p> |
| 1451 | </blockquote><p> | </blockquote><p> |
| 1452 | ||
| 1453 | </p> | </p> |
| 1454 | <p> | <p> |
| 1455 | </p> | </p> |
| # | Line 1422 Intellectual Property and Copyright Stat | Line 1459 Intellectual Property and Copyright Stat |
| 1459 | <p>S: "OK[1]" | <p>S: "OK[1]" |
| 1460 | </p> | </p> |
| 1461 | </blockquote><p> | </blockquote><p> |
| 1462 | ||
| 1463 | </p> | </p> |
| 1464 | <a name="rfc.section.6.2.6"></a><h4><a name="DESTROY AUDIO_OUTPUT_DEVICE">6.2.6</a> Destroying an audio output device</h4> | <a name="DESTROY AUDIO_OUTPUT_DEVICE"></a><br /><hr /> |
| 1465 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 1466 | <a name="rfc.section.6.2.6"></a><h3>6.2.6. Destroying an audio output device</h3> | |
| 1467 | ||
| 1468 | <p>Use the following command to destroy a created output device: | <p>Use the following command to destroy a created output device: |
| 1469 | </p> | </p> |
| # | Line 1434 Intellectual Property and Copyright Stat | Line 1473 Intellectual Property and Copyright Stat |
| 1473 | <p>DESTROY AUDIO_OUTPUT_DEVICE <device-id> | <p>DESTROY AUDIO_OUTPUT_DEVICE <device-id> |
| 1474 | </p> | </p> |
| 1475 | </blockquote><p> | </blockquote><p> |
| 1476 | ||
| 1477 | </p> | </p> |
| 1478 | <p>Where <device-id> should be replaced by the numerical ID of the | <p>Where <device-id> should be replaced by the numerical ID of the |
| 1479 | audio output device as given by the | audio output device as given by the |
| # | Line 1452 Intellectual Property and Copyright Stat | Line 1491 Intellectual Property and Copyright Stat |
| 1491 | <blockquote class="text"> | <blockquote class="text"> |
| 1492 | <p>in case the device was successfully destroyed | <p>in case the device was successfully destroyed |
| 1493 | </p> | </p> |
| 1494 | </blockquote><p> | </blockquote> |
| 1495 | ||
| 1496 | ||
| </p> | ||
| 1497 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 1498 | </p> | </p> |
| 1499 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1464 Intellectual Property and Copyright Stat | Line 1503 Intellectual Property and Copyright Stat |
| 1503 | informed about this situation), providing an appropriate | informed about this situation), providing an appropriate |
| 1504 | warning code and warning message | warning code and warning message |
| 1505 | </p> | </p> |
| 1506 | </blockquote><p> | </blockquote> |
| 1507 | ||
| 1508 | ||
| </p> | ||
| 1509 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 1510 | </p> | </p> |
| 1511 | <blockquote class="text"> | <blockquote class="text"> |
| 1512 | <p>in case it failed, providing an appropriate error code and | <p>in case it failed, providing an appropriate error code and |
| 1513 | error message | error message |
| 1514 | </p> | </p> |
| 1515 | </blockquote><p> | </blockquote> |
| 1516 | ||
| 1517 | ||
| </p> | ||
| 1518 | </blockquote><p> | </blockquote><p> |
| 1519 | ||
| 1520 | </p> | </p> |
| 1521 | <p>Example: | <p>Example: |
| 1522 | </p> | </p> |
| # | Line 1489 Intellectual Property and Copyright Stat | Line 1528 Intellectual Property and Copyright Stat |
| 1528 | <p>S: "OK" | <p>S: "OK" |
| 1529 | </p> | </p> |
| 1530 | </blockquote><p> | </blockquote><p> |
| 1531 | ||
| 1532 | </p> | </p> |
| 1533 | <a name="rfc.section.6.2.7"></a><h4><a name="GET AUDIO_OUTPUT_DEVICES">6.2.7</a> Getting all created audio output device count</h4> | <a name="GET AUDIO_OUTPUT_DEVICES"></a><br /><hr /> |
| 1534 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 1535 | <a name="rfc.section.6.2.7"></a><h3>6.2.7. Getting all created audio output device count</h3> | |
| 1536 | ||
| 1537 | <p>Use the following command to count all created audio output devices: | <p>Use the following command to count all created audio output devices: |
| 1538 | </p> | </p> |
| # | Line 1501 Intellectual Property and Copyright Stat | Line 1542 Intellectual Property and Copyright Stat |
| 1542 | <p>GET AUDIO_OUTPUT_DEVICES | <p>GET AUDIO_OUTPUT_DEVICES |
| 1543 | </p> | </p> |
| 1544 | </blockquote><p> | </blockquote><p> |
| 1545 | ||
| 1546 | </p> | </p> |
| 1547 | <p>Possible Answers: | <p>Possible Answers: |
| 1548 | </p> | </p> |
| # | Line 1512 Intellectual Property and Copyright Stat | Line 1553 Intellectual Property and Copyright Stat |
| 1553 | audio output devices. | audio output devices. |
| 1554 | </p> | </p> |
| 1555 | </blockquote><p> | </blockquote><p> |
| 1556 | ||
| 1557 | </p> | </p> |
| 1558 | <p>Example: | <p>Example: |
| 1559 | </p> | </p> |
| # | Line 1524 Intellectual Property and Copyright Stat | Line 1565 Intellectual Property and Copyright Stat |
| 1565 | <p>S: "4" | <p>S: "4" |
| 1566 | </p> | </p> |
| 1567 | </blockquote><p> | </blockquote><p> |
| 1568 | ||
| 1569 | </p> | </p> |
| 1570 | <a name="rfc.section.6.2.8"></a><h4><a name="LIST AUDIO_OUTPUT_DEVICES">6.2.8</a> Getting all created audio output device list</h4> | <a name="LIST AUDIO_OUTPUT_DEVICES"></a><br /><hr /> |
| 1571 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 1572 | <a name="rfc.section.6.2.8"></a><h3>6.2.8. Getting all created audio output device list</h3> | |
| 1573 | ||
| 1574 | <p>Use the following command to list all created audio output devices: | <p>Use the following command to list all created audio output devices: |
| 1575 | </p> | </p> |
| # | Line 1536 Intellectual Property and Copyright Stat | Line 1579 Intellectual Property and Copyright Stat |
| 1579 | <p>LIST AUDIO_OUTPUT_DEVICES | <p>LIST AUDIO_OUTPUT_DEVICES |
| 1580 | </p> | </p> |
| 1581 | </blockquote><p> | </blockquote><p> |
| 1582 | ||
| 1583 | </p> | </p> |
| 1584 | <p>Possible Answers: | <p>Possible Answers: |
| 1585 | </p> | </p> |
| # | Line 1547 Intellectual Property and Copyright Stat | Line 1590 Intellectual Property and Copyright Stat |
| 1590 | the numerical IDs of all audio output devices. | the numerical IDs of all audio output devices. |
| 1591 | </p> | </p> |
| 1592 | </blockquote><p> | </blockquote><p> |
| 1593 | ||
| 1594 | </p> | </p> |
| 1595 | <p>Example: | <p>Example: |
| 1596 | </p> | </p> |
| # | Line 1559 Intellectual Property and Copyright Stat | Line 1602 Intellectual Property and Copyright Stat |
| 1602 | <p>S: "0,1,4,5" | <p>S: "0,1,4,5" |
| 1603 | </p> | </p> |
| 1604 | </blockquote><p> | </blockquote><p> |
| 1605 | ||
| 1606 | </p> | </p> |
| 1607 | <a name="rfc.section.6.2.9"></a><h4><a name="GET AUDIO_OUTPUT_DEVICE INFO">6.2.9</a> Getting current settings of an audio output device</h4> | <a name="GET AUDIO_OUTPUT_DEVICE INFO"></a><br /><hr /> |
| 1608 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 1609 | <a name="rfc.section.6.2.9"></a><h3>6.2.9. Getting current settings of an audio output device</h3> | |
| 1610 | ||
| 1611 | <p>Use the following command to get current settings of a specific, created audio output device: | <p>Use the following command to get current settings of a specific, created audio output device: |
| 1612 | </p> | </p> |
| # | Line 1571 Intellectual Property and Copyright Stat | Line 1616 Intellectual Property and Copyright Stat |
| 1616 | <p>GET AUDIO_OUTPUT_DEVICE INFO <device-id> | <p>GET AUDIO_OUTPUT_DEVICE INFO <device-id> |
| 1617 | </p> | </p> |
| 1618 | </blockquote><p> | </blockquote><p> |
| 1619 | ||
| 1620 | </p> | </p> |
| 1621 | <p>Where <device-id> should be replaced by numerical ID | <p>Where <device-id> should be replaced by numerical ID |
| 1622 | of the audio output device as e.g. returned by the | of the audio output device as e.g. returned by the |
| # | Line 1598 Intellectual Property and Copyright Stat | Line 1643 Intellectual Property and Copyright Stat |
| 1643 | <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> | <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> |
| 1644 | command | command |
| 1645 | </p> | </p> |
| 1646 | </blockquote><p> | </blockquote> |
| 1647 | ||
| 1648 | ||
| </p> | ||
| 1649 | <p>CHANNELS - | <p>CHANNELS - |
| 1650 | </p> | </p> |
| 1651 | <blockquote class="text"> | <blockquote class="text"> |
| 1652 | <p>amount of audio output channels this device currently | <p>amount of audio output channels this device currently |
| 1653 | offers | offers |
| 1654 | </p> | </p> |
| 1655 | </blockquote><p> | </blockquote> |
| 1656 | ||
| 1657 | ||
| </p> | ||
| 1658 | <p>SAMPLERATE - | <p>SAMPLERATE - |
| 1659 | </p> | </p> |
| 1660 | <blockquote class="text"> | <blockquote class="text"> |
| 1661 | <p>playback sample rate the device uses | <p>playback sample rate the device uses |
| 1662 | </p> | </p> |
| 1663 | </blockquote><p> | </blockquote> |
| 1664 | ||
| 1665 | ||
| </p> | ||
| 1666 | <p>ACTIVE - | <p>ACTIVE - |
| 1667 | </p> | </p> |
| 1668 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1626 Intellectual Property and Copyright Stat | Line 1671 Intellectual Property and Copyright Stat |
| 1671 | sampler channels connected to this audio device render | sampler channels connected to this audio device render |
| 1672 | any audio | any audio |
| 1673 | </p> | </p> |
| 1674 | </blockquote><p> | </blockquote> |
| 1675 | ||
| 1676 | ||
| </p> | ||
| 1677 | </blockquote><p> | </blockquote><p> |
| 1678 | ||
| 1679 | </p> | </p> |
| 1680 | <p>The mentioned fields above don't have to be in particular | <p>The mentioned fields above don't have to be in particular |
| 1681 | order. The fields above are only those fields which are | order. The fields above are only those fields which are |
| # | Line 1663 Intellectual Property and Copyright Stat | Line 1708 Intellectual Property and Copyright Stat |
| 1708 | <p> "." | <p> "." |
| 1709 | </p> | </p> |
| 1710 | </blockquote><p> | </blockquote><p> |
| 1711 | ||
| 1712 | </p> | </p> |
| 1713 | <a name="rfc.section.6.2.10"></a><h4><a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER">6.2.10</a> Changing settings of audio output devices</h4> | <a name="SET AUDIO_OUTPUT_DEVICE_PARAMETER"></a><br /><hr /> |
| 1714 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 1715 | <a name="rfc.section.6.2.10"></a><h3>6.2.10. Changing settings of audio output devices</h3> | |
| 1716 | ||
| 1717 | <p>Use the following command to alter a specific setting of a created audio output device: | <p>Use the following command to alter a specific setting of a created audio output device: |
| 1718 | </p> | </p> |
| # | Line 1675 Intellectual Property and Copyright Stat | Line 1722 Intellectual Property and Copyright Stat |
| 1722 | <p>SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value> | <p>SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value> |
| 1723 | </p> | </p> |
| 1724 | </blockquote><p> | </blockquote><p> |
| 1725 | ||
| 1726 | </p> | </p> |
| 1727 | <p>Where <device-id> should be replaced by the numerical ID of the | <p>Where <device-id> should be replaced by the numerical ID of the |
| 1728 | audio output device as given by the | audio output device as given by the |
| # | Line 1694 Intellectual Property and Copyright Stat | Line 1741 Intellectual Property and Copyright Stat |
| 1741 | <blockquote class="text"> | <blockquote class="text"> |
| 1742 | <p>in case setting was successfully changed | <p>in case setting was successfully changed |
| 1743 | </p> | </p> |
| 1744 | </blockquote><p> | </blockquote> |
| 1745 | ||
| 1746 | ||
| </p> | ||
| 1747 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 1748 | </p> | </p> |
| 1749 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1704 Intellectual Property and Copyright Stat | Line 1751 Intellectual Property and Copyright Stat |
| 1751 | noteworthy issue(s) related, providing an appropriate | noteworthy issue(s) related, providing an appropriate |
| 1752 | warning code and warning message | warning code and warning message |
| 1753 | </p> | </p> |
| 1754 | </blockquote><p> | </blockquote> |
| 1755 | ||
| 1756 | ||
| </p> | ||
| 1757 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 1758 | </p> | </p> |
| 1759 | <blockquote class="text"> | <blockquote class="text"> |
| 1760 | <p>in case it failed, providing an appropriate error code and | <p>in case it failed, providing an appropriate error code and |
| 1761 | error message | error message |
| 1762 | </p> | </p> |
| 1763 | </blockquote><p> | </blockquote> |
| 1764 | ||
| 1765 | ||
| </p> | ||
| 1766 | </blockquote><p> | </blockquote><p> |
| 1767 | ||
| 1768 | </p> | </p> |
| 1769 | <p>Example: | <p>Example: |
| 1770 | </p> | </p> |
| # | Line 1729 Intellectual Property and Copyright Stat | Line 1776 Intellectual Property and Copyright Stat |
| 1776 | <p>S: "OK" | <p>S: "OK" |
| 1777 | </p> | </p> |
| 1778 | </blockquote><p> | </blockquote><p> |
| 1779 | ||
| 1780 | </p> | </p> |
| 1781 | <a name="rfc.section.6.2.11"></a><h4><a name="GET AUDIO_OUTPUT_CHANNEL INFO">6.2.11</a> Getting information about an audio channel</h4> | <a name="GET AUDIO_OUTPUT_CHANNEL INFO"></a><br /><hr /> |
| 1782 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 1783 | <a name="rfc.section.6.2.11"></a><h3>6.2.11. Getting information about an audio channel</h3> | |
| 1784 | ||
| 1785 | <p>Use the following command to get information about an audio channel: | <p>Use the following command to get information about an audio channel: |
| 1786 | </p> | </p> |
| # | Line 1741 Intellectual Property and Copyright Stat | Line 1790 Intellectual Property and Copyright Stat |
| 1790 | <p>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan> | <p>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan> |
| 1791 | </p> | </p> |
| 1792 | </blockquote><p> | </blockquote><p> |
| 1793 | ||
| 1794 | </p> | </p> |
| 1795 | <p>Where <device-id> is the numerical ID of the audio output device as given by the | <p>Where <device-id> is the numerical ID of the audio output device as given by the |
| 1796 | <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> | <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> |
| # | Line 1768 Intellectual Property and Copyright Stat | Line 1817 Intellectual Property and Copyright Stat |
| 1817 | <p>arbitrary character string naming the channel, which | <p>arbitrary character string naming the channel, which |
| 1818 | doesn't have to be unique (always returned by all audio channels) | doesn't have to be unique (always returned by all audio channels) |
| 1819 | </p> | </p> |
| 1820 | </blockquote><p> | </blockquote> |
| 1821 | ||
| 1822 | ||
| </p> | ||
| 1823 | <p>IS_MIX_CHANNEL - | <p>IS_MIX_CHANNEL - |
| 1824 | </p> | </p> |
| 1825 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1781 Intellectual Property and Copyright Stat | Line 1830 Intellectual Property and Copyright Stat |
| 1830 | channels than the used audio system might be able to offer | channels than the used audio system might be able to offer |
| 1831 | (always returned by all audio channels) | (always returned by all audio channels) |
| 1832 | </p> | </p> |
| 1833 | </blockquote><p> | </blockquote> |
| 1834 | ||
| 1835 | ||
| </p> | ||
| 1836 | <p>MIX_CHANNEL_DESTINATION - | <p>MIX_CHANNEL_DESTINATION - |
| 1837 | </p> | </p> |
| 1838 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1793 Intellectual Property and Copyright Stat | Line 1842 Intellectual Property and Copyright Stat |
| 1842 | the audio signal actually will be routed / added to | the audio signal actually will be routed / added to |
| 1843 | (only returned in case the audio channel is mix channel) | (only returned in case the audio channel is mix channel) |
| 1844 | </p> | </p> |
| 1845 | </blockquote><p> | </blockquote> |
| 1846 | ||
| 1847 | ||
| 1848 | </p> | </blockquote> |
| 1849 | </blockquote><p> | |
| 1850 | ||
| </p> | ||
| 1851 | </blockquote><p> | </blockquote><p> |
| 1852 | ||
| 1853 | </p> | </p> |
| 1854 | <p>The mentioned fields above don't have to be in particular | <p>The mentioned fields above don't have to be in particular |
| 1855 | order. The fields above are only those fields which are | order. The fields above are only those fields which are |
| # | Line 1823 Intellectual Property and Copyright Stat | Line 1872 Intellectual Property and Copyright Stat |
| 1872 | <p> "." | <p> "." |
| 1873 | </p> | </p> |
| 1874 | </blockquote><p> | </blockquote><p> |
| 1875 | ||
| 1876 | </p> | </p> |
| 1877 | <p> | <p> |
| 1878 | </p> | </p> |
| # | Line 1837 Intellectual Property and Copyright Stat | Line 1886 Intellectual Property and Copyright Stat |
| 1886 | <p> "." | <p> "." |
| 1887 | </p> | </p> |
| 1888 | </blockquote><p> | </blockquote><p> |
| 1889 | ||
| 1890 | </p> | </p> |
| 1891 | <p> | <p> |
| 1892 | </p> | </p> |
| # | Line 1853 Intellectual Property and Copyright Stat | Line 1902 Intellectual Property and Copyright Stat |
| 1902 | <p> "." | <p> "." |
| 1903 | </p> | </p> |
| 1904 | </blockquote><p> | </blockquote><p> |
| 1905 | ||
| 1906 | </p> | </p> |
| 1907 | <p> | <p> |
| 1908 | </p> | </p> |
| # | Line 1869 Intellectual Property and Copyright Stat | Line 1918 Intellectual Property and Copyright Stat |
| 1918 | <p> "." | <p> "." |
| 1919 | </p> | </p> |
| 1920 | </blockquote><p> | </blockquote><p> |
| 1921 | ||
| 1922 | </p> | </p> |
| 1923 | <a name="rfc.section.6.2.12"></a><h4><a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">6.2.12</a> Getting information about specific audio channel parameter</h4> | <a name="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"></a><br /><hr /> |
| 1924 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 1925 | <a name="rfc.section.6.2.12"></a><h3>6.2.12. Getting information about specific audio channel parameter</h3> | |
| 1926 | ||
| 1927 | <p>Use the following command to get detailed information about specific audio channel parameter: | <p>Use the following command to get detailed information about specific audio channel parameter: |
| 1928 | </p> | </p> |
| # | Line 1881 Intellectual Property and Copyright Stat | Line 1932 Intellectual Property and Copyright Stat |
| 1932 | <p>GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param> | <p>GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param> |
| 1933 | </p> | </p> |
| 1934 | </blockquote><p> | </blockquote><p> |
| 1935 | ||
| 1936 | </p> | </p> |
| 1937 | <p>Where <dev-id> is the numerical ID of the audio output device as returned by the | <p>Where <dev-id> is the numerical ID of the audio output device as returned by the |
| 1938 | <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> | <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> |
| # | Line 1915 Intellectual Property and Copyright Stat | Line 1966 Intellectual Property and Copyright Stat |
| 1966 | character string(s) | character string(s) |
| 1967 | (always returned) | (always returned) |
| 1968 | </p> | </p> |
| 1969 | </blockquote><p> | </blockquote> |
| 1970 | ||
| 1971 | ||
| </p> | ||
| 1972 | <p>DESCRIPTION - | <p>DESCRIPTION - |
| 1973 | </p> | </p> |
| 1974 | <blockquote class="text"> | <blockquote class="text"> |
| 1975 | <p>arbitrary text describing the purpose of the parameter (always returned) | <p>arbitrary text describing the purpose of the parameter (always returned) |
| 1976 | </p> | </p> |
| 1977 | </blockquote><p> | </blockquote> |
| 1978 | ||
| 1979 | ||
| </p> | ||
| 1980 | <p>FIX - | <p>FIX - |
| 1981 | </p> | </p> |
| 1982 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1933 Intellectual Property and Copyright Stat | Line 1984 Intellectual Property and Copyright Stat |
| 1984 | read only, thus cannot be altered | read only, thus cannot be altered |
| 1985 | (always returned) | (always returned) |
| 1986 | </p> | </p> |
| 1987 | </blockquote><p> | </blockquote> |
| 1988 | ||
| 1989 | ||
| </p> | ||
| 1990 | <p>MULTIPLICITY - | <p>MULTIPLICITY - |
| 1991 | </p> | </p> |
| 1992 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1944 Intellectual Property and Copyright Stat | Line 1995 Intellectual Property and Copyright Stat |
| 1995 | multiple values and false only a single value allowed | multiple values and false only a single value allowed |
| 1996 | (always returned) | (always returned) |
| 1997 | </p> | </p> |
| 1998 | </blockquote><p> | </blockquote> |
| 1999 | ||
| 2000 | ||
| </p> | ||
| 2001 | <p>RANGE_MIN - | <p>RANGE_MIN - |
| 2002 | </p> | </p> |
| 2003 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1957 Intellectual Property and Copyright Stat | Line 2008 Intellectual Property and Copyright Stat |
| 2008 | (optionally returned, dependent to driver and channel | (optionally returned, dependent to driver and channel |
| 2009 | parameter) | parameter) |
| 2010 | </p> | </p> |
| 2011 | </blockquote><p> | </blockquote> |
| 2012 | ||
| 2013 | ||
| </p> | ||
| 2014 | <p>RANGE_MAX - | <p>RANGE_MAX - |
| 2015 | </p> | </p> |
| 2016 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1970 Intellectual Property and Copyright Stat | Line 2021 Intellectual Property and Copyright Stat |
| 2021 | (optionally returned, dependent to driver and channel | (optionally returned, dependent to driver and channel |
| 2022 | parameter) | parameter) |
| 2023 | </p> | </p> |
| 2024 | </blockquote><p> | </blockquote> |
| 2025 | ||
| 2026 | ||
| </p> | ||
| 2027 | <p>POSSIBILITIES - | <p>POSSIBILITIES - |
| 2028 | </p> | </p> |
| 2029 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 1982 Intellectual Property and Copyright Stat | Line 2033 Intellectual Property and Copyright Stat |
| 2033 | (optionally returned, dependent to driver and channel | (optionally returned, dependent to driver and channel |
| 2034 | parameter) | parameter) |
| 2035 | </p> | </p> |
| 2036 | </blockquote><p> | </blockquote> |
| 2037 | ||
| 2038 | ||
| 2039 | </p> | </blockquote> |
| 2040 | </blockquote><p> | |
| 2041 | ||
| </p> | ||
| 2042 | <p>The mentioned fields above don't have to be in particular order. | <p>The mentioned fields above don't have to be in particular order. |
| 2043 | </p> | </p> |
| 2044 | </blockquote><p> | </blockquote><p> |
| 2045 | ||
| 2046 | </p> | </p> |
| 2047 | <p>Example: | <p>Example: |
| 2048 | </p> | </p> |
| # | Line 2013 Intellectual Property and Copyright Stat | Line 2064 Intellectual Property and Copyright Stat |
| 2064 | <p> "." | <p> "." |
| 2065 | </p> | </p> |
| 2066 | </blockquote><p> | </blockquote><p> |
| 2067 | ||
| 2068 | </p> | </p> |
| 2069 | <a name="rfc.section.6.2.13"></a><h4><a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">6.2.13</a> Changing settings of audio output channels</h4> | <a name="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"></a><br /><hr /> |
| 2070 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2071 | <a name="rfc.section.6.2.13"></a><h3>6.2.13. Changing settings of audio output channels</h3> | |
| 2072 | ||
| 2073 | <p>Use the following command to alter a specific setting of an audio output channel: | <p>Use the following command to alter a specific setting of an audio output channel: |
| 2074 | </p> | </p> |
| # | Line 2025 Intellectual Property and Copyright Stat | Line 2078 Intellectual Property and Copyright Stat |
| 2078 | <p>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value> | <p>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value> |
| 2079 | </p> | </p> |
| 2080 | </blockquote><p> | </blockquote><p> |
| 2081 | ||
| 2082 | </p> | </p> |
| 2083 | <p>Where <dev-id> should be replaced by the numerical ID of the audio output device as returned by the | <p>Where <dev-id> should be replaced by the numerical ID of the audio output device as returned by the |
| 2084 | <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> | <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> |
| # | Line 2043 Intellectual Property and Copyright Stat | Line 2096 Intellectual Property and Copyright Stat |
| 2096 | <blockquote class="text"> | <blockquote class="text"> |
| 2097 | <p>in case setting was successfully changed | <p>in case setting was successfully changed |
| 2098 | </p> | </p> |
| 2099 | </blockquote><p> | </blockquote> |
| 2100 | ||
| 2101 | ||
| </p> | ||
| 2102 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 2103 | </p> | </p> |
| 2104 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2053 Intellectual Property and Copyright Stat | Line 2106 Intellectual Property and Copyright Stat |
| 2106 | noteworthy issue(s) related, providing an appropriate | noteworthy issue(s) related, providing an appropriate |
| 2107 | warning code and warning message | warning code and warning message |
| 2108 | </p> | </p> |
| 2109 | </blockquote><p> | </blockquote> |
| 2110 | ||
| 2111 | ||
| </p> | ||
| 2112 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 2113 | </p> | </p> |
| 2114 | <blockquote class="text"> | <blockquote class="text"> |
| 2115 | <p>in case it failed, providing an appropriate error code and | <p>in case it failed, providing an appropriate error code and |
| 2116 | error message | error message |
| 2117 | </p> | </p> |
| 2118 | </blockquote><p> | </blockquote> |
| 2119 | ||
| 2120 | ||
| </p> | ||
| 2121 | </blockquote><p> | </blockquote><p> |
| 2122 | ||
| 2123 | </p> | </p> |
| 2124 | <p>Example: | <p>Example: |
| 2125 | </p> | </p> |
| # | Line 2078 Intellectual Property and Copyright Stat | Line 2131 Intellectual Property and Copyright Stat |
| 2131 | <p>S: "OK" | <p>S: "OK" |
| 2132 | </p> | </p> |
| 2133 | </blockquote><p> | </blockquote><p> |
| 2134 | ||
| 2135 | </p> | </p> |
| 2136 | <p> | <p> |
| 2137 | </p> | </p> |
| # | Line 2088 Intellectual Property and Copyright Stat | Line 2141 Intellectual Property and Copyright Stat |
| 2141 | <p>S: "OK" | <p>S: "OK" |
| 2142 | </p> | </p> |
| 2143 | </blockquote><p> | </blockquote><p> |
| 2144 | ||
| 2145 | </p> | </p> |
| 2146 | <a name="rfc.section.6.3"></a><h4><a name="anchor10">6.3</a> Configuring MIDI input drivers</h4> | <a name="anchor10"></a><br /><hr /> |
| 2147 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2148 | <a name="rfc.section.6.3"></a><h3>6.3. Configuring MIDI input drivers</h3> | |
| 2149 | ||
| 2150 | <p>Instances of drivers in LinuxSampler are called devices. You can use | <p>Instances of drivers in LinuxSampler are called devices. You can use |
| 2151 | multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as | multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as |
| # | Line 2118 Intellectual Property and Copyright Stat | Line 2173 Intellectual Property and Copyright Stat |
| 2173 | showing how to retrieve what parameters drivers are offering, how to retrieve their | showing how to retrieve what parameters drivers are offering, how to retrieve their |
| 2174 | possible values, etc. | possible values, etc. |
| 2175 | </p> | </p> |
| 2176 | <a name="rfc.section.6.3.1"></a><h4><a name="GET AVAILABLE_MIDI_INPUT_DRIVERS">6.3.1</a> Getting amount of available MIDI input drivers</h4> | <a name="GET AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr /> |
| 2177 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2178 | <a name="rfc.section.6.3.1"></a><h3>6.3.1. Getting amount of available MIDI input drivers</h3> | |
| 2179 | ||
| 2180 | <p>Use the following command to get the number of | <p>Use the following command to get the number of |
| 2181 | MIDI input drivers currently available for the | MIDI input drivers currently available for the |
| # | Line 2130 Intellectual Property and Copyright Stat | Line 2187 Intellectual Property and Copyright Stat |
| 2187 | <p>GET AVAILABLE_MIDI_INPUT_DRIVERS | <p>GET AVAILABLE_MIDI_INPUT_DRIVERS |
| 2188 | </p> | </p> |
| 2189 | </blockquote><p> | </blockquote><p> |
| 2190 | ||
| 2191 | </p> | </p> |
| 2192 | <p>Possible Answers: | <p>Possible Answers: |
| 2193 | </p> | </p> |
| # | Line 2141 Intellectual Property and Copyright Stat | Line 2198 Intellectual Property and Copyright Stat |
| 2198 | number of available MIDI input drivers. | number of available MIDI input drivers. |
| 2199 | </p> | </p> |
| 2200 | </blockquote><p> | </blockquote><p> |
| 2201 | ||
| 2202 | </p> | </p> |
| 2203 | <p>Example: | <p>Example: |
| 2204 | </p> | </p> |
| # | Line 2153 Intellectual Property and Copyright Stat | Line 2210 Intellectual Property and Copyright Stat |
| 2210 | <p>S: "2" | <p>S: "2" |
| 2211 | </p> | </p> |
| 2212 | </blockquote><p> | </blockquote><p> |
| 2213 | ||
| 2214 | </p> | </p> |
| 2215 | <a name="rfc.section.6.3.2"></a><h4><a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS">6.3.2</a> Getting all available MIDI input drivers</h4> | <a name="LIST AVAILABLE_MIDI_INPUT_DRIVERS"></a><br /><hr /> |
| 2216 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2217 | <a name="rfc.section.6.3.2"></a><h3>6.3.2. Getting all available MIDI input drivers</h3> | |
| 2218 | ||
| 2219 | <p>Use the following command to list all MIDI input drivers currently available | <p>Use the following command to list all MIDI input drivers currently available |
| 2220 | for the LinuxSampler instance: | for the LinuxSampler instance: |
| # | Line 2166 Intellectual Property and Copyright Stat | Line 2225 Intellectual Property and Copyright Stat |
| 2225 | <p>LIST AVAILABLE_MIDI_INPUT_DRIVERS | <p>LIST AVAILABLE_MIDI_INPUT_DRIVERS |
| 2226 | </p> | </p> |
| 2227 | </blockquote><p> | </blockquote><p> |
| 2228 | ||
| 2229 | </p> | </p> |
| 2230 | <p>Possible Answers: | <p>Possible Answers: |
| 2231 | </p> | </p> |
| # | Line 2177 Intellectual Property and Copyright Stat | Line 2236 Intellectual Property and Copyright Stat |
| 2236 | strings, each symbolizing a MIDI input driver. | strings, each symbolizing a MIDI input driver. |
| 2237 | </p> | </p> |
| 2238 | </blockquote><p> | </blockquote><p> |
| 2239 | ||
| 2240 | </p> | </p> |
| 2241 | <p>Example: | <p>Example: |
| 2242 | </p> | </p> |
| # | Line 2189 Intellectual Property and Copyright Stat | Line 2248 Intellectual Property and Copyright Stat |
| 2248 | <p>S: "ALSA,JACK" | <p>S: "ALSA,JACK" |
| 2249 | </p> | </p> |
| 2250 | </blockquote><p> | </blockquote><p> |
| 2251 | ||
| 2252 | </p> | </p> |
| 2253 | <a name="rfc.section.6.3.3"></a><h4><a name="GET MIDI_INPUT_DRIVER INFO">6.3.3</a> Getting information about a specific MIDI input driver</h4> | <a name="GET MIDI_INPUT_DRIVER INFO"></a><br /><hr /> |
| 2254 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2255 | <a name="rfc.section.6.3.3"></a><h3>6.3.3. Getting information about a specific MIDI input driver</h3> | |
| 2256 | ||
| 2257 | <p>Use the following command to get detailed information about a specific MIDI input driver: | <p>Use the following command to get detailed information about a specific MIDI input driver: |
| 2258 | </p> | </p> |
| # | Line 2201 Intellectual Property and Copyright Stat | Line 2262 Intellectual Property and Copyright Stat |
| 2262 | <p>GET MIDI_INPUT_DRIVER INFO <midi-input-driver> | <p>GET MIDI_INPUT_DRIVER INFO <midi-input-driver> |
| 2263 | </p> | </p> |
| 2264 | </blockquote><p> | </blockquote><p> |
| 2265 | ||
| 2266 | </p> | </p> |
| 2267 | <p>Where <midi-input-driver> is the name of the MIDI input driver as returned | <p>Where <midi-input-driver> is the name of the MIDI input driver as returned |
| 2268 | 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. | 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. |
| # | Line 2225 Intellectual Property and Copyright Stat | Line 2286 Intellectual Property and Copyright Stat |
| 2286 | <blockquote class="text"> | <blockquote class="text"> |
| 2287 | <p>arbitrary description text about the MIDI input driver | <p>arbitrary description text about the MIDI input driver |
| 2288 | </p> | </p> |
| 2289 | </blockquote><p> | </blockquote> |
| 2290 | ||
| 2291 | ||
| </p> | ||
| 2292 | <p>VERSION - | <p>VERSION - |
| 2293 | </p> | </p> |
| 2294 | <blockquote class="text"> | <blockquote class="text"> |
| 2295 | <p>arbitrary character string regarding the driver's version | <p>arbitrary character string regarding the driver's version |
| 2296 | </p> | </p> |
| 2297 | </blockquote><p> | </blockquote> |
| 2298 | ||
| 2299 | ||
| </p> | ||
| 2300 | <p>PARAMETERS - | <p>PARAMETERS - |
| 2301 | </p> | </p> |
| 2302 | <blockquote class="text"> | <blockquote class="text"> |
| 2303 | <p>comma separated list of all parameters available for the given MIDI input driver | <p>comma separated list of all parameters available for the given MIDI input driver |
| 2304 | </p> | </p> |
| 2305 | </blockquote><p> | </blockquote> |
| 2306 | ||
| 2307 | ||
| 2308 | </p> | </blockquote> |
| 2309 | </blockquote><p> | |
| 2310 | ||
| </p> | ||
| 2311 | <p>The mentioned fields above don't have to be in particular order. | <p>The mentioned fields above don't have to be in particular order. |
| 2312 | </p> | </p> |
| 2313 | </blockquote><p> | </blockquote><p> |
| 2314 | ||
| 2315 | </p> | </p> |
| 2316 | <p>Example: | <p>Example: |
| 2317 | </p> | </p> |
| # | Line 2268 Intellectual Property and Copyright Stat | Line 2329 Intellectual Property and Copyright Stat |
| 2329 | <p> "." | <p> "." |
| 2330 | </p> | </p> |
| 2331 | </blockquote><p> | </blockquote><p> |
| 2332 | ||
| 2333 | </p> | </p> |
| 2334 | <a name="rfc.section.6.3.4"></a><h4><a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO">6.3.4</a> Getting information about specific MIDI input driver parameter</h4> | <a name="GET MIDI_INPUT_DRIVER_PARAMETER INFO"></a><br /><hr /> |
| 2335 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2336 | <a name="rfc.section.6.3.4"></a><h3>6.3.4. Getting information about specific MIDI input driver parameter</h3> | |
| 2337 | ||
| 2338 | <p>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver: | <p>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver: |
| 2339 | </p> | </p> |
| # | Line 2280 Intellectual Property and Copyright Stat | Line 2343 Intellectual Property and Copyright Stat |
| 2343 | <p>GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>] | <p>GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>] |
| 2344 | </p> | </p> |
| 2345 | </blockquote><p> | </blockquote><p> |
| 2346 | ||
| 2347 | </p> | </p> |
| 2348 | <p>Where <midit> is the name of the MIDI input driver as returned | <p>Where <midit> is the name of the MIDI input driver as returned |
| 2349 | 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, <param> a specific | 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, <param> a specific |
| # | Line 2315 Intellectual Property and Copyright Stat | Line 2378 Intellectual Property and Copyright Stat |
| 2378 | character string(s) | character string(s) |
| 2379 | (always returned, no matter which driver parameter) | (always returned, no matter which driver parameter) |
| 2380 | </p> | </p> |
| 2381 | </blockquote><p> | </blockquote> |
| 2382 | ||
| 2383 | ||
| </p> | ||
| 2384 | <p>DESCRIPTION - | <p>DESCRIPTION - |
| 2385 | </p> | </p> |
| 2386 | <blockquote class="text"> | <blockquote class="text"> |
| 2387 | <p>arbitrary text describing the purpose of the parameter | <p>arbitrary text describing the purpose of the parameter |
| 2388 | (always returned, no matter which driver parameter) | (always returned, no matter which driver parameter) |
| 2389 | </p> | </p> |
| 2390 | </blockquote><p> | </blockquote> |
| 2391 | ||
| 2392 | ||
| </p> | ||
| 2393 | <p>MANDATORY - | <p>MANDATORY - |
| 2394 | </p> | </p> |
| 2395 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2335 Intellectual Property and Copyright Stat | Line 2398 Intellectual Property and Copyright Stat |
| 2398 | <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 | <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 |
| 2399 | (always returned, no matter which driver parameter) | (always returned, no matter which driver parameter) |
| 2400 | </p> | </p> |
| 2401 | </blockquote><p> | </blockquote> |
| 2402 | ||
| 2403 | ||
| </p> | ||
| 2404 | <p>FIX - | <p>FIX - |
| 2405 | </p> | </p> |
| 2406 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2346 Intellectual Property and Copyright Stat | Line 2409 Intellectual Property and Copyright Stat |
| 2409 | 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 | 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 |
| 2410 | (always returned, no matter which driver parameter) | (always returned, no matter which driver parameter) |
| 2411 | </p> | </p> |
| 2412 | </blockquote><p> | </blockquote> |
| 2413 | ||
| 2414 | ||
| </p> | ||
| 2415 | <p>MULTIPLICITY - | <p>MULTIPLICITY - |
| 2416 | </p> | </p> |
| 2417 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2357 Intellectual Property and Copyright Stat | Line 2420 Intellectual Property and Copyright Stat |
| 2420 | multiple values and false only a single value allowed | multiple values and false only a single value allowed |
| 2421 | (always returned, no matter which driver parameter) | (always returned, no matter which driver parameter) |
| 2422 | </p> | </p> |
| 2423 | </blockquote><p> | </blockquote> |
| 2424 | ||
| 2425 | ||
| </p> | ||
| 2426 | <p>DEPENDS - | <p>DEPENDS - |
| 2427 | </p> | </p> |
| 2428 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2374 Intellectual Property and Copyright Stat | Line 2437 Intellectual Property and Copyright Stat |
| 2437 | chosen by the 'card' parameter | chosen by the 'card' parameter |
| 2438 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 2439 | </p> | </p> |
| 2440 | </blockquote><p> | </blockquote> |
| 2441 | ||
| 2442 | ||
| </p> | ||
| 2443 | <p>DEFAULT - | <p>DEFAULT - |
| 2444 | </p> | </p> |
| 2445 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2388 Intellectual Property and Copyright Stat | Line 2451 Intellectual Property and Copyright Stat |
| 2451 | apostrophes (') | apostrophes (') |
| 2452 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 2453 | </p> | </p> |
| 2454 | </blockquote><p> | </blockquote> |
| 2455 | ||
| 2456 | ||
| </p> | ||
| 2457 | <p>RANGE_MIN - | <p>RANGE_MIN - |
| 2458 | </p> | </p> |
| 2459 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2400 Intellectual Property and Copyright Stat | Line 2463 Intellectual Property and Copyright Stat |
| 2463 | with RANGE_MAX, but may also appear without | with RANGE_MAX, but may also appear without |
| 2464 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 2465 | </p> | </p> |
| 2466 | </blockquote><p> | </blockquote> |
| 2467 | ||
| 2468 | ||
| </p> | ||
| 2469 | <p>RANGE_MAX - | <p>RANGE_MAX - |
| 2470 | </p> | </p> |
| 2471 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2412 Intellectual Property and Copyright Stat | Line 2475 Intellectual Property and Copyright Stat |
| 2475 | RANGE_MIN, but may also appear without | RANGE_MIN, but may also appear without |
| 2476 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 2477 | </p> | </p> |
| 2478 | </blockquote><p> | </blockquote> |
| 2479 | ||
| 2480 | ||
| </p> | ||
| 2481 | <p>POSSIBILITIES - | <p>POSSIBILITIES - |
| 2482 | </p> | </p> |
| 2483 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2423 Intellectual Property and Copyright Stat | Line 2486 Intellectual Property and Copyright Stat |
| 2486 | apostrophes | apostrophes |
| 2487 | (optionally returned, dependent to driver parameter) | (optionally returned, dependent to driver parameter) |
| 2488 | </p> | </p> |
| 2489 | </blockquote><p> | </blockquote> |
| 2490 | ||
| 2491 | ||
| </p> | ||
| 2492 | </blockquote><p> | </blockquote><p> |
| 2493 | ||
| 2494 | </p> | </p> |
| 2495 | <p>The mentioned fields above don't have to be in particular order. | <p>The mentioned fields above don't have to be in particular order. |
| 2496 | </p> | </p> |
| # | Line 2453 Intellectual Property and Copyright Stat | Line 2516 Intellectual Property and Copyright Stat |
| 2516 | <p> "." | <p> "." |
| 2517 | </p> | </p> |
| 2518 | </blockquote><p> | </blockquote><p> |
| 2519 | ||
| 2520 | </p> | </p> |
| 2521 | <a name="rfc.section.6.3.5"></a><h4><a name="CREATE MIDI_INPUT_DEVICE">6.3.5</a> Creating a MIDI input device</h4> | <a name="CREATE MIDI_INPUT_DEVICE"></a><br /><hr /> |
| 2522 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2523 | <a name="rfc.section.6.3.5"></a><h3>6.3.5. Creating a MIDI input device</h3> | |
| 2524 | ||
| 2525 | <p>Use the following command to create a new MIDI input device for the desired MIDI input system: | <p>Use the following command to create a new MIDI input device for the desired MIDI input system: |
| 2526 | </p> | </p> |
| # | Line 2465 Intellectual Property and Copyright Stat | Line 2530 Intellectual Property and Copyright Stat |
| 2530 | <p>CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>] | <p>CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>] |
| 2531 | </p> | </p> |
| 2532 | </blockquote><p> | </blockquote><p> |
| 2533 | ||
| 2534 | </p> | </p> |
| 2535 | <p>Where <midi-input-driver> should be replaced by the desired MIDI input system as returned | <p>Where <midi-input-driver> should be replaced by the desired MIDI input system as returned |
| 2536 | 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 <param-list> by an | 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 <param-list> by an |
| # | Line 2486 Intellectual Property and Copyright Stat | Line 2551 Intellectual Property and Copyright Stat |
| 2551 | <p>in case the device was successfully created, where | <p>in case the device was successfully created, where |
| 2552 | <device-id> is the numerical ID of the new device | <device-id> is the numerical ID of the new device |
| 2553 | </p> | </p> |
| 2554 | </blockquote><p> | </blockquote> |
| 2555 | ||
| 2556 | ||
| </p> | ||
| 2557 | <p>"WRN[<device-id>]:<warning-code>:<warning-message>" - | <p>"WRN[<device-id>]:<warning-code>:<warning-message>" - |
| 2558 | </p> | </p> |
| 2559 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2497 Intellectual Property and Copyright Stat | Line 2562 Intellectual Property and Copyright Stat |
| 2562 | there are noteworthy issue(s) related, providing an | there are noteworthy issue(s) related, providing an |
| 2563 | appropriate warning code and warning message | appropriate warning code and warning message |
| 2564 | </p> | </p> |
| 2565 | </blockquote><p> | </blockquote> |
| 2566 | ||
| 2567 | ||
| </p> | ||
| 2568 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 2569 | </p> | </p> |
| 2570 | <blockquote class="text"> | <blockquote class="text"> |
| 2571 | <p>in case it failed, providing an appropriate error code and error message | <p>in case it failed, providing an appropriate error code and error message |
| 2572 | </p> | </p> |
| 2573 | </blockquote><p> | </blockquote> |
| 2574 | ||
| 2575 | ||
| </p> | ||
| 2576 | </blockquote><p> | </blockquote><p> |
| 2577 | ||
| 2578 | </p> | </p> |
| 2579 | <p>Example: | <p>Example: |
| 2580 | </p> | </p> |
| # | Line 2521 Intellectual Property and Copyright Stat | Line 2586 Intellectual Property and Copyright Stat |
| 2586 | <p>S: "OK[0]" | <p>S: "OK[0]" |
| 2587 | </p> | </p> |
| 2588 | </blockquote><p> | </blockquote><p> |
| 2589 | ||
| 2590 | </p> | </p> |
| 2591 | <a name="rfc.section.6.3.6"></a><h4><a name="DESTROY MIDI_INPUT_DEVICE">6.3.6</a> Destroying a MIDI input device</h4> | <a name="DESTROY MIDI_INPUT_DEVICE"></a><br /><hr /> |
| 2592 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2593 | <a name="rfc.section.6.3.6"></a><h3>6.3.6. Destroying a MIDI input device</h3> | |
| 2594 | ||
| 2595 | <p>Use the following command to destroy a created MIDI input device: | <p>Use the following command to destroy a created MIDI input device: |
| 2596 | </p> | </p> |
| # | Line 2533 Intellectual Property and Copyright Stat | Line 2600 Intellectual Property and Copyright Stat |
| 2600 | <p>DESTROY MIDI_INPUT_DEVICE <device-id> | <p>DESTROY MIDI_INPUT_DEVICE <device-id> |
| 2601 | </p> | </p> |
| 2602 | </blockquote><p> | </blockquote><p> |
| 2603 | ||
| 2604 | </p> | </p> |
| 2605 | <p>Where <device-id> should be replaced by the device's numerical ID as returned by the | <p>Where <device-id> should be replaced by the device's numerical ID as returned by the |
| 2606 | <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> | <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> |
| # | Line 2550 Intellectual Property and Copyright Stat | Line 2617 Intellectual Property and Copyright Stat |
| 2617 | <blockquote class="text"> | <blockquote class="text"> |
| 2618 | <p>in case the device was successfully destroyed | <p>in case the device was successfully destroyed |
| 2619 | </p> | </p> |
| 2620 | </blockquote><p> | </blockquote> |
| 2621 | ||
| 2622 | ||
| </p> | ||
| 2623 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 2624 | </p> | </p> |
| 2625 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2560 Intellectual Property and Copyright Stat | Line 2627 Intellectual Property and Copyright Stat |
| 2627 | issue(s) related, providing an appropriate warning code and | issue(s) related, providing an appropriate warning code and |
| 2628 | warning message | warning message |
| 2629 | </p> | </p> |
| 2630 | </blockquote><p> | </blockquote> |
| 2631 | ||
| 2632 | ||
| </p> | ||
| 2633 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 2634 | </p> | </p> |
| 2635 | <blockquote class="text"> | <blockquote class="text"> |
| 2636 | <p>in case it failed, providing an appropriate error code and error message | <p>in case it failed, providing an appropriate error code and error message |
| 2637 | </p> | </p> |
| 2638 | </blockquote><p> | </blockquote> |
| 2639 | ||
| 2640 | ||
| </p> | ||
| 2641 | </blockquote><p> | </blockquote><p> |
| 2642 | ||
| 2643 | </p> | </p> |
| 2644 | <p>Example: | <p>Example: |
| 2645 | </p> | </p> |
| # | Line 2584 Intellectual Property and Copyright Stat | Line 2651 Intellectual Property and Copyright Stat |
| 2651 | <p>S: "OK" | <p>S: "OK" |
| 2652 | </p> | </p> |
| 2653 | </blockquote><p> | </blockquote><p> |
| 2654 | ||
| 2655 | </p> | </p> |
| 2656 | <a name="rfc.section.6.3.7"></a><h4><a name="GET MIDI_INPUT_DEVICES">6.3.7</a> Getting all created MIDI input device count</h4> | <a name="GET MIDI_INPUT_DEVICES"></a><br /><hr /> |
| 2657 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2658 | <a name="rfc.section.6.3.7"></a><h3>6.3.7. Getting all created MIDI input device count</h3> | |
| 2659 | ||
| 2660 | <p>Use the following command to count all created MIDI input devices: | <p>Use the following command to count all created MIDI input devices: |
| 2661 | </p> | </p> |
| # | Line 2596 Intellectual Property and Copyright Stat | Line 2665 Intellectual Property and Copyright Stat |
| 2665 | <p>GET MIDI_INPUT_DEVICES | <p>GET MIDI_INPUT_DEVICES |
| 2666 | </p> | </p> |
| 2667 | </blockquote><p> | </blockquote><p> |
| 2668 | ||
| 2669 | </p> | </p> |
| 2670 | <p>Possible Answers: | <p>Possible Answers: |
| 2671 | </p> | </p> |
| # | Line 2607 Intellectual Property and Copyright Stat | Line 2676 Intellectual Property and Copyright Stat |
| 2676 | MIDI input devices. | MIDI input devices. |
| 2677 | </p> | </p> |
| 2678 | </blockquote><p> | </blockquote><p> |
| 2679 | ||
| 2680 | </p> | </p> |
| 2681 | <p>Example: | <p>Example: |
| 2682 | </p> | </p> |
| # | Line 2619 Intellectual Property and Copyright Stat | Line 2688 Intellectual Property and Copyright Stat |
| 2688 | <p>S: "3" | <p>S: "3" |
| 2689 | </p> | </p> |
| 2690 | </blockquote><p> | </blockquote><p> |
| 2691 | ||
| 2692 | </p> | </p> |
| 2693 | <a name="rfc.section.6.3.8"></a><h4><a name="LIST MIDI_INPUT_DEVICES">6.3.8</a> Getting all created MIDI input device list</h4> | <a name="LIST MIDI_INPUT_DEVICES"></a><br /><hr /> |
| 2694 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2695 | <a name="rfc.section.6.3.8"></a><h3>6.3.8. Getting all created MIDI input device list</h3> | |
| 2696 | ||
| 2697 | <p>Use the following command to list all created MIDI input devices: | <p>Use the following command to list all created MIDI input devices: |
| 2698 | </p> | </p> |
| # | Line 2631 Intellectual Property and Copyright Stat | Line 2702 Intellectual Property and Copyright Stat |
| 2702 | <p>LIST MIDI_INPUT_DEVICES | <p>LIST MIDI_INPUT_DEVICES |
| 2703 | </p> | </p> |
| 2704 | </blockquote><p> | </blockquote><p> |
| 2705 | ||
| 2706 | </p> | </p> |
| 2707 | <p>Possible Answers: | <p>Possible Answers: |
| 2708 | </p> | </p> |
| # | Line 2642 Intellectual Property and Copyright Stat | Line 2713 Intellectual Property and Copyright Stat |
| 2713 | with the numerical Ids of all created MIDI input devices. | with the numerical Ids of all created MIDI input devices. |
| 2714 | </p> | </p> |
| 2715 | </blockquote><p> | </blockquote><p> |
| 2716 | ||
| 2717 | </p> | </p> |
| 2718 | <p>Examples: | <p>Examples: |
| 2719 | </p> | </p> |
| # | Line 2654 Intellectual Property and Copyright Stat | Line 2725 Intellectual Property and Copyright Stat |
| 2725 | <p>S: "0,1,2" | <p>S: "0,1,2" |
| 2726 | </p> | </p> |
| 2727 | </blockquote><p> | </blockquote><p> |
| 2728 | ||
| 2729 | </p> | </p> |
| 2730 | <p> | <p> |
| 2731 | </p> | </p> |
| # | Line 2664 Intellectual Property and Copyright Stat | Line 2735 Intellectual Property and Copyright Stat |
| 2735 | <p>S: "1,3" | <p>S: "1,3" |
| 2736 | </p> | </p> |
| 2737 | </blockquote><p> | </blockquote><p> |
| 2738 | ||
| 2739 | </p> | </p> |
| 2740 | <a name="rfc.section.6.3.9"></a><h4><a name="GET MIDI_INPUT_DEVICE INFO">6.3.9</a> Getting current settings of a MIDI input device</h4> | <a name="GET MIDI_INPUT_DEVICE INFO"></a><br /><hr /> |
| 2741 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2742 | <a name="rfc.section.6.3.9"></a><h3>6.3.9. Getting current settings of a MIDI input device</h3> | |
| 2743 | ||
| 2744 | <p>Use the following command to get current settings of a specific, created MIDI input device: | <p>Use the following command to get current settings of a specific, created MIDI input device: |
| 2745 | </p> | </p> |
| # | Line 2676 Intellectual Property and Copyright Stat | Line 2749 Intellectual Property and Copyright Stat |
| 2749 | <p>GET MIDI_INPUT_DEVICE INFO <device-id> | <p>GET MIDI_INPUT_DEVICE INFO <device-id> |
| 2750 | </p> | </p> |
| 2751 | </blockquote><p> | </blockquote><p> |
| 2752 | ||
| 2753 | </p> | </p> |
| 2754 | <p>Where <device-id> is the numerical ID of the MIDI input device as returned by the | <p>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
| 2755 | <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> | <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> |
| # | Line 2706 Intellectual Property and Copyright Stat | Line 2779 Intellectual Property and Copyright Stat |
| 2779 | 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> | 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> |
| 2780 | command | command |
| 2781 | </p> | </p> |
| 2782 | </blockquote><p> | </blockquote> |
| 2783 | ||
| 2784 | ||
| 2785 | </p> | </blockquote> |
| 2786 | </blockquote><p> | |
| </p> | ||
| 2787 | <blockquote class="text"> | <blockquote class="text"> |
| 2788 | <p>ACTIVE - | <p>ACTIVE - |
| 2789 | </p> | </p> |
| # | Line 2720 Intellectual Property and Copyright Stat | Line 2793 Intellectual Property and Copyright Stat |
| 2793 | and thus doesn't forward them to connected sampler | and thus doesn't forward them to connected sampler |
| 2794 | channels | channels |
| 2795 | </p> | </p> |
| 2796 | </blockquote><p> | </blockquote> |
| 2797 | ||
| 2798 | ||
| 2799 | </p> | </blockquote> |
| 2800 | </blockquote><p> | |
| 2801 | ||
| </p> | ||
| 2802 | </blockquote><p> | </blockquote><p> |
| 2803 | ||
| 2804 | </p> | </p> |
| 2805 | <p>The mentioned fields above don't have to be in particular | <p>The mentioned fields above don't have to be in particular |
| 2806 | order. The fields above are only those fields which are | order. The fields above are only those fields which are |
| # | Line 2750 Intellectual Property and Copyright Stat | Line 2823 Intellectual Property and Copyright Stat |
| 2823 | <p> "." | <p> "." |
| 2824 | </p> | </p> |
| 2825 | </blockquote><p> | </blockquote><p> |
| 2826 | ||
| 2827 | </p> | </p> |
| 2828 | <a name="rfc.section.6.3.10"></a><h4><a name="SET MIDI_INPUT_DEVICE_PARAMETER">6.3.10</a> Changing settings of MIDI input devices</h4> | <a name="SET MIDI_INPUT_DEVICE_PARAMETER"></a><br /><hr /> |
| 2829 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2830 | <a name="rfc.section.6.3.10"></a><h3>6.3.10. Changing settings of MIDI input devices</h3> | |
| 2831 | ||
| 2832 | <p>Use the following command to alter a specific setting of a created MIDI input device: | <p>Use the following command to alter a specific setting of a created MIDI input device: |
| 2833 | </p> | </p> |
| # | Line 2762 Intellectual Property and Copyright Stat | Line 2837 Intellectual Property and Copyright Stat |
| 2837 | <p>SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value> | <p>SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value> |
| 2838 | </p> | </p> |
| 2839 | </blockquote><p> | </blockquote><p> |
| 2840 | ||
| 2841 | </p> | </p> |
| 2842 | <p>Where <device-id> should be replaced by the numerical ID of the | <p>Where <device-id> should be replaced by the numerical ID of the |
| 2843 | MIDI input device as returned by the | MIDI input device as returned by the |
| # | Line 2781 Intellectual Property and Copyright Stat | Line 2856 Intellectual Property and Copyright Stat |
| 2856 | <blockquote class="text"> | <blockquote class="text"> |
| 2857 | <p>in case setting was successfully changed | <p>in case setting was successfully changed |
| 2858 | </p> | </p> |
| 2859 | </blockquote><p> | </blockquote> |
| 2860 | ||
| 2861 | ||
| </p> | ||
| 2862 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 2863 | </p> | </p> |
| 2864 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2791 Intellectual Property and Copyright Stat | Line 2866 Intellectual Property and Copyright Stat |
| 2866 | noteworthy issue(s) related, providing an appropriate | noteworthy issue(s) related, providing an appropriate |
| 2867 | warning code and warning message | warning code and warning message |
| 2868 | </p> | </p> |
| 2869 | </blockquote><p> | </blockquote> |
| 2870 | ||
| 2871 | ||
| </p> | ||
| 2872 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 2873 | </p> | </p> |
| 2874 | <blockquote class="text"> | <blockquote class="text"> |
| 2875 | <p>in case it failed, providing an appropriate error code and error message | <p>in case it failed, providing an appropriate error code and error message |
| 2876 | </p> | </p> |
| 2877 | </blockquote><p> | </blockquote> |
| 2878 | ||
| 2879 | ||
| </p> | ||
| 2880 | </blockquote><p> | </blockquote><p> |
| 2881 | ||
| 2882 | </p> | </p> |
| 2883 | <p>Example: | <p>Example: |
| 2884 | </p> | </p> |
| # | Line 2815 Intellectual Property and Copyright Stat | Line 2890 Intellectual Property and Copyright Stat |
| 2890 | <p>S: "OK" | <p>S: "OK" |
| 2891 | </p> | </p> |
| 2892 | </blockquote><p> | </blockquote><p> |
| 2893 | ||
| 2894 | </p> | </p> |
| 2895 | <a name="rfc.section.6.3.11"></a><h4><a name="GET MIDI_INPUT_PORT INFO">6.3.11</a> Getting information about a MIDI port</h4> | <a name="GET MIDI_INPUT_PORT INFO"></a><br /><hr /> |
| 2896 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2897 | <a name="rfc.section.6.3.11"></a><h3>6.3.11. Getting information about a MIDI port</h3> | |
| 2898 | ||
| 2899 | <p>Use the following command to get information about a MIDI port: | <p>Use the following command to get information about a MIDI port: |
| 2900 | </p> | </p> |
| # | Line 2827 Intellectual Property and Copyright Stat | Line 2904 Intellectual Property and Copyright Stat |
| 2904 | <p>GET MIDI_INPUT_PORT INFO <device-id> <midi-port> | <p>GET MIDI_INPUT_PORT INFO <device-id> <midi-port> |
| 2905 | </p> | </p> |
| 2906 | </blockquote><p> | </blockquote><p> |
| 2907 | ||
| 2908 | </p> | </p> |
| 2909 | <p>Where <device-id> is the numerical ID of the MIDI input device as returned by the | <p>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
| 2910 | <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> | <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> |
| # | Line 2850 Intellectual Property and Copyright Stat | Line 2927 Intellectual Property and Copyright Stat |
| 2927 | <blockquote class="text"> | <blockquote class="text"> |
| 2928 | <p>arbitrary character string naming the port | <p>arbitrary character string naming the port |
| 2929 | </p> | </p> |
| 2930 | </blockquote><p> | </blockquote> |
| 2931 | ||
| 2932 | ||
| </p> | ||
| 2933 | </blockquote><p> | </blockquote><p> |
| 2934 | ||
| 2935 | </p> | </p> |
| 2936 | <p>The field above is only the one which is returned by all MIDI | <p>The field above is only the one which is returned by all MIDI |
| 2937 | ports regardless of the MIDI driver and port. Every MIDI port | ports regardless of the MIDI driver and port. Every MIDI port |
| # | Line 2875 Intellectual Property and Copyright Stat | Line 2952 Intellectual Property and Copyright Stat |
| 2952 | <p> "." | <p> "." |
| 2953 | </p> | </p> |
| 2954 | </blockquote><p> | </blockquote><p> |
| 2955 | ||
| 2956 | </p> | </p> |
| 2957 | <a name="rfc.section.6.3.12"></a><h4><a name="GET MIDI_INPUT_PORT_PARAMETER INFO">6.3.12</a> Getting information about specific MIDI port parameter</h4> | <a name="GET MIDI_INPUT_PORT_PARAMETER INFO"></a><br /><hr /> |
| 2958 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 2959 | <a name="rfc.section.6.3.12"></a><h3>6.3.12. Getting information about specific MIDI port parameter</h3> | |
| 2960 | ||
| 2961 | <p>Use the following command to get detailed information about specific MIDI port parameter: | <p>Use the following command to get detailed information about specific MIDI port parameter: |
| 2962 | </p> | </p> |
| # | Line 2887 Intellectual Property and Copyright Stat | Line 2966 Intellectual Property and Copyright Stat |
| 2966 | <p>GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param> | <p>GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param> |
| 2967 | </p> | </p> |
| 2968 | </blockquote><p> | </blockquote><p> |
| 2969 | ||
| 2970 | </p> | </p> |
| 2971 | <p>Where <dev-id> is the numerical ID of the MIDI input device as returned by the | <p>Where <dev-id> is the numerical ID of the MIDI input device as returned by the |
| 2972 | <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> | <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> |
| # | Line 2918 Intellectual Property and Copyright Stat | Line 2997 Intellectual Property and Copyright Stat |
| 2997 | character string(s) | character string(s) |
| 2998 | (always returned) | (always returned) |
| 2999 | </p> | </p> |
| 3000 | </blockquote><p> | </blockquote> |
| 3001 | ||
| 3002 | ||
| </p> | ||
| 3003 | <p>DESCRIPTION - | <p>DESCRIPTION - |
| 3004 | </p> | </p> |
| 3005 | <blockquote class="text"> | <blockquote class="text"> |
| 3006 | <p>arbitrary text describing the purpose of the parameter | <p>arbitrary text describing the purpose of the parameter |
| 3007 | (always returned) | (always returned) |
| 3008 | </p> | </p> |
| 3009 | </blockquote><p> | </blockquote> |
| 3010 | ||
| 3011 | ||
| </p> | ||
| 3012 | <p>FIX - | <p>FIX - |
| 3013 | </p> | </p> |
| 3014 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2937 Intellectual Property and Copyright Stat | Line 3016 Intellectual Property and Copyright Stat |
| 3016 | read only, thus cannot be altered | read only, thus cannot be altered |
| 3017 | (always returned) | (always returned) |
| 3018 | </p> | </p> |
| 3019 | </blockquote><p> | </blockquote> |
| 3020 | ||
| 3021 | ||
| </p> | ||
| 3022 | <p>MULTIPLICITY - | <p>MULTIPLICITY - |
| 3023 | </p> | </p> |
| 3024 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2948 Intellectual Property and Copyright Stat | Line 3027 Intellectual Property and Copyright Stat |
| 3027 | multiple values and false only a single value allowed | multiple values and false only a single value allowed |
| 3028 | (always returned) | (always returned) |
| 3029 | </p> | </p> |
| 3030 | </blockquote><p> | </blockquote> |
| 3031 | ||
| 3032 | ||
| </p> | ||
| 3033 | <p>RANGE_MIN - | <p>RANGE_MIN - |
| 3034 | </p> | </p> |
| 3035 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2961 Intellectual Property and Copyright Stat | Line 3040 Intellectual Property and Copyright Stat |
| 3040 | (optionally returned, dependent to driver and port | (optionally returned, dependent to driver and port |
| 3041 | parameter) | parameter) |
| 3042 | </p> | </p> |
| 3043 | </blockquote><p> | </blockquote> |
| 3044 | ||
| 3045 | ||
| </p> | ||
| 3046 | <p>RANGE_MAX - | <p>RANGE_MAX - |
| 3047 | </p> | </p> |
| 3048 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2974 Intellectual Property and Copyright Stat | Line 3053 Intellectual Property and Copyright Stat |
| 3053 | (optionally returned, dependent to driver and port | (optionally returned, dependent to driver and port |
| 3054 | parameter) | parameter) |
| 3055 | </p> | </p> |
| 3056 | </blockquote><p> | </blockquote> |
| 3057 | ||
| 3058 | ||
| </p> | ||
| 3059 | <p>POSSIBILITIES - | <p>POSSIBILITIES - |
| 3060 | </p> | </p> |
| 3061 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 2986 Intellectual Property and Copyright Stat | Line 3065 Intellectual Property and Copyright Stat |
| 3065 | (optionally returned, dependent to device and port | (optionally returned, dependent to device and port |
| 3066 | parameter) | parameter) |
| 3067 | </p> | </p> |
| 3068 | </blockquote><p> | </blockquote> |
| 3069 | ||
| 3070 | ||
| </p> | ||
| 3071 | </blockquote><p> | </blockquote><p> |
| 3072 | ||
| 3073 | </p> | </p> |
| 3074 | <p>The mentioned fields above don't have to be in particular order. | <p>The mentioned fields above don't have to be in particular order. |
| 3075 | </p> | </p> |
| # | Line 3014 Intellectual Property and Copyright Stat | Line 3093 Intellectual Property and Copyright Stat |
| 3093 | <p> "." | <p> "." |
| 3094 | </p> | </p> |
| 3095 | </blockquote><p> | </blockquote><p> |
| 3096 | ||
| 3097 | </p> | </p> |
| 3098 | <a name="rfc.section.6.3.13"></a><h4><a name="SET MIDI_INPUT_PORT_PARAMETER">6.3.13</a> Changing settings of MIDI input ports</h4> | <a name="SET MIDI_INPUT_PORT_PARAMETER"></a><br /><hr /> |
| 3099 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3100 | <a name="rfc.section.6.3.13"></a><h3>6.3.13. Changing settings of MIDI input ports</h3> | |
| 3101 | ||
| 3102 | <p>Use the following command to alter a specific setting of a MIDI input port: | <p>Use the following command to alter a specific setting of a MIDI input port: |
| 3103 | </p> | </p> |
| # | Line 3026 Intellectual Property and Copyright Stat | Line 3107 Intellectual Property and Copyright Stat |
| 3107 | <p>SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value> | <p>SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value> |
| 3108 | </p> | </p> |
| 3109 | </blockquote><p> | </blockquote><p> |
| 3110 | ||
| 3111 | </p> | </p> |
| 3112 | <p>Where <device-id> should be replaced by the numerical ID of the | <p>Where <device-id> should be replaced by the numerical ID of the |
| 3113 | MIDI device as returned by the | MIDI device as returned by the |
| # | Line 3046 Intellectual Property and Copyright Stat | Line 3127 Intellectual Property and Copyright Stat |
| 3127 | <blockquote class="text"> | <blockquote class="text"> |
| 3128 | <p>in case setting was successfully changed | <p>in case setting was successfully changed |
| 3129 | </p> | </p> |
| 3130 | </blockquote><p> | </blockquote> |
| 3131 | ||
| 3132 | ||
| </p> | ||
| 3133 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 3134 | </p> | </p> |
| 3135 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3056 Intellectual Property and Copyright Stat | Line 3137 Intellectual Property and Copyright Stat |
| 3137 | noteworthy issue(s) related, providing an appropriate | noteworthy issue(s) related, providing an appropriate |
| 3138 | warning code and warning message | warning code and warning message |
| 3139 | </p> | </p> |
| 3140 | </blockquote><p> | </blockquote> |
| 3141 | ||
| 3142 | ||
| </p> | ||
| 3143 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 3144 | </p> | </p> |
| 3145 | <blockquote class="text"> | <blockquote class="text"> |
| 3146 | <p>in case it failed, providing an appropriate error code and error message | <p>in case it failed, providing an appropriate error code and error message |
| 3147 | </p> | </p> |
| 3148 | </blockquote><p> | </blockquote> |
| 3149 | ||
| 3150 | ||
| </p> | ||
| 3151 | </blockquote><p> | </blockquote><p> |
| 3152 | ||
| 3153 | </p> | </p> |
| 3154 | <p>Example: | <p>Example: |
| 3155 | </p> | </p> |
| # | Line 3078 Intellectual Property and Copyright Stat | Line 3159 Intellectual Property and Copyright Stat |
| 3159 | <p> | <p> |
| 3160 | </p> | </p> |
| 3161 | </blockquote><p> | </blockquote><p> |
| 3162 | ||
| 3163 | </p> | </p> |
| 3164 | <a name="rfc.section.6.4"></a><h4><a name="anchor11">6.4</a> Configuring sampler channels</h4> | <a name="anchor11"></a><br /><hr /> |
| 3165 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3166 | <a name="rfc.section.6.4"></a><h3>6.4. Configuring sampler channels</h3> | |
| 3167 | ||
| 3168 | <p>The following commands describe how to add and remove sampler channels, associate a | <p>The following commands describe how to add and remove sampler channels, associate a |
| 3169 | sampler channel with a sampler engine, load instruments and connect sampler channels to | sampler channel with a sampler engine, load instruments and connect sampler channels to |
| 3170 | MIDI and audio devices. | MIDI and audio devices. |
| 3171 | </p> | </p> |
| 3172 | <a name="rfc.section.6.4.1"></a><h4><a name="LOAD INSTRUMENT">6.4.1</a> Loading an instrument</h4> | <a name="LOAD INSTRUMENT"></a><br /><hr /> |
| 3173 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3174 | <a name="rfc.section.6.4.1"></a><h3>6.4.1. Loading an instrument</h3> | |
| 3175 | ||
| 3176 | <p>An instrument file can be loaded and assigned to a sampler channel by one of the following commands: | <p>An instrument file can be loaded and assigned to a sampler channel by one of the following commands: |
| 3177 | </p> | </p> |
| # | Line 3096 Intellectual Property and Copyright Stat | Line 3181 Intellectual Property and Copyright Stat |
| 3181 | <p>LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index> <sampler-channel> | <p>LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index> <sampler-channel> |
| 3182 | </p> | </p> |
| 3183 | </blockquote><p> | </blockquote><p> |
| 3184 | ||
| 3185 | </p> | </p> |
| 3186 | <p>Where <filename> is the name of the instrument file on the | <p>Where <filename> is the name of the instrument file on the |
| 3187 | LinuxSampler instance's host system, <instr-index> the index of the | LinuxSampler instance's host system, <instr-index> the index of the |
| # | Line 3125 Intellectual Property and Copyright Stat | Line 3210 Intellectual Property and Copyright Stat |
| 3210 | <blockquote class="text"> | <blockquote class="text"> |
| 3211 | <p>in case the instrument was successfully loaded | <p>in case the instrument was successfully loaded |
| 3212 | </p> | </p> |
| 3213 | </blockquote><p> | </blockquote> |
| 3214 | ||
| 3215 | ||
| </p> | ||
| 3216 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 3217 | </p> | </p> |
| 3218 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3137 Intellectual Property and Copyright Stat | Line 3222 Intellectual Property and Copyright Stat |
| 3222 | instrument file), providing an appropriate warning code and | instrument file), providing an appropriate warning code and |
| 3223 | warning message | warning message |
| 3224 | </p> | </p> |
| 3225 | </blockquote><p> | </blockquote> |
| 3226 | ||
| 3227 | ||
| </p> | ||
| 3228 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 3229 | </p> | </p> |
| 3230 | <blockquote class="text"> | <blockquote class="text"> |
| 3231 | <p>in case it failed, providing an appropriate error code and error message | <p>in case it failed, providing an appropriate error code and error message |
| 3232 | </p> | </p> |
| 3233 | </blockquote><p> | </blockquote> |
| 3234 | ||
| 3235 | ||
| </p> | ||
| 3236 | </blockquote><p> | </blockquote><p> |
| 3237 | ||
| 3238 | </p> | </p> |
| 3239 | <p>Example: | <p>Example: |
| 3240 | </p> | </p> |
| # | Line 3159 Intellectual Property and Copyright Stat | Line 3244 Intellectual Property and Copyright Stat |
| 3244 | <p> | <p> |
| 3245 | </p> | </p> |
| 3246 | </blockquote><p> | </blockquote><p> |
| 3247 | ||
| 3248 | </p> | </p> |
| 3249 | <a name="rfc.section.6.4.2"></a><h4><a name="LOAD ENGINE">6.4.2</a> Loading a sampler engine</h4> | <a name="LOAD ENGINE"></a><br /><hr /> |
| 3250 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3251 | <a name="rfc.section.6.4.2"></a><h3>6.4.2. Loading a sampler engine</h3> | |
| 3252 | ||
| 3253 | <p>A sampler engine type can be associated to a specific sampler | <p>A sampler engine type can be associated to a specific sampler |
| 3254 | channel by the following command: | channel by the following command: |
| # | Line 3172 Intellectual Property and Copyright Stat | Line 3259 Intellectual Property and Copyright Stat |
| 3259 | <p>LOAD ENGINE <engine-name> <sampler-channel> | <p>LOAD ENGINE <engine-name> <sampler-channel> |
| 3260 | </p> | </p> |
| 3261 | </blockquote><p> | </blockquote><p> |
| 3262 | ||
| 3263 | </p> | </p> |
| 3264 | <p>Where <engine-name> is an engine name as obtained by the | <p>Where <engine-name> is an engine name as obtained by the |
| 3265 | <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 <sampler-channel> | <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 <sampler-channel> |
| # | Line 3198 Intellectual Property and Copyright Stat | Line 3285 Intellectual Property and Copyright Stat |
| 3285 | <blockquote class="text"> | <blockquote class="text"> |
| 3286 | <p>in case the engine was successfully deployed | <p>in case the engine was successfully deployed |
| 3287 | </p> | </p> |
| 3288 | </blockquote><p> | </blockquote> |
| 3289 | ||
| 3290 | ||
| </p> | ||
| 3291 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 3292 | </p> | </p> |
| 3293 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3208 Intellectual Property and Copyright Stat | Line 3295 Intellectual Property and Copyright Stat |
| 3295 | are noteworthy issue(s) related, providing an appropriate | are noteworthy issue(s) related, providing an appropriate |
| 3296 | warning code and warning message | warning code and warning message |
| 3297 | </p> | </p> |
| 3298 | </blockquote><p> | </blockquote> |
| 3299 | ||
| 3300 | ||
| </p> | ||
| 3301 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 3302 | </p> | </p> |
| 3303 | <blockquote class="text"> | <blockquote class="text"> |
| 3304 | <p>in case it failed, providing an appropriate error code and | <p>in case it failed, providing an appropriate error code and |
| 3305 | error message | error message |
| 3306 | </p> | </p> |
| 3307 | </blockquote><p> | </blockquote> |
| 3308 | ||
| 3309 | ||
| </p> | ||
| 3310 | </blockquote><p> | </blockquote><p> |
| 3311 | ||
| 3312 | </p> | </p> |
| 3313 | <p>Example: | <p>Example: |
| 3314 | </p> | </p> |
| # | Line 3231 Intellectual Property and Copyright Stat | Line 3318 Intellectual Property and Copyright Stat |
| 3318 | <p> | <p> |
| 3319 | </p> | </p> |
| 3320 | </blockquote><p> | </blockquote><p> |
| 3321 | ||
| 3322 | </p> | </p> |
| 3323 | <a name="rfc.section.6.4.3"></a><h4><a name="GET CHANNELS">6.4.3</a> Getting all created sampler channel count</h4> | <a name="GET CHANNELS"></a><br /><hr /> |
| 3324 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3325 | <a name="rfc.section.6.4.3"></a><h3>6.4.3. Getting all created sampler channel count</h3> | |
| 3326 | ||
| 3327 | <p>The number of sampler channels can change on runtime. To get the | <p>The number of sampler channels can change on runtime. To get the |
| 3328 | current amount of sampler channels, the front-end can send the | current amount of sampler channels, the front-end can send the |
| # | Line 3245 Intellectual Property and Copyright Stat | Line 3334 Intellectual Property and Copyright Stat |
| 3334 | <p>GET CHANNELS | <p>GET CHANNELS |
| 3335 | </p> | </p> |
| 3336 | </blockquote><p> | </blockquote><p> |
| 3337 | ||
| 3338 | </p> | </p> |
| 3339 | <p>Possible Answers: | <p>Possible Answers: |
| 3340 | </p> | </p> |
| # | Line 3255 Intellectual Property and Copyright Stat | Line 3344 Intellectual Property and Copyright Stat |
| 3344 | <p>LinuxSampler will answer by returning the current number of sampler channels. | <p>LinuxSampler will answer by returning the current number of sampler channels. |
| 3345 | </p> | </p> |
| 3346 | </blockquote><p> | </blockquote><p> |
| 3347 | ||
| 3348 | </p> | </p> |
| 3349 | <p>Example: | <p>Example: |
| 3350 | </p> | </p> |
| # | Line 3267 Intellectual Property and Copyright Stat | Line 3356 Intellectual Property and Copyright Stat |
| 3356 | <p>S: "12" | <p>S: "12" |
| 3357 | </p> | </p> |
| 3358 | </blockquote><p> | </blockquote><p> |
| 3359 | ||
| 3360 | </p> | </p> |
| 3361 | <a name="rfc.section.6.4.4"></a><h4><a name="LIST CHANNELS">6.4.4</a> Getting all created sampler channel list</h4> | <a name="LIST CHANNELS"></a><br /><hr /> |
| 3362 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3363 | <a name="rfc.section.6.4.4"></a><h3>6.4.4. Getting all created sampler channel list</h3> | |
| 3364 | ||
| 3365 | <p>The number of sampler channels can change on runtime. To get the | <p>The number of sampler channels can change on runtime. To get the |
| 3366 | current list of sampler channels, the front-end can send the | current list of sampler channels, the front-end can send the |
| # | Line 3281 Intellectual Property and Copyright Stat | Line 3372 Intellectual Property and Copyright Stat |
| 3372 | <p>LIST CHANNELS | <p>LIST CHANNELS |
| 3373 | </p> | </p> |
| 3374 | </blockquote><p> | </blockquote><p> |
| 3375 | ||
| 3376 | </p> | </p> |
| 3377 | <p>Possible Answers: | <p>Possible Answers: |
| 3378 | </p> | </p> |
| # | Line 3292 Intellectual Property and Copyright Stat | Line 3383 Intellectual Property and Copyright Stat |
| 3383 | with all sampler channels numerical IDs. | with all sampler channels numerical IDs. |
| 3384 | </p> | </p> |
| 3385 | </blockquote><p> | </blockquote><p> |
| 3386 | ||
| 3387 | </p> | </p> |
| 3388 | <p>Example: | <p>Example: |
| 3389 | </p> | </p> |
| # | Line 3304 Intellectual Property and Copyright Stat | Line 3395 Intellectual Property and Copyright Stat |
| 3395 | <p>S: "0,1,2,3,4,5,6,9,10,11,15,20" | <p>S: "0,1,2,3,4,5,6,9,10,11,15,20" |
| 3396 | </p> | </p> |
| 3397 | </blockquote><p> | </blockquote><p> |
| 3398 | ||
| 3399 | </p> | </p> |
| 3400 | <a name="rfc.section.6.4.5"></a><h4><a name="ADD CHANNEL">6.4.5</a> Adding a new sampler channel</h4> | <a name="ADD CHANNEL"></a><br /><hr /> |
| 3401 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3402 | <a name="rfc.section.6.4.5"></a><h3>6.4.5. Adding a new sampler channel</h3> | |
| 3403 | ||
| 3404 | <p>A new sampler channel can be added to the end of the sampler | <p>A new sampler channel can be added to the end of the sampler |
| 3405 | channel list by sending the following command: | channel list by sending the following command: |
| # | Line 3317 Intellectual Property and Copyright Stat | Line 3410 Intellectual Property and Copyright Stat |
| 3410 | <p>ADD CHANNEL | <p>ADD CHANNEL |
| 3411 | </p> | </p> |
| 3412 | </blockquote><p> | </blockquote><p> |
| 3413 | ||
| 3414 | </p> | </p> |
| 3415 | <p>This will increment the sampler channel count by one and the new | <p>This will increment the sampler channel count by one and the new |
| 3416 | sampler channel will be appended to the end of the sampler channel | sampler channel will be appended to the end of the sampler channel |
| # | Line 3343 Intellectual Property and Copyright Stat | Line 3436 Intellectual Property and Copyright Stat |
| 3436 | the sampler channel by sending subsequent initialization | the sampler channel by sending subsequent initialization |
| 3437 | commands | commands |
| 3438 | </p> | </p> |
| 3439 | </blockquote><p> | </blockquote> |
| 3440 | ||
| 3441 | ||
| </p> | ||
| 3442 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 3443 | </p> | </p> |
| 3444 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3353 Intellectual Property and Copyright Stat | Line 3446 Intellectual Property and Copyright Stat |
| 3446 | noteworthy issue(s) related, providing an appropriate | noteworthy issue(s) related, providing an appropriate |
| 3447 | warning code and warning message | warning code and warning message |
| 3448 | </p> | </p> |
| 3449 | </blockquote><p> | </blockquote> |
| 3450 | ||
| 3451 | ||
| </p> | ||
| 3452 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 3453 | </p> | </p> |
| 3454 | <blockquote class="text"> | <blockquote class="text"> |
| 3455 | <p>in case it failed, providing an appropriate error code and | <p>in case it failed, providing an appropriate error code and |
| 3456 | error message | error message |
| 3457 | </p> | </p> |
| 3458 | </blockquote><p> | </blockquote> |
| 3459 | ||
| 3460 | ||
| </p> | ||
| 3461 | </blockquote><p> | </blockquote><p> |
| 3462 | ||
| 3463 | </p> | </p> |
| 3464 | <p>Example: | <p>Example: |
| 3465 | </p> | </p> |
| # | Line 3376 Intellectual Property and Copyright Stat | Line 3469 Intellectual Property and Copyright Stat |
| 3469 | <p> | <p> |
| 3470 | </p> | </p> |
| 3471 | </blockquote><p> | </blockquote><p> |
| 3472 | ||
| 3473 | </p> | </p> |
| 3474 | <a name="rfc.section.6.4.6"></a><h4><a name="REMOVE CHANNEL">6.4.6</a> Removing a sampler channel</h4> | <a name="REMOVE CHANNEL"></a><br /><hr /> |
| 3475 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3476 | <a name="rfc.section.6.4.6"></a><h3>6.4.6. Removing a sampler channel</h3> | |
| 3477 | ||
| 3478 | <p>A sampler channel can be removed by sending the following command: | <p>A sampler channel can be removed by sending the following command: |
| 3479 | </p> | </p> |
| # | Line 3388 Intellectual Property and Copyright Stat | Line 3483 Intellectual Property and Copyright Stat |
| 3483 | <p>REMOVE CHANNEL <sampler-channel> | <p>REMOVE CHANNEL <sampler-channel> |
| 3484 | </p> | </p> |
| 3485 | </blockquote><p> | </blockquote><p> |
| 3486 | ||
| 3487 | </p> | </p> |
| 3488 | <p>Where <sampler-channel> should be replaced by the | <p>Where <sampler-channel> should be replaced by the |
| 3489 | number of the sampler channel as given by the | number of the sampler channel as given by the |
| # | Line 3407 Intellectual Property and Copyright Stat | Line 3502 Intellectual Property and Copyright Stat |
| 3502 | <blockquote class="text"> | <blockquote class="text"> |
| 3503 | <p>in case the given sampler channel could be removed | <p>in case the given sampler channel could be removed |
| 3504 | </p> | </p> |
| 3505 | </blockquote><p> | </blockquote> |
| 3506 | ||
| 3507 | ||
| </p> | ||
| 3508 | <p>"WRN:<warning-code>:<warning-message>" - | <p>"WRN:<warning-code>:<warning-message>" - |
| 3509 | </p> | </p> |
| 3510 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3417 Intellectual Property and Copyright Stat | Line 3512 Intellectual Property and Copyright Stat |
| 3512 | noteworthy issue(s) related, providing an appropriate | noteworthy issue(s) related, providing an appropriate |
| 3513 | warning code and warning message | warning code and warning message |
| 3514 | </p> | </p> |
| 3515 | </blockquote><p> | </blockquote> |
| 3516 | ||
| 3517 | ||
| </p> | ||
| 3518 | <p>"ERR:<error-code>:<error-message>" - | <p>"ERR:<error-code>:<error-message>" - |
| 3519 | </p> | </p> |
| 3520 | <blockquote class="text"> | <blockquote class="text"> |
| 3521 | <p>in case it failed, providing an appropriate error code and | <p>in case it failed, providing an appropriate error code and |
| 3522 | error message | error message |
| 3523 | </p> | </p> |
| 3524 | </blockquote><p> | </blockquote> |
| 3525 | ||
| 3526 | ||
| </p> | ||
| 3527 | </blockquote><p> | </blockquote><p> |
| 3528 | ||
| 3529 | </p> | </p> |
| 3530 | <p>Example: | <p>Example: |
| 3531 | </p> | </p> |
| # | Line 3440 Intellectual Property and Copyright Stat | Line 3535 Intellectual Property and Copyright Stat |
| 3535 | <p> | <p> |
| 3536 | </p> | </p> |
| 3537 | </blockquote><p> | </blockquote><p> |
| 3538 | ||
| 3539 | </p> | </p> |
| 3540 | <a name="rfc.section.6.4.7"></a><h4><a name="GET AVAILABLE_ENGINES">6.4.7</a> Getting amount of available engines</h4> | <a name="GET AVAILABLE_ENGINES"></a><br /><hr /> |
| 3541 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3542 | <a name="rfc.section.6.4.7"></a><h3>6.4.7. Getting amount of available engines</h3> | |
| 3543 | ||
| 3544 | <p>The front-end can ask for the number of available engines by sending the following command: | <p>The front-end can ask for the number of available engines by sending the following command: |
| 3545 | </p> | </p> |
| # | Line 3452 Intellectual Property and Copyright Stat | Line 3549 Intellectual Property and Copyright Stat |
| 3549 | <p>GET AVAILABLE_ENGINES | <p>GET AVAILABLE_ENGINES |
| 3550 | </p> | </p> |
| 3551 | </blockquote><p> | </blockquote><p> |
| 3552 | ||
| 3553 | </p> | </p> |
| 3554 | <p>Possible Answers: | <p>Possible Answers: |
| 3555 | </p> | </p> |
| # | Line 3462 Intellectual Property and Copyright Stat | Line 3559 Intellectual Property and Copyright Stat |
| 3559 | <p>LinuxSampler will answer by sending the number of available engines. | <p>LinuxSampler will answer by sending the number of available engines. |
| 3560 | </p> | </p> |
| 3561 | </blockquote><p> | </blockquote><p> |
| 3562 | ||
| 3563 | </p> | </p> |
| 3564 | <p>Example: | <p>Example: |
| 3565 | </p> | </p> |
| # | Line 3474 Intellectual Property and Copyright Stat | Line 3571 Intellectual Property and Copyright Stat |
| 3571 | <p>S: "4" | <p>S: "4" |
| 3572 | </p> | </p> |
| 3573 | </blockquote><p> | </blockquote><p> |
| 3574 | ||
| 3575 | </p> | </p> |
| 3576 | <a name="rfc.section.6.4.8"></a><h4><a name="LIST AVAILABLE_ENGINES">6.4.8</a> Getting all available engines</h4> | <a name="LIST AVAILABLE_ENGINES"></a><br /><hr /> |
| 3577 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3578 | <a name="rfc.section.6.4.8"></a><h3>6.4.8. Getting all available engines</h3> | |
| 3579 | ||
| 3580 | <p>The front-end can ask for a list of all available engines by sending the following command: | <p>The front-end can ask for a list of all available engines by sending the following command: |
| 3581 | </p> | </p> |
| # | Line 3486 Intellectual Property and Copyright Stat | Line 3585 Intellectual Property and Copyright Stat |
| 3585 | <p>LIST AVAILABLE_ENGINES | <p>LIST AVAILABLE_ENGINES |
| 3586 | </p> | </p> |
| 3587 | </blockquote><p> | </blockquote><p> |
| 3588 | ||
| 3589 | </p> | </p> |
| 3590 | <p>Possible Answers: | <p>Possible Answers: |
| 3591 | </p> | </p> |
| # | Line 3499 Intellectual Property and Copyright Stat | Line 3598 Intellectual Property and Copyright Stat |
| 3598 | digits and underlines ("_" character). | digits and underlines ("_" character). |
| 3599 | </p> | </p> |
| 3600 | </blockquote><p> | </blockquote><p> |
| 3601 | ||
| 3602 | </p> | </p> |
| 3603 | <p>Example: | <p>Example: |
| 3604 | </p> | </p> |
| # | Line 3511 Intellectual Property and Copyright Stat | Line 3610 Intellectual Property and Copyright Stat |
| 3610 | <p>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'" | <p>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'" |
| 3611 | </p> | </p> |
| 3612 | </blockquote><p> | </blockquote><p> |
| 3613 | ||
| 3614 | </p> | </p> |
| 3615 | <a name="rfc.section.6.4.9"></a><h4><a name="GET ENGINE INFO">6.4.9</a> Getting information about an engine</h4> | <a name="GET ENGINE INFO"></a><br /><hr /> |
| 3616 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3617 | <a name="rfc.section.6.4.9"></a><h3>6.4.9. Getting information about an engine</h3> | |
| 3618 | ||
| 3619 | <p>The front-end can ask for information about a specific engine by | <p>The front-end can ask for information about a specific engine by |
| 3620 | sending the following command: | sending the following command: |
| # | Line 3524 Intellectual Property and Copyright Stat | Line 3625 Intellectual Property and Copyright Stat |
| 3625 | <p>GET ENGINE INFO <engine-name> | <p>GET ENGINE INFO <engine-name> |
| 3626 | </p> | </p> |
| 3627 | </blockquote><p> | </blockquote><p> |
| 3628 | ||
| 3629 | </p> | </p> |
| 3630 | <p>Where <engine-name> is an engine name as obtained by the | <p>Where <engine-name> is an engine name as obtained by the |
| 3631 | <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span> (</span><span class="info">Getting all available engines</span><span>)</span></a> command. | <a class="info" href="#LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"<span> (</span><span class="info">Getting all available engines</span><span>)</span></a> command. |
| # | Line 3548 Intellectual Property and Copyright Stat | Line 3649 Intellectual Property and Copyright Stat |
| 3649 | <blockquote class="text"> | <blockquote class="text"> |
| 3650 | <p>arbitrary description text about the engine | <p>arbitrary description text about the engine |
| 3651 | </p> | </p> |
| 3652 | </blockquote><p> | </blockquote> |
| 3653 | ||
| 3654 | ||
| </p> | ||
| 3655 | <p>VERSION - | <p>VERSION - |
| 3656 | </p> | </p> |
| 3657 | <blockquote class="text"> | <blockquote class="text"> |
| 3658 | <p>arbitrary character string regarding the engine's version | <p>arbitrary character string regarding the engine's version |
| 3659 | </p> | </p> |
| 3660 | </blockquote><p> | </blockquote> |
| 3661 | ||
| 3662 | ||
| 3663 | </p> | </blockquote> |
| 3664 | </blockquote><p> | |
| 3665 | ||
| </p> | ||
| 3666 | </blockquote><p> | </blockquote><p> |
| 3667 | ||
| 3668 | </p> | </p> |
| 3669 | <p>The mentioned fields above don't have to be in particular order. | <p>The mentioned fields above don't have to be in particular order. |
| 3670 | </p> | </p> |
| # | Line 3581 Intellectual Property and Copyright Stat | Line 3682 Intellectual Property and Copyright Stat |
| 3682 | <p> "." | <p> "." |
| 3683 | </p> | </p> |
| 3684 | </blockquote><p> | </blockquote><p> |
| 3685 | ||
| 3686 | </p> | </p> |
| 3687 | <a name="rfc.section.6.4.10"></a><h4><a name="GET CHANNEL INFO">6.4.10</a> Getting sampler channel information</h4> | <a name="GET CHANNEL INFO"></a><br /><hr /> |
| 3688 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3689 | <a name="rfc.section.6.4.10"></a><h3>6.4.10. Getting sampler channel information</h3> | |
| 3690 | ||
| 3691 | <p>The front-end can ask for the current settings of a sampler channel | <p>The front-end can ask for the current settings of a sampler channel |
| 3692 | by sending the following command: | by sending the following command: |
| # | Line 3594 Intellectual Property and Copyright Stat | Line 3697 Intellectual Property and Copyright Stat |
| 3697 | <p>GET CHANNEL INFO <sampler-channel> | <p>GET CHANNEL INFO <sampler-channel> |
| 3698 | </p> | </p> |
| 3699 | </blockquote><p> | </blockquote><p> |
| 3700 | ||
| 3701 | </p> | </p> |
| 3702 | <p>Where <sampler-channel> is the sampler channel number the front-end is interested in | <p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
| 3703 | 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> | 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> |
| # | Line 3621 Intellectual Property and Copyright Stat | Line 3724 Intellectual Property and Copyright Stat |
| 3724 | channel, "NONE" if there's no engine associated yet for | channel, "NONE" if there's no engine associated yet for |
| 3725 | this sampler channel | this sampler channel |
| 3726 | </p> | </p> |
| 3727 | </blockquote><p> | </blockquote> |
| 3728 | ||
| 3729 | ||
| </p> | ||
| 3730 | <p>AUDIO_OUTPUT_DEVICE - | <p>AUDIO_OUTPUT_DEVICE - |
| 3731 | </p> | </p> |
| 3732 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3632 Intellectual Property and Copyright Stat | Line 3735 Intellectual Property and Copyright Stat |
| 3735 | the audio signal, "NONE" if there's no device | the audio signal, "NONE" if there's no device |
| 3736 | connected to this sampler channel | connected to this sampler channel |
| 3737 | </p> | </p> |
| 3738 | </blockquote><p> | </blockquote> |
| 3739 | ||
| 3740 | ||
| </p> | ||
| 3741 | <p>AUDIO_OUTPUT_CHANNELS - | <p>AUDIO_OUTPUT_CHANNELS - |
| 3742 | </p> | </p> |
| 3743 | <blockquote class="text"> | <blockquote class="text"> |
| 3744 | <p>number of output channels the sampler channel offers | <p>number of output channels the sampler channel offers |
| 3745 | (dependent to used sampler engine and loaded instrument) | (dependent to used sampler engine and loaded instrument) |
| 3746 | </p> | </p> |
| 3747 | </blockquote><p> | </blockquote> |
| 3748 | ||
| 3749 | ||
| </p> | ||
| 3750 | <p>AUDIO_OUTPUT_ROUTING - | <p>AUDIO_OUTPUT_ROUTING - |
| 3751 | </p> | </p> |
| 3752 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3655 Intellectual Property and Copyright Stat | Line 3758 Intellectual Property and Copyright Stat |
| 3758 | channel 1 is routed to the channel 3 of the audio | channel 1 is routed to the channel 3 of the audio |
| 3759 | output device | output device |
| 3760 | </p> | </p> |
| 3761 | </blockquote><p> | </blockquote> |
| 3762 | ||
| 3763 | ||
| </p> | ||
| 3764 | <p>INSTRUMENT_FILE - | <p>INSTRUMENT_FILE - |
| 3765 | </p> | </p> |
| 3766 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3665 Intellectual Property and Copyright Stat | Line 3768 Intellectual Property and Copyright Stat |
| 3768 | there's no instrument yet loaded for this sampler | there's no instrument yet loaded for this sampler |
| 3769 | channel | channel |
| 3770 | </p> | </p> |
| 3771 | </blockquote><p> | </blockquote> |
| 3772 | ||
| 3773 | ||
| </p> | ||
| 3774 | <p>INSTRUMENT_NR - | <p>INSTRUMENT_NR - |
| 3775 | </p> | </p> |
| 3776 | <blockquote class="text"> | <blockquote class="text"> |
| 3777 | <p>the instrument index number of the loaded instrument | <p>the instrument index number of the loaded instrument |
| 3778 | </p> | </p> |
| 3779 | </blockquote><p> | </blockquote> |
| 3780 | ||
| 3781 | ||
| </p> | ||
| 3782 | <p>INSTRUMENT_NAME - | <p>INSTRUMENT_NAME - |
| 3783 | </p> | </p> |
| 3784 | <blockquote class="text"> | <blockquote class="text"> |
| 3785 | <p>the instrument name of the loaded instrument | <p>the instrument name of the loaded instrument |
| 3786 | </p> | </p> |
| 3787 | </blockquote><p> | </blockquote> |
| 3788 | ||
| 3789 | ||
| </p> | ||
| 3790 | <p>INSTRUMENT_STATUS - | <p>INSTRUMENT_STATUS - |
| 3791 | </p> | </p> |
| 3792 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3691 Intellectual Property and Copyright Stat | Line 3794 Intellectual Property and Copyright Stat |
| 3794 | value indicates a loading exception. Value of 100 indicates that the instrument is fully | value indicates a loading exception. Value of 100 indicates that the instrument is fully |
| 3795 | loaded. | loaded. |
| 3796 | </p> | </p> |
| 3797 | </blockquote><p> | </blockquote> |
| 3798 | ||
| 3799 | ||
| </p> | ||
| 3800 | <p>MIDI_INPUT_DEVICE - | <p>MIDI_INPUT_DEVICE - |
| 3801 | </p> | </p> |
| 3802 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3702 Intellectual Property and Copyright Stat | Line 3805 Intellectual Property and Copyright Stat |
| 3805 | MIDI input commands, "NONE" if there's no device | MIDI input commands, "NONE" if there's no device |
| 3806 | connected to this sampler channel | connected to this sampler channel |
| 3807 | </p> | </p> |
| 3808 | </blockquote><p> | </blockquote> |
| 3809 | ||
| 3810 | ||
| </p> | ||
| 3811 | <p>MIDI_INPUT_PORT - | <p>MIDI_INPUT_PORT - |
| 3812 | </p> | </p> |
| 3813 | <blockquote class="text"> | <blockquote class="text"> |
| 3814 | <p>port number of the MIDI input device | <p>port number of the MIDI input device |
| 3815 | </p> | </p> |
| 3816 | </blockquote><p> | </blockquote> |
| 3817 | ||
| 3818 | ||
| </p> | ||
| 3819 | <p>MIDI_INPUT_CHANNEL - | <p>MIDI_INPUT_CHANNEL - |
| 3820 | </p> | </p> |
| 3821 | <blockquote class="text"> | <blockquote class="text"> |
| 3822 | <p>the MIDI input channel number this sampler channel | <p>the MIDI input channel number this sampler channel |
| 3823 | should listen to or "ALL" to listen on all MIDI channels | should listen to or "ALL" to listen on all MIDI channels |
| 3824 | </p> | </p> |
| 3825 | </blockquote><p> | </blockquote> |
| 3826 | ||
| 3827 | ||
| </p> | ||
| 3828 | <p>VOLUME - | <p>VOLUME - |
| 3829 | </p> | </p> |
| 3830 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3729 Intellectual Property and Copyright Stat | Line 3832 Intellectual Property and Copyright Stat |
| 3832 | (where a value < 1.0 means attenuation and a value > | (where a value < 1.0 means attenuation and a value > |
| 3833 | 1.0 means amplification) | 1.0 means amplification) |
| 3834 | </p> | </p> |
| 3835 | </blockquote><p> | </blockquote> |
| 3836 | ||
| 3837 | ||
| </p> | ||
| 3838 | <p>MUTE - | <p>MUTE - |
| 3839 | </p> | </p> |
| 3840 | <blockquote class="text"> | <blockquote class="text"> |
| # | Line 3741 Intellectual Property and Copyright Stat | Line 3844 Intellectual Property and Copyright Stat |
| 3844 | presence of a solo channel and will be unmuted when | presence of a solo channel and will be unmuted when |
| 3845 | there are no solo channels left | there are no solo channels left |
| 3846 | </p> | </p> |
| 3847 | </blockquote><p> | </blockquote> |
| 3848 | ||
| 3849 | ||
| </p> | ||
| 3850 | <p>SOLO - | <p>SOLO - |
| 3851 | </p> | </p> |
| 3852 | <blockquote class="text"> | <blockquote class="text"> |
| 3853 | <p>Determines whether this is a solo channel, "true" if | <p>Determines whether this is a solo channel, "true" if |
| 3854 | the channel is a solo channel; "false" otherwise | the channel is a solo channel; "false" otherwise |
| 3855 | </p> | </p> |
| 3856 | </blockquote><p> | </blockquote> |
| 3857 | ||
| 3858 | ||
| 3859 | </p> | </blockquote> |
| 3860 | </blockquote><p> | |
| 3861 | ||
| </p> | ||
| 3862 | </blockquote><p> | </blockquote><p> |
| 3863 | ||
| 3864 | </p> | </p> |
| 3865 | <p>The mentioned fields above don't have to be in particular order. | <p>The mentioned fields above don't have to be in particular order. |
| 3866 | </p> | </p> |
| # | Line 3795 Intellectual Property and Copyright Stat | Line 3898 Intellectual Property and Copyright Stat |
| 3898 | <p> "." | <p> "." |
| 3899 | </p> | </p> |
| 3900 | </blockquote><p> | </blockquote><p> |
| 3901 | ||
| 3902 | </p> | </p> |
| 3903 | <a name="rfc.section.6.4.11"></a><h4><a name="GET CHANNEL VOICE_COUNT">6.4.11</a> Current number of active voices</h4> | <a name="GET CHANNEL VOICE_COUNT"></a><br /><hr /> |
| 3904 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3905 | <a name="rfc.section.6.4.11"></a><h3>6.4.11. Current number of active voices</h3> | |
| 3906 | ||
| 3907 | <p>The front-end can ask for the current number of active voices on a | <p>The front-end can ask for the current number of active voices on a |
| 3908 | sampler channel by sending the following command: | sampler channel by sending the following command: |
| # | Line 3808 Intellectual Property and Copyright Stat | Line 3913 Intellectual Property and Copyright Stat |
| 3913 | <p>GET CHANNEL VOICE_COUNT <sampler-channel> | <p>GET CHANNEL VOICE_COUNT <sampler-channel> |
| 3914 | </p> | </p> |
| 3915 | </blockquote><p> | </blockquote><p> |
| 3916 | ||
| 3917 | </p> | </p> |
| 3918 | <p>Where <sampler-channel> is the sampler channel number the front-end is interested in | <p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
| 3919 | 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> | 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> |
| # | Line 3823 Intellectual Property and Copyright Stat | Line 3928 Intellectual Property and Copyright Stat |
| 3928 | voices on that channel. | voices on that channel. |
| 3929 | </p> | </p> |
| 3930 | </blockquote><p> | </blockquote><p> |
| 3931 | ||
| 3932 | </p> | </p> |
| 3933 | <p>Example: | <p>Example: |
| 3934 | </p> | </p> |
| # | Line 3833 Intellectual Property and Copyright Stat | Line 3938 Intellectual Property and Copyright Stat |
| 3938 | <p> | <p> |
| 3939 | </p> | </p> |
| 3940 | </blockquote><p> | </blockquote><p> |
| 3941 | ||
| 3942 | </p> | </p> |
| 3943 | <a name="rfc.section.6.4.12"></a><h4><a name="GET CHANNEL STREAM_COUNT">6.4.12</a> Current number of active disk streams</h4> | <a name="GET CHANNEL STREAM_COUNT"></a><br /><hr /> |
| 3944 | <table summary="layout" cellpadding="0" cellspacing="2" class="bug" align="right"><tr><td class="bug"><a href="#toc" class="link2"> TOC </a></td></tr></table> | |
| 3945 | <a name="rfc.section.6.4.12"></a><h3>6.4.12. Current number of active disk streams</h3> | |
| 3946 | ||
| 3947 | <p>The front-end can ask for the current number of active disk streams | <p>The front-end can ask for the current number of active disk streams |
| 3948 | on a sampler channel by sending the following command: | on a sampler channel by sending the following command: |
| # | Line 3846 Intellectual Property and Copyright Stat | Line 3953 Intellectual Property and Copyright Stat |
| 3953 | <p>GET CHANNEL STREAM_COUNT <sampler-channel> | <p>GET CHANNEL STREAM_COUNT <sampler-channel> |
| 3954 | </p> | </p> |
| 3955 | </blockquote><p> | </blockquote><p> |
| 3956 | ||
| 3957 | </p> | </p> |
| 3958 | <p>Where <sampler-channel> is the sampler channel number the front-end is interested in | <p>Where <sampler-channel> is the sampler channel number the front-end is interested in |
| 3959 | 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> | 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> |
| # | Line 3863 Intellectual Property and Copyright Stat | Line 3970 Intellectual Property and Copyright Stat |
| 3970 | return "NA" for not available. | return "NA" for not available. |
| 3971 | </p> | </p> |
| 3972 | </blockquote><p> | </blockquote><p> |
| 3973 | ||
| 3974 | </p> | </p> |
| 3975 | <p>Example: | <p>Example: |
| 3976 | </p> | </p> |
| # | Line 3873 Intellectual Property and Copyright Stat | Line 3980 Intellectual Property and Copyright Stat |
| 3980 | <p> | <p> |
| 3981 | </p> | </p> |
| 3982 | </blockquote><p> | </blockquote><p> |
| 3983 | ||
| 3984 | </p> | </p> |
| 3985 | <a name="rfc.section.6.4.13"></a><h4><a name="GET CHANNEL BUFFER_FILL">6.4.13</a> Current fill state of disk stream buffers</h4> | <a name="GET CHANNEL BUFFER_FILL"></a><br /><hr /> |
| 3986 |