vorbis_encode_setup_init.html 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. <html>
  2. <head>
  3. <title>libvorbisenc - function - vorbis_encode_setup_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>libvorbisenc documentation</p></td>
  10. <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
  11. </tr>
  12. </table>
  13. <h1>vorbis_encode_setup_init</h1>
  14. <p><i>declared in "vorbis/libvorbisenc.h";</i></p>
  15. <p>This function performs the last stage of three-step encoding setup, as described in the API overview under <a href="overview.html#BBR">managed bitrate modes</a>.
  16. <p>Before this function is called, the <a
  17. href="vorbis_info.html">vorbis_info</a> struct should be initialized
  18. by using vorbis_info_init() from the libvorbis API, one of <a
  19. href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()</a>
  20. or <a
  21. href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()</a>
  22. called to initialize the high-level encoding setup, and <a
  23. href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> called if
  24. necessary to make encoding setup changes. vorbis_encode_setup_init()
  25. finalizes the highlevel encoding structure into a complete encoding
  26. setup after which the application may make no further setup changes.<p>
  27. After encoding, vorbis_info_clear should be called.
  28. <p>
  29. <br><br>
  30. <table border=0 color=black cellspacing=0 cellpadding=7>
  31. <tr bgcolor=#cccccc>
  32. <td>
  33. <pre><b>
  34. extern int vorbis_encode_setup_init(<a href="vorbis_info.html">vorbis_info</a> *vi);
  35. </b></pre>
  36. </td>
  37. </tr>
  38. </table>
  39. <h3>Parameters</h3>
  40. <dl>
  41. <dt><i>vi</i></dt>
  42. <dd>File pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
  43. </dl>
  44. <h3>Return Values</h3>
  45. <blockquote>
  46. <li>
  47. 0 for success</li>
  48. <li>less than zero for failure:</li>
  49. <ul>
  50. <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
  51. <li>OV_EINVAL - Attempt to use vorbis_encode_setup_init() without first calling one of <a
  52. href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()</a>
  53. or <a
  54. href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()</a>
  55. to initialize the high-level encoding setup
  56. </li>
  57. </ul>
  58. </blockquote>
  59. <p>
  60. <br><br>
  61. <hr noshade>
  62. <table border=0 width=100%>
  63. <tr valign=top>
  64. <td><p class=tiny>copyright &copy; 2004 xiph.org</p></td>
  65. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
  66. </tr><tr>
  67. <td><p class=tiny>libvorbisenc documentation</p></td>
  68. <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
  69. </tr>
  70. </table>
  71. </body>
  72. </html>