org/jsampler/AudioDeviceModel.java

/*
 *   JSampler - a java front-end for LinuxSampler
 *
 *   Copyright (C) 2005 Grigor Kirilov Iliev
 *
 *   This file is part of JSampler.
 *
 *   JSampler 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.
 *
 *   JSampler 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 JSampler; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.jsampler;

import org.jsampler.event.AudioDeviceListener;

import org.linuxsampler.lscp.AudioOutputDevice;


/**
 *
 * @author Grigor Iliev
 */
public interface AudioDeviceModel {
        /**
         * Registers the specified listener to be notified when
         * the settings of the audio device are changed.
         * @param l The <code>AudioDeviceListener</code> to register.
         */
        public void
        addAudioDeviceListener(AudioDeviceListener l);
        
        /**
         * Removes the specified listener.
         * @param l The <code>AudioDeviceListener</code> to remove.
         */
        public void removeAudioDeviceListener(AudioDeviceListener l);
        
        /**
         * Gets the numerical ID of this audio device.
         * @return The numerical ID of this audio device or
         * -1 if the device number is not set.
         */
        public int getDeviceID();
        
        /**
         * Gets the current settings of the audio device represented by this model.
         * @return <code>AudioOutputDevice</code> instance providing
         * the current settings of the audio device represented by this model.
         */
        public AudioOutputDevice getDeviceInfo();
        
        /**
         * Updates the settings of the audio device represented by this model.
         * @param device The new audio device settings.
         */
        public void setDeviceInfo(AudioOutputDevice device);
        
        /**
         * Sets whether the audio device is enabled or disabled.
         * @param active If <code>true</code> the audio device is enabled,
         * else the device is disabled.
         */
        public void setActive(boolean active);
        
        /**
         * Determines whether the audio device is active.
         * @return <code>true</code> if the device is enabled and <code>false</code> otherwise.
         */
        public boolean isActive();
}
1	iliev	787	/*
2			* JSampler - a java front-end for LinuxSampler
3			*
4			* Copyright (C) 2005 Grigor Kirilov Iliev
5			*
6			* This file is part of JSampler.
7			*
8			* JSampler 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			* JSampler 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 JSampler; 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.jsampler;
24
25			import org.jsampler.event.AudioDeviceListener;
26
27			import org.linuxsampler.lscp.AudioOutputDevice;
28
29
30			/**
31			*
32			* @author Grigor Iliev
33			*/
34			public interface AudioDeviceModel {
35			/**
36			* Registers the specified listener to be notified when
37			* the settings of the audio device are changed.
38			* @param l The <code>AudioDeviceListener</code> to register.
39			*/
40			public void
41			addAudioDeviceListener(AudioDeviceListener l);
42
43			/**
44			* Removes the specified listener.
45			* @param l The <code>AudioDeviceListener</code> to remove.
46			*/
47			public void removeAudioDeviceListener(AudioDeviceListener l);
48
49			/**
50			* Gets the numerical ID of this audio device.
51			* @return The numerical ID of this audio device or
52			* -1 if the device number is not set.
53			*/
54			public int getDeviceID();
55
56			/**
57			* Gets the current settings of the audio device represented by this model.
58			* @return <code>AudioOutputDevice</code> instance providing
59			* the current settings of the audio device represented by this model.
60			*/
61			public AudioOutputDevice getDeviceInfo();
62
63			/**
64			* Updates the settings of the audio device represented by this model.
65			* @param device The new audio device settings.
66			*/
67			public void setDeviceInfo(AudioOutputDevice device);
68
69			/**
70			* Sets whether the audio device is enabled or disabled.
71			* @param active If <code>true</code> the audio device is enabled,
72			* else the device is disabled.
73			*/
74			public void setActive(boolean active);
75
76			/**
77			* Determines whether the audio device is active.
78			* @return <code>true</code> if the device is enabled and <code>false</code> otherwise.
79			*/
80			public boolean isActive();
81			}