lscp/event/BufferFillEvent.java

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

import java.util.Vector;

import org.linuxsampler.lscp.BufferFill;

/**
 * A semantic event which indicates that the fill state of a disk stream buffer
 * in a sampler channel has changed.
 *
 * @author  Grigor Iliev
 */
public class BufferFillEvent extends java.util.EventObject {
        private int samplerChn;
        private Vector<BufferFill> fills = new Vector<BufferFill>();
        
        /**
         * Constructs a <code>BufferFillEvent</code> object.
         *
         * @param source The object that originated the event.
         * @param samplerChn The number of the sampler channel for which 
         * the buffer fill state change occurred.
         * @param fills The new fill state of all disk streams in percent.
         */
        public
        BufferFillEvent(Object source, int samplerChn, Vector<BufferFill> fills) {
                super(source);
                this.samplerChn = samplerChn;
                this.fills = fills;
        }
        
        /**
         * Gets the number of the sampler channel for which 
         * the buffer fill state change occurred.
         *
         * @return The number of the sampler channel for which 
         * the buffer fill state change occurred.
         */
        public int
        getSamplerChannel() { return samplerChn; }
        
        /**
         *  Gets the new fill state of all disk streams in percent.
         *
         * @return The new fill state of all disk streams in percent.
         */
        public Vector<BufferFill>
        getChannelBufferFillPercentage() { return fills; }
}
1	iliev	596	/*
2			* jlscp - a java LinuxSampler control protocol API
3			*
4	iliev	1139	* Copyright (C) 2005-2006 Grigor Iliev <grigor@grigoriliev.com>
5	iliev	596	*
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			import java.util.Vector;
26
27			import org.linuxsampler.lscp.BufferFill;
28
29			/**
30			* A semantic event which indicates that the fill state of a disk stream buffer
31			* in a sampler channel has changed.
32			*
33			* @author Grigor Iliev
34			*/
35			public class BufferFillEvent extends java.util.EventObject {
36			private int samplerChn;
37			private Vector<BufferFill> fills = new Vector<BufferFill>();
38
39			/**
40			* Constructs a <code>BufferFillEvent</code> object.
41			*
42			* @param source The object that originated the event.
43			* @param samplerChn The number of the sampler channel for which
44			* the buffer fill state change occurred.
45			* @param fills The new fill state of all disk streams in percent.
46			*/
47			public
48			BufferFillEvent(Object source, int samplerChn, Vector<BufferFill> fills) {
49			super(source);
50			this.samplerChn = samplerChn;
51			this.fills = fills;
52			}
53
54			/**
55			* Gets the number of the sampler channel for which
56			* the buffer fill state change occurred.
57			*
58			* @return The number of the sampler channel for which
59			* the buffer fill state change occurred.
60			*/
61			public int
62			getSamplerChannel() { return samplerChn; }
63
64			/**
65			* Gets the new fill state of all disk streams in percent.
66			*
67			* @return The new fill state of all disk streams in percent.
68			*/
69			public Vector<BufferFill>
70			getChannelBufferFillPercentage() { return fills; }
71			}