diff options
| author | Jack Moffitt <jack@xiph.org> | 2001-12-19 00:47:18 +0000 |
|---|---|---|
| committer | Jack Moffitt <jack@xiph.org> | 2001-12-19 00:47:18 +0000 |
| commit | 143c68df7fe157617e10fa9108d9795b1e7e15c9 (patch) | |
| tree | 23581e1896149279794a50b3b6af402210776ee7 /doc | |
| parent | 65b4a640f7b05c7043a50091a0eab1d3d25ffc48 (diff) | |
| download | ogg-143c68df7fe157617e10fa9108d9795b1e7e15c9.tar.gz | |
Documentations updates for RC3 release.
git-svn-id: http://svn.xiph.org/trunk/ogg@2821 0101bb08-14d6-0310-b084-bc0e0c8e3800
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ogg/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/ogg/general.html | 14 | ||||
| -rw-r--r-- | doc/ogg/ogg_page_packets.html | 75 | ||||
| -rw-r--r-- | doc/ogg/ogg_stream_eof.html | 62 | ||||
| -rw-r--r-- | doc/ogg/reference.html | 10 |
5 files changed, 96 insertions, 69 deletions
diff --git a/doc/ogg/Makefile.am b/doc/ogg/Makefile.am index 1e52f6c..e27e33a 100644 --- a/doc/ogg/Makefile.am +++ b/doc/ogg/Makefile.am @@ -9,7 +9,7 @@ doc_DATA = bitpacking.html datastructures.html decoding.html encoding.html\ ogg_page_bos.html ogg_page_continued.html ogg_page_eos.html\ ogg_page_granulepos.html ogg_page_pageno.html ogg_page_serialno.html\ ogg_page_version.html ogg_stream_clear.html ogg_stream_destroy.html\ - ogg_stream_eof.html ogg_stream_eos.html ogg_stream_flush.html\ + ogg_page_packets.html ogg_stream_eos.html ogg_stream_flush.html\ ogg_stream_init.html ogg_stream_packetin.html ogg_stream_packetout.html\ ogg_stream_pagein.html ogg_stream_pageout.html ogg_stream_reset.html\ ogg_stream_state.html ogg_sync_buffer.html ogg_sync_clear.html\ @@ -22,6 +22,6 @@ doc_DATA = bitpacking.html datastructures.html decoding.html encoding.html\ oggpack_read1.html oggpack_readinit.html oggpack_reset.html\ oggpack_write.html oggpack_writeclear.html oggpack_writeinit.html\ overview.html reference.html style.css vorbis_comment.html\ - vorbis_info.html + vorbis_info.html ogg_packet_clear.html ogg_page_checksum_set.html EXTRA_DIST = $(doc_DATA) diff --git a/doc/ogg/general.html b/doc/ogg/general.html index 6c26bab..48ff51b 100644 --- a/doc/ogg/general.html +++ b/doc/ogg/general.html @@ -53,7 +53,11 @@ All the <b>libogg</b> specific functions are declared in "ogg/ogg.h". <tr valign=top> <td><a href="ogg_page_continued.html">ogg_page_continued</a></td> <td>Indicates if the current page contains a continued packet from the last page.</td> -</tr>
+</tr> +<tr valign=top> +<td><a href="ogg_page_packets.html">ogg_page_packets</a></td> + <td>Indicates the number of packets contained in a page.</td> +</tr> <tr valign=top> <td><a href="ogg_page_bos.html">ogg_page_bos</a></td> <td>Indicates if the current page is the beginning of the stream.</td> @@ -74,6 +78,14 @@ All the <b>libogg</b> specific functions are declared in "ogg/ogg.h". <td><a href="ogg_page_pageno.html">ogg_page_pageno</a></td> <td>Returns the sequential page number for this page.</td> </tr>
+<tr valign=top> +<td><a href="ogg_packet_clear.html">ogg_packet_clear</a><td> + <td>Clears the ogg_packet structure.</td> +</tr> +<tr valign=top> +<td><a href="ogg_page_checksum_set.html">ogg_page_checksum_set</a></td> + <td>Checksums an ogg_page.</td> +</tr> </table> <br><br> diff --git a/doc/ogg/ogg_page_packets.html b/doc/ogg/ogg_page_packets.html new file mode 100644 index 0000000..bc4f04f --- /dev/null +++ b/doc/ogg/ogg_page_packets.html @@ -0,0 +1,75 @@ +<html> + +<head> +<title>libogg - function - ogg_page_packets</title> +<link rel=stylesheet href="style.css" type="text/css"> +</head> + +<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> +<table border=0 width=100%> +<tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg - 20011218</p></td> +</tr> +</table> + +<h1>ogg_page_packets</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>Returns the number of packets that are completed on this page. If the +leading packet is begun on a previous page, but ends on this page, it's +counted. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_page_packets(ogg_page *og);
+ +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>og</i></dt> +<dd>Pointer to the current ogg_page struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +If a page consists of a packet begun on a previous page, and a new packet +begun (but not completed) on this page, the return will be:<br> +<br> +ogg_page_packets(page) will return 1,<br> +ogg_page_continued(paged) will return non-zero.<br> +<br><br> +If a page happens to be a single packet that was begun on a previous page, and +spans to the next page (in the case of a three or more page packet), the +return will be:<br> +<br> +ogg_page_packets(page) will return 0,<br> +ogg_page_continued(page) will return non-zero.<br> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2001 xiph.org</p></td> +<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> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg - 20011218</p></td> +</tr> +</table> + + +</body> + +</html> diff --git a/doc/ogg/ogg_stream_eof.html b/doc/ogg/ogg_stream_eof.html deleted file mode 100644 index 20fc389..0000000 --- a/doc/ogg/ogg_stream_eof.html +++ /dev/null @@ -1,62 +0,0 @@ -<html> - -<head> -<title>libogg - function - ogg_stream_destroy</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ogg_stream_eof</h1> - -<p><i>declared in "ogg/ogg.h";</i></p> - -<p>This function indicates whether we have reached the end of the stream or not. -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ogg_stream_eof(ogg_stream_state *os); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>os</i></dt> -<dd>Pointer to the current ogg_stream_state struct.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>1 if we are at the end of the stream.</li>
-<li> -0 if we have not yet reached the end of the stream.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 xiph.org</p></td> -<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> -</tr><tr> -<td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/ogg/reference.html b/doc/ogg/reference.html index fecb075..d3decc8 100644 --- a/doc/ogg/reference.html +++ b/doc/ogg/reference.html @@ -9,7 +9,7 @@ <table border=0 width=100%> <tr> <td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td> +<td align=right><p class=tiny>libogg - 20011218</p></td> </tr> </table> @@ -64,23 +64,25 @@ <a href="ogg_stream_clear.html">ogg_stream_clear()</a><br> <a href="ogg_stream_reset.html">ogg_stream_reset()</a><br> <a href="ogg_stream_destroy.html">ogg_stream_destroy()</a><br> -<a href="ogg_stream_eof.html">ogg_stream_eof()</a><br> <a href="ogg_page_version.html">ogg_page_version()</a><br> <a href="ogg_page_continued.html">ogg_page_continued()</a><br> +<a href="ogg_page_packets.html">ogg_page_packets()</a></br> <a href="ogg_page_bos.html">ogg_page_bos()</a><br> <a href="ogg_page_eos.html">ogg_page_eos()</a><br> <a href="ogg_page_granulepos.html">ogg_page_granulepos()</a><br> <a href="ogg_page_serialno.html">ogg_page_serialno()</a><br> <a href="ogg_page_pageno.html">ogg_page_pageno()</a><br> +<a href="ogg_packet_clear.html">ogg_packet_clear()</a><br> +<a href="ogg_page_checksum_set.html">ogg_page_checksum_set()</a><br> <br><br> <hr noshade> <table border=0 width=100%> <tr valign=top> -<td><p class=tiny>copyright © 2000 xiph.org</p></td> +<td><p class=tiny>copyright © 2001 xiph.org</p></td> <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> </tr><tr> <td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg version 1.25 - 20000615</p></td> +<td align=right><p class=tiny>libogg - 20011218</p></td> </tr> </table> |