4720 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
4721 |
<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> |
4722 |
|
|
4723 |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL"> |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"> |
4724 |
|
<t>Client may want to be notified when the total number of audio output devices on the |
4725 |
|
back-end changes by issuing the following command:</t> |
4726 |
|
<t> |
4727 |
|
<list> |
4728 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t> |
4729 |
|
</list> |
4730 |
|
</t> |
4731 |
|
<t>Server will start sending the following notification messages:</t> |
4732 |
|
<t> |
4733 |
|
<list> |
4734 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"</t> |
4735 |
|
</list> |
4736 |
|
</t> |
4737 |
|
<t>where <devices> will be replaced by the new number |
4738 |
|
of audio output devices.</t> |
4739 |
|
</section> |
4740 |
|
|
4741 |
|
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"> |
4742 |
|
<t>Client may want to be notified when changes were made to audio output devices on the |
4743 |
|
back-end by issuing the following command:</t> |
4744 |
|
<t> |
4745 |
|
<list> |
4746 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t> |
4747 |
|
</list> |
4748 |
|
</t> |
4749 |
|
<t>Server will start sending the following notification messages:</t> |
4750 |
|
<t> |
4751 |
|
<list> |
4752 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"</t> |
4753 |
|
</list> |
4754 |
|
</t> |
4755 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio output device, |
4756 |
|
which settings has been changed. The front-end will have to send |
4757 |
|
the respective command to actually get the audio output device info. Because these messages |
4758 |
|
will be triggered by LSCP commands issued by other clients rather than real |
4759 |
|
time events happening on the server, it is believed that an empty notification |
4760 |
|
message is sufficient here.</t> |
4761 |
|
</section> |
4762 |
|
|
4763 |
|
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"> |
4764 |
|
<t>Client may want to be notified when the total number of MIDI input devices on the |
4765 |
|
back-end changes by issuing the following command:</t> |
4766 |
|
<t> |
4767 |
|
<list> |
4768 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t> |
4769 |
|
</list> |
4770 |
|
</t> |
4771 |
|
<t>Server will start sending the following notification messages:</t> |
4772 |
|
<t> |
4773 |
|
<list> |
4774 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"</t> |
4775 |
|
</list> |
4776 |
|
</t> |
4777 |
|
<t>where <devices> will be replaced by the new number |
4778 |
|
of MIDI input devices.</t> |
4779 |
|
</section> |
4780 |
|
|
4781 |
|
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"> |
4782 |
|
<t>Client may want to be notified when changes were made to MIDI input devices on the |
4783 |
|
back-end by issuing the following command:</t> |
4784 |
|
<t> |
4785 |
|
<list> |
4786 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t> |
4787 |
|
</list> |
4788 |
|
</t> |
4789 |
|
<t>Server will start sending the following notification messages:</t> |
4790 |
|
<t> |
4791 |
|
<list> |
4792 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"</t> |
4793 |
|
</list> |
4794 |
|
</t> |
4795 |
|
<t>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
4796 |
|
which settings has been changed. The front-end will have to send |
4797 |
|
the respective command to actually get the MIDI input device info. Because these messages |
4798 |
|
will be triggered by LSCP commands issued by other clients rather than real |
4799 |
|
time events happening on the server, it is believed that an empty notification |
4800 |
|
message is sufficient here.</t> |
4801 |
|
</section> |
4802 |
|
|
4803 |
|
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT"> |
4804 |
<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 |
4805 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
4806 |
<t> |
<t> |
4877 |
"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> |
4878 |
</section> |
</section> |
4879 |
|
|
4880 |
<section title="Channel information changed" anchor="SUBSCRIBE INFO"> |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO"> |
4881 |
<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 |
4882 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
4883 |
<t> |
<t> |
4917 |
all currently active voices.</t> |
all currently active voices.</t> |
4918 |
</section> |
</section> |
4919 |
|
|
4920 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
4921 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
4922 |
|
back-end changes by issuing the following command:</t> |
4923 |
|
<t> |
4924 |
|
<list> |
4925 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t> |
4926 |
|
</list> |
4927 |
|
</t> |
4928 |
|
<t>Server will start sending the following notification messages:</t> |
4929 |
|
<t> |
4930 |
|
<list> |
4931 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"</t> |
4932 |
|
</list> |
4933 |
|
</t> |
4934 |
|
<t>where <maps> will be replaced by the new number |
4935 |
|
of MIDI instrument maps.</t> |
4936 |
|
</section> |
4937 |
|
|
4938 |
|
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"> |
4939 |
|
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
4940 |
|
back-end by issuing the following command:</t> |
4941 |
|
<t> |
4942 |
|
<list> |
4943 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t> |
4944 |
|
</list> |
4945 |
|
</t> |
4946 |
|
<t>Server will start sending the following notification messages:</t> |
4947 |
|
<t> |
4948 |
|
<list> |
4949 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"</t> |
4950 |
|
</list> |
4951 |
|
</t> |
4952 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
4953 |
|
for which information changes occurred. The front-end will have to send |
4954 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
4955 |
|
will be triggered by LSCP commands issued by other clients rather than real |
4956 |
|
time events happening on the server, it is believed that an empty notification |
4957 |
|
message is sufficient here.</t> |
4958 |
|
</section> |
4959 |
|
|
4960 |
|
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT"> |
4961 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
4962 |
|
back-end changes by issuing the following command:</t> |
4963 |
|
<t> |
4964 |
|
<list> |
4965 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t> |
4966 |
|
</list> |
4967 |
|
</t> |
4968 |
|
<t>Server will start sending the following notification messages:</t> |
4969 |
|
<t> |
4970 |
|
<list> |
4971 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
4972 |
|
</list> |
4973 |
|
</t> |
4974 |
|
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
4975 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
4976 |
|
the new number of MIDI instruments in the specified map.</t> |
4977 |
|
</section> |
4978 |
|
|
4979 |
|
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO"> |
4980 |
|
<t>Client may want to be notified when changes were made to MIDI instruments on the |
4981 |
|
back-end by issuing the following command:</t> |
4982 |
|
<t> |
4983 |
|
<list> |
4984 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t> |
4985 |
|
</list> |
4986 |
|
</t> |
4987 |
|
<t>Server will start sending the following notification messages:</t> |
4988 |
|
<t> |
4989 |
|
<list> |
4990 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"</t> |
4991 |
|
</list> |
4992 |
|
</t> |
4993 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
4994 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
4995 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
4996 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
4997 |
|
will be triggered by LSCP commands issued by other clients rather than real |
4998 |
|
time events happening on the server, it is believed that an empty notification |
4999 |
|
message is sufficient here.</t> |
5000 |
|
</section> |
5001 |
|
|
5002 |
|
<<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
5003 |
<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 |
5004 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
5005 |
<t> |
<t> |