org.gagravarr.vorbis

Class VorbisComments

java.lang.Object

org.gagravarr.ogg.HighLevelOggStreamPacket

org.gagravarr.vorbis.VorbisStyleComments

org.gagravarr.vorbis.VorbisComments

All Implemented Interfaces:

OggAudioTagsHeader, OggStreamPacket, VorbisPacket

public class VorbisComments
extends VorbisStyleComments
implements VorbisPacket, OggAudioTagsHeader

Holds encoder information and user specified tags

Field Summary

Fields inherited from class org.gagravarr.vorbis.VorbisStyleComments

KEY_ALBUM, KEY_ARTIST, KEY_DATE, KEY_GENRE, KEY_TITLE, KEY_TRACKNUMBER

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
VorbisComments()
VorbisComments(OggPacket pkt)

Method Summary

Modifier and Type	Method and Description
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.
protected boolean	hasFramingBit() Vorbis Comments have framing bits if there's padding after the end of the defined comments
void	populateMetadataFooter(OutputStream out)
void	populateMetadataHeader(byte[] b, int dataLength) Have the metadata header populated into the data, normally used when writing out.

Methods inherited from class org.gagravarr.vorbis.VorbisStyleComments

addComment, getAlbum, getAllComments, getArtist, getComments, getDate, getGenre, getInt4, getSingleComment, getTitle, getTrackNumber, getTrackNumberNumeric, getVendor, normaliseTag, removeAllComments, removeComments, setComments, setVendor, 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.audio.OggAudioTagsHeader

getAlbum, getAllComments, getArtist, getComments, getDate, getGenre, getTitle, getTrackNumber, getTrackNumberNumeric, getVendor

Methods inherited from interface org.gagravarr.ogg.OggStreamPacket

getData, getOggOverheadSize, setData, write

Constructor Detail

VorbisComments

public VorbisComments(OggPacket pkt)

VorbisComments

public VorbisComments()

Method Detail

hasFramingBit

protected boolean hasFramingBit()

Vorbis Comments have framing bits if there's padding after the end of the defined comments

Specified by:

hasFramingBit in class VorbisStyleComments

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

Specified by:

getHeaderSize in class VorbisStyleComments

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

Specified by:

populateMetadataHeader in class VorbisStyleComments

populateMetadataFooter

public void populateMetadataFooter(OutputStream out)

Specified by:

populateMetadataFooter in class VorbisStyleComments