java.lang.Object
- ipsk.audio.capture.Capture3

All Implemented Interfaces:

TargetDataLineListener, EventQuequeListener, java.awt.event.ActionListener, java.lang.Runnable, java.util.EventListener, javax.sound.sampled.LineListener
```
public class Capture3
extends java.lang.Object
implements java.lang.Runnable, EventQuequeListener, TargetDataLineListener, java.awt.event.ActionListener, javax.sound.sampled.LineListener
```
Audio capture engine.

Author:

klausj

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`class`	`Capture3.RecordingFileInfo`
`class`	`Capture3.RecordingFileSequenceInfo`
`class`	`Capture3.RecordingInfo`
`class`	`Capture3.RecordingInfos`
`static class`	`Capture3.State`

Field Summary

Fields
Modifier and Type	Field	Description
`static javax.sound.sampled.AudioFileFormat`	`DEF_AUDIO_FILE_FORMAT`
`static javax.sound.sampled.AudioFileFormat.Type`	`DEF_AUDIO_FILE_TYPE`
`static javax.sound.sampled.AudioFormat`	`DEF_AUDIO_FORMAT`

Constructor Summary

Constructors
Constructor	Description
`Capture3()`	Create capture engine.
`Capture3(javax.sound.sampled.Mixer device)`	Create capture engine which will capture audio data from given device.
`Capture3(javax.sound.sampled.Mixer device, java.io.File recFile, javax.sound.sampled.AudioFileFormat aff)`	Create capture engine.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`_close()`	Close engine.
`void`	`actionPerformed(java.awt.event.ActionEvent e)`
`void`	`addAudioOutputStream(IAudioOutputStream aos)`	Add audio output stream.
`void`	`addCaptureListener(CaptureListener pl)`	Add capture listener.
`void`	`close()`	Close engine.
`javax.sound.sampled.AudioFileFormat`	`getAudioFileFormat()`	Get audio file format.
`javax.sound.sampled.AudioFormat`	`getAudioFormat()`	Get audio format.
`int`	`getBufferSize()`	The actually set buffer size.
`ChannelRouting`	`getChannelRouting()`	Get channel routing
`long`	`getFramePosition()`	Get already captured frames.
`java.lang.Integer`	`getLineBufferSize()`	Get the last used line buffer size.
`java.lang.Float`	`getLineBufferSizeSeconds()`	Get the last used line buffer size in seconds.
`long`	`getMaxFrameLength()`	Get maxim recording length in frames.
`java.lang.Integer`	`getMaxLineBufferSize()`	Get maximum line bugffer size.
`java.lang.Integer`	`getMinLineBufferSize()`	Get minimum line buffer size.
`java.lang.Integer`	`getPreferredBufferSize()`	Get preferred buffer size in bytes.
`java.lang.Integer`	`getPreferredLineBufferSize()`	Get the preferred audio line buffer size setting.
`java.lang.Float`	`getPreferredLineBufferSizeMillis()`	Get preferred line buffer size in milliseconds.
`PrimaryRecordTarget`	`getPrimaryRecordTarget()`
`java.lang.String`	`getRecId()`
`java.io.File`	`getRecordingFile()`	Get recording file
`java.io.File`	`getRecordingSessionInfoFile()`
`boolean`	`isCaptureOnly()`	Returns true if the engine is only capturing, not recording to file.
`boolean`	`isCapturing()`	Return true if capturing.
`boolean`	`isForceOpening()`
`boolean`	`isNotifyLineActivation()`
`boolean`	`isOpen()`	Return open status.
`boolean`	`isRecording()`	Returns true if recording.
`boolean`	`isUseAWTEventThread()`	True if generated events will be queued to AWT event queue.
`boolean`	`isUseTempFile()`
`boolean`	`isWriteRecordingInfo()`
`static void`	`main(java.lang.String[] args)`
`void`	`open()`	Open audio line and engine.
`void`	`removeAudioOutputStream(IAudioOutputStream aos)`	Remove audio output stream
`void`	`removeCaptureListener(CaptureListener pl)`	Remove capture listener.
`void`	`run()`
`void`	`setAudioFileFormat(javax.sound.sampled.AudioFileFormat aff)`	Set audio file format.
`void`	`setAudioFormat(javax.sound.sampled.AudioFormat af)`	Set audio format.
`void`	`setCaptureOnly(boolean captureOnly)`	Set capture only mode.
`void`	`setChannelRouting(ChannelRouting channelRouting)`	Set channel routing
`void`	`setForceOpening(boolean forceOpening)`
`void`	`setMaxFrameLength(long maxFrameLength)`	Set the maximum length of recording in frames.
`void`	`setMixer(javax.sound.sampled.Mixer newCaptureMixer)`	Set the recording device to capture from.
`void`	`setNotifyLineActivation(boolean notifyLineActivation)`
`void`	`setPreferredBufferSize(int preferredBufferSize)`	Set the buffer size of this capture engine in bytes.
`void`	`setPreferredLineBufferSize(java.lang.Integer preferredLineBufferSize)`	Set the buffer size of the audio line.
`void`	`setPreferredLineBufferSizeMillis(java.lang.Float preferredLineBufferSizeMillis)`	Set the buffer size of the audio line.
`void`	`setPrimaryRecordTarget(PrimaryRecordTarget primaryRecordTarget)`
`void`	`setRecId(java.lang.String recId)`
`void`	`setRecordingFile(java.io.File file)`	Set recording file.
`void`	`setRecordingItem(java.io.File file, java.lang.String recId)`	Set recording file and ID.
`void`	`setRecordingSessionInfoFile(java.io.File recordingSessionInfoFile)`
`void`	`setUseAWTEventThread(boolean useAWTEventThread)`	Determines if events should be queued to the AWTEventThread.
`void`	`setWriteRecordingInfo(boolean writeRecordingInfo)`
`void`	`start()`	Start capturing or recording.
`void`	`stop()`	Stop engine.
`void`	`update(CaptureEvent targetDataLineEvent)`
`void`	`update(java.util.EventObject eventObject)`
`void`	`update(javax.sound.sampled.LineEvent event)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEF_AUDIO_FILE_TYPE
```
public static javax.sound.sampled.AudioFileFormat.Type DEF_AUDIO_FILE_TYPE
```
  - DEF_AUDIO_FORMAT
```
public static javax.sound.sampled.AudioFormat DEF_AUDIO_FORMAT
```
  - DEF_AUDIO_FILE_FORMAT
```
public static javax.sound.sampled.AudioFileFormat DEF_AUDIO_FILE_FORMAT
```
- Constructor Detail
  - Capture3
```
public Capture3()
```
    Create capture engine.
  - Capture3
```
public Capture3(javax.sound.sampled.Mixer device)
```
    Create capture engine which will capture audio data from given device.
    
    Parameters:
    
    device - audio device to use
  - Capture3
```
public Capture3(javax.sound.sampled.Mixer device,
                java.io.File recFile,
                javax.sound.sampled.AudioFileFormat aff)
