<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>liboggz: oggz_deprecated.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>oggz_deprecated.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Deprecated interfaces.
<p>
<p>
<p>
<a href="oggz__deprecated_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#aa24ef96507165b2c5e1ac4108d59288">OGGZ_ERR_USER_STOPPED</a> OGGZ_ERR_STOP_OK</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED CONSTANT. <a href="#aa24ef96507165b2c5e1ac4108d59288"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#0d9b4d212038e72fb45d751fe750d3cf">OGGZ_ERR_READ_STOP_OK</a> OGGZ_ERR_STOP_OK</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED CONSTANT. <a href="#0d9b4d212038e72fb45d751fe750d3cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#7fb3e5030a672e6ecfd8e8e6bf57fdfa">OGGZ_ERR_READ_STOP_ERR</a> OGGZ_ERR_STOP_ERR</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED CONSTANT. <a href="#7fb3e5030a672e6ecfd8e8e6bf57fdfa"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#12f232bca448853e66a1226ddccff7e0">oggz_set_metric_linear</a> (<a class="el" href="oggz_8h.html#672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, ogg_int64_t granule_rate_numerator, ogg_int64_t granule_rate_denominator)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED FUNCTION This function has been replaced with the more clearly named <a class="el" href="group__metric.html#ga2a86ec590161bc2295a2c8e91cefa49" title="Specify the granulerate of a logical bitstream.">oggz_set_granulerate()</a>. <a href="#12f232bca448853e66a1226ddccff7e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ogg_packet * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__deprecated_8h.html#ab908fe161372aceb99f98a3be54ead5">oggz_comment_generate</a> (<a class="el" href="oggz_8h.html#672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, long serialno, <a class="el" href="oggz__constants_8h.html#b20058e3d54fc5540aa719a99e1e9598">OggzStreamContent</a> packet_type, int FLAC_final_metadata_block)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED FUNCTION This function has been replaced with <a class="el" href="oggz__comments_8h.html#1ee69481fa517d80e63db962a23d53ae" title="Output a comment packet for the specified stream.">oggz_comments_generate()</a>, which does not require the packet_type argument. <a href="#ab908fe161372aceb99f98a3be54ead5"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="7fb3e5030a672e6ecfd8e8e6bf57fdfa"></a><!-- doxytag: member="oggz_deprecated.h::OGGZ_ERR_READ_STOP_ERR" ref="7fb3e5030a672e6ecfd8e8e6bf57fdfa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OGGZ_ERR_READ_STOP_ERR OGGZ_ERR_STOP_ERR </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
DEPRECATED CONSTANT.
<p>
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.
</div>
</div><p>
<a class="anchor" name="0d9b4d212038e72fb45d751fe750d3cf"></a><!-- doxytag: member="oggz_deprecated.h::OGGZ_ERR_READ_STOP_OK" ref="0d9b4d212038e72fb45d751fe750d3cf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OGGZ_ERR_READ_STOP_OK OGGZ_ERR_STOP_OK </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
DEPRECATED CONSTANT.
<p>
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.
</div>
</div><p>
<a class="anchor" name="aa24ef96507165b2c5e1ac4108d59288"></a><!-- doxytag: member="oggz_deprecated.h::OGGZ_ERR_USER_STOPPED" ref="aa24ef96507165b2c5e1ac4108d59288" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OGGZ_ERR_USER_STOPPED OGGZ_ERR_STOP_OK </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
DEPRECATED CONSTANT.
<p>
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 <<a class="el" href="oggz__constants_8h.html" title="General constants used by liboggz.">oggz/oggz_constants.h</a>>. 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.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ab908fe161372aceb99f98a3be54ead5"></a><!-- doxytag: member="oggz_deprecated.h::oggz_comment_generate" ref="ab908fe161372aceb99f98a3be54ead5" args="(OGGZ *oggz, long serialno, OggzStreamContent packet_type, int FLAC_final_metadata_block)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ogg_packet* oggz_comment_generate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>serialno</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="oggz__constants_8h.html#b20058e3d54fc5540aa719a99e1e9598">OggzStreamContent</a> </td>
<td class="paramname"> <em>packet_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>FLAC_final_metadata_block</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
DEPRECATED FUNCTION This function has been replaced with <a class="el" href="oggz__comments_8h.html#1ee69481fa517d80e63db962a23d53ae" title="Output a comment packet for the specified stream.">oggz_comments_generate()</a>, which does not require the packet_type argument.
<p>
Instead, the packet type is determined by the content type of the stream, which was discovered when the bos packet was passed to oggz_write_feed.<p>
Output a comment packet for the specified stream. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>A OGGZ* handle (created with OGGZ_WRITE) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identify a logical bitstream within <em>oggz</em> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>packet_type</em> </td><td>Type of comment packet to generate, FLAC, OggPCM, Speex, Theora and Vorbis are supported </td></tr>
<tr><td valign="top"></td><td valign="top"><em>FLAC_final_metadata_block</em> </td><td>Set this to zero unless the packet_type is FLAC, and there are no further metadata blocks to follow. See note below for details. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A comment packet for the stream. When no longer needed it should be freed with <a class="el" href="oggz__comments_8h.html#9301332e99b0397cff54c3593595b809" title="Free a packet and its payload.">oggz_packet_destroy()</a>. </dd></dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>NULL</em> </td><td>content type does not support comments, not enough memory or comment was too long for FLAC </td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>FLAC streams may contain multiple metadata blocks of different types. When encapsulated in Ogg the first of these must be a Vorbis comment packet but PADDING, APPLICATION, SEEKTABLE, CUESHEET and PICTURE may follow. The last metadata block must have its first bit set to 1. Since liboggz does not know whether you will supply more metadata blocks you must tell it if this is the last (or only) metadata block by setting FLAC_final_metadata_block to 1. <br>
As FLAC metadata blocks are limited in size to 16MB minus 1 byte, this function will refuse to produce longer comment packets for FLAC. <br>
See <a href="http://flac.sourceforge.net/format.html">http://flac.sourceforge.net/format.html</a> for more details. </dd></dl>
</div>
</div><p>
<a class="anchor" name="12f232bca448853e66a1226ddccff7e0"></a><!-- doxytag: member="oggz_deprecated.h::oggz_set_metric_linear" ref="12f232bca448853e66a1226ddccff7e0" args="(OGGZ *oggz, long serialno, ogg_int64_t granule_rate_numerator, ogg_int64_t granule_rate_denominator)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_set_metric_linear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>serialno</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_int64_t </td>
<td class="paramname"> <em>granule_rate_numerator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ogg_int64_t </td>
<td class="paramname"> <em>granule_rate_denominator</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
DEPRECATED FUNCTION This function has been replaced with the more clearly named <a class="el" href="group__metric.html#ga2a86ec590161bc2295a2c8e91cefa49" title="Specify the granulerate of a logical bitstream.">oggz_set_granulerate()</a>.
<p>
Specify that a logical bitstream has a linear metric <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serialno</em> </td><td>Identify the logical bitstream in <em>oggz</em> to attach this linear metric to. A value of -1 indicates that the metric should be attached to all unattached logical bitstreams in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>granule_rate_numerator</em> </td><td>The numerator of the granule rate </td></tr>
<tr><td valign="top"></td><td valign="top"><em>granule_rate_denominator</em> </td><td>The denominator of the granule rate </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 Success </dd></dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_SERIALNO</em> </td><td><em>serialno</em> does not identify an existing logical bitstream in <em>oggz</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
</table>
</dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 15 08:06:11 2009 for liboggz by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
2946d6d651bbdb069ce8220554506190
>
files
>
51
