/[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 706 by iliev, Thu Jul 21 08:34:46 2005 UTC revision 778 by iliev, Fri Sep 23 06:58:26 2005 UTC
# Line 31  Schoenebeck'> Line 31  Schoenebeck'>
31                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
32              </address>              </address>
33          </author>          </author>
34          <date month="May" year="2005"/>          <date month="September" year="2005"/>
35          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
36          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
37          <abstract>          <abstract>
# Line 2559  Schoenebeck'> Line 2559  Schoenebeck'>
2559                                      <t>MUTE -                                      <t>MUTE -
2560                                          <list>                                          <list>
2561                                              <t>Determines whether the channel is muted, "true" if the                                              <t>Determines whether the channel is muted, "true" if the
2562                                              channel is muted, "false" if the channel is not muted, and                                              channel is muted, "false" if the channel is not muted, and
2563                                              "MUTED_BY_SOLO" if the channel is muted because of the                                              "MUTED_BY_SOLO" if the channel is muted because of the
2564                                              presence of a solo channel and will be unmuted when                                              presence of a solo channel and will be unmuted when
2565                                              there are no solo channels left</t>                                              there are no solo channels left</t>
2566                                          </list>                                          </list>
2567                                      </t>                                      </t>
# Line 3329  Schoenebeck'> Line 3329  Schoenebeck'>
3329              <section title="Global commands">              <section title="Global commands">
3330                  <t>The following commands have global impact on the sampler.</t>                  <t>The following commands have global impact on the sampler.</t>
3331    
3332                    <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
3333                        <t>The front-end can ask for the current number of active voices on
3334                        the sampler by sending the following command:</t>
3335                        <t>
3336                            <list>
3337                                <t>GET TOTAL_VOICE_COUNT</t>
3338                            </list>
3339                        </t>
3340    
3341                        <t>Possible Answers:</t>
3342                        <t>
3343                            <list>
3344                                <t>LinuxSampler will answer by returning the number of all active
3345                                voices on the sampler.</t>
3346                            </list>
3347                        </t>
3348                    </section>
3349    
3350                    <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
3351                        <t>The front-end can ask for the maximum number of active voices
3352                        by sending the following command:</t>
3353                        <t>
3354                            <list>
3355                                <t>GET TOTAL_VOICE_COUNT_MAX</t>
3356                            </list>
3357                        </t>
3358    
3359                        <t>Possible Answers:</t>
3360                        <t>
3361                            <list>
3362                                <t>LinuxSampler will answer by returning the maximum number
3363                                of active voices.</t>
3364                            </list>
3365                        </t>
3366                    </section>
3367    
3368                  <section title="Reset sampler" anchor="RESET">                  <section title="Reset sampler" anchor="RESET">
3369                      <t>The front-end can reset the whole sampler by sending the following command:</t>                      <t>The front-end can reset the whole sampler by sending the following command:</t>
3370                      <t>                      <t>
# Line 3422  Schoenebeck'> Line 3458  Schoenebeck'>
3458  </t>  </t>
3459  <t>line =  <t>line =
3460          <list>          <list>
3461                  <t>/* epsilon (empty line ignored) */                  <t>/* epsilon (empty line ignored) */
3462                  </t>                  </t>
3463                  <t>/ comment                    <t>/ comment
3464                  </t>                  </t>
3465                  <t>/ command                    <t>/ command
3466                  </t>                  </t>
3467                  <t>/ error                      <t>/ error
3468                  </t>                  </t>
3469          </list>          </list>
3470  </t>  </t>
# Line 3448  Schoenebeck'> Line 3484  Schoenebeck'>
3484  </t>  </t>
3485  <t>command =  <t>command =
3486          <list>          <list>
3487                  <t>ADD SP CHANNEL                                          <t>ADD SP CHANNEL
3488                  </t>                  </t>
3489                  <t>/ GET SP get_instruction                                  <t>/ GET SP get_instruction
3490                  </t>                  </t>
3491                  <t>/ CREATE SP create_instruction                            <t>/ CREATE SP create_instruction
3492                  </t>                  </t>
3493                  <t>/ DESTROY SP destroy_instruction                          <t>/ DESTROY SP destroy_instruction
3494                  </t>                  </t>
3495                  <t>/ LIST SP list_instruction                                <t>/ LIST SP list_instruction
3496                  </t>                  </t>
3497                  <t>/ LOAD SP load_instruction                                <t>/ LOAD SP load_instruction
3498                  </t>                  </t>
3499                  <t>/ REMOVE SP CHANNEL SP sampler_channel                    <t>/ REMOVE SP CHANNEL SP sampler_channel
3500                  </t>                  </t>
3501                  <t>/ SET SP set_instruction                                  <t>/ SET SP set_instruction
3502                  </t>                  </t>
3503                  <t>/ SUBSCRIBE SP subscribe_event                            <t>/ SUBSCRIBE SP subscribe_event
3504                  </t>                  </t>
3505                  <t>/ UNSUBSCRIBE SP unsubscribe_event                        <t>/ UNSUBSCRIBE SP unsubscribe_event
3506                  </t>                  </t>
3507                  <t>/ SELECT SP text                                          <t>/ SELECT SP text
3508                  </t>                  </t>
3509                  <t>/ RESET SP CHANNEL SP sampler_channel                    <t>/ RESET SP CHANNEL SP sampler_channel
3510                  </t>                  </t>
3511                  <t>/ RESET                                                  <t>/ RESET
3512                  </t>                  </t>
3513                  <t>/ QUIT                                                    <t>/ QUIT
3514                  </t>                  </t>
3515          </list>          </list>
3516  </t>  </t>
3517  <t>subscribe_event =  <t>subscribe_event =
3518          <list>          <list>
3519                  <t>CHANNEL_COUNT                                          <t>CHANNEL_COUNT
3520                    </t>
3521                    <t>/ VOICE_COUNT
3522                  </t>                  </t>
3523                  <t>/ VOICE_COUNT                                            <t>/ STREAM_COUNT
3524                  </t>                  </t>
3525                  <t>/ STREAM_COUNT                                            <t>/ BUFFER_FILL
3526                  </t>                  </t>
3527                  <t>/ BUFFER_FILL                                            <t>/ CHANNEL_INFO
3528                  </t>                  </t>
3529                  <t>/ CHANNEL_INFO                                            <t>/ MISCELLANEOUS
3530                  </t>                  </t>
3531                  <t>/ MISCELLANEOUS                                          <t>/ TOTAL_VOICE_COUNT
3532                  </t>                  </t>
3533          </list>          </list>
3534  </t>  </t>
3535  <t>unsubscribe_event =  <t>unsubscribe_event =
3536          <list>          <list>
3537                  <t>CHANNEL_COUNT                                          <t>CHANNEL_COUNT
3538                  </t>                  </t>
3539                  <t>/ VOICE_COUNT                                            <t>/ VOICE_COUNT
3540                  </t>                  </t>
3541                  <t>/ STREAM_COUNT                                            <t>/ STREAM_COUNT
3542                  </t>                  </t>
3543                  <t>/ BUFFER_FILL                                            <t>/ BUFFER_FILL
3544                  </t>                  </t>
3545                  <t>/ CHANNEL_INFO                                            <t>/ CHANNEL_INFO
3546                  </t>                  </t>
3547                  <t>/ MISCELLANEOUS                                          <t>/ MISCELLANEOUS
3548                    </t>
3549                    <t>/ TOTAL_VOICE_COUNT
3550                  </t>                  </t>
3551          </list>          </list>
3552  </t>  </t>
3553  <t>get_instruction =  <t>get_instruction =
3554          <list>          <list>
3555                  <t>AVAILABLE_ENGINES                                                                            <t>AVAILABLE_ENGINES
3556                    </t>
3557                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
3558                    </t>
3559                    <t>/ MIDI_INPUT_DRIVER SP INFO SP string
3560                  </t>                  </t>
3561                  <t>/ AVAILABLE_MIDI_INPUT_DRIVERS                                                                <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
3562                  </t>                  </t>
3563                  <t>/ MIDI_INPUT_DRIVER SP INFO SP string                                                          <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
3564                  </t>                  </t>
3565                  <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string                                      <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
3566                  </t>                  </t>
3567                  <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list                      <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
3568                  </t>                  </t>
3569                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS                                                              <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
3570                  </t>                  </t>
3571                  <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string                                                        <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
3572                  </t>                  </t>
3573                  <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string                                    <t>/ AUDIO_OUTPUT_DEVICES
3574                  </t>                  </t>
3575                  <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list                    <t>/ MIDI_INPUT_DEVICES
3576                  </t>                  </t>
3577                  <t>/ AUDIO_OUTPUT_DEVICES                                                                        <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
3578                  </t>                  </t>
3579                  <t>/ MIDI_INPUT_DEVICES                                                                          <t>/ MIDI_INPUT_DEVICE SP INFO SP number
3580                  </t>                  </t>
3581                  <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number                                                        <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
3582                  </t>                  </t>
3583                  <t>/ MIDI_INPUT_DEVICE SP INFO SP number                                                          <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
3584                  </t>                  </t>
3585                  <t>/ MIDI_INPUT_PORT SP INFO SP number SP number                                                  <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
3586                  </t>                  </t>
3587                  <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string                              <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
3588                  </t>                  </t>
3589                  <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number                                            <t>/ CHANNELS
3590                  </t>                  </t>
3591                  <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string                        <t>/ CHANNEL SP INFO SP sampler_channel
3592                  </t>                  </t>
3593                  <t>/ CHANNELS                                                                                    <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
3594                  </t>                  </t>
3595                  <t>/ CHANNEL SP INFO SP sampler_channel                                                          <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
3596                  </t>                  </t>
3597                  <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel                                <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
3598                  </t>                  </t>
3599                  <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel                                                  <t>/ ENGINE SP INFO SP engine_name
3600                  </t>                  </t>
3601                  <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel                                                    <t>/ SERVER SP INFO
3602                  </t>                  </t>
3603                  <t>/ ENGINE SP INFO SP engine_name                                                                <t>/ TOTAL_VOICE_COUNT
3604                  </t>                  </t>
3605                  <t>/ SERVER SP INFO                                                                              <t>/ TOTAL_VOICE_COUNT_MAX
3606                  </t>                  </t>
3607          </list>          </list>
3608  </t>  </t>
3609  <t>set_instruction =  <t>set_instruction =
3610          <list>          <list>
3611                  <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                              <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
3612                  </t>                  </t>
3613                  <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
3614                  </t>                  </t>
3615                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                                <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
3616                  </t>                  </t>
3617                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list                        <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
3618                  </t>                  </t>
3619                  <t>/ CHANNEL SP set_chan_instruction                                                                    <t>/ CHANNEL SP set_chan_instruction
3620                  </t>                  </t>
3621                  <t>/ ECHO SP boolean                                                                                    <t>/ ECHO SP boolean
3622                  </t>                  </t>
3623          </list>          </list>
3624  </t>  </t>
3625  <t>create_instruction =  <t>create_instruction =
3626          <list>          <list>
3627                  <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list                    <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
3628                  </t>                  </t>
3629                  <t>/ AUDIO_OUTPUT_DEVICE SP string                                    <t>/ AUDIO_OUTPUT_DEVICE SP string
3630                  </t>                  </t>
3631                  <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list                      <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
3632                  </t>                  </t>
3633                  <t>/ MIDI_INPUT_DEVICE SP string                                      <t>/ MIDI_INPUT_DEVICE SP string
3634                  </t>                  </t>
3635          </list>          </list>
3636  </t>  </t>
3637  <t>destroy_instruction =  <t>destroy_instruction =
3638          <list>          <list>
3639                  <t>AUDIO_OUTPUT_DEVICE SP number                    <t>AUDIO_OUTPUT_DEVICE SP number
3640                  </t>                  </t>
3641                  <t>/ MIDI_INPUT_DEVICE SP number                      <t>/ MIDI_INPUT_DEVICE SP number
3642                  </t>                  </t>
3643          </list>          </list>
3644  </t>  </t>
3645  <t>load_instruction =  <t>load_instruction =
3646          <list>          <list>
3647                  <t>INSTRUMENT SP load_instr_args                    <t>INSTRUMENT SP load_instr_args
3648                  </t>                  </t>
3649                  <t>/ ENGINE SP load_engine_args                      <t>/ ENGINE SP load_engine_args
3650                  </t>                  </t>
3651          </list>          </list>
3652  </t>  </t>
3653  <t>set_chan_instruction =  <t>set_chan_instruction =
3654          <list>          <list>
3655                  <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index                                                                <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
3656                  </t>                  </t>
3657                  <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index                                <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
3658                  </t>                  </t>
3659                  <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name                                                        <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
3660                  </t>                  </t>
3661                  <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index                    <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
3662                  </t>                  </t>
3663                  <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index                                                                  <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
3664                  </t>                  </t>
3665                  <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index                                                          <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
3666                  </t>                  </t>
3667                  <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index                                                    <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
3668                  </t>                  </t>
3669                  <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name                                                            <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
3670                  </t>                  </t>
3671                  <t>/ VOLUME SP sampler_channel SP volume_value                                                                            <t>/ VOLUME SP sampler_channel SP volume_value
3672                  </t>                  </t>
3673                  <t>/ MUTE SP sampler_channel SP boolean                                                                                    <t>/ MUTE SP sampler_channel SP boolean
3674                  </t>                  </t>
3675                  <t>/ SOLO SP sampler_channel SP boolean                                                                                    <t>/ SOLO SP sampler_channel SP boolean
3676                  </t>                  </t>
3677          </list>          </list>
3678  </t>  </t>
3679  <t>key_val_list =  <t>key_val_list =
3680          <list>          <list>
3681                  <t>string '=' param_val_list                                    <t>string '=' param_val_list
3682                  </t>                  </t>
3683                  <t>/ key_val_list SP string '=' param_val_list                    <t>/ key_val_list SP string '=' param_val_list
3684                  </t>                  </t>
3685          </list>          </list>
3686  </t>  </t>
3687  <t>buffer_size_type =  <t>buffer_size_type =
3688          <list>          <list>
3689                  <t>BYTES                        <t>BYTES
3690                  </t>                  </t>
3691                  <t>/ PERCENTAGE                    <t>/ PERCENTAGE
3692                  </t>                  </t>
3693          </list>          </list>
3694  </t>  </t>
3695  <t>list_instruction =  <t>list_instruction =
3696          <list>          <list>
3697                  <t>AUDIO_OUTPUT_DEVICES                              <t>AUDIO_OUTPUT_DEVICES
3698                  </t>                  </t>
3699                  <t>/ MIDI_INPUT_DEVICES                                <t>/ MIDI_INPUT_DEVICES
3700                  </t>                  </t>
3701                  <t>/ CHANNELS                                          <t>/ CHANNELS
3702                  </t>                  </t>
3703                  <t>/ AVAILABLE_ENGINES                                <t>/ AVAILABLE_ENGINES
3704                  </t>                  </t>
3705                  <t>/ AVAILABLE_MIDI_INPUT_DRIVERS                      <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
3706                  </t>                  </t>
3707                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
3708                  </t>                  </t>
3709          </list>          </list>
3710  </t>  </t>
3711  <t>load_instr_args =  <t>load_instr_args =
3712          <list>          <list>
3713                  <t>filename SP instrument_index SP sampler_channel                                <t>filename SP instrument_index SP sampler_channel
3714                  </t>                  </t>
3715                  <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel                    <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
3716                  </t>                  </t>
3717          </list>          </list>
3718  </t>  </t>
3719  <t>load_engine_args =  <t>load_engine_args =
3720          <list>          <list>
3721                  <t>engine_name SP sampler_channel                    <t>engine_name SP sampler_channel
3722                  </t>                  </t>
3723          </list>          </list>
3724  </t>  </t>
# Line 3706  Schoenebeck'> Line 3750  Schoenebeck'>
3750          <list>          <list>
3751                  <t>number                  <t>number
3752                  </t>                  </t>
3753                  <t>/ ALL                    <t>/ ALL
3754                  </t>                  </t>
3755          </list>          </list>
3756  </t>  </t>
# Line 3720  Schoenebeck'> Line 3764  Schoenebeck'>
3764          <list>          <list>
3765                  <t>dotnum                  <t>dotnum
3766                  </t>                  </t>
3767                  <t>/ number                    <t>/ number
3768                  </t>                  </t>
3769          </list>          </list>
3770  </t>  </t>
# Line 3752  Schoenebeck'> Line 3796  Schoenebeck'>
3796          <list>          <list>
3797                  <t>param_val                  <t>param_val
3798                  </t>                  </t>
3799                  <t>/ param_val_list','param_val                    <t>/ param_val_list','param_val
3800                  </t>                  </t>
3801          </list>          </list>
3802  </t>  </t>
# Line 3760  Schoenebeck'> Line 3804  Schoenebeck'>
3804          <list>          <list>
3805                  <t>string                  <t>string
3806                  </t>                  </t>
3807                  <t>/ '\'' string '\''                      <t>/ '\'' string '\''
3808                  </t>                  </t>
3809                  <t>/ '\"' string '\"'                      <t>/ '\"' string '\"'
3810                  </t>                  </t>
3811                  <t>/ number                              <t>/ number
3812                  </t>                  </t>
3813                  <t>/ dotnum                              <t>/ dotnum
3814                  </t>                  </t>
3815          </list>          </list>
3816  </t>  </t>
# Line 3876  Schoenebeck'> Line 3920  Schoenebeck'>
3920                  message is sufficient here.</t>                  message is sufficient here.</t>
3921              </section>              </section>
3922    
3923                <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
3924                    <t>Client may want to be notified when the total number of voices on the
3925                    back-end changes by issuing the following command:</t>
3926                    <t>
3927                        <list>
3928                            <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
3929                        </list>
3930                    </t>
3931                    <t>Server will start sending the following notification messages:</t>
3932                    <t>
3933                        <list>
3934                            <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>
3935                        </list>
3936                    </t>
3937                    <t>where &lt;voices&gt; will be replaced by the new number of
3938                    all currently active voices.</t>
3939                </section>
3940    
3941              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
3942                  <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
3943                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
Legend:
Removed from v.706  
changed lines
  Added in v.778
  ViewVC Help
Powered by ViewVC