oggz_deprecated.h File Reference


Detailed Description

Deprecated interfaces.

Go to the source code of this file.

Defines

#define OGGZ_ERR_USER_STOPPED   OGGZ_ERR_STOP_OK
 DEPRECATED CONSTANT.
#define OGGZ_ERR_READ_STOP_OK   OGGZ_ERR_STOP_OK
 DEPRECATED CONSTANT.
#define OGGZ_ERR_READ_STOP_ERR   OGGZ_ERR_STOP_ERR
 DEPRECATED CONSTANT.

Functions

int oggz_set_metric_linear (OGGZ *oggz, long serialno, ogg_int64_t granule_rate_numerator, ogg_int64_t granule_rate_denominator)
 DEPRECATED FUNCTION This function has been replaced with the more clearly named oggz_set_granulerate().


Define Documentation

#define OGGZ_ERR_READ_STOP_ERR   OGGZ_ERR_STOP_ERR

DEPRECATED CONSTANT.

OGGZ_ERR_READ_STOP_OK, OGGZ_ERR_READ_STOP_ERR were introduced to allow the user to differentiate between a cancelled oggz_read_*() returning due to error or an ok condition. From 0.9.4 similar functionality was added for oggz_write_*(), hence this constant was renamed.

#define OGGZ_ERR_READ_STOP_OK   OGGZ_ERR_STOP_OK

DEPRECATED CONSTANT.

OGGZ_ERR_READ_STOP_OK, OGGZ_ERR_READ_STOP_ERR were introduced to allow the user to differentiate between a cancelled oggz_read_*() returning due to error or an ok condition. From 0.9.4 similar functionality was added for oggz_write_*(), hence this constant was renamed.

#define OGGZ_ERR_USER_STOPPED   OGGZ_ERR_STOP_OK

DEPRECATED CONSTANT.

OGGZ_ERR_USER_STOPPED was introduced during development (post 0.8.3), and is similar in functionality to and numerically equal to (ie. ABI compatible with) OGGZ_ERR_STOP_OK in <oggz/oggz_constants.h>. It was badly named, as the preferred functionality distinguishes between a user's OggzReadCallback returning OGGZ_STOP_OK or OGGZ_STOP_ERR; your code should distinguish between these two too :-) Hence, don't use this (unreleased) name in new code.


Function Documentation

int oggz_set_metric_linear ( OGGZ oggz,
long  serialno,
ogg_int64_t  granule_rate_numerator,
ogg_int64_t  granule_rate_denominator 
)

DEPRECATED FUNCTION This function has been replaced with the more clearly named oggz_set_granulerate().

Specify that a logical bitstream has a linear metric

Parameters:
oggz An OGGZ handle
serialno Identify the logical bitstream in oggz to attach this linear metric to. A value of -1 indicates that the metric should be attached to all unattached logical bitstreams in oggz.
granule_rate_numerator The numerator of the granule rate
granule_rate_denominator The denominator of the granule rate
Returns:
0 Success
Return values:
OGGZ_ERR_BAD_SERIALNO serialno does not identify an existing logical bitstream in oggz.
OGGZ_ERR_BAD_OGGZ oggz does not refer to an existing OGGZ


Generated on Sun Jan 13 14:14:03 2008 for liboggz by  doxygen 1.5.1