📄 id3v2frame.html
字号:
<DD>Create an ID3v2Frame with a specified id, a byte array containing the frame header flags, and a byte array containing the data for this frame.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - the id of this frame<DD><CODE>flags</CODE> - the flags found in the header of the frame (2 bytes)<DD><CODE>data</CODE> - the data found in this frame<DT><B>Throws:</B><DD><CODE><A HREF="../../helliker/id3/ID3v2FormatException.html">ID3v2FormatException</A></CODE> - if an error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="ID3v2Frame(java.lang.String, byte[])"><!-- --></A><H3>
ID3v2Frame</H3>
<PRE>
public <B>ID3v2Frame</B>(java.lang.String id, byte[] data)</PRE>
<DL>
<DD>Create and ID3v2 frame with the specified id and data. All the flag bits are set to false.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - the id of this frame<DD><CODE>data</CODE> - the data for this frame</DL>
</DD>
</DL>
<HR>
<A NAME="ID3v2Frame(java.lang.String, byte[], boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)"><!-- --></A><H3>
ID3v2Frame</H3>
<PRE>
public <B>ID3v2Frame</B>(java.lang.String id, byte[] data, boolean tagAlterDiscard, boolean fileAlterDiscard, boolean readOnly, boolean grouped, boolean compressed, boolean encrypted, boolean unsynchronised, boolean lengthIndicator)</PRE>
<DL>
<DD>Create an ID3v2Frame with the specified id, data, and flags set. It is expected that the corresponing data for the flags that require extra data is found in the data array in the standard place.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - the id for this frame<DD><CODE>data</CODE> - the data for this frame<DD><CODE>tagAlterDiscard</CODE> - the tag alter preservation flag<DD><CODE>fileAlterDiscard</CODE> - the file alter preservation flag<DD><CODE>readOnly</CODE> - the read only flag<DD><CODE>grouped</CODE> - the grouping identity flag<DD><CODE>compressed</CODE> - the compression flag<DD><CODE>encrypted</CODE> - the encryption flag<DD><CODE>unsynchronised</CODE> - the unsynchronisation flag<DD><CODE>lengthIndicator</CODE> - the data length indicator flag</DL>
</DD>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getFrameData()"><!-- --></A><H3>
getFrameData</H3>
<PRE>
public byte[] <B>getFrameData</B>()</PRE>
<DL>
<DD>Returns the data for this frame<DD><DL>
<DT><B>Returns:</B><DD>the data for this frame</DL>
</DD>
</DL>
<HR>
<A NAME="setFrameData(byte[])"><!-- --></A><H3>
setFrameData</H3>
<PRE>
public void <B>setFrameData</B>(byte[] newData)</PRE>
<DL>
<DD>Set the data for this frame. This does nothing if this frame is read only.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newData</CODE> - a byte array contianing the new data</DL>
</DD>
</DL>
<HR>
<A NAME="getFrameLength()"><!-- --></A><H3>
getFrameLength</H3>
<PRE>
public int <B>getFrameLength</B>()</PRE>
<DL>
<DD>Return the length of this frame in bytes, including the header.<DD><DL>
<DT><B>Returns:</B><DD>the length of this frame</DL>
</DD>
</DL>
<HR>
<A NAME="getFrameBytes()"><!-- --></A><H3>
getFrameBytes</H3>
<PRE>
public byte[] <B>getFrameBytes</B>()</PRE>
<DL>
<DD>Returns a byte array representation of this frame that can be written to a file. Includes the header and data.<DD><DL>
<DT><B>Returns:</B><DD>a binary representation of this frame to be written to a file</DL>
</DD>
</DL>
<HR>
<A NAME="getTagAlterDiscard()"><!-- --></A><H3>
getTagAlterDiscard</H3>
<PRE>
public boolean <B>getTagAlterDiscard</B>()</PRE>
<DL>
<DD>Returns true if the tag alter preservation bit has been set. If set then the frame should be discarded if it is altered and the id is unknown.<DD><DL>
<DT><B>Returns:</B><DD>true if the tag alter preservation bit has been set</DL>
</DD>
</DL>
<HR>
<A NAME="getFileAlterDiscard()"><!-- --></A><H3>
getFileAlterDiscard</H3>
<PRE>
public boolean <B>getFileAlterDiscard</B>()</PRE>
<DL>
<DD>Returns true if the file alter preservation bit has been set. If set then the frame should be discarded if the file is altered and the id is unknown.<DD><DL>
<DT><B>Returns:</B><DD>true if the file alter preservation bit has been set</DL>
</DD>
</DL>
<HR>
<A NAME="getReadOnly()"><!-- --></A><H3>
getReadOnly</H3>
<PRE>
public boolean <B>getReadOnly</B>()</PRE>
<DL>
<DD>Returns true if this frame is read only<DD><DL>
<DT><B>Returns:</B><DD>true if this frame is read only</DL>
</DD>
</DL>
<HR>
<A NAME="getGrouped()"><!-- --></A><H3>
getGrouped</H3>
<PRE>
public boolean <B>getGrouped</B>()</PRE>
<DL>
<DD>Returns true if this frame is a part of a group<DD><DL>
<DT><B>Returns:</B><DD>true if this frame is a part of a group</DL>
</DD>
</DL>
<HR>
<A NAME="getCompressed()"><!-- --></A><H3>
getCompressed</H3>
<PRE>
public boolean <B>getCompressed</B>()</PRE>
<DL>
<DD>Returns true if this frame is compressed<DD><DL>
<DT><B>Returns:</B><DD>true if this frame is compressed</DL>
</DD>
</DL>
<HR>
<A NAME="getEncrypted()"><!-- --></A><H3>
getEncrypted</H3>
<PRE>
public boolean <B>getEncrypted</B>()</PRE>
<DL>
<DD>Returns true if this frame is encrypted<DD><DL>
<DT><B>Returns:</B><DD>true if this frame is encrypted</DL>
</DD>
</DL>
<HR>
<A NAME="getUnsynchronised()"><!-- --></A><H3>
getUnsynchronised</H3>
<PRE>
public boolean <B>getUnsynchronised</B>()</PRE>
<DL>
<DD>Returns true if this frame is unsynchronised<DD><DL>
<DT><B>Returns:</B><DD>true if this frame is unsynchronised</DL>
</DD>
</DL>
<HR>
<A NAME="getLengthIndicator()"><!-- --></A><H3>
getLengthIndicator</H3>
<PRE>
public boolean <B>getLengthIndicator</B>()</PRE>
<DL>
<DD>Returns true if this frame has a length indicator added<DD><DL>
<DT><B>Returns:</B><DD>true if this frame has a length indicator added</DL>
</DD>
</DL>
<HR>
<A NAME="getGroup()"><!-- --></A><H3>
getGroup</H3>
<PRE>
public byte <B>getGroup</B>()</PRE>
<DL>
<DD>Returns the group identifier if added. Otherwise the null byte is returned.<DD><DL>
<DT><B>Returns:</B><DD>the groupd identifier if added, null byte otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="getEncryptionType()"><!-- --></A><H3>
getEncryptionType</H3>
<PRE>
public byte <B>getEncryptionType</B>()</PRE>
<DL>
<DD>If encrypted, this returns the encryption method byte. If it is not encrypted, the null byte is returned.<DD><DL>
<DT><B>Returns:</B><DD>the encryption method if set and the null byte if not</DL>
</DD>
</DL>
<HR>
<A NAME="getDataLength()"><!-- --></A><H3>
getDataLength</H3>
<PRE>
public int <B>getDataLength</B>()</PRE>
<DL>
<DD>If a length indicator has been added, the length of the data is returned. Otherwise -1 is returned.<DD><DL>
<DT><B>Returns:</B><DD>the length of the data if a length indicator is present or -1</DL>
</DD>
</DL>
<HR>
<A NAME="getDataString()"><!-- --></A><H3>
getDataString</H3>
<PRE>
public java.lang.String <B>getDataString</B>() throws <A HREF="../../helliker/id3/ID3v2FormatException.html">ID3v2FormatException</A></PRE>
<DL>
<DD>If possible, this method attempts to convert textual part of the data into a string. If this frame does not contain textual information, an empty string is returned.<DD><DL>
<DT><B>Returns:</B><DD>the textual portion of the data in this frame<DT><B>Throws:</B><DD><CODE><A HREF="../../helliker/id3/ID3v2FormatException.html">ID3v2FormatException</A></CODE> - if an error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Return a string representation of this object that contains all the information contained within it.<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a string representation of this object</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../helliker/id3/ID3v2FormatException.html"><B>PREV CLASS</B></A>
<A HREF="../../helliker/id3/ID3v2Frames.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ID3v2Frame.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -