CcmAccess

java.lang.Object
- com.sig.ccm.CcmBase
- - com.sig.ccm.CcmAccess

public class CcmAccess
extends com.sig.ccm.CcmBase

Provides access to the Ccm.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CCM_BLOCKSIZE_1024` The Constant CCM_BLOCKSIZE_1024.
`static int`	`CCM_BLOCKSIZE_128` The Constant CCM_BLOCKSIZE_128.
`static int`	`CCM_BLOCKSIZE_2048` The Constant CCM_BLOCKSIZE_2048.
`static int`	`CCM_BLOCKSIZE_256` The Constant CCM_BLOCKSIZE_256.
`static int`	`CCM_BLOCKSIZE_512` The Constant CCM_BLOCKSIZE_512.
`static int`	`CCM_BLOCKSIZE_64` The Constant CCM_BLOCKSIZE_64.
`static int`	`CCM_SAMPLERATE_10000` The Constant CCM_SAMPLERATE_10000.
`static int`	`CCM_SAMPLERATE_12500` The Constant CCM_SAMPLERATE_12500.
`static int`	`CCM_SAMPLERATE_20000` The Constant CCM_SAMPLERATE_20000.
`static int`	`CCM_SAMPLERATE_25000` The Constant CCM_SAMPLERATE_25000.
`static int`	`CCM_SAMPLERATE_40000` The Constant CCM_SAMPLERATE_40000.
`static int`	`CCM_SAMPLERATE_50000` The Constant CCM_SAMPLERATE_50000.
`static int`	`CCM_STATUS_LOGGING_ENA` The Constant CCM_STATUS_LOGGING_ENA.
`static int`	`CCM_STATUS_MEMORY_FULL` The Constant CCM_STATUS_MEMORY_FULL.
`static int`	`CCM_STATUS_OVERFLOW` The Constant CCM_STATUS_OVERFLOW.
`static int`	`CCM_STATUS_RUNNING` The Constant CCM_STATUS_RUNNING.
`static int`	`CCM_STATUS_VALID_MASK` The Constant CCM_STATUS_VALID_MASK.
`static int`	`CCM_WINDOW_CUSTOM` The Constant CCM_WINDOW_CUSTOM.
`static int`	`CCM_WINDOW_HAMMING` The Constant CCM_WINDOW_HAMMING.
`static int`	`CCM_WINDOW_HANNING` The Constant CCM_WINDOW_HANNING.
`static int`	`CCM_WINDOW_RECTANGULAR` The Constant CCM_WINDOW_RECTANGULAR.

Constructor Summary

Constructors
Constructor and Description

CcmAccess()
Instantiates a new Ccm access.

Constructors
Constructor and Description
`CcmAccess()` Instantiates a new Ccm access.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close the I/O handle previously opened with open
`java.lang.String`	`getDescription()` Gets the description of an accessible Command and Control Module (CCM).
`CcmVersion`	`getFirmwareVersion()` Gets the firmware version of the current CCM.
`int`	`getFrequencyDomainBlockSize()` Gets the block size value currently used with frequency-domain data.
`int`	`getFrequencyDomainFrameBufferAvailable()` Gets the number of frequency domain frames available for reading from the frame buffer.
`int`	`getFrequencyDomainFrameBufferSize()` Gets the the number of frames maintained in the frequency domain frame buffer
`int`	`getFrequencyDomainFramesAvailable()` Gets the number of frequency domain frames available to read.
`int`	`getFrequencyDomainSkipFrames()` Gets the number of frequency domain frames that are skipped after taking frames.
`int`	`getFrequencyDomainTakeFrames()` Gets the number of frequency domain frames that are returned (taken) after skipping frames
`int`	`getFrequencyDomainWindow()` Gets the frequency domain window identifier.
`CcmVersion`	`getLibraryVersion()` Gets the version of the access library being used.
`java.lang.String`	`getLogfilePath()` Gets the current base folder used for server logging.
`int[]`	`getMicrophoneCoordinates()` Gets the coordinates of the microphones on the Ccm panel.
`int`	`getMicrophoneCount()` Gets the number of microphones available in the Ccm device.
`java.lang.String`	`getModel()` Gets the model of an accessible Command and Control Module (CCM).
`int`	`getOverflowWarning()` Gets the overflow warning level.
`int`	`getSampleRate()` Gets the current sample rate in Hz.
`java.lang.String`	`getSerialNumber()` Gets the serial number of the Command and Control Module (CCM).
`CcmVersion`	`getServiceVersion()` Gets the version of the system service being used
`int`	`getStatus()` Gets the current status information.
`int`	`getTimeDomainBlockSize()` Gets the block size value used for time domain data.
`int`	`getTimeDomainFrameBufferAvailable()` Gets the number of time domain frames available for reading from the frame buffer.
`int`	`getTimeDomainFrameBufferSize()` Gets the the number of frames maintained in the time domain frame buffer
`int`	`getTimeDomainFramesAvailable()` Gets the number of time domain frames available to read.
`int`	`getTimeDomainSkipFrames()` Gets the number of time domain frames that are skipped after taking frames.
`int`	`getTimeDomainTakeFrames()` Gets the number of time domain frames that are returned (taken) after skipping frames
`boolean`	`isFrequencyDomainEnabled()` Checks if is frequency domain enabled.
`boolean`	`isFrequencyDomainFrameBufferEnabled()` Checks if the frequency domain frame buffer is enabled.
`boolean`	`isFrequencyDomainLoggingEnabled()` Checks if service level frequency domain logging is enabled.
`boolean`	`isFrequencyDomainOverlapEnabled()` Checks if is frequency domain overlap is enabled.
`boolean`	`isTimeDomainEnabled()` Checks if time domain is enabled.
`boolean`	`isTimeDomainFrameBufferEnabled()` Checks if the time domain frame buffer is enabled.
`boolean`	`isTimeDomainLoggingEnabled()` Checks if is service level time domain logging is enabled.
`void`	`loadConfiguration(java.lang.String filepath)` Load a previously saved configuration from a file.
`void`	`open()` Open I/O handle for an accessible Command and Control Modules (CCM).
`void`	`readFrames(int[] frame, boolean block)` Read one or more time domain or frequency domain frames.
`int[]`	`readFrames(int[] timeDomainFrame, int[] frequencyDomainFrame, boolean block)` Read read one or more time domain and frequency domain frames.
`void`	`saveConfiguration(java.lang.String filepath)` Save the Ccm configuration to a file
`void`	`setFrequencyDomainBlockSize(int blockSize)` Sets the block size to be used for frequency-domain data.
`void`	`setFrequencyDomainEnabled(boolean enabled)` Enable or disable frequency domain output from the CCM
`void`	`setFrequencyDomainFrameBufferEnabled(boolean enabled)` Enable or disable the frequency domain frame buffer
`void`	`setFrequencyDomainFrameBufferSize(int size)` Sets the the number of frames to be maintained in the frequency domain frame buffer
`void`	`setFrequencyDomainLoggingEnabled(boolean isEnabled)` Enable or disable the frequency domain service level logging
`void`	`setFrequencyDomainOverlapEnabled(boolean enabled)` Enable or disable the frequency domain frame overlap
`void`	`setFrequencyDomainSkipFrames(int skipFrame)` Set the number of frequency domain frames that are skipped after taking frames.
`void`	`setFrequencyDomainTakeFrames(int takeFrame)` Set the number of frequency domain frames that are taken after skipping frames.
`void`	`setFrequencyDomainWindow(int window)` Sets the frequency domain window.
`void`	`setFrequencyDomainWindowCoefficients(double[] buffer)` Sets the frequency domain window coefficients.
`void`	`setLogfilePath(java.lang.String path)` Sets the current base folder used for server logging.
`void`	`setPowerState(boolean power)` Turn Ccm power on or off
`void`	`setSampleRate(int sampleRate)` Sets the sample rate in Hz.
`void`	`setTimeDomainBlockSize(int blockSize)` Sets the block size to be used for time domain data.
`void`	`setTimeDomainEnabled(boolean enabled)` Enable or disable the time domain output.
`void`	`setTimeDomainFrameBufferEnabled(boolean enabled)` Enable or disable the time domain frame buffer.
`void`	`setTimeDomainFrameBufferSize(int size)` Set the number of frames maintained in the time domain frame buffer
`void`	`setTimeDomainLoggingEnabled(boolean isEnabled)` Enable or disable the time domain service level logging
`void`	`setTimeDomainSkipFrames(int skipFrame)` Set the number of time domain frames that are skipped after taking frames.
`void`	`setTimeDomainTakeFrames(int takeFrame)` Set the number of time domain frames that are taken after skipping frames.
`void`	`startInput()` Start the input sampling clock.
`void`	`stopInput()` Stop the input sampling clock
`void`	`writeData(int[] buffer)` Write data.

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

- Field Detail
  - CCM_WINDOW_RECTANGULAR
```
public static final int CCM_WINDOW_RECTANGULAR
```
    The Constant CCM_WINDOW_RECTANGULAR.
    
    See Also:
    
    Constant Field Values
  - CCM_WINDOW_CUSTOM
```
public static final int CCM_WINDOW_CUSTOM
```
    The Constant CCM_WINDOW_CUSTOM.
    
    See Also:
    
    Constant Field Values
  - CCM_WINDOW_HAMMING
```
public static final int CCM_WINDOW_HAMMING
```
    The Constant CCM_WINDOW_HAMMING.
    
    See Also:
    
    Constant Field Values
  - CCM_WINDOW_HANNING
```
public static final int CCM_WINDOW_HANNING
```
    The Constant CCM_WINDOW_HANNING.
    
    See Also:
    
    Constant Field Values
  - CCM_STATUS_RUNNING
```
public static final int CCM_STATUS_RUNNING
```
    The Constant CCM_STATUS_RUNNING.
    
    See Also:
    
    Constant Field Values
  - CCM_STATUS_OVERFLOW
```
public static final int CCM_STATUS_OVERFLOW
```
    The Constant CCM_STATUS_OVERFLOW.
    
    See Also:
    
    Constant Field Values
  - CCM_STATUS_VALID_MASK
```
public static final int CCM_STATUS_VALID_MASK
```
    The Constant CCM_STATUS_VALID_MASK.
    
    See Also:
    
    Constant Field Values
  - CCM_STATUS_LOGGING_ENA
```
public static final int CCM_STATUS_LOGGING_ENA
```
    The Constant CCM_STATUS_LOGGING_ENA.
    
    See Also:
    
    Constant Field Values
  - CCM_STATUS_MEMORY_FULL
```
public static final int CCM_STATUS_MEMORY_FULL
```
    The Constant CCM_STATUS_MEMORY_FULL.
    
    See Also:
    
    Constant Field Values
  - CCM_SAMPLERATE_10000
```
public static final int CCM_SAMPLERATE_10000
```
    The Constant CCM_SAMPLERATE_10000.
    
    See Also:
    
    Constant Field Values
  - CCM_SAMPLERATE_12500
```
public static final int CCM_SAMPLERATE_12500
```
    The Constant CCM_SAMPLERATE_12500.
    
    See Also:
    
    Constant Field Values
  - CCM_SAMPLERATE_20000
```
public static final int CCM_SAMPLERATE_20000
```
    The Constant CCM_SAMPLERATE_20000.
    
    See Also:
    
    Constant Field Values
  - CCM_SAMPLERATE_25000
```
public static final int CCM_SAMPLERATE_25000
```
    The Constant CCM_SAMPLERATE_25000.
    
    See Also:
    
    Constant Field Values
  - CCM_SAMPLERATE_40000
```
public static final int CCM_SAMPLERATE_40000
```
    The Constant CCM_SAMPLERATE_40000.
    
    See Also:
    
    Constant Field Values
  - CCM_SAMPLERATE_50000
```
public static final int CCM_SAMPLERATE_50000
```
    The Constant CCM_SAMPLERATE_50000.
    
    See Also:
    
    Constant Field Values
  - CCM_BLOCKSIZE_64
```
public static final int CCM_BLOCKSIZE_64
```
    The Constant CCM_BLOCKSIZE_64.
    
    See Also:
    
    Constant Field Values
  - CCM_BLOCKSIZE_128
```
public static final int CCM_BLOCKSIZE_128
```
    The Constant CCM_BLOCKSIZE_128.
    
    See Also:
    
    Constant Field Values
  - CCM_BLOCKSIZE_256
```
public static final int CCM_BLOCKSIZE_256
```
    The Constant CCM_BLOCKSIZE_256.
    
    See Also:
    
    Constant Field Values
  - CCM_BLOCKSIZE_512
```
public static final int CCM_BLOCKSIZE_512
```
    The Constant CCM_BLOCKSIZE_512.
    
    See Also:
    
    Constant Field Values
  - CCM_BLOCKSIZE_1024
```
public static final int CCM_BLOCKSIZE_1024
```
    The Constant CCM_BLOCKSIZE_1024.
    
    See Also:
    
    Constant Field Values
  - CCM_BLOCKSIZE_2048
```
public static final int CCM_BLOCKSIZE_2048
```
    The Constant CCM_BLOCKSIZE_2048.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CcmAccess
```
public CcmAccess()
```
    Instantiates a new Ccm access.
- Method Detail
  - getLibraryVersion
```
public CcmVersion getLibraryVersion()
                             throws CcmException
