org.intellimate.izou.system.sound

Class IzouSoundLineBaseClass

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.system.sound.IzouSoundLineBaseClass

All Implemented Interfaces:

AutoCloseable, Line, Identifiable, IzouSoundLine, MainProvider

Direct Known Subclasses:

IzouSoundDataLine

public class IzouSoundLineBaseClass
extends IzouModule
implements Line, AutoCloseable, IzouSoundLine

the base class for every IzouSoundLine, provides basic implementation of the Methods defined int IzouSoundLine and delegates to Line, AutoCloseable etc.

Version:

1.0

Author:

LeanderK

Nested Class Summary

Nested classes/interfaces inherited from interface javax.sound.sampled.Line

Line.Info

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isMutable
protected boolean	isMutedFromSystem
protected Line	line
protected SoundManager	soundManager

Fields inherited from class org.intellimate.izou.util.IzouModule

log, main

Constructor Summary

Constructors

Constructor and Description
IzouSoundLineBaseClass(Line line, Main main, boolean isPermanent, AddOnModel addOnModel)

Method Summary

Modifier and Type	Method and Description
void	addLineListener(LineListener listener) follows no predictable behaviour, can be seen as not implemented.
void	close() Closes the line, indicating that any system resources in use by the line can be released.
AddOnModel	getAddOnModel() gets the associated AddonModel
Control	getControl(Control.Type control) Obtains a control of the specified type, if there is any.
Control[]	getControls() Obtains the set of controls associated with this line.
Line.Info	getLineInfo() Obtains the Line.Info object describing this line.
Identification	getResponsibleID() gets the ID responsible
boolean	isControlSupported(Control.Type control) Indicates whether the line supports a control of the specified type.
boolean	isMutedFromSystem() returns whether the Line is muted
boolean	isMuteIfNonPermanent() retruns whether other Addons audio-inputs should be muted while this line is open (only works for non-permanent lines).
boolean	isOpen() Indicates whether the line is open, meaning that it has reserved system resources and is operational, although it might not currently be playing or capturing sound.
boolean	isPermanent() returns whether the line is permanently-available.
void	open() Opens the line, indicating that it should acquire any required system resources and become operational.
protected void	opening()
void	removeLineListener(LineListener listener) follows no predictable behaviour, can be seen as not implemented.
void	setMuteIfNonPermanent(boolean muteIfNonPermanent) sets whether other Addons audio-inputs should be muted while this line is open (only works for non-permanent lines).

Methods inherited from class org.intellimate.izou.util.IzouModule

debug, debug, error, error, fatal, fatal, getID, getMain

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Field Detail

line

protected final Line line

soundManager

protected final SoundManager soundManager

isMutable

protected final boolean isMutable

isMutedFromSystem

protected boolean isMutedFromSystem

Constructor Detail

IzouSoundLineBaseClass

public IzouSoundLineBaseClass(Line line,
                              Main main,
                              boolean isPermanent,
                              AddOnModel addOnModel)

Method Detail

getLineInfo

public Line.Info getLineInfo()

Obtains the Line.Info object describing this line.

Specified by:

getLineInfo in interface Line

Returns:

description of the line

open

public void open()
          throws LineUnavailableException

Opens the line, indicating that it should acquire any required system resources and become operational. If this operation succeeds, the line is marked as open, and an OPEN event is dispatched to the line's listeners.

Note that some lines, once closed, cannot be reopened. Attempts to reopen such a line will always result in an LineUnavailableException.

Some types of lines have configurable properties that may affect resource allocation. For example, a DataLine must be opened with a particular format and buffer size. Such lines should provide a mechanism for configuring these properties, such as an additional open method or methods which allow an application to specify the desired settings.

This method takes no arguments, and opens the line with the current settings. For SourceDataLine and TargetDataLine objects, this means that the line is opened with default settings. For a Clip, however, the buffer size is determined when data is loaded. Since this method does not allow the application to specify any data to load, an IllegalArgumentException is thrown. Therefore, you should instead use one of the open methods provided in the Clip interface to load data into the Clip.

