Mercurial > hg > sv-dependency-builds
annotate src/libogg-1.3.0/doc/libogg/oggpack_bytes.html @ 1:05aa0afa9217
Bring in flac, ogg, vorbis
| author | Chris Cannam |
|---|---|
| date | Tue, 19 Mar 2013 17:37:49 +0000 |
| parents | |
| children |
| rev | line source |
|---|---|
| Chris@1 | 1 <html> |
| Chris@1 | 2 |
| Chris@1 | 3 <head> |
| Chris@1 | 4 <title>libogg - function - oggpack_bytes</title> |
| Chris@1 | 5 <link rel=stylesheet href="style.css" type="text/css"> |
| Chris@1 | 6 </head> |
| Chris@1 | 7 |
| Chris@1 | 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| Chris@1 | 9 <table border=0 width=100%> |
| Chris@1 | 10 <tr> |
| Chris@1 | 11 <td><p class=tiny>libogg documentation</p></td> |
| Chris@1 | 12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| Chris@1 | 13 </tr> |
| Chris@1 | 14 </table> |
| Chris@1 | 15 |
| Chris@1 | 16 <h1>oggpack_bytes</h1> |
| Chris@1 | 17 |
| Chris@1 | 18 <p><i>declared in "ogg/ogg.h";</i></p> |
| Chris@1 | 19 |
| Chris@1 | 20 <p>This function returns the total number of bytes behind the current |
| Chris@1 | 21 access point in the <a href="oggpack_buffer.html">oggpack_buffer</a>. |
| Chris@1 | 22 For write-initialized buffers, this is the number of complete bytes |
| Chris@1 | 23 written so far. For read-initialized buffers, it is the number of |
| Chris@1 | 24 complete bytes that have been read so far. |
| Chris@1 | 25 <p>The return value is the number of <b>complete</b> bytes in the buffer. |
| Chris@1 | 26 There may be extra (<8) bits. |
| Chris@1 | 27 <br><br> |
| Chris@1 | 28 <table border=0 color=black cellspacing=0 cellpadding=7> |
| Chris@1 | 29 <tr bgcolor=#cccccc> |
| Chris@1 | 30 <td> |
| Chris@1 | 31 <pre><b> |
| Chris@1 | 32 long oggpack_bytes(<a href="oggpack_buffer.html">oggpack_buffer</a> *b); |
| Chris@1 | 33 </b></pre> |
| Chris@1 | 34 </td> |
| Chris@1 | 35 </tr> |
| Chris@1 | 36 </table> |
| Chris@1 | 37 |
| Chris@1 | 38 <h3>Parameters</h3> |
| Chris@1 | 39 <dl> |
| Chris@1 | 40 <dt><i>b</i></dt> |
| Chris@1 | 41 <dd><a href="oggpack_buffer.html">oggpack_buffer</a> struct to be checked.</dd> |
| Chris@1 | 42 </dl> |
| Chris@1 | 43 |
| Chris@1 | 44 |
| Chris@1 | 45 <h3>Return Values</h3> |
| Chris@1 | 46 <blockquote> |
| Chris@1 | 47 <li> |
| Chris@1 | 48 <i>n</i> is the total number of bytes within the current buffer.</li> |
| Chris@1 | 49 </blockquote> |
| Chris@1 | 50 <p> |
| Chris@1 | 51 |
| Chris@1 | 52 <br><br> |
| Chris@1 | 53 <hr noshade> |
| Chris@1 | 54 <table border=0 width=100%> |
| Chris@1 | 55 <tr valign=top> |
| Chris@1 | 56 <td><p class=tiny>copyright © 2000-2010 xiph.org</p></td> |
| Chris@1 | 57 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> |
| Chris@1 | 58 </tr><tr> |
| Chris@1 | 59 <td><p class=tiny>libogg documentation</p></td> |
| Chris@1 | 60 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| Chris@1 | 61 </tr> |
| Chris@1 | 62 </table> |
| Chris@1 | 63 |
| Chris@1 | 64 |
| Chris@1 | 65 </body> |
| Chris@1 | 66 |
| Chris@1 | 67 </html> |