|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jaudiotagger.tag.id3.AbstractTagItem org.jaudiotagger.tag.id3.AbstractTagFrameBody org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody org.jaudiotagger.tag.id3.framebody.FrameBodyUSLT
public class FrameBodyUSLT
Unsychronised lyrics/text transcription frame.
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> |
getFirstTextValue()
For more details, please refer to the ID3 specifications:
Field Summary |
---|
Fields inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody |
---|
TYPE_BODY |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody |
---|
objectList |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem |
---|
logger |
Constructor Summary | |
---|---|
FrameBodyUSLT()
Creates a new FrameBodyUSLT datatype. |
|
FrameBodyUSLT(java.nio.ByteBuffer byteBuffer,
int frameSize)
Creates a new FrameBodyUSLT datatype, populated from buffer |
|
FrameBodyUSLT(byte textEncoding,
java.lang.String language,
java.lang.String description,
java.lang.String text)
Creates a new FrameBodyUSLT datatype. |
|
FrameBodyUSLT(FrameBodyUSLT body)
Copy constructor |
Method Summary | |
---|---|
void |
addLyric(Lyrics3Line line)
|
void |
addLyric(java.lang.String text)
Add additional lyric to the lyric field |
java.lang.String |
getDescription()
Get a description field |
java.lang.String |
getFirstTextValue()
Get first value |
java.lang.String |
getIdentifier()
The ID3v2 frame identifier |
java.lang.String |
getLanguage()
Get the language field |
java.lang.String |
getLyric()
Get the lyric field |
void |
setDescription(java.lang.String description)
Set a description field |
void |
setLanguage(java.lang.String language)
Set the language field |
void |
setLyric(java.lang.String lyric)
Set the lyric field |
protected void |
setupObjectList()
Create the list of Datatypes that this body expects in the correct order This method needs to be implemented by concrete subclasses |
void |
write(java.io.ByteArrayOutputStream tagBuffer)
Write the contents of this datatype to the byte array |
Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody |
---|
createStructure, equals, getSize, read, setSize, setSize |
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody |
---|
getBriefDescription, getHeader, getLongDescription, getObject, getObjectValue, getTextEncoding, isSubsetOf, iterator, setHeader, setObjectValue, setTextEncoding, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FrameBodyUSLT()
public FrameBodyUSLT(FrameBodyUSLT body)
body
- public FrameBodyUSLT(byte textEncoding, java.lang.String language, java.lang.String description, java.lang.String text)
textEncoding
- language
- description
- text
- public FrameBodyUSLT(java.nio.ByteBuffer byteBuffer, int frameSize) throws InvalidTagException
byteBuffer
- frameSize
-
InvalidTagException
InvalidTagException
Method Detail |
---|
public void setDescription(java.lang.String description)
description
- public java.lang.String getDescription()
public java.lang.String getIdentifier()
getIdentifier
in class AbstractID3v2FrameBody
public void setLanguage(java.lang.String language)
language
- public java.lang.String getLanguage()
public void setLyric(java.lang.String lyric)
lyric
- public java.lang.String getLyric()
public java.lang.String getFirstTextValue()
public void addLyric(java.lang.String text)
text
- public void addLyric(Lyrics3Line line)
line
- public void write(java.io.ByteArrayOutputStream tagBuffer)
AbstractID3v2FrameBody
write
in class AbstractID3v2FrameBody
protected void setupObjectList()
AbstractTagFrameBody
setupObjectList
in class AbstractTagFrameBody
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |