|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jaudiotagger.tag.id3.AbstractTagItem
org.jaudiotagger.tag.id3.AbstractTagFrameBody
org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
org.jaudiotagger.tag.id3.framebody.FrameBodyIPLS
public class FrameBodyIPLS
Involved People List ID3v22/v23 Only
Since there might be a lot of people contributing to an audio file in various ways, such as musicians and technicians, the 'Text information frames' are often insufficient to list everyone involved in a project. The 'Involved people list' is a frame containing the names of those involved, and how they were involved. The body simply contains a terminated string with the involvement directly followed by a terminated string with the involvee followed by a new involvement and so on. There may only be one "IPLS" frame in each tag.For more details, please refer to the ID3 specifications:
Field Summary |
---|
Fields inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody |
---|
TYPE_BODY |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody |
---|
objectList |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem |
---|
logger |
Constructor Summary | |
---|---|
FrameBodyIPLS()
Creates a new FrameBodyIPLS datatype. |
|
FrameBodyIPLS(java.nio.ByteBuffer byteBuffer,
int frameSize)
|
|
FrameBodyIPLS(byte textEncoding,
java.lang.String text)
Creates a new FrameBodyIPLS data type. |
|
FrameBodyIPLS(FrameBodyIPLS body)
|
|
FrameBodyIPLS(FrameBodyTIPL body)
Convert from V4 to V3 Frame |
Method Summary | |
---|---|
void |
addPair(java.lang.String text)
|
java.lang.String |
getIdentifier()
The ID3v23 frame identifier |
java.lang.String |
getKeyAtIndex(int index)
Get key at index |
int |
getNumberOfPairs()
|
PairedTextEncodedStringNullTerminated.ValuePairs |
getPairing()
|
java.lang.String |
getText()
|
java.lang.String |
getUserFriendlyValue()
|
java.lang.String |
getValueAtIndex(int index)
Get value at index |
void |
setText(java.lang.String text)
Set the text, decoded as pairs of involvee - involvement |
protected void |
setupObjectList()
Consists of a text encoding , and then a series of null terminated Strings, there should be an even number of Strings as they are paired as involvement/involvee |
void |
write(java.io.ByteArrayOutputStream tagBuffer)
Because have a text encoding we need to check the data values do not contain characters that cannot be encoded in current encoding before we write data. |
Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody |
---|
createStructure, equals, getSize, read, setSize, setSize |
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody |
---|
getBriefDescription, getHeader, getLongDescription, getObject, getObjectValue, getTextEncoding, isSubsetOf, iterator, setHeader, setObjectValue, setTextEncoding, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FrameBodyIPLS()
public FrameBodyIPLS(java.nio.ByteBuffer byteBuffer, int frameSize) throws InvalidTagException
InvalidTagException
public FrameBodyIPLS(FrameBodyIPLS body)
public FrameBodyIPLS(byte textEncoding, java.lang.String text)
textEncoding
- text
- public FrameBodyIPLS(FrameBodyTIPL body)
body
- Method Detail |
---|
public java.lang.String getIdentifier()
getIdentifier
in class AbstractID3v2FrameBody
public void setText(java.lang.String text)
text
- public void addPair(java.lang.String text)
public void write(java.io.ByteArrayOutputStream tagBuffer)
write
in class AbstractID3v2FrameBody
protected void setupObjectList()
setupObjectList
in class AbstractTagFrameBody
public PairedTextEncodedStringNullTerminated.ValuePairs getPairing()
public java.lang.String getKeyAtIndex(int index)
index
-
public java.lang.String getValueAtIndex(int index)
index
-
public int getNumberOfPairs()
public java.lang.String getText()
public java.lang.String getUserFriendlyValue()
getUserFriendlyValue
in class AbstractTagFrameBody
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |