Vorbisfile documentation

vorbisfile version 1.2.0 - 20070723

ov_comment

declared in "vorbis/vorbisfile.h";

Returns a pointer to the vorbis_comment struct for the specified bitstream. For nonseekable streams, returns the struct for the current bitstream.




vorbis_comment *ov_comment(OggVorbis_File *vf,int link);

Parameters

vf
A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile functions.
i
Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the vorbis_comment struct for the current bitstream, this parameter should be set to -1.

Return Values

  • Returns the vorbis_comment struct for the specified bitstream.
  • NULL if the specified bitstream does not exist or the file has been initialized improperly.



  • copyright © 2007 Xiph.org

    Ogg Vorbis

    Vorbisfile documentation

    vorbisfile version 1.2.0 - 20070723