```
    Gets the version of the access library being used.
    
    Returns:
    
    the version
    
    Throws:
    
    CcmException - the Ccm exception
  - getServiceVersion
```
public CcmVersion getServiceVersion()
                             throws CcmException
```
    Gets the version of the system service being used
    
    Returns:
    
    the service version
    
    Throws:
    
    CcmException - the Ccm exception
  - getFirmwareVersion
```
public CcmVersion getFirmwareVersion()
                              throws CcmException
```
    Gets the firmware version of the current CCM.
    
    Returns:
    
    the firmware version
    
    Throws:
    
    CcmException - the Ccm exception
  - getDescription
```
public java.lang.String getDescription()
                                throws CcmException
```
    Gets the description of an accessible Command and Control Module (CCM).
    
    Returns:
    
    the description
    
    Throws:
    
    CcmException - the Ccm exception
  - getModel
```
public java.lang.String getModel()
                          throws CcmException
```
    Gets the model of an accessible Command and Control Module (CCM).
    
    Returns:
    
    the model
    
    Throws:
    
    CcmException - the Ccm exception
  - getSerialNumber
```
public java.lang.String getSerialNumber()
                                 throws CcmException
```
    Gets the serial number of the Command and Control Module (CCM).
    
    Returns:
    
    the serial number
    
    Throws:
    
    CcmException - the Ccm exception
  - getMicrophoneCount
```
public int getMicrophoneCount()
                       throws CcmException
