public class ID3v23FrameBodyTermsOfUse extends ID3v23FrameBody
A terms of use frame body is associated with an ID3v2.3 USER
frame
which is used to include a brief description of the
terms of use and/or ownership of the .mp3 file. More detailed information concerning the legal terms might be available through the
Copyright/Legal information
frame. The terms of use frame body contains the following fields:
Field | Description | |
---|---|---|
1. | encoding | character set used to encode the text field. |
2. | language | language that the text field is written in. |
3. | text | the actual terms of use or ownership of the .mp3 file. |
There may only be one terms of use frame in an ID3v2.3 tag
.
buffer, dirty, frameType
nextNullTerminatorIndex, nullTerminatorIndex
Constructor and Description |
---|
ID3v23FrameBodyTermsOfUse()
The default constructor is called when creating a new frame.
|
ID3v23FrameBodyTermsOfUse(Encoding encoding,
Language language,
java.lang.String text)
This constructor is called when creating a new frame.
|
ID3v23FrameBodyTermsOfUse(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 |
---|---|
Encoding |
getEncoding()
gets the character encoding of the text.
|
Language |
getLanguage()
gets the
language the terms of user are written in. |
java.lang.String |
getText()
gets the terms of use or ownership of the .mp3 file.
|
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 |
setEncoding(Encoding encoding)
sets the character encoding of the text.
|
void |
setLanguage(Language language)
sets the
language the terms of user are written in. |
void |
setText(java.lang.String text)
sets the terms of use or ownership of the .mp3 file.
|
java.lang.String |
toString()
gets a string representation of the terms of use 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 ID3v23FrameBodyTermsOfUse()
public ID3v23FrameBodyTermsOfUse(Encoding encoding, Language language, java.lang.String text)
encoding
- character set used to encode the terms of use.language
- ISO-639-2 language code.text
- text.public ID3v23FrameBodyTermsOfUse(java.io.InputStream inputStream, int frameBodySize) throws java.io.IOException
inputStream
- input stream pointing to a terms of use frame body in the .mp3 file.frameBodySize
- size (in bytes) of the frame's body.java.io.IOException
- if there is an error while reading the frame body.public void parse() throws java.lang.IllegalArgumentException
parse
in class ID3v23FrameBody
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 text. Only those supported by the Encoding
enum are allowed.getEncoding()
public Language getLanguage()
language
the terms of user are written in.language
the terms of user are written in.setLanguage(Language)
public void setLanguage(Language language)
language
the terms of user are written in.language
- language
the terms of user are written in.getLanguage()
public java.lang.String getText()
setText(String)
public void setText(java.lang.String text)
text
- the terms of use or ownership of the .mp3 file.getText()
public void setBuffer()
setBuffer
in class ID3v23FrameBody
public java.lang.String toString()
toString
in class java.lang.Object