1 | <html>
|
---|
2 |
|
---|
3 | <head>
|
---|
4 | <title>libogg - function - ogg_stream_iovecin</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.3.5 - 20210603</p></td>
|
---|
13 | </tr>
|
---|
14 | </table>
|
---|
15 |
|
---|
16 | <h1>ogg_stream_iovecin</h1>
|
---|
17 |
|
---|
18 | <p><i>declared in "ogg/ogg.h";</i></p>
|
---|
19 |
|
---|
20 | <p>This function submits packet data (in the form of
|
---|
21 | an array of <a href="ogg_iovec_t.html">ogg_iovec_t</a>, rather than using
|
---|
22 | an <a href="ogg_packet.html">ogg_packet</a> structure) to the
|
---|
23 | bitstream for page encapsulation. After this is called, more packets
|
---|
24 | can be submitted, or pages can be written out.</p>
|
---|
25 |
|
---|
26 | <p>In a typical encoding situation, this should be used after filling a
|
---|
27 | packet with data.
|
---|
28 | The data in the packet is copied into the internal storage managed by
|
---|
29 | the <a href="ogg_stream_state.html">ogg_stream_state</a>, so the caller
|
---|
30 | is free to alter the contents of <i>os</i> after this call has returned.
|
---|
31 |
|
---|
32 | <br><br>
|
---|
33 | <table border=0 color=black cellspacing=0 cellpadding=7>
|
---|
34 | <tr bgcolor=#cccccc>
|
---|
35 | <td>
|
---|
36 | <pre><b>
|
---|
37 | int ogg_stream_iovecin(ogg_stream_state *os, ogg_iovec_t *iov, int count, long e_o_s, ogg_int64_t granulepos);
|
---|
38 | </b></pre>
|
---|
39 | </td>
|
---|
40 | </tr>
|
---|
41 | </table>
|
---|
42 |
|
---|
43 | <h3>Parameters</h3>
|
---|
44 | <dl>
|
---|
45 | <dt><i>os</i></dt>
|
---|
46 | <dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</dd>
|
---|
47 | <dt><i>iov</i></dt>
|
---|
48 | <dd>Length-encoded buffers held in an array of <a href="ogg_iovec_t.html">ogg_iovec_t</a>.
|
---|
49 | <dt><i>count</i></dt>
|
---|
50 | <dd>Length of the iov array.
|
---|
51 | <dt><i>e_o_s</i></dt>
|
---|
52 | <dd>End of stream flag, analogous to the e_o_s field in an <a href="ogg_packet.html">ogg_packet</a>.
|
---|
53 | <dt><i>granulepos</i></dt>
|
---|
54 | <dd>Granule position value, analogous to the granpos field in an <a href="ogg_packet.html">ogg_packet</a>.
|
---|
55 | </dl>
|
---|
56 |
|
---|
57 |
|
---|
58 | <h3>Return Values</h3>
|
---|
59 | <blockquote>
|
---|
60 | <li>
|
---|
61 | 0 returned on success. -1 returned in the event of internal error.</li>
|
---|
62 | </blockquote>
|
---|
63 | <p>
|
---|
64 |
|
---|
65 | <br><br>
|
---|
66 | <hr noshade>
|
---|
67 | <table border=0 width=100%>
|
---|
68 | <tr valign=top>
|
---|
69 | <td><p class=tiny>copyright © 2000-2021 Xiph.Org Foundation</p></td>
|
---|
70 | <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
---|
71 | </tr><tr>
|
---|
72 | <td><p class=tiny>libogg documentation</p></td>
|
---|
73 | <td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td>
|
---|
74 | </tr>
|
---|
75 | </table>
|
---|
76 |
|
---|
77 |
|
---|
78 | </body>
|
---|
79 |
|
---|
80 | </html>
|
---|