```
    Gets the number of microphones available in the Ccm device.
    
    Returns:
    
    the number of microphones
    
    Throws:
    
    CcmException - the Ccm exception
  - close
```
public void close()
           throws CcmException
```
    Close the I/O handle previously opened with open
    
    Throws:
    
    CcmException - the Ccm exception
  - open
```
public void open()
          throws CcmException
```
    Open I/O handle for an accessible Command and Control Modules (CCM).
    
    Throws:
    
    CcmException - the Ccm exception
  - setPowerState
```
public void setPowerState(boolean power)
                   throws CcmException
```
    Turn Ccm power on or off
    
    Parameters:
    
    power - true to turn on, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - setSampleRate
```
public void setSampleRate(int sampleRate)
                   throws CcmException
```
    Sets the sample rate in Hz.
    Parameters:
    sampleRate - the sample rate
    
    CCM_SAMPLERATE_10000
    
    CCM_SAMPLERATE_12500
    
    CCM_SAMPLERATE_20000
    
    CCM_SAMPLERATE_25000
    
    CCM_SAMPLERATE_40000
    
    CCM_SAMPLERATE_50000
    Throws:
    
    CcmException - the Ccm exception
  - getSampleRate
```
public int getSampleRate()
                  throws CcmException
```
    Gets the current sample rate in Hz.
    
    Returns:
    
    the sample rate
    
    Throws:
    
    CcmException - the Ccm exception
  - setTimeDomainBlockSize
```
public void setTimeDomainBlockSize(int blockSize)
                            throws CcmException
