ogg_stream_init.html 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. <html>
  2. <head>
  3. <title>libogg - function - ogg_stream_init</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>libogg documentation</p></td>
  10. <td align=right><p class=tiny>libogg release 1.3.4 - 20190830</p></td>
  11. </tr>
  12. </table>
  13. <h1>ogg_stream_init</h1>
  14. <p><i>declared in "ogg/ogg.h";</i></p>
  15. <p>This function is used to initialize an <a href="ogg_sync_state.html">ogg_stream_state</a> struct and allocates appropriate memory in preparation for encoding or decoding.
  16. <p>It also assigns the stream a given serial number.
  17. <br><br>
  18. <table border=0 color=black cellspacing=0 cellpadding=7>
  19. <tr bgcolor=#cccccc>
  20. <td>
  21. <pre><b>
  22. int ogg_stream_init(<a href="ogg_stream_state.html">ogg_stream_state</a> *os,int serialno);
  23. </b></pre>
  24. </td>
  25. </tr>
  26. </table>
  27. <h3>Parameters</h3>
  28. <dl>
  29. <dt><i>os</i></dt>
  30. <dd>Pointer to the ogg_stream_state struct that we will be initializing.</dd>
  31. <dt><i>serialno</i></dt>
  32. <dd>Serial number that we will attach to this stream.</dd>
  33. </dl>
  34. <h3>Return Values</h3>
  35. <blockquote>
  36. <li>
  37. 0 if successful</li>
  38. <li>
  39. -1 if unsuccessful.</li>
  40. </blockquote>
  41. <p>
  42. <br><br>
  43. <hr noshade>
  44. <table border=0 width=100%>
  45. <tr valign=top>
  46. <td><p class=tiny>copyright &copy; 2000-2019 Xiph.Org Foundation</p></td>
  47. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
  48. </tr><tr>
  49. <td><p class=tiny>libogg documentation</p></td>
  50. <td align=right><p class=tiny>libogg release 1.3.4 - 20190830</p></td>
  51. </tr>
  52. </table>
  53. </body>
  54. </html>