From 8f3471999e929bb99116fac52b94d572c42ba15e Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 29 Sep 2021 22:52:15 +0200 Subject: Squashed 'ogg/' content from commit 4380566a4 git-subtree-dir: ogg git-subtree-split: 4380566a44b8d5e85ad511c9c17eb04197863ec5 --- doc/libogg/ogg_stream_pageout.html | 84 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 doc/libogg/ogg_stream_pageout.html (limited to 'doc/libogg/ogg_stream_pageout.html') diff --git a/doc/libogg/ogg_stream_pageout.html b/doc/libogg/ogg_stream_pageout.html new file mode 100644 index 0000000..66139e3 --- /dev/null +++ b/doc/libogg/ogg_stream_pageout.html @@ -0,0 +1,84 @@ + + + +libogg - function - ogg_stream_pageout + + + + + + + + + +

libogg documentation

libogg release 1.3.2 - 20140527

+ +

ogg_stream_pageout

+ +

declared in "ogg/ogg.h";

+ +

This function forms packets into pages.

+ +

In a typical encoding situation, this would be called after using ogg_stream_packetin() to submit +data packets to the bitstream. Internally, this function assembles +the accumulated packet bodies into an Ogg page suitable for writing +to a stream. The function is typically called in a loop until there +are no more pages ready for output.

+ +

This function will only return a page when a "reasonable" amount of +packet data is available. Normally this is appropriate since it +limits the overhead of the Ogg page headers in the bitstream, and so +calling ogg_stream_pageout() after ogg_stream_packetin() should be the +common case. Call ogg_stream_flush() +if immediate page generation is desired. This may be occasionally +necessary, for example, to limit the temporal latency of a variable +bitrate stream.

+ +

+ + + + +
+

+int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og);
+
+
+ +

Parameters

+
+
os
+
Pointer to a previously declared ogg_stream struct, which represents the current logical bitstream.
+
og
+
Pointer to an ogg_page structure to fill +in. Data pointed to is owned by libogg. The structure is valid until the +next call to ogg_stream_pageout(), ogg_stream_packetin(), or +ogg_stream_flush().
+
+ + +

Return Values

+
+
  • Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In +this case og is not modified.
    • +
  • Non-zero means that a page has been completed and returned.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000-2010 xiph.org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    + + + + + -- cgit v1.1