Whole document tree
    

Whole document tree

vorbisfile - function - ov_serialnumber

vorbisfile documentation

vorbisfile version 1.25 - 20000615

ov_serialnumber

declared in "vorbis/vorbisfile.h";

Returns the serialnumber of the specified logical bitstream.


long ov_serialnumber(OggVorbis_File *vf,int i);

Parameters

vf
A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile functions. Once this has been called, the same OggVorbis_File struct should be passed to all the vorbisfile functions.
i
Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the vorbis_info struct for the current bitstream, this parameter should be set to -1.

Return Values

  • -1 if the specified logical bitstream i does not exist.
  • Returns the serial number of the logical bitstream i or the serial number of the current bitstream if the file is nonseekable.



  • copyright © 2000 vorbis team

    Ogg Vorbis
    team@vorbis.org

    vorbisfile documentation

    vorbisfile version 1.25 - 20000615