TagOggVorbis (iFish scanner 1.5.0-SNAPSHOT API) - iFish-scanner - shredzone.org

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.shredzone.ifish.ltr
Class TagOggVorbis

java.lang.Object
  net.shredzone.ifish.ltr.LTR
      net.shredzone.ifish.ltr.TagOggVorbis

public class TagOggVorbis
extends LTR
extends LTR

Decodes an Ogg Vorbis stream. It uses the J-Ogg library, which is copyrighted by Tor-Einar Jarnbjo. His licence says that may use and modify it as will (even commercial), as long as a reference to his library is stated in the software.

NOTE: Due to a bug, there is a patch required in the J-Ogg library. In class de.jarnbjo.vorbis.CommentHeader, private method addComment(), add a line

   key = key.toUpperCase();

after the method declaration header.

Version:: $Id: TagOggVorbis.java 289 2009-04-28 21:21:46Z shred $

Field Summary

Fields inherited from class net.shredzone.ifish.ltr.LTR
`factory, in`

Constructor Summary
`TagOggVorbis(RandomAccessFile in, LTRFactory factory)` Create a new TagOggVorbis object.

Method Summary
`String`	`getAlbum()` Get the album.
`String`	`getArtist()` Get the artist.
`String`	`getComment()` Get the comment.
`String`	`getGenre()` Get the genre.
`String`	`getTitle()` Get the title.
`String`	`getTrack()` Get the track.
`String`	`getType()` Get the type of this file.
`String`	`getYear()` Get the year.

Methods inherited from class net.shredzone.ifish.ltr.LTR
`readStringLen, readStringLen, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

TagOggVorbis

public TagOggVorbis(RandomAccessFile in,
                    LTRFactory factory)
             throws FormatDecodeException

Create a new TagOggVorbis object.

Parameters:: in - File to read; factory - Reference to the LTRFactory
Throws:: FormatDecodeException - Couldn't decode this file

Method Detail

getType

public String getType()

Get the type of this file. This is usually the compression format itself (e.g. "OGG" or "MP3"). If there are different taggings for this format, the used tag format is appended after a slash (e.g. "MP3/id3v2").

Specified by:: getType in class LTR

Returns:: The type

getArtist

public String getArtist()

Get the artist.

Specified by:: getArtist in class LTR

Returns:: The artist (never null)

getAlbum

public String getAlbum()

Get the album.

Specified by:: getAlbum in class LTR

Returns:: The album (never null)

getTitle

public String getTitle()

Get the title.

Specified by:: getTitle in class LTR

Returns:: The title (never null)

getGenre

public String getGenre()

Get the genre.

Specified by:: getGenre in class LTR

Returns:: The genre (never null)

getYear

public String getYear()

Get the year.

Specified by:: getYear in class LTR

Returns:: The year (never null)

getComment

public String getComment()

Get the comment.

Specified by:: getComment in class LTR

Returns:: The comment (never null)

getTrack

public String getTrack()

Get the track.

Specified by:: getTrack in class LTR

Returns:: The track (never null)