```
    Create capture engine.
    
    Parameters:
    
    device - audio device to use
    
    recFile - recordingfile
    
    aff - audio file format
- Method Detail
  - isNotifyLineActivation
```
public boolean isNotifyLineActivation()
```
    Returns:
    
    the notifyLineActivation
  - setNotifyLineActivation
```
public void setNotifyLineActivation(boolean notifyLineActivation)
```
    Parameters:
    
    notifyLineActivation - the notifyLineActivation to set
  - isUseTempFile
```
public boolean isUseTempFile()
```
  - setAudioFileFormat
```
public void setAudioFileFormat(javax.sound.sampled.AudioFileFormat aff)
```
    Set audio file format.
    
    Parameters:
    
    aff - audio file format
  - getAudioFileFormat
```
public javax.sound.sampled.AudioFileFormat getAudioFileFormat()
```
    Get audio file format.
    
    Returns:
    
    audio file format
  - setAudioFormat
```
public void setAudioFormat(javax.sound.sampled.AudioFormat af)
```
    Set audio format.
    
    Parameters:
    
    af - audio format.
  - getAudioFormat
```
public javax.sound.sampled.AudioFormat getAudioFormat()
```
    Get audio format.
    
    Returns:
    
    audio format
  - getMinLineBufferSize
```
public java.lang.Integer getMinLineBufferSize()
```
    Get minimum line buffer size.
    
    Returns:
    
    minimum line buffer size or null if not available
  - getMaxLineBufferSize
```
public java.lang.Integer getMaxLineBufferSize()
```
    Get maximum line bugffer size.
    
    Returns:
    
    maximum line buffer size or null if not available
  - open
```
public void open()
          throws CaptureException
```
    Open audio line and engine.
    
    Throws:
    
    CaptureException
  - start
```
public void start()
```
    Start capturing or recording.
  - getMaxFrameLength
```
public long getMaxFrameLength()
```
    Get maxim recording length in frames.
    
    Returns:
    
    max length in frames
  - stop
```
public void stop()
          throws CaptureException
