[xiph-commits] r9449 - trunk/theora/include/theora

[giles at motherfish-iii.xiph.org]

Author: giles
Date: 2005-06-14 05:08:06 -0700 (Tue, 14 Jun 2005)
New Revision: 9449

Modified:
   trunk/theora/include/theora/theora.h
Log:
Document the normal return value of theora_decode_packetin().


Modified: trunk/theora/include/theora/theora.h
===================================================================
--- trunk/theora/include/theora/theora.h	2005-06-14 05:54:35 UTC (rev 9448)
+++ trunk/theora/include/theora/theora.h	2005-06-14 12:08:06 UTC (rev 9449)
@@ -251,6 +251,8 @@
  */
 extern int theora_encode_packetout( theora_state *t, int last_p,
                                     ogg_packet *op);
+extern int theora_encode_empty_packetout( theora_state *t, int last_p,
+                                    ogg_packet *op);
 
 /**
  * Request a packet containing the initial header.
@@ -347,6 +349,7 @@
  * Input a packet containing encoded data into the theora decoder.
  * \param th A theora_state handle previously initialized for decoding.
  * \param op An ogg_packet containing encoded theora data.
+ * \retval 0 Success
  * \retval OC_BADPACKET \a op does not contain encoded video data
  */
 extern int theora_decode_packetin(theora_state *th,ogg_packet *op);