From 8e94244f86e657e4113e35438e59cf5771882b25 Mon Sep 17 00:00:00 2001 From: Aki Date: Sun, 3 Mar 2024 12:51:03 +0100 Subject: libogg and libvorbis are no longer part of this source tree --- .../vorbis/doc/vorbisfile/ov_test_callbacks.html | 111 --------------------- 1 file changed, 111 deletions(-) delete mode 100644 contrib/vorbis/doc/vorbisfile/ov_test_callbacks.html (limited to 'contrib/vorbis/doc/vorbisfile/ov_test_callbacks.html') diff --git a/contrib/vorbis/doc/vorbisfile/ov_test_callbacks.html b/contrib/vorbis/doc/vorbisfile/ov_test_callbacks.html deleted file mode 100644 index 9abc84c..0000000 --- a/contrib/vorbis/doc/vorbisfile/ov_test_callbacks.html +++ /dev/null @@ -1,111 +0,0 @@ - - - -Vorbisfile - function - ov_test_callbacks - - - - - - - - - -

Vorbisfile documentation

vorbisfile version 1.3.2 - 20101101

- -

ov_test_callbacks

- -

declared in "vorbis/vorbisfile.h";

- -

This is an alternative function used to open and test an OggVorbis_File -structure when using a data source other than a file, -when its necessary to modify default file access behavior, or to -test for Vorbis content from a FILE * pointer under -Windows where ov_test() cannot be used. It -allows the application to specify custom file manipulation routines -and sets up all the related decoding structures. - -

Once this has been called, the same OggVorbis_File -struct should be passed to all the libvorbisfile functions. -

-

- - - - -
-

-int ov_test_callbacks(void *datasource, OggVorbis_File *vf, char *initial, long ibytes, ov_callbacks callbacks);
-
-
- -

Parameters

-
-
f
-
File pointer to an already opened file -or pipe (it need not be seekable--though this obviously restricts what -can be done with the bitstream).
-
vf
-
A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile -functions. Once this has been called, the same OggVorbis_File -struct should be passed to all the libvorbisfile functions.
-
initial
-
Typically set to NULL. This parameter is useful if some data has already been -read from the file and the stream is not seekable. It is used in conjunction with ibytes. In this case, initial -should be a pointer to a buffer containing the data read.
-
ibytes
-
Typically set to 0. This parameter is useful if some data has already been -read from the file and the stream is not seekable. In this case, ibytes -should contain the length (in bytes) of the buffer. Used together with initial.
-
callbacks
-
A completed ov_callbacks struct which indicates desired custom file manipulation routines. vorbisfile.h defines several preprovided callback sets; see ov_callbacks for details.
-
- - -

Return Values

-
-
  • 0 for success
    • -
  • less than zero for failure:
    • - -
    -

    - -

    Notes

    -
    - -
    [a] Windows and use as an ov_test() substitute

    Windows -applications should not use ov_test() due -to the likelihood of CRT linking -mismatches and runtime protection faults -[ov_open:a]. ov_test_callbacks() is a safe substitute; specifically: - -

    ov_test_callbacks(f, vf, initial, ibytes, OV_CALLBACKS_DEFAULT);
-
    - -... provides exactly the same functionality as ov_test() but will always work correctly under -Windows, regardless of linking setup details.

    - -

    - -

    -
    - - - - - - - - -

    copyright © 2000-2010 Xiph.Org

    Ogg Vorbis

    Vorbisfile documentation

    vorbisfile version 1.3.2 - 20101101

    - - - - -- cgit v1.1