com.canto.cumulus

Class Audio

java.lang.Object

com.canto.cumulus.Audio

public class Audio
extends java.lang.Object

The Audio object allows you to access a Cumulus audio field. The audio data is compressed using one of the components installed into Apple's QuickTime system.

Constructor Summary

Constructors

Constructor and Description
Audio(byte[] pack) Creates a new Audio object from a pack array.
Audio(Pack pack) Creates a new Audio object from a pack.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getAudio() Returns the compressed audio data.
int	getBitsPerSample() Returns the number of bits per sample.
int	getCompressor() Returns the compression mode.
byte[]	getData() Returns the Audio field as binary data.
int	getDuration() Returns the sound duration in milliseconds.
int	getNbChannel() Returns the number of channels.
int	getRate() Returns the sample rate.

Methods inherited from class java.lang.Object

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

Constructor Detail

Audio

public Audio(byte[] pack)

Creates a new Audio object from a pack array.

Parameters:

pack - a pack array obtained from a call to Item.getBinaryValue(GUID).

Audio

public Audio(Pack pack)

Creates a new Audio object from a pack.

Parameters:

pack - an audio pack initialized with the result of a call to Item.getBinaryValue(GUID).

Method Detail

getCompressor

public int getCompressor()
                  throws CumulusException

Returns the compression mode. The value is taken from the format member of the QuickTime CompressionInfo structure.

Returns:

the audio compressor component used to compress the audio data.

Throws:

CumulusException - if this information is not available.

getRate

public int getRate()
            throws CumulusException

Returns the sample rate.

Returns:

the number of samples per second.

Throws:

CumulusException - if this information is not available.

getBitsPerSample

public int getBitsPerSample()
                     throws CumulusException

Returns the number of bits per sample.

Returns:

the number of bits per sample (8 or 16).

Throws:

CumulusException - if this information is not available.

getNbChannel

public int getNbChannel()
                 throws CumulusException

Returns the number of channels.

Returns:

the number of channels (1 or 2).

Throws:

CumulusException - if this information is not available.

getAudio

public byte[] getAudio()
                throws CumulusException

Returns the compressed audio data.

Returns:

the compressed audio data.

Throws:

CumulusException - if this information is not available.

getDuration

public int getDuration()
                throws CumulusException

Returns the sound duration in milliseconds. This value can also be calculated using the size of the sound data and the sample rate, sample size and the number of channels, but is provided as extra information.

Returns:

the sound duration in milliseconds.

Throws:

CumulusException - if this information is not available.

getData

public byte[] getData()

Returns the Audio field as binary data.

Returns:

the Audio field as binary data.

Since:

6.6