```
    Sets the block size to be used for time domain data.
    Parameters:
    blockSize - the time domain block size
    
    CCM_BLOCKSIZE_64
    
    CCM_BLOCKSIZE_128
    
    CCM_BLOCKSIZE_256
    
    CCM_BLOCKSIZE_512
    
    CCM_BLOCKSIZE_1024
    
    CCM_BLOCKSIZE_2048
    Throws:
    
    CcmException - the Ccm exception
  - getTimeDomainBlockSize
```
public int getTimeDomainBlockSize()
                           throws CcmException
```
    Gets the block size value used for time domain data.
    
    Returns:
    
    the time domain block size
    
    Throws:
    
    CcmException - the Ccm exception
  - setTimeDomainEnabled
```
public void setTimeDomainEnabled(boolean enabled)
                          throws CcmException
```
    Enable or disable the time domain output.
    
    Parameters:
    
    enabled - true to enable the time domain output, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - isTimeDomainEnabled
```
public boolean isTimeDomainEnabled()
                            throws CcmException
```
    Checks if time domain is enabled.
    
    Returns:
    
    true if time domain is enabled, false if not
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainBlockSize
```
public void setFrequencyDomainBlockSize(int blockSize)
                                 throws CcmException
```
    Sets the block size to be used for frequency-domain data.
    Parameters:
    blockSize - the frequency domain block size
    
    CCM_BLOCKSIZE_64
    
    CCM_BLOCKSIZE_128
    
    CCM_BLOCKSIZE_256
    
    CCM_BLOCKSIZE_512
    
    CCM_BLOCKSIZE_1024
    
    CCM_BLOCKSIZE_2048
    Throws:
    
    CcmException - the Ccm exception
  - getFrequencyDomainBlockSize
```
public int getFrequencyDomainBlockSize()
                                throws CcmException
