public class ID3v24FrameBodyUserDefinedURLLink extends ID3v24FrameBody
![]() |
![]() |
A user defined url link frame body is associated with an ID3v2.4 WXXX
frame
which is used to include URL links concerning the
audio file in a similar way to the other url link
frames. The user defined url link frame body contains the following fields:
Field | Description | |
---|---|---|
1. | encoding | character set used to encode the description field. |
2. | description | description of the url. |
3. | url | URL of a website. |
There may be more than one user defined url link frame in an ID3v2.4 tag
, but only one with the same description field.
buffer, dirty, frameType
nextNullTerminatorIndex, nullTerminatorIndex
Constructor and Description |
---|
ID3v24FrameBodyUserDefinedURLLink()
The default constructor is called when creating a new frame.
|
ID3v24FrameBodyUserDefinedURLLink(Encoding encoding,
java.lang.String description,
java.lang.String url)
This constructor is called when creating a new frame.
|
ID3v24FrameBodyUserDefinedURLLink(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 url.
|
Encoding |
getEncoding()
gets the character encoding of the description.
|
java.lang.String |
getURL()
gets the URL.
|
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 url.
|
void |
setEncoding(Encoding encoding)
sets the character encoding of the description.
|
void |
setURL(java.lang.String url)
sets the URL.
|
java.lang.String |
toString()
gets a string representation of the user defined url link 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, getUTF16String, getUTF8String, hex, hex, hex, intToBytes, littleEndianBytesToInt, pad, shortToBytes, synchsafeIntToBytes
public ID3v24FrameBodyUserDefinedURLLink()
public ID3v24FrameBodyUserDefinedURLLink(Encoding encoding, java.lang.String description, java.lang.String url)
encoding
- character set used to encode the description.description
- description of the url.url
- url.public ID3v24FrameBodyUserDefinedURLLink(java.io.InputStream inputStream, int frameBodySize) throws java.io.IOException
inputStream
- input stream pointing to a user defined url link 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 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. Only ISO 8859-1 and UTF-16 are allowed.getEncoding()
public java.lang.String getDescription()
setDescription(String)
public void setDescription(java.lang.String description)
description
- the description of the url.getDescription()
public java.lang.String getURL()
setURL(String)
public void setURL(java.lang.String url)
url
- the url.getURL()
public void setBuffer()
setBuffer
in class ID3v24FrameBody
public java.lang.String toString()
toString
in class java.lang.Object