audio.modules
Interface AudioInput

All Superinterfaces:

java.io.Serializable, VDMModule

All Known Implementing Classes:

DummyKeyboardInterface, LineInterface, MIDIFileInput, MIDIInterface

public interface AudioInput
extends VDMModule

This interface defines how an audio module should interact with the audio processor.

Method Summary

void	close() Shuts the interface down and frees any resources associated with it.
java.lang.String	getDescription() Returns a description of the interface.
java.lang.String	getFriendlyName() Returns a user defined interface name or null if the user has not changed it.
java.lang.String	getPathToIcon() Returns the path an image suitable for use as an icon.
java.lang.String	getType() Returns the type of the interface - useful for writing specific display algorithms for specific instrument types
java.lang.String	getVendor() Returns the interface vendor,
boolean	isOpen() Should return whether the interface is in a state where it can start transmitting data.
void	open() Turns on the interface - it should then be in a state where it can start transmitting data.
void	sendMessage() Send locally stored messages when called.
void	setFriendlyName(java.lang.String newName) Used when the user changes the name of the interface in the audio processor GUI.

Methods inherited from interface utilities.serializer.VDMModule

getName, getVersion

Method Detail

open

void open()

Turns on the interface - it should then be in a state where it can start transmitting data.

isOpen

boolean isOpen()

Should return whether the interface is in a state where it can start transmitting data.

Returns:

True if it is accepting data, false otherwise.

close

void close()

Shuts the interface down and frees any resources associated with it.

getDescription

java.lang.String getDescription()

Returns a description of the interface.

Returns:

"On hardware USB bus" or something

getType

java.lang.String getType()

Returns the type of the interface - useful for writing specific display algorithms for specific instrument types

Returns:

"midi" or similar

getVendor

java.lang.String getVendor()

Returns the interface vendor,

Returns:

"ACME MIDI" or something like that

setFriendlyName

void setFriendlyName(java.lang.String newName)

Used when the user changes the name of the interface in the audio processor GUI.

Parameters:

newName -

getFriendlyName

java.lang.String getFriendlyName()

Returns a user defined interface name or null if the user has not changed it.

Returns:

The user defined name or null.

getPathToIcon

java.lang.String getPathToIcon()

Returns the path an image suitable for use as an icon.

Returns:

The image path or null.

sendMessage

void sendMessage()

Send locally stored messages when called.