File	Doc	Category	Size	Date	Package
FrameBodyUSLT.java	API Doc	Jaudiotagger 2.0.4	7650	Wed Mar 30 16:12:02 BST 2011	org.jaudiotagger.tag.id3.framebody

FrameBodyUSLT

• java.lang.Object
  • AbstractID3v2FrameBody

Fields Summary

Constructors Summary
public FrameBodyUSLT() Creates a new FrameBodyUSLT dataType. setObjectValue(DataTypes.OBJ_TEXT_ENCODING, TextEncoding.ISO_8859_1); setObjectValue(DataTypes.OBJ_LANGUAGE, ""); setObjectValue(DataTypes.OBJ_DESCRIPTION, ""); setObjectValue(DataTypes.OBJ_LYRICS, "");
public FrameBodyUSLT(FrameBodyUSLT body) Copy constructor param body super(body);
public FrameBodyUSLT(byte textEncoding, String language, String description, String text) Creates a new FrameBodyUSLT datatype. param textEncoding param language param description param text setObjectValue(DataTypes.OBJ_TEXT_ENCODING, textEncoding); setObjectValue(DataTypes.OBJ_LANGUAGE, language); setObjectValue(DataTypes.OBJ_DESCRIPTION, description); setObjectValue(DataTypes.OBJ_LYRICS, text);
public FrameBodyUSLT(ByteBuffer byteBuffer, int frameSize) Creates a new FrameBodyUSLT datatype, populated from buffer param byteBuffer param frameSize throws InvalidTagException throws InvalidTagException super(byteBuffer, frameSize);

Methods Summary
public void	addLyric(java.lang.String text) Add additional lyric to the lyric field param text setLyric(getLyric() + text);
public void	addLyric(Lyrics3Line line) param line setLyric(getLyric() + line.writeString());
public java.lang.String	getDescription() Get a description field return description return (String) getObjectValue(DataTypes.OBJ_DESCRIPTION);
public java.lang.String	getFirstTextValue() Get first value return value at index 0 TextEncodedStringSizeTerminated text = (TextEncodedStringSizeTerminated) getObject(DataTypes.OBJ_LYRICS); return text.getValueAtIndex(0);
public java.lang.String	getIdentifier() The ID3v2 frame identifier return the ID3v2 frame identifier for this frame type return ID3v24Frames.FRAME_ID_UNSYNC_LYRICS;
public java.lang.String	getLanguage() Get the language field return language return (String) getObjectValue(DataTypes.OBJ_LANGUAGE);
public java.lang.String	getLyric() Get the lyric field return lyrics return (String) getObjectValue(DataTypes.OBJ_LYRICS);
public java.lang.String	getUserFriendlyValue() return getFirstTextValue();
public void	setDescription(java.lang.String description) Set a description field param description setObjectValue(DataTypes.OBJ_DESCRIPTION, description);
public void	setLanguage(java.lang.String language) Set the language field param language setObjectValue(DataTypes.OBJ_LANGUAGE, language);
public void	setLyric(java.lang.String lyric) Set the lyric field param lyric setObjectValue(DataTypes.OBJ_LYRICS, lyric);
protected void	setupObjectList() objectList.add(new NumberHashMap(DataTypes.OBJ_TEXT_ENCODING, this, TextEncoding.TEXT_ENCODING_FIELD_SIZE)); objectList.add(new StringHashMap(DataTypes.OBJ_LANGUAGE, this, Languages.LANGUAGE_FIELD_SIZE)); objectList.add(new TextEncodedStringNullTerminated(DataTypes.OBJ_DESCRIPTION, this)); objectList.add(new TextEncodedStringSizeTerminated(DataTypes.OBJ_LYRICS, this));
public void	write(java.io.ByteArrayOutputStream tagBuffer) //Ensure valid for type this.setTextEncoding(ID3TextEncodingConversion.getTextEncoding(getHeader(), getTextEncoding())); //Ensure valid for data if (!((AbstractString) getObject(DataTypes.OBJ_DESCRIPTION)).canBeEncoded()) { this.setTextEncoding(ID3TextEncodingConversion.getUnicodeTextEncoding(getHeader())); } if (!((AbstractString) getObject(DataTypes.OBJ_LYRICS)).canBeEncoded()) { this.setTextEncoding(ID3TextEncodingConversion.getUnicodeTextEncoding(getHeader())); } super.write(tagBuffer);