org.xiph.speex.spi
Class SpeexEncoding

java.lang.Object
  javax.sound.sampled.AudioFormat.Encoding
      org.xiph.speex.spi.SpeexEncoding

public class SpeexEncoding
extends javax.sound.sampled.AudioFormat.Encoding

Encodings used by the Speex audio decoder.

Version:

$Revision: 1.2 $

Author:

Marc Gimpel, Wimba S.A. (mgimpel@horizonwimba.com)

Field Summary

static int	DEFAULT_QUALITY Default quality setting for the Speex encoding.
static boolean	DEFAULT_VBR Default VBR setting for the Speex encoding.
protected int	quality Quality setting for the Speex encoding.
static SpeexEncoding	SPEEX Specifies any Speex encoding.
static SpeexEncoding	SPEEX_Q0 Specifies constant bitrate, quality 0, Speex encoding.
static SpeexEncoding	SPEEX_Q1 Specifies constant bitrate, quality 1, Speex encoding.
static SpeexEncoding	SPEEX_Q10 Specifies constant bitrate, quality 10, Speex encoding.
static SpeexEncoding	SPEEX_Q2 Specifies constant bitrate, quality 2, Speex encoding.
static SpeexEncoding	SPEEX_Q3 Specifies constant bitrate, quality 3, Speex encoding.
static SpeexEncoding	SPEEX_Q4 Specifies constant bitrate, quality 4, Speex encoding.
static SpeexEncoding	SPEEX_Q5 Specifies constant bitrate, quality 5, Speex encoding.
static SpeexEncoding	SPEEX_Q6 Specifies constant bitrate, quality 6, Speex encoding.
static SpeexEncoding	SPEEX_Q7 Specifies constant bitrate, quality 7, Speex encoding.
static SpeexEncoding	SPEEX_Q8 Specifies constant bitrate, quality 8, Speex encoding.
static SpeexEncoding	SPEEX_Q9 Specifies constant bitrate, quality 9, Speex encoding.
static SpeexEncoding	SPEEX_VBR0 Specifies variable bitrate, quality 0, Speex encoding.
static SpeexEncoding	SPEEX_VBR1 Specifies variable bitrate, quality 1, Speex encoding.
static SpeexEncoding	SPEEX_VBR10 Specifies variable bitrate, quality 10, Speex encoding.
static SpeexEncoding	SPEEX_VBR2 Specifies variable bitrate, quality 2, Speex encoding.
static SpeexEncoding	SPEEX_VBR3 Specifies variable bitrate, quality 3, Speex encoding.
static SpeexEncoding	SPEEX_VBR4 Specifies variable bitrate, quality 4, Speex encoding.
static SpeexEncoding	SPEEX_VBR5 Specifies variable bitrate, quality 5, Speex encoding.
static SpeexEncoding	SPEEX_VBR6 Specifies variable bitrate, quality 6, Speex encoding.
static SpeexEncoding	SPEEX_VBR7 Specifies variable bitrate, quality 7, Speex encoding.
static SpeexEncoding	SPEEX_VBR8 Specifies variable bitrate, quality 8, Speex encoding.
static SpeexEncoding	SPEEX_VBR9 Specifies variable bitrate, quality 9, Speex encoding.
protected boolean	vbr Defines whether or not the encoding is Variable Bit Rate.

Fields inherited from class javax.sound.sampled.AudioFormat.Encoding

ALAW, PCM_SIGNED, PCM_UNSIGNED, ULAW

Constructor Summary

SpeexEncoding(java.lang.String name)
Constructs a new encoding.

SpeexEncoding(java.lang.String name, int quality, boolean vbr)
Constructs a new encoding.

Method Summary

int	getQuality() Returns the quality setting for the Speex encoding.
boolean	isVBR() Returns whether or not the encoding is Variable Bit Rate.

Methods inherited from class javax.sound.sampled.AudioFormat.Encoding

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SPEEX

public static final SpeexEncoding SPEEX

Specifies any Speex encoding.

SPEEX_Q0

public static final SpeexEncoding SPEEX_Q0

Specifies constant bitrate, quality 0, Speex encoding.

SPEEX_Q1

