org.gagravarr.vorbis

Class VorbisInfo

java.lang.Object

org.gagravarr.ogg.HighLevelOggStreamPacket

org.gagravarr.vorbis.VorbisInfo

All Implemented Interfaces:

OggAudioInfoHeader, OggStreamPacket, VorbisPacket

public class VorbisInfo
extends HighLevelOggStreamPacket
implements VorbisPacket, OggAudioInfoHeader

The identification header identifies the bitstream as Vorbis, Vorbis version, and the simple audio characteristics of the stream such as sample rate and number of channels.

Field Summary

Fields inherited from interface org.gagravarr.vorbis.VorbisPacket

HEADER_LENGTH_AUDIO, HEADER_LENGTH_METADATA, TYPE_COMMENTS, TYPE_INFO, TYPE_SETUP

Constructor Summary

Constructors

Constructor and Description
VorbisInfo()
VorbisInfo(OggPacket pkt)

Method Summary

Modifier and Type	Method and Description
int	getBitrateLower()
int	getBitrateNominal()
int	getBitrateUpper()
int	getBlocksize0()
int	getBlocksize1()
int	getChannels()
int	getHeaderSize() How big is the header on this packet? For Metadata packets it's normally 7 bytes, otherwise for audio packets there is no header.
int	getNumChannels()
int	getPreSkip()
long	getRate()
int	getSampleRate()
int	getVersion()
String	getVersionString()
void	populateMetadataHeader(byte[] b, int dataLength) Have the metadata header populated into the data, normally used when writing out.
void	setBitrateLower(int bitrateLower)
void	setBitrateNominal(int bitrateNominal)
void	setBitrateUpper(int bitrateUpper)
void	setBlocksize0(int blocksize)
void	setBlocksize1(int blocksize)
void	setChannels(int channels)
void	setRate(long rate)
OggPacket	write()

Methods inherited from class org.gagravarr.ogg.HighLevelOggStreamPacket

getData, getOggOverheadSize, getOggPacket, setData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gagravarr.ogg.OggStreamPacket

getData, getOggOverheadSize, setData

Constructor Detail

VorbisInfo

public VorbisInfo()

VorbisInfo

public VorbisInfo(OggPacket pkt)

Method Detail

getHeaderSize

public int getHeaderSize()

Description copied from interface: VorbisPacket

How big is the header on this packet? For Metadata packets it's normally 7 bytes, otherwise for audio packets there is no header.

Specified by:

getHeaderSize in interface VorbisPacket

populateMetadataHeader

public void populateMetadataHeader(byte[] b,
                                   int dataLength)

Description copied from interface: VorbisPacket

Have the metadata header populated into the data, normally used when writing out. See VorbisPacketFactory.populateMetadataHeader(byte[], int, int)

Specified by:

populateMetadataHeader in interface VorbisPacket

write

public OggPacket write()

Specified by:

write in interface OggStreamPacket

Overrides:

write in class HighLevelOggStreamPacket

getVersion

public int getVersion()

getVersionString

public String getVersionString()

Specified by:

getVersionString in interface OggAudioInfoHeader

Returns:

The version of the codec / format used

getChannels

public int getChannels()

setChannels

public void setChannels(int channels)

getNumChannels

public int getNumChannels()

Specified by:

getNumChannels in interface OggAudioInfoHeader

Returns:

The number of channels (1=mono, 2=stereo etc)

getRate

public long getRate()

setRate

public void setRate(long rate)

getSampleRate

public int getSampleRate()

Specified by:

getSampleRate in interface OggAudioInfoHeader

Returns:

Sample rate in Hz

getPreSkip

public int getPreSkip()

Specified by:

getPreSkip in interface OggAudioInfoHeader

Returns:

The number of samples to be skipped from the beginning of the stream

getBitrateUpper

public int getBitrateUpper()

setBitrateUpper

public void setBitrateUpper(int bitrateUpper)

getBitrateNominal

public int getBitrateNominal()

setBitrateNominal

public void setBitrateNominal(int bitrateNominal)

getBitrateLower

public int getBitrateLower()

setBitrateLower

public void setBitrateLower(int bitrateLower)

getBlocksize0

public int getBlocksize0()

setBlocksize0

public void setBlocksize0(int blocksize)

getBlocksize1

public int getBlocksize1()

setBlocksize1

public void setBlocksize1(int blocksize)