com.jsyn.devices.jportaudio

Class JPortAudioDevice

java.lang.Object

com.jsyn.devices.jportaudio.JPortAudioDevice

All Implemented Interfaces:

AudioDeviceManager

public class JPortAudioDevice
extends java.lang.Object
implements AudioDeviceManager

Field Summary

Fields inherited from interface com.jsyn.devices.AudioDeviceManager

USE_DEFAULT_DEVICE

Constructor Summary

Constructors

Constructor and Description
JPortAudioDevice()

Method Summary

Modifier and Type	Method and Description
AudioDeviceInputStream	createInputStream(int deviceID, int frameRate, int samplesPerFrame) Create a stream that can be used internally by JSyn for acquiring audio input data.
AudioDeviceOutputStream	createOutputStream(int deviceID, int frameRate, int samplesPerFrame) Create a stream that can be used internally by JSyn for outputting audio data.
double	getDefaultHighInputLatency(int deviceID) This the highest latency that the device can support.
double	getDefaultHighOutputLatency(int deviceID)
int	getDefaultInputDeviceID() The user can generally select a default device using a control panel that is part of the operating system.
double	getDefaultLowInputLatency(int deviceID) This the lowest latency that the device can support reliably.
double	getDefaultLowOutputLatency(int deviceID)
int	getDefaultOutputDeviceID() The user can generally select a default device using a control panel that is part of the operating system.
int	getDeviceCount()
java.lang.String	getDeviceName(int deviceID) Get the name of an audio device.
int	getMaxInputChannels(int deviceID)
int	getMaxOutputChannels(int deviceID)
java.lang.String	getName()
int	setSuggestedInputLatency(double latency) Set latency in seconds for the audio device.
int	setSuggestedOutputLatency(double latency)

Methods inherited from class java.lang.Object

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

Constructor Detail

JPortAudioDevice

public JPortAudioDevice()

Method Detail

getDeviceCount

public int getDeviceCount()

Specified by:

getDeviceCount in interface AudioDeviceManager

Returns:

The number of devices available.

getDeviceName

public java.lang.String getDeviceName(int deviceID)

Description copied from interface: AudioDeviceManager

Get the name of an audio device.

Specified by:

getDeviceName in interface AudioDeviceManager

Parameters:

deviceID - An index between 0 to deviceCount-1.

Returns:

A name that can be shown to the user.

getDefaultInputDeviceID

public int getDefaultInputDeviceID()

Description copied from interface: AudioDeviceManager

The user can generally select a default device using a control panel that is part of the operating system.

Specified by:

getDefaultInputDeviceID in interface AudioDeviceManager

Returns:

The ID for the input device that the user has selected as the default.

getDefaultOutputDeviceID

public int getDefaultOutputDeviceID()

Description copied from interface: AudioDeviceManager

The user can generally select a default device using a control panel that is part of the operating system.

Specified by:

getDefaultOutputDeviceID in interface AudioDeviceManager

Returns:

The ID for the output device that the user has selected as the default.

getMaxInputChannels

public int getMaxInputChannels(int deviceID)

Specified by:

getMaxInputChannels in interface AudioDeviceManager

Returns:

The maximum number of channels that the device will support.

getMaxOutputChannels

public int getMaxOutputChannels(int deviceID)

Specified by:

getMaxOutputChannels in interface AudioDeviceManager

Parameters:

deviceID - An index between 0 to numDevices-1.

Returns:

The maximum number of channels that the device will support.

getDefaultLowInputLatency

public double getDefaultLowInputLatency(int deviceID)

Description copied from interface: AudioDeviceManager

This the lowest latency that the device can support reliably. It should be used for applications that require low latency such as live processing of guitar signals.

Specified by:

getDefaultLowInputLatency in interface AudioDeviceManager

Parameters:

deviceID - An index between 0 to numDevices-1.

Returns:

Latency in seconds.

getDefaultHighInputLatency

public double getDefaultHighInputLatency(int deviceID)

Description copied from interface: AudioDeviceManager

This the highest latency that the device can support. High latency is recommended for applications that are not time critical, such as recording.

Specified by:

getDefaultHighInputLatency in interface AudioDeviceManager

Parameters:

deviceID - An index between 0 to numDevices-1.

Returns:

Latency in seconds.

getDefaultLowOutputLatency

public double getDefaultLowOutputLatency(int deviceID)

Specified by:

getDefaultLowOutputLatency in interface AudioDeviceManager

getDefaultHighOutputLatency

public double getDefaultHighOutputLatency(int deviceID)

Specified by:

getDefaultHighOutputLatency in interface AudioDeviceManager

setSuggestedOutputLatency

public int setSuggestedOutputLatency(double latency)

Specified by:

setSuggestedOutputLatency in interface AudioDeviceManager

setSuggestedInputLatency

public int setSuggestedInputLatency(double latency)

Description copied from interface: AudioDeviceManager

Set latency in seconds for the audio device. If set to zero then the DefaultLowLatency value for the device will be used. This is just a suggestion that will be used when the AudioDeviceInputStream is started.

Specified by:

setSuggestedInputLatency in interface AudioDeviceManager

createOutputStream

public AudioDeviceOutputStream createOutputStream(int deviceID,
                                                  int frameRate,
                                                  int samplesPerFrame)

Description copied from interface: AudioDeviceManager

Create a stream that can be used internally by JSyn for outputting audio data. Applications should not call this directly.

Specified by:

createOutputStream in interface AudioDeviceManager

createInputStream

public AudioDeviceInputStream createInputStream(int deviceID,
                                                int frameRate,
                                                int samplesPerFrame)

Description copied from interface: AudioDeviceManager

Create a stream that can be used internally by JSyn for acquiring audio input data. Applications should not call this directly.

Specified by:

createInputStream in interface AudioDeviceManager

getName

public java.lang.String getName()

Specified by:

getName in interface AudioDeviceManager

Returns:

A name of the device manager that can be shown to the user.