public static final SpeexEncoding SPEEX_Q1

Specifies constant bitrate, quality 1, Speex encoding.

SPEEX_Q2

public static final SpeexEncoding SPEEX_Q2

Specifies constant bitrate, quality 2, Speex encoding.

SPEEX_Q3

public static final SpeexEncoding SPEEX_Q3

Specifies constant bitrate, quality 3, Speex encoding.

SPEEX_Q4

public static final SpeexEncoding SPEEX_Q4

Specifies constant bitrate, quality 4, Speex encoding.

SPEEX_Q5

public static final SpeexEncoding SPEEX_Q5

Specifies constant bitrate, quality 5, Speex encoding.

SPEEX_Q6

public static final SpeexEncoding SPEEX_Q6

Specifies constant bitrate, quality 6, Speex encoding.

SPEEX_Q7

public static final SpeexEncoding SPEEX_Q7

Specifies constant bitrate, quality 7, Speex encoding.

SPEEX_Q8

public static final SpeexEncoding SPEEX_Q8

Specifies constant bitrate, quality 8, Speex encoding.

SPEEX_Q9

public static final SpeexEncoding SPEEX_Q9

Specifies constant bitrate, quality 9, Speex encoding.

SPEEX_Q10

public static final SpeexEncoding SPEEX_Q10

Specifies constant bitrate, quality 10, Speex encoding.

SPEEX_VBR0

public static final SpeexEncoding SPEEX_VBR0

Specifies variable bitrate, quality 0, Speex encoding.

SPEEX_VBR1

public static final SpeexEncoding SPEEX_VBR1

Specifies variable bitrate, quality 1, Speex encoding.

SPEEX_VBR2

public static final SpeexEncoding SPEEX_VBR2

Specifies variable bitrate, quality 2, Speex encoding.

SPEEX_VBR3

public static final SpeexEncoding SPEEX_VBR3

Specifies variable bitrate, quality 3, Speex encoding.

SPEEX_VBR4

public static final SpeexEncoding SPEEX_VBR4

Specifies variable bitrate, quality 4, Speex encoding.

SPEEX_VBR5

public static final SpeexEncoding SPEEX_VBR5

Specifies variable bitrate, quality 5, Speex encoding.

SPEEX_VBR6

public static final SpeexEncoding SPEEX_VBR6

Specifies variable bitrate, quality 6, Speex encoding.

SPEEX_VBR7

public static final SpeexEncoding SPEEX_VBR7

Specifies variable bitrate, quality 7, Speex encoding.

SPEEX_VBR8

public static final SpeexEncoding SPEEX_VBR8

Specifies variable bitrate, quality 8, Speex encoding.

SPEEX_VBR9

public static final SpeexEncoding SPEEX_VBR9

Specifies variable bitrate, quality 9, Speex encoding.

SPEEX_VBR10

public static final SpeexEncoding SPEEX_VBR10

Specifies variable bitrate, quality 10, Speex encoding.

DEFAULT_QUALITY

public static final int DEFAULT_QUALITY

Default quality setting for the Speex encoding.

See Also:

Constant Field Values

DEFAULT_VBR

public static final boolean DEFAULT_VBR

Default VBR setting for the Speex encoding.

See Also:

Constant Field Values

quality

protected int quality

Quality setting for the Speex encoding.

vbr

protected boolean vbr

Defines whether or not the encoding is Variable Bit Rate.

Constructor Detail

SpeexEncoding

public SpeexEncoding(java.lang.String name,
                     int quality,
                     boolean vbr)

Constructs a new encoding.

Parameters:

name - - Name of the Speex encoding.

quality - - Quality setting for the Speex encoding.

vbr - - Defines whether or not the encoding is Variable Bit Rate.

SpeexEncoding

public SpeexEncoding(java.lang.String name)

Constructs a new encoding.

Parameters:

name - - Name of the Speex encoding.

Method Detail

getQuality

public int getQuality()

Returns the quality setting for the Speex encoding.

Returns:

the quality setting for the Speex encoding.

isVBR

public boolean isVBR()

Returns whether or not the encoding is Variable Bit Rate.

Returns:

whether or not the encoding is Variable Bit Rate.