For DataLine's, if the DataLine.Info object which was used to retrieve the line, specifies at least one fully qualified audio format, the last one will be used as the default format.

Specified by:

open in interface Line

Throws:

IllegalArgumentException - if this method is called on a Clip instance.

LineUnavailableException - if the line cannot be opened due to resource restrictions.

SecurityException - if the line cannot be opened due to security restrictions.

See Also:

close(), isOpen()

opening

protected void opening()

close

public void close()

Closes the line, indicating that any system resources in use by the line can be released. If this operation succeeds, the line is marked closed and a CLOSE event is dispatched to the line's listeners.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Line

Throws:

SecurityException - if the line cannot be closed due to security restrictions.

See Also:

open(), isOpen()

isOpen

public boolean isOpen()

Indicates whether the line is open, meaning that it has reserved system resources and is operational, although it might not currently be playing or capturing sound.

Specified by:

isOpen in interface Line

Returns:

true if the line is open, otherwise false

See Also:

open(), close()

getControls

public Control[] getControls()

Obtains the set of controls associated with this line. Some controls may only be available when the line is open. If there are no controls, this method returns an array of length 0. The mute-control operation may be overridden by the System.

Specified by:

getControls in interface Line

Returns:

the array of controls

See Also:

isMutedFromSystem()

isControlSupported

public boolean isControlSupported(Control.Type control)

Indicates whether the line supports a control of the specified type. Some controls may only be available when the line is open.

Specified by:

isControlSupported in interface Line

Parameters:

control - the type of the control for which support is queried

Returns:

true if at least one control of the specified type is supported, otherwise false.

getControl

public Control getControl(Control.Type control)
                   throws IllegalArgumentException

Obtains a control of the specified type, if there is any. Some controls may only be available when the line is open. The mute-control operation may be overridden by the System.

Specified by:

getControl in interface Line

Parameters:

control - the type of the requested control

Returns:

a control of the specified type

Throws:

IllegalArgumentException - - if a control of the specified type is not supported

See Also:

isMutedFromSystem()

addLineListener

public void addLineListener(LineListener listener)

follows no predictable behaviour, can be seen as not implemented.

Specified by:

addLineListener in interface Line

Parameters:

listener - the listener

removeLineListener

public void removeLineListener(LineListener listener)

follows no predictable behaviour, can be seen as not implemented.

Specified by:

removeLineListener in interface Line

Parameters:

listener - the listener

isPermanent

public boolean isPermanent()

returns whether the line is permanently-available. If a line is not permanently available, it will close after max. 10 minutes

Specified by:

isPermanent in interface IzouSoundLine

Returns:

true if permanent.

getAddOnModel

public AddOnModel getAddOnModel()

gets the associated AddonModel

Specified by:

getAddOnModel in interface IzouSoundLine

Returns:

the AddonModel

getResponsibleID

public Identification getResponsibleID()

gets the ID responsible

Specified by:

getResponsibleID in interface IzouSoundLine

Returns:

the the ID

isMutedFromSystem

public boolean isMutedFromSystem()

returns whether the Line is muted

Specified by:

isMutedFromSystem in interface IzouSoundLine

Returns:

true if muted.

setMuteIfNonPermanent

public void setMuteIfNonPermanent(boolean muteIfNonPermanent)

sets whether other Addons audio-inputs should be muted while this line is open (only works for non-permanent lines). The standard is true.

Specified by:

setMuteIfNonPermanent in interface IzouSoundLine

Parameters:

muteIfNonPermanent - true if muted, false if not

isMuteIfNonPermanent

public boolean isMuteIfNonPermanent()

retruns whether other Addons audio-inputs should be muted while this line is open (only works for non-permanent lines).

Specified by:

isMuteIfNonPermanent in interface IzouSoundLine

Returns:

true if muted, false if not