public class ID3v24FrameBodyUserDefinedTextInformation extends ID3v24FrameBody
A user defined text information frame body is associated with an ID3v2.4 TXXX
frame
which is used to include one-string text
information concerning the audio file in a similar way to the other text information
frames. The user defined text information frame body
contains the following fields:
Field | Description | |
---|---|---|
1. | encoding | character set used to encode the description and text fields. |
2. | description | description of the text field. |
3. | text | the actual text. |
There may be more than one user defined text information frame in an ID3v2.4 tag
, but only one with the same description field.
buffer, dirty, frameType
nextNullTerminatorIndex, nullTerminatorIndex
Constructor and Description |
---|
ID3v24FrameBodyUserDefinedTextInformation()
The default constructor is called when creating a new frame.
|
ID3v24FrameBodyUserDefinedTextInformation(Encoding encoding,
java.lang.String description,
java.lang.String text)
This constructor is called when creating a new frame.
|
ID3v24FrameBodyUserDefinedTextInformation(java.io.InputStream inputStream,
int frameBodySize)
This constructor is called when reading in an existing frame from an .mp3 file.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription()
gets the description of the text.
|
Encoding |
getEncoding()
gets the character encoding of the description and the text..
|
java.lang.String |
getText()
gets the text.
|
void |
parse()
parses the raw bytes of the frame body and stores the parsed values in the frame's fields.
|
void |
setBuffer()
If the frame body's values have been modified, then resize the raw binary buffer and store the new values there.
|
void |
setDescription(java.lang.String description)
sets the description of the text.
|
void |
setEncoding(Encoding encoding)
sets the character encoding of the description and the text..
|
void |
setText(java.lang.String text)
sets the text.
|
java.lang.String |
toString()
gets a string representation of the user defined text information frame body showing all of the frame's fields and their values.
|
getFrameType, getNextNullTerminator, getSize, isDirty, save, save
getNextNullTerminator, pricesToString, stringToBytes
bytesToInt, bytesToInt, bytesToShort, bytesToShort, bytesToSynchsafeInt, bytesToSynchsafeShort, formateDate, hex, hex, hex, intToBytes, littleEndianBytesToInt, pad, shortToBytes, synchsafeIntToBytes
public ID3v24FrameBodyUserDefinedTextInformation()
public ID3v24FrameBodyUserDefinedTextInformation(Encoding encoding, java.lang.String description, java.lang.String text)
encoding
- character set used to encode the description.description
- description of the text.text
- text;public ID3v24FrameBodyUserDefinedTextInformation(java.io.InputStream inputStream, int frameBodySize) throws java.io.IOException
inputStream
- input stream pointing to a user defined text information frame body in the .mp3 file.frameBodySize
- size (in bytes) of the frame body.java.io.IOException
- if there is an error while reading the frame body.public void parse() throws java.lang.IllegalArgumentException
parse
in class ID3v24FrameBody
java.lang.IllegalArgumentException
- if an invalid value is detected while parsing the frame body's raw bytes.public Encoding getEncoding()
setEncoding(Encoding)
public void setEncoding(Encoding encoding)
encoding
- the character set used to encode the description and the text. Only those supported by the Encoding
enum are allowed.getEncoding()
public java.lang.String getDescription()
setDescription(String)
public void setDescription(java.lang.String description)
description
- the description of the text.getDescription()
public java.lang.String getText()
setText(String)
public void setText(java.lang.String text)
text
- the text.getText()
public void setBuffer()
setBuffer
in class ID3v24FrameBody
public java.lang.String toString()
toString
in class java.lang.Object