Tree - source-git/mingw-libvorbis

source-git / mingw-libvorbis

Blame doc/vorbisfile/ov_clear.html

Blob History Raw

Packit

<html>

Packit

06404a

Packit

06404a

<head>

Packit

06404a

<title>Vorbisfile - function - ov_clear</title>

Packit

06404a

<link rel=stylesheet href="style.css" type="text/css">

Packit

06404a

</head>

Packit

06404a

Packit

06404a

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">

Packit

06404a

Packit

06404a

Packit

06404a

Vorbisfile documentation

Packit

06404a

vorbisfile version 1.3.2 - 20101101

Packit

Packit

Packit

Packit

ov_clear

Packit

06404a

Packit

06404a

declared in "vorbis/vorbisfile.h";

Packit

06404a

Packit

06404a

 After a bitstream has been opened using ov_fopen()/ov_open()/ov_open_callbacks() and decoding is complete, the application must call <tt>ov_clear()</tt> to clear

Packit

06404a

the decoder's buffers.  <tt>ov_clear()</tt> will also close the file unless it was opened using ov_open_callbacks() with the <tt>close_func</tt> callback set to NULL.

Packit

06404a

Packit

06404a

<tt>ov_clear()</tt> must also be called after a successful call to ov_test() or ov_test_callbacks().

Packit

Packit

Packit

Packit

Packit

Packit

Packit

int ov_clear(OggVorbis_File *vf);

Packit

Packit

Packit

Packit

Packit

Packit

Parameters

Packit

06404a

Packit

06404a

vf

Packit

06404a

A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile

Packit

06404a

functions.  After <tt>ov_clear</tt> 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().

Packit

Packit

Packit

Packit