/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 560 by schoenebeck, Sat May 21 01:30:30 2005 UTC revision 561 by schoenebeck, Sat May 21 20:01:32 2005 UTC
# Line 813  Internet-Draft       LinuxSampler Contro Line 813  Internet-Draft       LinuxSampler Contro
813           false only a single value allowed (always returned, no matter           false only a single value allowed (always returned, no matter
814           which driver parameter)           which driver parameter)
815        DEPENDS -        DEPENDS -
816           comma separated list of paramters this parameter depends on,           comma separated list of parameters this parameter depends on,
817           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
818           and 'POSSIBILITIES' might depend on these listed parameters,           and 'POSSIBILITIES' might depend on these listed parameters,
819           for example assuming that an audio driver (like the ALSA           for example assuming that an audio driver (like the ALSA
# Line 1420  Internet-Draft       LinuxSampler Contro Line 1420  Internet-Draft       LinuxSampler Contro
1420    
1421        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
1422    
1423     Where <midi-t> is the name of the MIDI input driver as returned by     Where <midit> is the name of the MIDI input driver as returned by the
1424     the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 5.3.2) command,     "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 5.3.2) command, <param>
1425     <param> a specific parameter name for which information should be     a specific parameter name for which information should be obtained
1426     obtained (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section     (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section 5.3.3)
1427     5.3.3) command) and <deplist> is an optional list of parameters on     command) and <deplist> is an optional list of parameters on which the
1428     which the sought parameter <param> depends on, <deplist> is a     sought parameter <param> depends on, <deplist> is a key-value pair
1429     key-value pair list in form of "key1=val1 key2=val2 ...", where     list in form of "key1=val1 key2=val2 ...", where character string
1430     character string values are encapsulated into apostrophes (').     values are encapsulated into apostrophes (').  Arguments given with
1431     Arguments given with <deplist> which are not dependency parameters of     <deplist> which are not dependency parameters of <param> will be
1432     <param> will be ignored, means the front-end application can simply     ignored, means the front-end application can simply put all
1433     put all parameters in <deplist> with the values selected by the user.     parameters in <deplist> with the values selected by the user.
1434    
1435     Possible Answers:     Possible Answers:
1436    
# Line 1476  Internet-Draft       LinuxSampler Contro Line 1476  Internet-Draft       LinuxSampler Contro
1476           false only a single value allowed (always returned, no matter           false only a single value allowed (always returned, no matter
1477           which driver parameter)           which driver parameter)
1478        DEPENDS -        DEPENDS -
1479           comma separated list of paramters this parameter depends on,           comma separated list of parameters this parameter depends on,
1480           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
1481           and 'POSSIBILITIES' might depend on these listed parameters,           and 'POSSIBILITIES' might depend on these listed parameters,
1482           for example assuming that an audio driver (like the ALSA           for example assuming that an audio driver (like the ALSA
# Line 2027  Internet-Draft       LinuxSampler Contro Line 2027  Internet-Draft       LinuxSampler Contro
2027        "OK[<sampler-channel>]" -        "OK[<sampler-channel>]" -
2028           in case a new sampler channel could be added, where           in case a new sampler channel could be added, where
2029           <sampler-channel> reflects the channel number of the new           <sampler-channel> reflects the channel number of the new
2030           created sampler channel which should the be used to set up the           created sampler channel which should be used to set up the
2031           sampler channel by sending subsequent intialization commands           sampler channel by sending subsequent initialization commands
2032        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2033           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2034           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
# Line 2047  Internet-Draft       LinuxSampler Contro Line 2047  Internet-Draft       LinuxSampler Contro
2047    
2048        REMOVE CHANNEL <sampler-channel>        REMOVE CHANNEL <sampler-channel>
2049    
2050     This will decrement the sampler channel count by one and also     Where <sampler-channel> should be replaced by the number of the
2051     decrement the channel numbers of all subsequent sampler channels by     sampler channel as given by the "ADD CHANNEL" (Section 5.4.5) or
2052     one.     "LIST CHANNELS" (Section 5.4.4) command.  The channel numbers of all
2053       subsequent sampler channels remain the same.
2054    
2055     Possible Answers:     Possible Answers:
2056    
# Line 2067  Internet-Draft       LinuxSampler Contro Line 2068  Internet-Draft       LinuxSampler Contro
2068    
2069    
2070    
   
2071  Schoenebeck            Expires November 19, 2005               [Page 37]  Schoenebeck            Expires November 19, 2005               [Page 37]
2072    
2073  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft       LinuxSampler Control Protocol              May 2005
# Line 2101  Internet-Draft       LinuxSampler Contro Line 2101  Internet-Draft       LinuxSampler Contro
2101    
2102     Possible Answers:     Possible Answers:
2103    
2104        LinuxSampler will answer by sending a comma separated character        LinuxSampler will answer by sending a comma separated list of the
2105        string of the engines' names.  Engine names can consist of lower        engines' names encapsulated into apostrophes (').  Engine names
2106        and upper cases, digits and underlines ("_" character).        can consist of lower and upper cases, digits and underlines ("_"
2107          character).
2108    
2109     Example:     Example:
2110    
2111        C: "LIST AVAILABLE_ENGINES"        C: "LIST AVAILABLE_ENGINES"
2112        S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
2113    
2114  5.4.9  Getting information about an engine  5.4.9  Getting information about an engine
2115    
# Line 2120  Internet-Draft       LinuxSampler Contro Line 2121  Internet-Draft       LinuxSampler Contro
2121     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2122     AVAILABLE_ENGINES" (Section 5.4.8) command.     AVAILABLE_ENGINES" (Section 5.4.8) command.
2123    
    Possible Answers:  
2124    
2125    
2126    
# Line 2129  Schoenebeck            Expires November Line 2129  Schoenebeck            Expires November
2129  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft       LinuxSampler Control Protocol              May 2005
2130    
2131    
2132       Possible Answers:
2133    
2134        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2135        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2136        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 2175  Internet-Draft       LinuxSampler Contro Line 2177  Internet-Draft       LinuxSampler Contro
2177              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2178              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2179              signal, "NONE" if there's no device connected to this              signal, "NONE" if there's no device connected to this
             sampler channel  
   
2180    
2181    
2182    
# Line 2185  Schoenebeck            Expires November Line 2185  Schoenebeck            Expires November
2185  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft       LinuxSampler Control Protocol              May 2005
2186    
2187    
2188                sampler channel
2189           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2190              number of output channels the sampler channel offers              number of output channels the sampler channel offers
2191              (dependent to used sampler engine and loaded instrument)              (dependent to used sampler engine and loaded instrument)
# Line 2231  Internet-Draft       LinuxSampler Contro Line 2232  Internet-Draft       LinuxSampler Contro
2232           "VOLUME: 1.0"           "VOLUME: 1.0"
2233           "AUDIO_OUTPUT_DEVICE: 0"           "AUDIO_OUTPUT_DEVICE: 0"
2234           "AUDIO_OUTPUT_CHANNELS: 2"           "AUDIO_OUTPUT_CHANNELS: 2"
          "AUDIO_OUTPUT_ROUTING: 0,1"  
2235    
2236    
2237    
# Line 2241  Schoenebeck            Expires November Line 2241  Schoenebeck            Expires November
2241  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft       LinuxSampler Control Protocol              May 2005
2242    
2243    
2244             "AUDIO_OUTPUT_ROUTING: 0,1"
2245           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2246           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
2247           "INSTRUMENT_NAME: Fazioli Piano"           "INSTRUMENT_NAME: Fazioli Piano"
# Line 2291  Internet-Draft       LinuxSampler Contro Line 2292  Internet-Draft       LinuxSampler Contro
2292    
2293    
2294    
   
2295  Schoenebeck            Expires November 19, 2005               [Page 41]  Schoenebeck            Expires November 19, 2005               [Page 41]
2296    
2297  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft       LinuxSampler Control Protocol              May 2005
# Line 2529  Internet-Draft       LinuxSampler Contro Line 2529  Internet-Draft       LinuxSampler Contro
2529           message           message
2530        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2531           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2532           error messag           error message
2533    
2534     Examples:     Examples:
2535    
# Line 2935  Internet-Draft       LinuxSampler Contro Line 2935  Internet-Draft       LinuxSampler Contro
2935  7.5  Channel information changed  7.5  Channel information changed
2936    
2937     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
2938     channels on the back-end changes by issuing the following command:     channels on the back-end by issuing the following command:
2939    
2940        SUBSCRIBE CHANNEL_INFO        SUBSCRIBE CHANNEL_INFO
2941    
# Line 3090  Internet-Draft       LinuxSampler Contro Line 3090  Internet-Draft       LinuxSampler Contro
3090        Rui Nuno Capela        Rui Nuno Capela
3091        Vladimir Senkov        Vladimir Senkov
3092        Mark Knecht        Mark Knecht
3093          Grigor Iliev
3094    
3095  10  References  10  References
3096    
# Line 3109  Author's Address Line 3110  Author's Address
3110    
3111    
3112    
   
3113    
3114    
3115    

Legend:
Removed from v.560  
changed lines
  Added in v.561

  ViewVC Help
Powered by ViewVC