From 74f4b1bc3b627ba4c7e03498234d88cacdfbe97b Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 29 Sep 2021 22:52:49 +0200 Subject: Squashed 'vorbis/' content from commit d22c3ab5f git-subtree-dir: vorbis git-subtree-split: d22c3ab5f633460abc2532feee60ca0892134cbf --- doc/vorbisfile/ov_clear.html | 64 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 doc/vorbisfile/ov_clear.html (limited to 'doc/vorbisfile/ov_clear.html') diff --git a/doc/vorbisfile/ov_clear.html b/doc/vorbisfile/ov_clear.html new file mode 100644 index 0000000..e67107c --- /dev/null +++ b/doc/vorbisfile/ov_clear.html @@ -0,0 +1,64 @@ + + + +Vorbisfile - function - ov_clear + + + + + + + + + +

Vorbisfile documentation

vorbisfile version 1.3.2 - 20101101

+ +

ov_clear

+ +

declared in "vorbis/vorbisfile.h";

+ +

After a bitstream has been opened using ov_fopen()/ov_open()/ov_open_callbacks() and decoding is complete, the application must call ov_clear() to clear +the decoder's buffers. ov_clear() will also close the file unless it was opened using ov_open_callbacks() with the close_func callback set to NULL.

+ +ov_clear() must also be called after a successful call to ov_test() or ov_test_callbacks().

+ +

+ + + + +
+

+int ov_clear(OggVorbis_File *vf);
+
+
+ +

Parameters

+
+
vf
+
A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile +functions. After ov_clear has been called, the contents of this structure are deallocated, and it can no longer be used without being reinitialized by a call to ov_fopen(), ov_open() or ov_open_callbacks().
+
+ + +

Return Values

+
+
  • 0 for success
  • +
    + + +

    +
    + + + + + + + + +

    copyright © 2000-2010 Xiph.Org

    Ogg Vorbis

    Vorbisfile documentation

    vorbisfile version 1.3.2 - 20101101

    + + + + -- cgit v1.1