spritemediahandler.html

这个是java的quicktime for java 的详细使用文档

                 throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>This method returns the number of sprites contained in the media.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#40391">QuickTime::SpriteMediaCountSprites()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the number of sprites contained in the media.</DL>
</DD>
</DL>
<HR>

<A NAME="countImages()"><!-- --></A><H3>
countImages</H3>
<PRE>
public int <B>countImages</B>()
                throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>This method returns the number of images contained in the image pool of this media.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#42369">QuickTime::SpriteMediaCountImages()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the number of images.</DL>
</DD>
</DL>
<HR>

<A NAME="getIndImageDescription(int)"><!-- --></A><H3>
getIndImageDescription</H3>
<PRE>
public <A HREF="../../../../quicktime/std/image/ImageDescription.html">ImageDescription</A> <B>getIndImageDescription</B>(int&nbsp;imageIndex)
                                        throws <A HREF="../../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method returns the image description for the image specified by the index.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#19630">QuickTime::SpriteMediaGetIndImageDescription()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageIndex</CODE> - Specifies the image index.<DT><B>Returns:</B><DD>the image description for the image specified by the index.</DL>
</DD>
</DL>
<HR>

<A NAME="getDisplayedSampleNumber()"><!-- --></A><H3>
getDisplayedSampleNumber</H3>
<PRE>
public int <B>getDisplayedSampleNumber</B>()
                             throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>This method returns the sample number displayed currently.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#22481">QuickTime::SpriteMediaGetDisplayedSampleNumber()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the sample number displayed currently.</DL>
</DD>
</DL>
<HR>

<A NAME="getSpriteName(int)"><!-- --></A><H3>
getSpriteName</H3>
<PRE>
public java.lang.String <B>getSpriteName</B>(int&nbsp;spriteID)
                               throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Returns the name of the sprite with the specified ID.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#33432">QuickTime::SpriteMediaGetSpriteName()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>spriteID</CODE> - Specifies the id of the sprite in question.<DT><B>Returns:</B><DD>the sprite name for a given sprite ID.</DL>
</DD>
</DL>
<HR>

<A NAME="getImageName(int)"><!-- --></A><H3>
getImageName</H3>
<PRE>
public java.lang.String <B>getImageName</B>(int&nbsp;imageIndex)
                              throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Returns the name of the sprite with the specified ID.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#11079">QuickTime::SpriteMediaGetImageName()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageIndex</CODE> - Specifies the index of the image whose name we wish to receive.<DT><B>Returns:</B><DD>the name of the image with the specified index from the current key frame sample.</DL>
</DD>
</DL>
<HR>

<A NAME="spriteIndexToID(int)"><!-- --></A><H3>
spriteIndexToID</H3>
<PRE>
public int <B>spriteIndexToID</B>(int&nbsp;spriteIndex)
                    throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Return the ID of the sprite specified by spriteIndex.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#36982">QuickTime::SpriteMediaSpriteIndexToID()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>spriteIndex</CODE> - Specifies the index of the sprite for the operation.<DT><B>Returns:</B><DD>sprite ID of the sprite Index.</DL>
</DD>
</DL>
<HR>

<A NAME="spriteIDtoIndex(int)"><!-- --></A><H3>
spriteIDtoIndex</H3>
<PRE>
public short <B>spriteIDtoIndex</B>(int&nbsp;spriteID)
                      throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Return the index of the sprite specified by spriteID.
 <BR><BR><b>QuickTime::SpriteMediaSpriteIDToIndex()</b><BR><BR><DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>spriteID</CODE> - Specifies the ID of the sprite for the operation.<DT><B>Returns:</B><DD>sprite ID of the sprite Index.</DL>
</DD>
</DL>
<HR>

<A NAME="setActionVariable(int, float)"><!-- --></A><H3>
setActionVariable</H3>
<PRE>
public void <B>setActionVariable</B>(int&nbsp;variableID,
                              float&nbsp;value)
                       throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Sets the value of the sprite track variable with the ID of the variable to the supplied value.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.b.htm#28592">QuickTime::SpriteMediaSetActionVariable()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>variableID</CODE> - Specifies a variable ID of the sprite name.</DL>
</DD>
</DL>
<HR>

