1 | <html> |
---|
2 | |
---|
3 | <head> |
---|
4 | <title>libogg - function - ogg_sync_wrote</title> |
---|
5 | <link rel=stylesheet href="style.css" type="text/css"> |
---|
6 | </head> |
---|
7 | |
---|
8 | <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
---|
9 | <table border=0 width=100%> |
---|
10 | <tr> |
---|
11 | <td><p class=tiny>libogg documentation</p></td> |
---|
12 | <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> |
---|
13 | </tr> |
---|
14 | </table> |
---|
15 | |
---|
16 | <h1>ogg_sync_wrote</h1> |
---|
17 | |
---|
18 | <p><i>declared in "ogg/ogg.h";</i></p> |
---|
19 | |
---|
20 | <p>This function is used to tell the <a href="ogg_sync_state.html">ogg_sync_state</a> struct how many bytes we wrote into the buffer. |
---|
21 | |
---|
22 | <p> |
---|
23 | The general proceedure is to request a pointer into an internal |
---|
24 | <a href="ogg_sync_state.html">ogg_sync_state</a> buffer by calling |
---|
25 | <a href="ogg_sync_buffer.html">ogg_sync_buffer()</a>. The buffer |
---|
26 | is then filled up to the requested size with new input, and |
---|
27 | ogg_sync_wrote() is called to advance the fill pointer by however |
---|
28 | much data was actually available.</p> |
---|
29 | |
---|
30 | <br> |
---|
31 | <table border=0 color=black cellspacing=0 cellpadding=7> |
---|
32 | <tr bgcolor=#cccccc> |
---|
33 | <td> |
---|
34 | <pre><b> |
---|
35 | int ogg_sync_wrote(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, long bytes); |
---|
36 | </b></pre> |
---|
37 | </td> |
---|
38 | </tr> |
---|
39 | </table> |
---|
40 | |
---|
41 | <h3>Parameters</h3> |
---|
42 | <dl> |
---|
43 | <dt><i>oy</i></dt> |
---|
44 | <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> |
---|
45 | <dt><i>bytes</i></dt> |
---|
46 | <dd>Number of bytes of new data written.</dd> |
---|
47 | </dl> |
---|
48 | |
---|
49 | |
---|
50 | <h3>Return Values</h3> |
---|
51 | <blockquote> |
---|
52 | <li>-1 if the number of bytes written overflows the internal storage of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct. |
---|
53 | <li> |
---|
54 | 0 in all other cases.</li> |
---|
55 | </blockquote> |
---|
56 | |
---|
57 | |
---|
58 | <br><br> |
---|
59 | <hr noshade> |
---|
60 | <table border=0 width=100%> |
---|
61 | <tr valign=top> |
---|
62 | <td><p class=tiny>copyright © 2000 xiph.org</p></td> |
---|
63 | <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td> |
---|
64 | </tr><tr> |
---|
65 | <td><p class=tiny>libogg documentation</p></td> |
---|
66 | <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td> |
---|
67 | </tr> |
---|
68 | </table> |
---|
69 | |
---|
70 | |
---|
71 | </body> |
---|
72 | |
---|
73 | </html> |
---|