```
    Stop engine.
    
    Throws:
    
    CaptureException
  - close
```
public void close()
           throws CaptureException
```
    Close engine.
    
    Throws:
    
    CaptureException
  - _close
```
public void _close()
            throws CaptureException
```
    Close engine.
    
    Throws:
    
    CaptureException
  - getFramePosition
```
public long getFramePosition()
```
    Get already captured frames.
    
    Returns:
    
    frames captured/recorded
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - addCaptureListener
```
public void addCaptureListener(CaptureListener pl)
```
    Add capture listener.
    
    Parameters:
    
    pl - capture listener
  - removeCaptureListener
```
public void removeCaptureListener(CaptureListener pl)
```
    Remove capture listener.
    
    Parameters:
    
    pl - capture listener
  - addAudioOutputStream
```
public void addAudioOutputStream(IAudioOutputStream aos)
```
    Add audio output stream.
    
    Parameters:
    
    aos - audio output stream
  - removeAudioOutputStream
```
public void removeAudioOutputStream(IAudioOutputStream aos)
```
    Remove audio output stream
    
    Parameters:
    
    aos - audio output stream
  - update
```
public void update(java.util.EventObject eventObject)
```
    Specified by:
    
    update in interface EventQuequeListener
  - isRecording
```
public boolean isRecording()
```
    Returns true if recording.
    
    Returns:
    
    true if recording
  - isCapturing
```
public boolean isCapturing()
```
    Return true if capturing.
    
    Returns:
    
    true if capturing
  - setRecordingFile
```
public void setRecordingFile(java.io.File file)
```
    Set recording file.
    
    Parameters:
    
    file - recording file
  - setRecordingItem
```
public void setRecordingItem(java.io.File file,
                             java.lang.String recId)