```
    Gets the block size value currently used with frequency-domain data.
    
    Returns:
    
    the block size
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainEnabled
```
public void setFrequencyDomainEnabled(boolean enabled)
                               throws CcmException
```
    Enable or disable frequency domain output from the CCM
    
    Parameters:
    
    enabled - true to enable the frequency domain output, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - isFrequencyDomainEnabled
```
public boolean isFrequencyDomainEnabled()
                                 throws CcmException
```
    Checks if is frequency domain enabled.
    
    Returns:
    
    true if is frequency domain is enabled, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainWindow
```
public void setFrequencyDomainWindow(int window)
                              throws CcmException
```
    Sets the frequency domain window.
    Parameters:
    window - the frequency domain window identifier
    
    CCM_WINDOW_RECTANGULAR
    
    CCM_WINDOW_CUSTOM
    
    CCM_WINDOW_HAMMING
    
    CCM_WINDOW_HANNING
    Throws:
    
    CcmException - the Ccm exception
  - getFrequencyDomainWindow
```
public int getFrequencyDomainWindow()
                             throws CcmException
```
    Gets the frequency domain window identifier.
    
    Returns:
    
    the frequency domain window identifier
    
    Throws:
    
    CcmException - the Ccm exception
  - setTimeDomainLoggingEnabled
```
public void setTimeDomainLoggingEnabled(boolean isEnabled)
                                 throws CcmException
```
    Enable or disable the time domain service level logging
    
    Parameters:
    
    isEnabled - true to enable time domain logging, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - isTimeDomainLoggingEnabled
```
public boolean isTimeDomainLoggingEnabled()
                                   throws CcmException
```
    Checks if is service level time domain logging is enabled.
    
    Returns:
    
    true, if time domain logging is enabled, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainLoggingEnabled
```
public void setFrequencyDomainLoggingEnabled(boolean isEnabled)
                                      throws CcmException
```
    Enable or disable the frequency domain service level logging
    
    Parameters:
    
    isEnabled - true to enable the frequency domain logging, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - isFrequencyDomainLoggingEnabled
```
public boolean isFrequencyDomainLoggingEnabled()
                                        throws CcmException
```
    Checks if service level frequency domain logging is enabled.
    
    Returns:
    
    true, if frequency domain logging is enabled, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - setLogfilePath
```
public void setLogfilePath(java.lang.String path)
                    throws CcmException
```
    Sets the current base folder used for server logging.
    
    Parameters:
    
    path - the logging base folder path
    
    Throws:
    
    CcmException - the Ccm exception
  - getLogfilePath
```
public java.lang.String getLogfilePath()
                                throws CcmException
```
    Gets the current base folder used for server logging.
    
    Returns:
    
    the logging base folder path
    
    Throws:
    
    CcmException - the Ccm exception
  - readFrames
```
public void readFrames(int[] frame,
                       boolean block)
                throws CcmException,
                       CcmInsufficientDataException
