public class ID3v23FrameBodyInvolvedPeopleList extends ID3v23FrameBody
An involved people list frame body is associated with an ID3v2.3 IPLS
frame
which is used to list the people who were involved
in the song. The involved people list frame body contains the following fields:
Field | Description | |
---|---|---|
1. | encoding | character set used to encode the involved people field. |
2. | involvedPeople | List of people involved in making the .mp3 song. |
There may only be one involved people list frame in an ID3v2.3 tag
.
Modifier and Type | Class and Description |
---|---|
static class |
ID3v23FrameBodyInvolvedPeopleList.InvolvedPerson
contains the involvement (what the person did) and the person's name.
|
buffer, dirty, frameType
nextNullTerminatorIndex, nullTerminatorIndex
Constructor and Description |
---|
ID3v23FrameBodyInvolvedPeopleList()
The default constructor is called when creating a new frame.
|
ID3v23FrameBodyInvolvedPeopleList(Encoding encoding,
java.util.List<ID3v23FrameBodyInvolvedPeopleList.InvolvedPerson> involvedPeople)
This constructor is called when creating a new frame.
|
ID3v23FrameBodyInvolvedPeopleList(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 involved people.
|
java.util.List<ID3v23FrameBodyInvolvedPeopleList.InvolvedPerson> |
getInvolvedPeople()
gets the list of people involved with the song.
|
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 involved people.
|
void |
setInvolvedPeople(java.util.List<ID3v23FrameBodyInvolvedPeopleList.InvolvedPerson> involvedPeople)
sets the list of involved people and their role.
|
java.lang.String |
toString()
gets a string representation of the involved people list 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 ID3v23FrameBodyInvolvedPeopleList()
public ID3v23FrameBodyInvolvedPeopleList(Encoding encoding, java.util.List<ID3v23FrameBodyInvolvedPeopleList.InvolvedPerson> involvedPeople)
encoding
- character set used to encode the entries of a person and their involvement.involvedPeople
- list of involved people and their roles.public ID3v23FrameBodyInvolvedPeopleList(java.io.InputStream inputStream, int frameBodySize) throws java.io.IOException
inputStream
- input stream pointing to an involved people list 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 involved people. Only ISO 8859-1 and UTF-16 are allowed.getEncoding()
public java.util.List<ID3v23FrameBodyInvolvedPeopleList.InvolvedPerson> getInvolvedPeople()
setInvolvedPeople(List)
public void setInvolvedPeople(java.util.List<ID3v23FrameBodyInvolvedPeopleList.InvolvedPerson> involvedPeople)
involvedPeople
- the involved people.getInvolvedPeople()
public void setBuffer()
setBuffer
in class ID3v23FrameBody
public java.lang.String toString()
toString
in class java.lang.Object