<A NAME="getActionVariable(int)"><!-- --></A><H3>
getActionVariable</H3>
<PRE>
public float <B>getActionVariable</B>(int&nbsp;variableID)
                        throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Returns the value of the sprite track variable with specified ID.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.b.htm#30681">QuickTime::SpriteMediaGetActionVariable()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>variableID</CODE> - Specifies a variable ID of the sprite name.</DL>
</DD>
</DL>
<HR>

<A NAME="setActionVariableToString(int, java.lang.String)"><!-- --></A><H3>
setActionVariableToString</H3>
<PRE>
public void <B>setActionVariableToString</B>(int&nbsp;variableID,
                                      java.lang.String&nbsp;theString)
                               throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Sets the value of the sprite track variable with the ID of the variable to the supplied theString.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/ref_undocfuncs.htm#pgfId=17305">QuickTime::SpriteMediaSetActionVariableToString()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>variableID</CODE> - Specifies a variable ID of the sprite name.<DD><CODE>theString</CODE> - Specifies the string value of the variableID.</DL>
</DD>
</DL>
<HR>

<A NAME="getActionVariableAsString(int)"><!-- --></A><H3>
getActionVariableAsString</H3>
<PRE>
public java.lang.String <B>getActionVariableAsString</B>(int&nbsp;variableID)
                                           throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Returns the value as String of the sprite track variable with specified ID.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/ref_undocfuncs.htm#pgfId=17299">QuickTime::SpriteMediaGetActionVariableAsString()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>variableID</CODE> - Specifies a variable ID of the sprite name.<DT><B>Returns:</B><DD>the string value of the variableID sprite track</DL>
</DD>
</DL>
<HR>

<A NAME="getSpriteImageGroupID(int)"><!-- --></A><H3>
getSpriteImageGroupID</H3>
<PRE>
public int <B>getSpriteImageGroupID</B>(int&nbsp;imageIndex)
                          throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Returns a propert value for the image specified by imageIndex.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#42456">QuickTime::SpriteMediaGetIndImageProperty()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageIndex</CODE> - Specifies the index of the image.</DL>
</DD>
</DL>
<HR>

<A NAME="getSpriteImageRegistrationPoint(int)"><!-- --></A><H3>
getSpriteImageRegistrationPoint</H3>
<PRE>
public <A HREF="../../../../quicktime/qd/QDPoint.html">QDPoint</A> <B>getSpriteImageRegistrationPoint</B>(int&nbsp;imageIndex)
                                        throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Returns a propert value for the image specified by imageIndex.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refMHSpriteAPI.a.htm#42456">QuickTime::SpriteMediaGetIndImageProperty()</a> </b><BR><BR>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageIndex</CODE> - Specifies the index of the image.</DL>
</DD>
</DL>
<HR>

<A NAME="newImage(quicktime.std.movies.media.DataRef, int)"><!-- --></A><H3>
newImage</H3>
<PRE>
public void <B>newImage</B>(<A HREF="../../../../quicktime/std/movies/media/DataRef.html">DataRef</A>&nbsp;dataRef,
                     int&nbsp;imageID)
              throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Creates a new Sprite image. The new image can be used by the target sprite track like any 
 other sprite image.
 If imageID is 0, then the image is referenced by the next available image index, which is equal to the number of images
 in the track before this call is made.
 Requires QuickTime 6
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataRef</CODE> - Specifies the image to be added to the sprite track.<DD><CODE>imageID</CODE> - a unique ID for the image. Pass in 0 to assign next (incremental) ID, which is usually same as 
 the next image index unless its previously assigned</DL>
</DD>
</DL>
<HR>

<A NAME="disposeImage(int)"><!-- --></A><H3>
disposeImage</H3>
<PRE>
public void <B>disposeImage</B>(int&nbsp;imageIndex)
                  throws <A HREF="../../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>Free memory allocated for image and removes image from track.
 Requires QuickTime 6
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageIndex</CODE> - the index of image to be removed</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="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SpriteMediaHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../quicktime/std/movies/media/SpriteMedia.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../quicktime/std/movies/media/StreamDescription.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>  &nbsp;
&nbsp;<A HREF="SpriteMediaHandler.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>