```
    Read one or more time domain or frequency domain frames.
    
    Parameters:
    
    frame - the data buffer for the frames
    
    block - wait for a frame to be available
    
    Throws:
    
    CcmException - the Ccm exception
    
    CcmInsufficientDataException - the Ccm insufficient data exception
  - readFrames
```
public int[] readFrames(int[] timeDomainFrame,
                        int[] frequencyDomainFrame,
                        boolean block)
                 throws CcmException,
                        CcmInsufficientDataException
```
    Read read one or more time domain and frequency domain frames.
    
    Parameters:
    
    timeDomainFrame - the data buffer for the time domain frames
    
    frequencyDomainFrame - the data buffer for the frequency domain frames
    
    block - the block
    
    Returns:
    
    the number of frames read. [TD, FD];
    
    Throws:
    
    CcmException - the Ccm exception
    
    CcmInsufficientDataException - the Ccm insufficient data exception
  - writeData
```
public void writeData(int[] buffer)
               throws CcmException
```
    Write data.
    
    Parameters:
    
    buffer - the buffer
    
    Throws:
    
    CcmException - the Ccm exception
  - getTimeDomainFramesAvailable
```
public int getTimeDomainFramesAvailable()
                                 throws CcmException
```
    Gets the number of time domain frames available to read.
    
    Returns:
    
    the number of frames available
    
    Throws:
    
    CcmException - the Ccm exception
  - getFrequencyDomainFramesAvailable
```
public int getFrequencyDomainFramesAvailable()
                                      throws CcmException
```
    Gets the number of frequency domain frames available to read.
    
    Returns:
    
    the number of frames available
    
    Throws:
    
    CcmException - the Ccm exception
  - startInput
```
public void startInput()
                throws CcmException
```
    Start the input sampling clock.
    
    Throws:
    
    CcmException - the Ccm exception
  - stopInput
```
public void stopInput()
               throws CcmException
```
    Stop the input sampling clock
    
    Throws:
    
    CcmException - the Ccm exception
  - getStatus
```
public int getStatus()
              throws CcmException,
                     CcmNotUpdatedException
```
    Gets the current status information.
    Returns:
    the status
    
    CCM_STATUS_RUNNING
    
    CCM_STATUS_OVERFLOW
    
    CCM_STATUS_VALID_MASK
    
    CCM_STATUS_LOGGING_ENA
    
    CCM_STATUS_MEMORY_FULL
    Throws:
    
    CcmException - the Ccm exception
    
    CcmNotUpdatedException - the Ccm not updated exception
  - getOverflowWarning
```
public int getOverflowWarning()
                       throws CcmException
```
    Gets the overflow warning level. An overflow means that the internal buffer is full. Input sampling is stopped when an overflow occurs.
    
    Returns:
    
    the overflow warning level
    
    Throws:
    
    CcmException - the Ccm exception
  - loadConfiguration
```
public void loadConfiguration(java.lang.String filepath)
                       throws CcmException
```
    Load a previously saved configuration from a file.
    
    Parameters:
    
    filepath - the the path to the configuration file
    
    Throws:
    
    CcmException - the Ccm exception
  - saveConfiguration
```
public void saveConfiguration(java.lang.String filepath)
                       throws CcmException
```
    Save the Ccm configuration to a file
    
    Parameters:
    
    filepath - the path to where to save the configuration
    
    Throws:
    
    CcmException - the Ccm exception
  - setTimeDomainFrameBufferEnabled
```
public void setTimeDomainFrameBufferEnabled(boolean enabled)
                                     throws CcmException
```
    Enable or disable the time domain frame buffer.
    
    Parameters:
    
    enabled - true to enable the time domain frame buffer, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - setTimeDomainFrameBufferSize
```
public void setTimeDomainFrameBufferSize(int size)
                                  throws CcmException
```
    Set the number of frames maintained in the time domain frame buffer
    
    Parameters:
    
    size - the number of time domain frames
    
    Throws:
    
    CcmException - the Ccm exception
  - isTimeDomainFrameBufferEnabled
```
public boolean isTimeDomainFrameBufferEnabled()
                                       throws CcmException
```
    Checks if the time domain frame buffer is enabled.
    
    Returns:
    
    true if the time domain frame buffer is enabled, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - getTimeDomainFrameBufferSize
```
public int getTimeDomainFrameBufferSize()
                                 throws CcmException
```
    Gets the the number of frames maintained in the time domain frame buffer
    
    Returns:
    
    the time domain frame buffer size
    
    Throws:
    
    CcmException - the Ccm exception
  - getTimeDomainFrameBufferAvailable
```
public int getTimeDomainFrameBufferAvailable()
                                      throws CcmException
```
    Gets the number of time domain frames available for reading from the frame buffer.
    
    Returns:
    
    the number of frames available
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainFrameBufferEnabled
```
public void setFrequencyDomainFrameBufferEnabled(boolean enabled)
                                          throws CcmException
```
    Enable or disable the frequency domain frame buffer
    
    Parameters:
    
    enabled - true to enable the frequency domain frame buffer, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainFrameBufferSize
```
public void setFrequencyDomainFrameBufferSize(int size)
                                       throws CcmException
```
    Sets the the number of frames to be maintained in the frequency domain frame buffer
    
    Parameters:
    
    size - the number of frequency domain frames
    
    Throws:
    
    CcmException - the Ccm exception
  - isFrequencyDomainFrameBufferEnabled
```
public boolean isFrequencyDomainFrameBufferEnabled()
                                            throws CcmException
```
    Checks if the frequency domain frame buffer is enabled.
    
    Returns:
    
    true if the frequency domain frame buffer is enabled, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - getFrequencyDomainFrameBufferSize
```
public int getFrequencyDomainFrameBufferSize()
                                      throws CcmException
```
    Gets the the number of frames maintained in the frequency domain frame buffer
    
    Returns:
    
    the frequency domain frame buffer size.
    
    Throws:
    
    CcmException - the Ccm exception
  - getFrequencyDomainFrameBufferAvailable
```
public int getFrequencyDomainFrameBufferAvailable()
                                           throws CcmException
```
    Gets the number of frequency domain frames available for reading from the frame buffer.
    
    Returns:
    
    the number of frequency domain frames available
    
    Throws:
    
    CcmException - the Ccm exception
  - getMicrophoneCoordinates
```
public int[] getMicrophoneCoordinates()
                               throws CcmException,
                                      CcmNotUpdatedException
```
    Gets the coordinates of the microphones on the Ccm panel.
    
    Returns:
    
    the microphone coordinates
    
    Throws:
    
    CcmException - the Ccm exception
    
    CcmNotUpdatedException - the Ccm not updated exception
  - setFrequencyDomainWindowCoefficients
```
public void setFrequencyDomainWindowCoefficients(double[] buffer)
                                          throws CcmException
```
    Sets the frequency domain window coefficients.
    
    Parameters:
    
    buffer - the frequency domain window coefficients
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainOverlapEnabled
```
public void setFrequencyDomainOverlapEnabled(boolean enabled)
                                      throws CcmException
```
    Enable or disable the frequency domain frame overlap
    
    Parameters:
    
    enabled - true to enable the frequency domain frame overlap, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - isFrequencyDomainOverlapEnabled
```
public boolean isFrequencyDomainOverlapEnabled()
                                        throws CcmException
```
    Checks if is frequency domain overlap is enabled.
    
    Returns:
    
    true if is frequency domain overlap is enabled, false otherwise
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainTakeFrames
```
public void setFrequencyDomainTakeFrames(int takeFrame)
                                  throws CcmException
```
    Set the number of frequency domain frames that are taken after skipping frames.
    
    Parameters:
    
    takeFrame - the number of frequency domain frames to take
    
    Throws:
    
    CcmException - the Ccm exception
  - setFrequencyDomainSkipFrames
```
public void setFrequencyDomainSkipFrames(int skipFrame)
                                  throws CcmException
```
    Set the number of frequency domain frames that are skipped after taking frames.
    
    Parameters:
    
    skipFrame - the number of frequency domain frames to skip
    
    Throws:
    
    CcmException - the Ccm exception
  - getFrequencyDomainTakeFrames
```
public int getFrequencyDomainTakeFrames()
                                 throws CcmException