```
    Set recording file and ID.
    
    Parameters:
    
    file - recording file
    
    recId - recording ID
  - getRecordingFile
```
public java.io.File getRecordingFile()
```
    Get recording file
    
    Returns:
    
    recording file
  - setMixer
```
public void setMixer(javax.sound.sampled.Mixer newCaptureMixer)
```
    Set the recording device to capture from. The given device will be used if the capture engine is opened the next time.
    
    Parameters:
    
    newCaptureMixer - recording device
  - isCaptureOnly
```
public boolean isCaptureOnly()
```
    Returns true if the engine is only capturing, not recording to file.
    
    Returns:
    
    true if capturing
  - setCaptureOnly
```
public void setCaptureOnly(boolean captureOnly)
```
    Set capture only mode. In capture mode no recording file will be written. Capture mode may be used to measure input level without recording.
  - getPreferredBufferSize
```
public java.lang.Integer getPreferredBufferSize()
```
    Get preferred buffer size in bytes.
    
    Returns:
    
    preferred buffer size or null if default
  - setPreferredBufferSize
```
public void setPreferredBufferSize(int preferredBufferSize)
```
    Set the buffer size of this capture engine in bytes.
    
    Parameters:
    
    preferredBufferSize -
  - getBufferSize
```
public int getBufferSize()
```
    The actually set buffer size.
    
    Returns:
    
    buffer size
  - getPreferredLineBufferSize
```
public java.lang.Integer getPreferredLineBufferSize()
```
    Get the preferred audio line buffer size setting.
    
    Returns:
    
    preferred audio line buffer size
  - setPreferredLineBufferSize
```
public void setPreferredLineBufferSize(java.lang.Integer preferredLineBufferSize)
```
    Set the buffer size of the audio line. It is recommended to set this to one second ( @see setPreferredLineBufferSizeMillis(Float) setPreferredLineBufferSizeMillis(Float)), which is the maximum line buffer size under Windows XP to avoid buffer overruns (especially during garbage collector runs). The default setting is to open the line with default JavaSound settings (500ms for Windows).
    
    Parameters:
    
    preferredLineBufferSize -
  - getLineBufferSize
```
public java.lang.Integer getLineBufferSize()
```
    Get the last used line buffer size. Returns the last used line buffer size.
    
    Returns:
    
    audio line buffer size or null if capture was not started yet
  - getLineBufferSizeSeconds
```
public java.lang.Float getLineBufferSizeSeconds()
```
    Get the last used line buffer size in seconds. Returns the last used line buffer size.
    
    Returns:
    
    audio line buffer size or null if capture line was not opened yet
  - isOpen
```
public boolean isOpen()
```
    Return open status.
    
    Returns:
    
    false if capture engine is closed
  - getPreferredLineBufferSizeMillis
```
public java.lang.Float getPreferredLineBufferSizeMillis()
```
    Get preferred line buffer size in milliseconds.
    
    Returns:
    
    preferred line buffer size in milliseconds or null if not set.
  - setPreferredLineBufferSizeMillis
```
public void setPreferredLineBufferSizeMillis(java.lang.Float preferredLineBufferSizeMillis)
```
    Set the buffer size of the audio line. It is recommended to set this to one second, which is the maximum line buffer size under Windows XP to avoid buffer overruns (especially during garbage collector runs). The default setting is to open the line with default JavSound settings (500ms for Windows).
    
    Parameters:
    
    preferredLineBufferSizeMillis - preferred line buffer size in milliseconds or null for default
  - isUseAWTEventThread
```
public boolean isUseAWTEventThread()
```
    True if generated events will be queued to AWT event queue.
    
    Returns:
    
    true if AWT event queue is used
  - setUseAWTEventThread
```
public void setUseAWTEventThread(boolean useAWTEventThread)
```
    Determines if events should be queued to the AWTEventThread. For GUI applications it is recommended to set this to true, to avoid AWT/Swing deadlocks (Swing is not thread safe).
    
    Parameters:
    
    useAWTEventThread -
  - setMaxFrameLength
```
public void setMaxFrameLength(long maxFrameLength)
```
    Set the maximum length of recording in frames. The capture engine will stop if the amount of frames are recorded.
    
    Parameters:
    
    maxFrameLength - maximum recording length in frames
  - isForceOpening
```
public boolean isForceOpening()
```
  - setForceOpening
```
public void setForceOpening(boolean forceOpening)
```
  - getPrimaryRecordTarget
```
public PrimaryRecordTarget getPrimaryRecordTarget()
```
  - setPrimaryRecordTarget
```
public void setPrimaryRecordTarget(PrimaryRecordTarget primaryRecordTarget)
```
  - getRecordingSessionInfoFile
```
public java.io.File getRecordingSessionInfoFile()
```
  - setRecordingSessionInfoFile
```
public void setRecordingSessionInfoFile(java.io.File recordingSessionInfoFile)
```
  - isWriteRecordingInfo
```
public boolean isWriteRecordingInfo()
```
  - setWriteRecordingInfo
```
public void setWriteRecordingInfo(boolean writeRecordingInfo)
```
  - getRecId
```
public java.lang.String getRecId()
```
  - setRecId
```
public void setRecId(java.lang.String recId)
```
  - getChannelRouting
```
public ChannelRouting getChannelRouting()
```
    Get channel routing
    
    Returns:
    
    current applied channel routing
  - setChannelRouting
```
public void setChannelRouting(ChannelRouting channelRouting)
```
    Set channel routing
    
    Parameters:
    
    channelRouting - channel routing to set
  - main
```
public static void main(java.lang.String[] args)
```
  - update
```
public void update(CaptureEvent targetDataLineEvent)
```
    Specified by:
    
    update in interface TargetDataLineListener
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent e)
```
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
  - update
```
public void update(javax.sound.sampled.LineEvent event)
```
    Specified by:
    
    update in interface javax.sound.sampled.LineListener

Class Capture3

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEF_AUDIO_FILE_TYPE

DEF_AUDIO_FORMAT

DEF_AUDIO_FILE_FORMAT

Constructor Detail

Capture3

Capture3

Capture3

Method Detail

isNotifyLineActivation

setNotifyLineActivation

isUseTempFile

setAudioFileFormat

getAudioFileFormat

setAudioFormat

getAudioFormat

getMinLineBufferSize

getMaxLineBufferSize

open

start

getMaxFrameLength

stop

close

_close

getFramePosition

run

addCaptureListener

removeCaptureListener

addAudioOutputStream

removeAudioOutputStream

update

isRecording

isCapturing

setRecordingFile

setRecordingItem

getRecordingFile

setMixer

isCaptureOnly

setCaptureOnly

getPreferredBufferSize

setPreferredBufferSize

getBufferSize

getPreferredLineBufferSize

setPreferredLineBufferSize

getLineBufferSize

getLineBufferSizeSeconds

isOpen

getPreferredLineBufferSizeMillis

setPreferredLineBufferSizeMillis

isUseAWTEventThread

setUseAWTEventThread

setMaxFrameLength

isForceOpening

setForceOpening

getPrimaryRecordTarget

setPrimaryRecordTarget

getRecordingSessionInfoFile

setRecordingSessionInfoFile

isWriteRecordingInfo

setWriteRecordingInfo

getRecId

setRecId

getChannelRouting

setChannelRouting

main

update

actionPerformed

update