ddf.minim

Class AudioInput

java.lang.Object

ddf.minim.Controller

ddf.minim.AudioSource

ddf.minim.AudioInput

All Implemented Interfaces:

Effectable, Recordable

public class AudioInput
extends AudioSource

An AudioInput is a connection to the current record source of the computer. How the record source for a computer is set will depend on the soundcard and OS, but typically a user can open a control panel and set the source from there. Unfortunately, there is no way to set the record source from Java. This is particularly problematic on the Mac because the input will always wind up being connected to the Mic-In, even if the user has set the input differently using their audio control panel.

You can obtain an AudioInput from Minim by using one of the getLineIn methods:

 // get the default STEREO input
 AudioInput getLineIn()
 
 // specifiy either Minim.MONO or Minim.STEREO for type
 AudioInput getLineIn(int type)
 
 // bufferSize is the size of the left, right,
 // and mix buffers of the input you get back
 AudioInput getLineIn(int type, int bufferSize)
 
 // sampleRate is a request for an input of a certain sample rate
 AudioInput getLineIn(int type, int bufferSize, float sampleRate)
 
 // bitDepth is a request for an input with a certain bit depth
 AudioInput getLineIn(int type, int bufferSize, float sampleRate, int bitDepth)
 

In the event that an input doesn't exist with the requested parameters, Minim will spit out an error and return null. In general, you will want to use the first two methods listed above.

Author:

Damien Di Fede

Field Summary

Fields inherited from class ddf.minim.AudioSource

left, mix, right

Fields inherited from class ddf.minim.Controller

BALANCE, GAIN, MUTE, PAN, SAMPLE_RATE, VOLUME

Constructor Summary

Constructors

Constructor and Description
AudioInput(ddf.minim.spi.AudioStream stream, ddf.minim.spi.AudioOut out)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this source, making it unavailable.
void	disableMonitoring() When monitoring is disabled, you will not hear the audio that is coming through the input, but you will still be able to access the samples in the left, right, and mix buffers.
void	enableMonitoring() When monitoring is enabled, you will be able to hear the audio that is coming through the input.
boolean	isMonitoring() Returns whether or not this AudioInput is monitoring.

Methods inherited from class ddf.minim.AudioSource

addEffect, addListener, bufferSize, clearEffects, disableEffect, disableEffect, effectCount, effects, enableEffect, enableEffect, getEffect, getFormat, hasEffect, isEffected, isEnabled, noEffects, removeEffect, removeEffect, removeListener, sampleRate, type

Methods inherited from class ddf.minim.Controller

balance, gain, getBalance, getControl, getControls, getGain, getPan, getVolume, hasControl, isMuted, mute, pan, printControls, setBalance, setGain, setPan, setVolume, shiftBalance, shiftGain, shiftPan, shiftVolume, unmute, volume

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioInput

public AudioInput(ddf.minim.spi.AudioStream stream,
                  ddf.minim.spi.AudioOut out)

Parameters:

stream - the AudioStream that provides the samples

out - the AudioOut that will read from stream

Method Detail

close

public void close()

Description copied from class: AudioSource

Closes this source, making it unavailable.

Overrides:

close in class AudioSource

isMonitoring

public boolean isMonitoring()

Returns whether or not this AudioInput is monitoring. In other words, whether you will hear in your speakers the audio coming into the input.

Returns:

boolean: true if monitoring is on

enableMonitoring

public void enableMonitoring()

When monitoring is enabled, you will be able to hear the audio that is coming through the input.

disableMonitoring

public void disableMonitoring()

When monitoring is disabled, you will not hear the audio that is coming through the input, but you will still be able to access the samples in the left, right, and mix buffers. This is default state of an AudioInput and is what you will want if your input is microphone and your output is speakers. Otherwise: feedback.