```
    Gets the number of frequency domain frames that are returned (taken) after skipping frames
    
    Returns:
    
    the number of frequency domain frames taken
    
    Throws:
    
    CcmException - the Ccm exception
  - getFrequencyDomainSkipFrames
```
public int getFrequencyDomainSkipFrames()
                                 throws CcmException
```
    Gets the number of frequency domain frames that are skipped after taking frames.
    
    Returns:
    
    the number of frequency domain frames skipped
    
    Throws:
    
    CcmException - the Ccm exception
  - setTimeDomainTakeFrames
```
public void setTimeDomainTakeFrames(int takeFrame)
                             throws CcmException
```
    Set the number of time domain frames that are taken after skipping frames.
    
    Parameters:
    
    takeFrame - the number of time domain frames to take
    
    Throws:
    
    CcmException - the Ccm exception
  - setTimeDomainSkipFrames
```
public void setTimeDomainSkipFrames(int skipFrame)
                             throws CcmException
```
    Set the number of time domain frames that are skipped after taking frames.
    
    Parameters:
    
    skipFrame - the number of time domain frames to skip
    
    Throws:
    
    CcmException - the Ccm exception
    
    See Also:
    
    setTimeDomainTakeFrames
  - getTimeDomainTakeFrames
```
public int getTimeDomainTakeFrames()
                            throws CcmException
```
    Gets the number of time domain frames that are returned (taken) after skipping frames
    
    Returns:
    
    the number of time domain frames taken
    
    Throws:
    
    CcmException - the Ccm exception
  - getTimeDomainSkipFrames
```
public int getTimeDomainSkipFrames()
                            throws CcmException
```
    Gets the number of time domain frames that are skipped after taking frames.
    
    Returns:
    
    the number of time domain frames skipped
    
    Throws:
    
    CcmException - the Ccm exception

Class CcmAccess

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CCM_WINDOW_RECTANGULAR

CCM_WINDOW_CUSTOM

CCM_WINDOW_HAMMING

CCM_WINDOW_HANNING

CCM_STATUS_RUNNING

CCM_STATUS_OVERFLOW

CCM_STATUS_VALID_MASK

CCM_STATUS_LOGGING_ENA

CCM_STATUS_MEMORY_FULL

CCM_SAMPLERATE_10000

CCM_SAMPLERATE_12500

CCM_SAMPLERATE_20000

CCM_SAMPLERATE_25000

CCM_SAMPLERATE_40000

CCM_SAMPLERATE_50000

CCM_BLOCKSIZE_64

CCM_BLOCKSIZE_128

CCM_BLOCKSIZE_256

CCM_BLOCKSIZE_512

CCM_BLOCKSIZE_1024

CCM_BLOCKSIZE_2048

Constructor Detail

CcmAccess

Method Detail

getLibraryVersion

getServiceVersion

getFirmwareVersion

getDescription

getModel

getSerialNumber

getMicrophoneCount

close

open

setPowerState

setSampleRate

getSampleRate

setTimeDomainBlockSize

getTimeDomainBlockSize

setTimeDomainEnabled

isTimeDomainEnabled

setFrequencyDomainBlockSize

getFrequencyDomainBlockSize

setFrequencyDomainEnabled

isFrequencyDomainEnabled

setFrequencyDomainWindow

getFrequencyDomainWindow

setTimeDomainLoggingEnabled

isTimeDomainLoggingEnabled

setFrequencyDomainLoggingEnabled

isFrequencyDomainLoggingEnabled

setLogfilePath

getLogfilePath

readFrames

readFrames

writeData

getTimeDomainFramesAvailable

getFrequencyDomainFramesAvailable

startInput

stopInput

getStatus

getOverflowWarning

loadConfiguration

saveConfiguration

setTimeDomainFrameBufferEnabled

setTimeDomainFrameBufferSize

isTimeDomainFrameBufferEnabled

getTimeDomainFrameBufferSize

getTimeDomainFrameBufferAvailable

setFrequencyDomainFrameBufferEnabled

setFrequencyDomainFrameBufferSize

isFrequencyDomainFrameBufferEnabled

getFrequencyDomainFrameBufferSize

getFrequencyDomainFrameBufferAvailable

getMicrophoneCoordinates