linuxsampler/lscp/Instrument.java

/*
 *   jlscp - a java LinuxSampler control protocol API
 *
 *   Copyright (C) 2005-2007 Grigor Iliev <grigor@grigoriliev.com>
 *
 *   This file is part of jlscp.
 *
 *   jlscp is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2
 *   as published by the Free Software Foundation.
 *
 *   jlscp is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with jlscp; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.linuxsampler.lscp;

/**
 *
 * @author Grigor Iliev
 */
public interface Instrument {
        /**
         * Gets the name of this instrument.
         * @return The name of this instrument.
         */
        public String getName();
        
        /**
         * Sets the name of this instrument.
         * @param name The name of this instrument.
         */
        public void setName(String name);
        
        /**
         * Returns the absolute path name of the instrument file.
         * @return The absolute path name of the instrument file.
         */
        public String getFilePath();
        
        /**
         * Sets the absolute path name of the instrument file.
         * @param path Specifies the absolute path name of the instrument file.
         */
        public void setFilePath(String path);
        
        /**
         * Returns the index of the instrument in the instrument file.
         * @return The index of the instrument in the instrument file.
         */
        public int getInstrumentIndex();
        
        /**
         * Sets the index of the instrument in the instrument file.
         * @param idx The index of the instrument in the instrument file.
         */
        public void setInstrumentIndex(int idx);
        
        /**
         * Returns the format family of the instrument.
         **/
        public String getFormatFamily();
        
        /**
         * Returns the format version of the instrument.
         **/
        public String getFormatVersion();
        
        /**
         * Gets the name of the sampler engine to be used to load the instrument.
         * @return The name of the sampler engine to be used to load the instrument.
         */
        public String getEngine();
        
        public Integer[] getKeyMapping();
        
        public Integer[] getKeyswitchMapping();
}
1	/*
2	* jlscp - a java LinuxSampler control protocol API
3	*
4	* Copyright (C) 2005-2007 Grigor Iliev <grigor@grigoriliev.com>
5	*
6	* This file is part of jlscp.
7	*
8	* jlscp is free software; you can redistribute it and/or modify
9	* it under the terms of the GNU General Public License version 2
10	* as published by the Free Software Foundation.
11	*
12	* jlscp is distributed in the hope that it will be useful,
13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	* GNU General Public License for more details.
16	*
17	* You should have received a copy of the GNU General Public License
18	* along with jlscp; if not, write to the Free Software
19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
20	* MA 02111-1307 USA
21	*/
22
23	package org.linuxsampler.lscp;
24
25	/**
26	*
27	* @author Grigor Iliev
28	*/
29	public interface Instrument {
30	/**
31	* Gets the name of this instrument.
32	* @return The name of this instrument.
33	*/
34	public String getName();
35
36	/**
37	* Sets the name of this instrument.
38	* @param name The name of this instrument.
39	*/
40	public void setName(String name);
41
42	/**
43	* Returns the absolute path name of the instrument file.
44	* @return The absolute path name of the instrument file.
45	*/
46	public String getFilePath();
47
48	/**
49	* Sets the absolute path name of the instrument file.
50	* @param path Specifies the absolute path name of the instrument file.
51	*/
52	public void setFilePath(String path);
53
54	/**
55	* Returns the index of the instrument in the instrument file.
56	* @return The index of the instrument in the instrument file.
57	*/
58	public int getInstrumentIndex();
59
60	/**
61	* Sets the index of the instrument in the instrument file.
62	* @param idx The index of the instrument in the instrument file.
63	*/
64	public void setInstrumentIndex(int idx);
65
66	/**
67	* Returns the format family of the instrument.
68	**/
69	public String getFormatFamily();
70
71	/**
72	* Returns the format version of the instrument.
73	**/
74	public String getFormatVersion();
75
76	/**
77	* Gets the name of the sampler engine to be used to load the instrument.
78	* @return The name of the sampler engine to be used to load the instrument.
79	*/
80	public String getEngine();
81
82	public Integer[] getKeyMapping();
83
84	public Integer[] getKeyswitchMapping();
85	}