/[svn]/linuxsampler/trunk/Documentation/lscp.xml
ViewVC logotype

Diff of /linuxsampler/trunk/Documentation/lscp.xml

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

revision 973 by schoenebeck, Fri Dec 15 21:40:27 2006 UTC revision 984 by iliev, Mon Dec 18 10:28:00 2006 UTC
# Line 4311  Schoenebeck'> Line 4311  Schoenebeck'>
4311  </t>  </t>
4312  <t>subscribe_event =  <t>subscribe_event =
4313          <list>          <list>
4314                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
4315                    </t>
4316                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
4317                    </t>
4318                    <t>/ MIDI_INPUT_DEVICE_COUNT
4319                    </t>
4320                    <t>/ MIDI_INPUT_DEVICE_INFO
4321                    </t>
4322                    <t>/ CHANNEL_COUNT
4323                  </t>                  </t>
4324                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
4325                  </t>                  </t>
# Line 4321  Schoenebeck'> Line 4329  Schoenebeck'>
4329                  </t>                  </t>
4330                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4331                  </t>                  </t>
4332                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
4333                    </t>
4334                    <t>/ MIDI_INSTRUMENT_MAP_INFO
4335                    </t>
4336                    <t>/ MIDI_INSTRUMENT_COUNT
4337                    </t>
4338                    <t>/ MIDI_INSTRUMENT_INFO
4339                    </t>
4340                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
4341                  </t>                  </t>
4342                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 4329  Schoenebeck'> Line 4345  Schoenebeck'>
4345  </t>  </t>
4346  <t>unsubscribe_event =  <t>unsubscribe_event =
4347          <list>          <list>
4348                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
4349                    </t>
4350                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
4351                    </t>
4352                    <t>/ MIDI_INPUT_DEVICE_COUNT
4353                    </t>
4354                    <t>/ MIDI_INPUT_DEVICE_INFO
4355                    </t>
4356                    <t>/ CHANNEL_COUNT
4357                  </t>                  </t>
4358                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
4359                  </t>                  </t>
# Line 4339  Schoenebeck'> Line 4363  Schoenebeck'>
4363                  </t>                  </t>
4364                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4365                  </t>                  </t>
4366                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
4367                    </t>
4368                    <t>/ MIDI_INSTRUMENT_MAP_INFO
4369                    </t>
4370                    <t>/ MIDI_INSTRUMENT_COUNT
4371                    </t>
4372                    <t>/ MIDI_INSTRUMENT_INFO
4373                    </t>
4374                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
4375                  </t>                  </t>
4376                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 4720  Schoenebeck'> Line 4752  Schoenebeck'>
4752          <section title="Events" anchor="events">          <section title="Events" anchor="events">
4753              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>
4754    
4755              <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL">              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
4756                    <t>Client may want to be notified when the total number of audio output devices on the
4757                    back-end changes by issuing the following command:</t>
4758                    <t>
4759                        <list>
4760                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
4761                        </list>
4762                    </t>
4763                    <t>Server will start sending the following notification messages:</t>
4764                    <t>
4765                        <list>
4766                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
4767                        </list>
4768                    </t>
4769                    <t>where &lt;devices&gt; will be replaced by the new number
4770                    of audio output devices.</t>
4771                </section>
4772    
4773                <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
4774                    <t>Client may want to be notified when changes were made to audio output devices on the
4775                    back-end by issuing the following command:</t>
4776                    <t>
4777                        <list>
4778                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
4779                        </list>
4780                    </t>
4781                    <t>Server will start sending the following notification messages:</t>
4782                    <t>
4783                        <list>
4784                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
4785                        </list>
4786                    </t>
4787                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
4788                    which settings has been changed. The front-end will have to send
4789                    the respective command to actually get the audio output device info. Because these messages
4790                    will be triggered by LSCP commands issued by other clients rather than real
4791                    time events happening on the server, it is believed that an empty notification
4792                    message is sufficient here.</t>
4793                </section>
4794    
4795                <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
4796                    <t>Client may want to be notified when the total number of MIDI input devices on the
4797                    back-end changes by issuing the following command:</t>
4798                    <t>
4799                        <list>
4800                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
4801                        </list>
4802                    </t>
4803                    <t>Server will start sending the following notification messages:</t>
4804                    <t>
4805                        <list>
4806                            <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
4807                        </list>
4808                    </t>
4809                    <t>where &lt;devices&gt; will be replaced by the new number
4810                    of MIDI input devices.</t>
4811                </section>
4812    
4813                <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
4814                    <t>Client may want to be notified when changes were made to MIDI input devices on the
4815                    back-end by issuing the following command:</t>
4816                    <t>
4817                        <list>
4818                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
4819                        </list>
4820                    </t>
4821                    <t>Server will start sending the following notification messages:</t>
4822                    <t>
4823                        <list>
4824                            <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
4825                        </list>
4826                    </t>
4827                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
4828                    which settings has been changed. The front-end will have to send
4829                    the respective command to actually get the MIDI input device info. Because these messages
4830                    will be triggered by LSCP commands issued by other clients rather than real
4831                    time events happening on the server, it is believed that an empty notification
4832                    message is sufficient here.</t>
4833                </section>
4834    
4835                <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
4836                  <t>Client may want to be notified when the total number of channels on the                  <t>Client may want to be notified when the total number of channels on the
4837                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
4838                  <t>                  <t>
# Line 4797  Schoenebeck'> Line 4909  Schoenebeck'>
4909                  "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>                  "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
4910              </section>              </section>
4911    
4912              <section title="Channel information changed" anchor="SUBSCRIBE INFO">              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
4913                  <t>Client may want to be notified when changes were made to sampler channels on the                  <t>Client may want to be notified when changes were made to sampler channels on the
4914                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
4915                  <t>                  <t>
# Line 4837  Schoenebeck'> Line 4949  Schoenebeck'>
4949                  all currently active voices.</t>                  all currently active voices.</t>
4950              </section>              </section>
4951    
4952              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
4953                    <t>Client may want to be notified when the number of MIDI instrument maps on the
4954                    back-end changes by issuing the following command:</t>
4955                    <t>
4956                        <list>
4957                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
4958                        </list>
4959                    </t>
4960                    <t>Server will start sending the following notification messages:</t>
4961                    <t>
4962                        <list>
4963                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
4964                        </list>
4965                    </t>
4966                    <t>where &lt;maps&gt; will be replaced by the new number
4967                    of MIDI instrument maps.</t>
4968                </section>
4969    
4970                <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
4971                    <t>Client may want to be notified when changes were made to MIDI instrument maps on the
4972                    back-end by issuing the following command:</t>
4973                    <t>
4974                        <list>
4975                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
4976                        </list>
4977                    </t>
4978                    <t>Server will start sending the following notification messages:</t>
4979                    <t>
4980                        <list>
4981                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
4982                        </list>
4983                    </t>
4984                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
4985                    for which information changes occurred. The front-end will have to send
4986                    the respective command to actually get the MIDI instrument map info. Because these messages
4987                    will be triggered by LSCP commands issued by other clients rather than real
4988                    time events happening on the server, it is believed that an empty notification
4989                    message is sufficient here.</t>
4990                </section>
4991    
4992                <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
4993                    <t>Client may want to be notified when the number of MIDI instrument maps on the
4994                    back-end changes by issuing the following command:</t>
4995                    <t>
4996                        <list>
4997                            <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
4998                        </list>
4999                    </t>
5000                    <t>Server will start sending the following notification messages:</t>
5001                    <t>
5002                        <list>
5003                            <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
5004                        </list>
5005                    </t>
5006                    <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
5007                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
5008                    the new number of MIDI instruments in the specified map.</t>
5009                </section>
5010    
5011                <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
5012                    <t>Client may want to be notified when changes were made to MIDI instruments on the
5013                    back-end by issuing the following command:</t>
5014                    <t>
5015                        <list>
5016                            <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
5017                        </list>
5018                    </t>
5019                    <t>Server will start sending the following notification messages:</t>
5020                    <t>
5021                        <list>
5022                            <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
5023                        </list>
5024                    </t>
5025                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
5026                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
5027                    the location of the changed MIDI instrument in the map. The front-end will have to send
5028                    the respective command to actually get the MIDI instrument info. Because these messages
5029                    will be triggered by LSCP commands issued by other clients rather than real
5030                    time events happening on the server, it is believed that an empty notification
5031                    message is sufficient here.</t>
5032                </section>
5033    
5034                <<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
5035                  <t>Client may want to be notified of miscellaneous and debugging events occurring at                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
5036                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
5037                  <t>                  <t>
Legend:
Removed from v.973  
changed lines
  Added in v.984
  ViewVC Help
Powered by ViewVC