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_flush.html | 67 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 doc/libogg/ogg_stream_flush.html (limited to 'doc/libogg/ogg_stream_flush.html') diff --git a/doc/libogg/ogg_stream_flush.html b/doc/libogg/ogg_stream_flush.html new file mode 100644 index 0000000..317f442 --- /dev/null +++ b/doc/libogg/ogg_stream_flush.html @@ -0,0 +1,67 @@ + + + +libogg - function - ogg_stream_flush + + + + + + + + + +

libogg documentation

libogg release 1.3.2 - 20140527

+ +

ogg_stream_flush

+ +

declared in "ogg/ogg.h";

+ +

This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page. +

This should only be used when you want to flush an undersized page from the middle of the stream. Otherwise, ogg_stream_pageout or ogg_stream_pageout_fill should always be used. +

This function can also be used to verify that all packets have been flushed. If the return value is 0, all packets have been placed into a page. Like ogg_stream_pageout, it should generally be called in a loop until available packet data has been flushes, since even a single packet may span multiple pages. + +

+ + + + +
+

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

Parameters

+
+
os
+
Pointer to a previously declared ogg_stream_state struct, which represents the current logical bitstream.
+
og
+
Pointer to a page of data. The remaining packets in the stream will be placed into this page, if any remain. +
+ + +

Return Values

+
+
  • 0 means that all packet data has already been flushed into pages, and there are no packets to put into the page. 0 is also returned in the case of an ogg_stream_state that has been cleared explicitly or implicitly due to an internal error.
    • +
  • +Nonzero means that remaining packets have successfully been flushed into the page.
    • +
    +

    + +

    +

    + + + + + + + + +

    copyright © 2000-2014 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.2 - 20140527

    + + + + + -- cgit v1.1