vorbis_bitrate_flushpacket.html 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. <html>
  2. <head>
  3. <title>libvorbis - function - vorbis_bitrate_flushpacket</title>
  4. <link rel=stylesheet href="style.css" type="text/css">
  5. </head>
  6. <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
  7. <table border=0 width=100%>
  8. <tr>
  9. <td><p class=tiny>libvorbis documentation</p></td>
  10. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  11. </tr>
  12. </table>
  13. <h1>vorbis_bitrate_flushpacket</h1>
  14. <p><i>declared in "vorbis/codec.h";</i></p>
  15. <p>This function returns the next available completed packet from the
  16. bitrate management engine. It should be called in a loop after any call
  17. to vorbis_bitrate_addblock() until it returns either 0 (more data needed)
  18. or a negative value (error).
  19. </p>
  20. <p>
  21. The data returned in the ogg_packet structure can be copied to the
  22. final compressed output stream.
  23. </p>
  24. <table border=0 color=black cellspacing=0 cellpadding=7>
  25. <tr bgcolor=#cccccc>
  26. <td>
  27. <pre><b>
  28. extern int vorbis_bitrate_flushpacket(vorbis_dsp_state *vd,
  29. ogg_packet *op);
  30. </b></pre>
  31. </td>
  32. </tr>
  33. </table>
  34. <h3>Parameters</h3>
  35. <dl>
  36. <dt><i>vd</i></dt>
  37. <dd>Pointer to the vorbis_dsp_state represending the encoder.</dd>
  38. <dt><i>op</i></dt>
  39. <dd>Pointer to an ogg_packet to be filled out with the compressed data.</dd>
  40. </dl>
  41. <h3>Return Values</h3>
  42. <ul>
  43. <li>1 for success when more packets are available.
  44. <li>0 for success when this is the last packet available from the current input.</li>
  45. <li>negative values for failure:
  46. <ul>
  47. <li>OV_EINVAL - Invalid parameters.</li>
  48. <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
  49. <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
  50. </ul>
  51. </li>
  52. </ul>
  53. <br><br>
  54. <hr noshade>
  55. <table border=0 width=100%>
  56. <tr valign=top>
  57. <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  58. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  59. </tr><tr>
  60. <td><p class=tiny>libvorbis documentation</p></td>
  61. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  62. </tr>
  63. </table>
  64. </body>
  65. </html>