lscp/event/GlobalInfoEvent.java

/*
 *   jlscp - a java LinuxSampler control protocol API
 *
 *   Copyright (C) 2005-2008 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.event;

/**
 * A semantic event which indicates changes to the global settings of the sampler.
 * @author Grigor Iliev
 */
public class GlobalInfoEvent extends java.util.EventObject {
        private float volume = 0;
        private int voiceLimit;
        private int streamLimit;
        
        /**
         * Constructs a <code>GlobalInfoEvent</code> object.
         * @param source The object that originated the event.
         */
        public
        GlobalInfoEvent(Object source) {
                super(source);
        }
        
        /**
         * Constructs a <code>GlobalInfoEvent</code> object.
         * @param source The object that originated the event.
         * @param volume Specifies the new global volume of the sampler.
         */
        public
        GlobalInfoEvent(Object source, float volume) {
                super(source);
                this.volume = volume;
        }
        
        /**
         * Constructs a <code>GlobalInfoEvent</code> object.
         * @param source The object that originated the event.
         */
        public
        GlobalInfoEvent(Object source, int maxVoices, int maxStreams) {
                super(source);
                voiceLimit = maxVoices;
                streamLimit = maxStreams;
        }
        
        /**
         * Gets the new global volume value of the sampler.
         * The returned value is only valid when {@link GlobalInfoListener#volumeChanged}
         * event is fired.
         * @return The new global volume value of the sampler.
         */
        public float
        getVolume() { return volume; }
        
        /**
         * Gets the new global sampler-wide limit of maximum voices.
         * The returned value is only valid when {@link GlobalInfoListener#voiceLimitChanged}
         * event is fired.
         * @return The new global sampler-wide limit of maximum voices.
         */
        public int
        getVoiceLimit() { return voiceLimit; }
        
        /**
         * Gets the new global sampler-wide limit of maximum disk streams.
         * The returned value is only valid when {@link GlobalInfoListener#streamLimitChanged}
         * event is fired.
         * @return The new global sampler-wide limit of maximum disk streams.
         */
        public int
        getStreamLimit() { return streamLimit; }
}
1	iliev	1140	/*
2			* jlscp - a java LinuxSampler control protocol API
3			*
4	iliev	1817	* Copyright (C) 2005-2008 Grigor Iliev <grigor@grigoriliev.com>
5	iliev	1140	*
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.event;
24
25			/**
26			* A semantic event which indicates changes to the global settings of the sampler.
27			* @author Grigor Iliev
28			*/
29			public class GlobalInfoEvent extends java.util.EventObject {
30			private float volume = 0;
31	iliev	1817	private int voiceLimit;
32			private int streamLimit;
33	iliev	1140
34			/**
35			* Constructs a <code>GlobalInfoEvent</code> object.
36			* @param source The object that originated the event.
37			*/
38			public
39			GlobalInfoEvent(Object source) {
40			super(source);
41			}
42
43			/**
44			* Constructs a <code>GlobalInfoEvent</code> object.
45			* @param source The object that originated the event.
46			* @param volume Specifies the new global volume of the sampler.
47			*/
48			public
49			GlobalInfoEvent(Object source, float volume) {
50			super(source);
51			this.volume = volume;
52			}
53
54			/**
55	iliev	1817	* Constructs a <code>GlobalInfoEvent</code> object.
56			* @param source The object that originated the event.
57			*/
58			public
59			GlobalInfoEvent(Object source, int maxVoices, int maxStreams) {
60			super(source);
61			voiceLimit = maxVoices;
62			streamLimit = maxStreams;
63			}
64
65			/**
66	iliev	1140	* Gets the new global volume value of the sampler.
67			* The returned value is only valid when {@link GlobalInfoListener#volumeChanged}
68			* event is fired.
69			* @return The new global volume value of the sampler.
70			*/
71			public float
72			getVolume() { return volume; }
73	iliev	1817
74			/**
75			* Gets the new global sampler-wide limit of maximum voices.
76			* The returned value is only valid when {@link GlobalInfoListener#voiceLimitChanged}
77			* event is fired.
78			* @return The new global sampler-wide limit of maximum voices.
79			*/
80			public int
81			getVoiceLimit() { return voiceLimit; }
82
83			/**
84			* Gets the new global sampler-wide limit of maximum disk streams.
85			* The returned value is only valid when {@link GlobalInfoListener#streamLimitChanged}
86			* event is fired.
87			* @return The new global sampler-wide limit of maximum disk streams.
88			*/
89			public int
90			getStreamLimit() { return streamLimit; }
91	iliev	1140	}