Chris@1: Chris@1: Chris@1: Chris@1: Vorbisfile - function - ov_bitrate Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

Vorbisfile documentation

vorbisfile version 1.3.2 - 20101101

Chris@1: Chris@1:

ov_bitrate

Chris@1: Chris@1:

declared in "vorbis/vorbisfile.h";

Chris@1: Chris@1:

This function returns the average bitrate for the specified logical bitstream. This may be different from the ov_info->nominal_bitrate value, as it is based on the actual average for this bitstream if the file is seekable. Chris@1:

Nonseekable files will return the nominal bitrate setting or the average of the upper and lower bounds, if any of these values are set. Chris@1:

Chris@1: Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: 

Chris@1: long ov_bitrate(OggVorbis_File *vf,int i);
Chris@1:
Chris@1:
Chris@1: Chris@1:

Parameters

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

Return Values

Chris@1:
Chris@1:
  • OV_EINVAL indicates that an invalid argument value was submitted or that the stream represented by vf is not open.
    • Chris@1:
  • OV_FALSE means the call returned a 'false' status, which in this case most likely indicates that the file is nonseekable and the upper, lower, and nominal bitrates were unset. Chris@1:
  • n indicates the bitrate for the given logical bitstream or the entire Chris@1: physical bitstream. If the file is open for random (seekable) access, it will Chris@1: find the *actual* average bitrate. If the file is streaming (nonseekable), it Chris@1: returns the nominal bitrate (if set) or else the average of the Chris@1: upper/lower bounds (if set).
    • Chris@1:
    Chris@1:

    Chris@1: Chris@1: Chris@1:

    Chris@1:

    Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

    copyright © 2000-2010 Xiph.Org

    Ogg Vorbis

    Vorbisfile documentation

    vorbisfile version 1.3.2 - 20101101

    Chris@1: Chris@1: Chris@1: Chris@1: