|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.blinkenlights.jid3.v2.ID3V2Frame
org.blinkenlights.jid3.v2.APICID3V2Frame
Nested Class Summary | |
static class |
APICID3V2Frame.PictureType
|
Constructor Summary | |
APICID3V2Frame(java.io.InputStream oIS)
|
|
APICID3V2Frame(java.lang.String sMimeType,
APICID3V2Frame.PictureType oPictureType,
java.lang.String sDescription,
byte[] abyPictureData)
Constructor. |
Method Summary | |
void |
accept(ID3Visitor oID3Visitor)
Accept a visitor. |
boolean |
equals(java.lang.Object oOther)
|
java.lang.String |
getDescription()
Get the description for the picture in this frame. |
protected byte[] |
getFrameId()
Get the four bytes which uniquely specify of which type this frame is. |
java.lang.String |
getMimeType()
Get the MIME type of the image contained in this frame. |
byte[] |
getPictureData()
Get the picture data for the image in this frame. |
APICID3V2Frame.PictureType |
getPictureType()
Get the classification of the picture in this frame. |
TextEncoding |
getTextEncoding()
Get the text encoding used for the description in this frame. |
void |
setDescription(java.lang.String sDescription)
Set the description for the picture in this frame. |
void |
setMimeType(java.lang.String sMimeType)
Set the MIME type for the image contained in this frame. |
void |
setPictureData(byte[] abyPictureData)
Set the picture data for the image in this frame. |
void |
setPictureType(APICID3V2Frame.PictureType oPictureType)
Set the classification of the picture in this frame. |
void |
setTextEncoding(TextEncoding oTextEncoding)
Set the text encoding to be used for the description in this frame. |
java.lang.String |
toString()
Represent the contents of this frame as a string. |
protected void |
writeBody(ID3DataOutputStream oIDOS)
Write the body of the frame to an ID3 data output stream. |
Methods inherited from class org.blinkenlights.jid3.v2.ID3V2Frame |
addID3Observer, getEncryptionMethod, isEncrypted, notifyID3Observers, removeID3Observer, setCompressionFlag, setEncryption, setFileAlterPreservationFlag, setGroupingIdentityFlag, setReadOnlyFlag, setTagAlterPreservationFlag, write, writeHeader |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public APICID3V2Frame(java.lang.String sMimeType, APICID3V2Frame.PictureType oPictureType, java.lang.String sDescription, byte[] abyPictureData) throws ID3Exception
sMimeType
- the valid MIME type (ie. image/png) describing the format of the contained image (the default
if null is specified is "image/")oPictureType
- the classification of the picture attachedsDescription
- an optional description of the image, or null if no description requiredabyPictureData
- the data content of the image
ID3Exception
- if the description is longer than 64 characters
ID3Exception
- if the picture data is null, or zero lengthpublic APICID3V2Frame(java.io.InputStream oIS) throws ID3Exception
Method Detail |
public void accept(ID3Visitor oID3Visitor)
ID3Visitable
oID3Visitor
- a visitor of this objectpublic void setMimeType(java.lang.String sMimeType)
sMimeType
- the valid MIME type (ie. image/png) describing the format of the contained image (the default
if null is specified is "image/")public java.lang.String getMimeType()
public void setPictureType(APICID3V2Frame.PictureType oPictureType)
oPictureType
- the type of the picture in this frame.public APICID3V2Frame.PictureType getPictureType()
public void setDescription(java.lang.String sDescription) throws ID3Exception
sDescription
- an optional description of the image, or null if no description required
ID3Exception
- if the description is longer than 64 characters
ID3Exception
- if this frame is in a tag with another APIC frame which would have the same descriptionpublic java.lang.String getDescription()
public void setPictureData(byte[] abyPictureData) throws ID3Exception
abyPictureData
- the data content of the image
ID3Exception
- if the picture data is null, or zero lengthpublic byte[] getPictureData()
public void setTextEncoding(TextEncoding oTextEncoding)
oTextEncoding
- the text encoding to be used for this framepublic TextEncoding getTextEncoding()
protected byte[] getFrameId()
ID3V2Frame
getFrameId
in class ID3V2Frame
public java.lang.String toString()
ID3V2Frame
toString
in class ID3V2Frame
protected void writeBody(ID3DataOutputStream oIDOS) throws java.io.IOException
ID3V2Frame
writeBody
in class ID3V2Frame
oIDOS
- the output stream to write to
java.io.IOException
public boolean equals(java.lang.Object oOther)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |