org.farng.mp3.id3
Class FrameBodyUSLT

java.lang.Object
  org.farng.mp3.AbstractMP3FileItem
      org.farng.mp3.AbstractMP3FragmentBody
          org.farng.mp3.id3.AbstractID3v2FrameBody
              org.farng.mp3.id3.FrameBodyUSLT

public class FrameBodyUSLT

extends AbstractID3v2FrameBody

4.8. Unsynchronised lyrics/text transcription

This frame contains the lyrics of the song or a text transcription of
other vocal activities. The head includes an encoding descriptor and

a content descriptor. The body consists of the actual text. The
'Content descriptor' is a terminated string. If no descriptor is
entered, 'Content descriptor' is $00 (00) only. Newline characters
are allowed in the text. There may be more than one 'Unsynchronised
lyrics/text transcription' frame in each tag, but only one with the

same language and content descriptor.

<Header for 'Unsynchronised lyrics/text transcription', ID: "USLT">
Text encoding $xx

Language $xx xx xx
Content descriptor <text string according to encoding> $00 (00)
Lyrics/text <full text string according to encoding>

Version:

$Revision: 1.4 $

Author:

Eric Farng

Constructor Summary

FrameBodyUSLT()
Creates a new FrameBodyUSLT object.

FrameBodyUSLT(byte textEncoding, java.lang.String language, java.lang.String description, java.lang.String text)
Creates a new FrameBodyUSLT object.

FrameBodyUSLT(FrameBodyUSLT body)
Creates a new FrameBodyUSLT object.

FrameBodyUSLT(java.io.RandomAccessFile file)
Creates a new FrameBodyUSLT object.

Method Summary

void	addLyric(ObjectLyrics3Line line)
void	addLyric(java.lang.String text)
java.lang.String	getDescription() This method calls toString for all it's objects and appends them.
java.lang.String	getIdentifier() ID string that usually corresponds to the class name, but can be displayed to the user.
java.lang.String	getLanguage()
java.lang.String	getLyric()
void	setDescription(java.lang.String description)
void	setLanguage(java.lang.String language)
void	setLyric(java.lang.String lyric)
protected void	setupObjectList() Create the order of MP3Object objects that this body expects.

Methods inherited from class org.farng.mp3.id3.AbstractID3v2FrameBody

equals, readHeader, writeHeader

Methods inherited from class org.farng.mp3.AbstractMP3FragmentBody

appendToObjectList, getBriefDescription, getObject, getObjectListIterator, getSize, has6ByteHeader, isSubsetOf, iterator, read, setObject, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameBodyUSLT

public FrameBodyUSLT()

Creates a new FrameBodyUSLT object.

FrameBodyUSLT

public FrameBodyUSLT(FrameBodyUSLT body)

Creates a new FrameBodyUSLT object.

FrameBodyUSLT

public FrameBodyUSLT(byte textEncoding,
                     java.lang.String language,
                     java.lang.String description,
                     java.lang.String text)

Creates a new FrameBodyUSLT object.

FrameBodyUSLT

public FrameBodyUSLT(java.io.RandomAccessFile file)
              throws java.io.IOException,
                     InvalidTagException

Creates a new FrameBodyUSLT object.

Method Detail

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractMP3FragmentBody

This method calls toString for all it's objects and appends them. It contains new line characters and is more suited for display purposes

Overrides:

getDescription in class AbstractMP3FragmentBody

Returns:

formatted description string

getIdentifier

public java.lang.String getIdentifier()

Description copied from class: AbstractMP3FileItem

ID string that usually corresponds to the class name, but can be displayed to the user. It is not indended to identify each individual instance.

Specified by:

getIdentifier in class AbstractMP3FileItem

Returns:

ID string

setLanguage

public void setLanguage(java.lang.String language)

getLanguage

public java.lang.String getLanguage()

setLyric

public void setLyric(java.lang.String lyric)

getLyric

public java.lang.String getLyric()

addLyric

public void addLyric(java.lang.String text)

addLyric

public void addLyric(ObjectLyrics3Line line)

setupObjectList

protected void setupObjectList()

Description copied from class: AbstractMP3FragmentBody

Create the order of MP3Object objects that this body expects. This method needs to be overwritten.

Specified by:

setupObjectList in class AbstractMP3FragmentBody