|
|||||||||
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.AbstractTagFrame
org.jaudiotagger.tag.id3.AbstractID3v2Frame
org.jaudiotagger.tag.id3.ID3v24Frame
public class ID3v24Frame
Represents an ID3v2.4 frame.
Nested Class Summary | |
---|---|
(package private) class |
ID3v24Frame.EncodingFlags
This represents a frame headers Encoding Flags |
(package private) class |
ID3v24Frame.StatusFlags
Member Class This represents a frame headers Status Flags Make adjustments if necessary based on frame type and specification. |
Field Summary | |
---|---|
private int |
encryptionMethod
If the frame is encrypted then the encryption method is stored in this byte |
protected static int |
FRAME_DATA_LENGTH_SIZE
|
protected static int |
FRAME_ENCRYPTION_INDICATOR_SIZE
|
protected static int |
FRAME_FLAGS_SIZE
|
protected static int |
FRAME_GROUPING_INDICATOR_SIZE
|
protected static int |
FRAME_HEADER_SIZE
|
protected static int |
FRAME_ID_SIZE
|
protected static int |
FRAME_SIZE_SIZE
|
private int |
groupIdentifier
If the frame belongs in a group with other frames then the group identifier byte is stored |
private static java.util.regex.Pattern |
validFrameIdentifier
|
Fields inherited from class org.jaudiotagger.tag.id3.AbstractID3v2Frame |
---|
encodingFlags, frameSize, identifier, statusFlags, TYPE_FRAME, TYPE_FRAME_SIZE, UNSUPPORTED_ID |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagFrame |
---|
frameBody |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem |
---|
logger |
Constructor Summary | |
---|---|
ID3v24Frame()
|
|
ID3v24Frame(AbstractID3v2Frame frame)
Creates a new ID3v2_4Frame datatype based on another frame of different version Converts the framebody to the equivalent v24 framebody or to UnsupportedFrameBody if identifier is unknown. |
|
ID3v24Frame(java.nio.ByteBuffer byteBuffer)
Deprecated. use ID3v24Frame(ByteBuffer,String) instead |
|
ID3v24Frame(java.nio.ByteBuffer byteBuffer,
java.lang.String loggingFilename)
Creates a new ID3v24Frame datatype by reading from byteBuffer. |
|
ID3v24Frame(ID3v24Frame frame)
Copy Constructor:Creates a new ID3v2_4Frame datatype based on another frame. |
|
ID3v24Frame(Lyrics3v2Field field)
Creates a new ID3v2_4Frame datatype based on Lyrics3. |
|
ID3v24Frame(java.lang.String identifier)
Creates a new ID3v2_4Frame of type identifier. |
Method Summary | |
---|---|
private void |
checkIfFrameSizeThatIsNotSyncSafe(java.nio.ByteBuffer byteBuffer)
If frame is greater than certain size it will be decoded differently if unsynchronized to if synchronized Frames with certain byte sequences should be unsynchronized but sometimes editors do not unsynchronize them so this method checks both cases and goes with the option that fits best with the data |
void |
createStructure()
Return String Representation of body |
private void |
createV24FrameFromV23Frame(ID3v23Frame frame)
|
boolean |
equals(java.lang.Object obj)
Returns true if this datatype and its body equals the argument and its body. |
AbstractID3v2Frame.EncodingFlags |
getEncodingFlags()
Get Encoding Flags Object |
int |
getEncryptionMethod()
|
protected int |
getFrameFlagsSize()
|
protected int |
getFrameHeaderSize()
|
protected int |
getFrameIdSize()
|
private void |
getFrameSize(java.nio.ByteBuffer byteBuffer)
Read the frame size form the header, check okay , if not try to fix or just throw exception |
protected int |
getFrameSizeSize()
|
int |
getGroupIdentifier()
|
int |
getSize()
Return size of frame |
AbstractID3v2Frame.StatusFlags |
getStatusFlags()
Get Status Flags Object |
boolean |
isBinary()
Determines whether the represented field contains (is made up of) binary data, instead of text data. Software can identify fields to be displayed because they are human readable if this method returns false . |
boolean |
isCommon()
Identifies a field to be of common use. Some software may differ between common and not common fields. |
boolean |
isValidID3v2FrameIdentifier(java.lang.String identifier)
Does the frame identifier meet the syntax for a idv3v2 frame identifier. |
void |
read(java.nio.ByteBuffer byteBuffer)
Read the frame from the specified file. |
void |
setEncoding(java.lang.String encoding)
Sets the charset encoding used by the field. |
void |
write(java.io.ByteArrayOutputStream tagBuffer)
Write the frame. |
Methods inherited from class org.jaudiotagger.tag.id3.AbstractID3v2Frame |
---|
copyContent, getContent, getEncoding, getId, getIdentifier, getLoggingFilename, getRawContent, isBinary, isEmpty, isPadding, readBody, readBody, readEncryptedBody, readIdentifier, setContent, setLoggingFilename |
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrame |
---|
getBody, isSubsetOf, setBody |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jaudiotagger.tag.TagField |
---|
toString |
Field Detail |
---|
private static java.util.regex.Pattern validFrameIdentifier
protected static final int FRAME_DATA_LENGTH_SIZE
protected static final int FRAME_ID_SIZE
protected static final int FRAME_FLAGS_SIZE
protected static final int FRAME_SIZE_SIZE
protected static final int FRAME_ENCRYPTION_INDICATOR_SIZE
protected static final int FRAME_GROUPING_INDICATOR_SIZE
protected static final int FRAME_HEADER_SIZE
private int encryptionMethod
private int groupIdentifier
Constructor Detail |
---|
public ID3v24Frame()
public ID3v24Frame(java.lang.String identifier)
identifier
- defines the type of body to be createdpublic ID3v24Frame(ID3v24Frame frame)
frame
- public ID3v24Frame(AbstractID3v2Frame frame) throws InvalidFrameException
frame
- to construct a new frame from
InvalidFrameException
public ID3v24Frame(Lyrics3v2Field field) throws InvalidTagException
field
-
InvalidTagException
public ID3v24Frame(java.nio.ByteBuffer byteBuffer, java.lang.String loggingFilename) throws InvalidFrameException, InvalidDataTypeException
byteBuffer
- to read fromloggingFilename
-
InvalidFrameException
InvalidDataTypeException
public ID3v24Frame(java.nio.ByteBuffer byteBuffer) throws InvalidFrameException, InvalidDataTypeException
ID3v24Frame(ByteBuffer,String)
instead
byteBuffer
- to read from
InvalidFrameException
InvalidDataTypeException
Method Detail |
---|
protected int getFrameIdSize()
getFrameIdSize
in class AbstractID3v2Frame
protected int getFrameSizeSize()
getFrameSizeSize
in class AbstractID3v2Frame
protected int getFrameFlagsSize()
protected int getFrameHeaderSize()
getFrameHeaderSize
in class AbstractID3v2Frame
private void createV24FrameFromV23Frame(ID3v23Frame frame) throws InvalidFrameException
InvalidFrameException
public boolean equals(java.lang.Object obj)
AbstractTagFrame
getSubId
id string.
equals
in class AbstractID3v2Frame
obj
-
public int getSize()
getSize
in class AbstractTagItem
private void checkIfFrameSizeThatIsNotSyncSafe(java.nio.ByteBuffer byteBuffer) throws InvalidFrameException
byteBuffer
-
InvalidFrameException
private void getFrameSize(java.nio.ByteBuffer byteBuffer) throws InvalidFrameException
byteBuffer
-
InvalidFrameException
public void read(java.nio.ByteBuffer byteBuffer) throws InvalidFrameException, InvalidDataTypeException
read
in class AbstractTagItem
byteBuffer
- to read the frame from
InvalidFrameException
InvalidDataTypeException
public void write(java.io.ByteArrayOutputStream tagBuffer)
write
in class AbstractID3v2Frame
java.io.IOException
public AbstractID3v2Frame.StatusFlags getStatusFlags()
getStatusFlags
in class AbstractID3v2Frame
public AbstractID3v2Frame.EncodingFlags getEncodingFlags()
getEncodingFlags
in class AbstractID3v2Frame
public int getEncryptionMethod()
public int getGroupIdentifier()
public boolean isValidID3v2FrameIdentifier(java.lang.String identifier)
identifier
- to be checked
public void createStructure()
createStructure
in class AbstractID3v2Frame
public boolean isCommon()
TagField
public boolean isBinary()
TagField
false
.
public void setEncoding(java.lang.String encoding)
encoding
- charset.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |