[xiph-commits] r18098 - websites/opus-codec.org/docs/html_api
jm at svn.xiph.org
jm at svn.xiph.org
Thu Sep 22 20:09:50 PDT 2011
Author: jm
Date: 2011-09-22 20:09:50 -0700 (Thu, 22 Sep 2011)
New Revision: 18098
Added:
websites/opus-codec.org/docs/html_api/group__ctlvalues.html
Log:
forgot to add that one
Added: websites/opus-codec.org/docs/html_api/group__ctlvalues.html
===================================================================
--- websites/opus-codec.org/docs/html_api/group__ctlvalues.html (rev 0)
+++ websites/opus-codec.org/docs/html_api/group__ctlvalues.html 2011-09-23 03:09:50 UTC (rev 18098)
@@ -0,0 +1,291 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Opus: Pre-defined values for CTL interface</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body onload='searchBox.OnSelectItem(0);'>
+<!-- Generated by Doxygen 1.7.4 -->
+<script type="text/javascript"><!--
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+--></script>
+<div id="top">
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">Opus <span id="projectnumber">0.9.6-157-g363924e</span></div>
+ <div id="projectbrief">IETFlow-delayaudiocodec</div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li id="searchli">
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+</div>
+<div class="header">
+ <div class="summary">
+<a href="#define-members">Defines</a> </div>
+ <div class="headertitle">
+<div class="title">Pre-defined values for CTL interface</div> </div>
+</div>
+<div class="contents">
+<table class="memberdecls">
+<tr><td colspan="2"><h2><a name="define-members"></a>
+Defines</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga1c5b3244b018ff4548d2d6bffa418472">OPUS_AUTO</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Auto/default setting. <a href="#ga1c5b3244b018ff4548d2d6bffa418472"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#gaeadbaa3b4b9e15d39cd1d6e7d91519e5">OPUS_BITRATE_MAX</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum bitrate. <a href="#gaeadbaa3b4b9e15d39cd1d6e7d91519e5"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga07884aa018303a419d1f7acb2f3fa669">OPUS_APPLICATION_VOIP</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Best for "standard" VoIP/videoconference applications where listening quality and intelligibility matter most. <a href="#ga07884aa018303a419d1f7acb2f3fa669"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga5909f7cb35c04f1110026c6889edd345">OPUS_APPLICATION_AUDIO</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input. <a href="#ga5909f7cb35c04f1110026c6889edd345"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga592232fb39db60c1369989c5c5d19a07">OPUS_APPLICATION_RESTRICTED_LOWDELAY</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Only use when lowest-achievable latency is what matters most. <a href="#ga592232fb39db60c1369989c5c5d19a07"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga085a116fed816373d3b9eae28df49404">OPUS_SIGNAL_VOICE</a>   3001</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal being encoded is voice. <a href="#ga085a116fed816373d3b9eae28df49404"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#gaa0c228c664b6d426f4c213e3a5350889">OPUS_SIGNAL_MUSIC</a>   3002</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal being encoded is music. <a href="#gaa0c228c664b6d426f4c213e3a5350889"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga607dd310958b9c7d545d005e4572d47f">OPUS_BANDWIDTH_NARROWBAND</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">4kHz bandpass <a href="#ga607dd310958b9c7d545d005e4572d47f"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga53a2aff4dc0ee23682927ca568c422a3">OPUS_BANDWIDTH_MEDIUMBAND</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">6kHz bandpass <a href="#ga53a2aff4dc0ee23682927ca568c422a3"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#gac698e5d1281a3632251d2a4ead48afb9">OPUS_BANDWIDTH_WIDEBAND</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">8kHz bandpass <a href="#gac698e5d1281a3632251d2a4ead48afb9"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga41f86df35af0033a7361895da88671c1">OPUS_BANDWIDTH_SUPERWIDEBAND</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">12kHz bandpass <a href="#ga41f86df35af0033a7361895da88671c1"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ctlvalues.html#ga74cb052d8ec36cbcc9708c417558ebdd">OPUS_BANDWIDTH_FULLBAND</a></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">20kHz bandpass <a href="#ga74cb052d8ec36cbcc9708c417558ebdd"></a><br/></td></tr>
+</table>
+<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
+<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__genericctls.html">Generic CTLs</a>,<a class="el" href="group__encoderctls.html">Encoder related CTLs</a> </dd></dl>
+<hr/><h2>Define Documentation</h2>
+<a class="anchor" id="ga5909f7cb35c04f1110026c6889edd345"></a><!-- doxytag: member="opus_defines.h::OPUS_APPLICATION_AUDIO" ref="ga5909f7cb35c04f1110026c6889edd345" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_APPLICATION_AUDIO</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Best for broadcast/high-fidelity application where the decoded audio should be as close as possible to the input. </p>
+
+</div>
+</div>
+<a class="anchor" id="ga592232fb39db60c1369989c5c5d19a07"></a><!-- doxytag: member="opus_defines.h::OPUS_APPLICATION_RESTRICTED_LOWDELAY" ref="ga592232fb39db60c1369989c5c5d19a07" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_APPLICATION_RESTRICTED_LOWDELAY</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Only use when lowest-achievable latency is what matters most. </p>
+<p>Voice-optimized modes cannot be used. </p>
+
+</div>
+</div>
+<a class="anchor" id="ga07884aa018303a419d1f7acb2f3fa669"></a><!-- doxytag: member="opus_defines.h::OPUS_APPLICATION_VOIP" ref="ga07884aa018303a419d1f7acb2f3fa669" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_APPLICATION_VOIP</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Best for "standard" VoIP/videoconference applications where listening quality and intelligibility matter most. </p>
+
+</div>
+</div>
+<a class="anchor" id="ga1c5b3244b018ff4548d2d6bffa418472"></a><!-- doxytag: member="opus_defines.h::OPUS_AUTO" ref="ga1c5b3244b018ff4548d2d6bffa418472" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_AUTO</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Auto/default setting. </p>
+
+</div>
+</div>
+<a class="anchor" id="ga74cb052d8ec36cbcc9708c417558ebdd"></a><!-- doxytag: member="opus_defines.h::OPUS_BANDWIDTH_FULLBAND" ref="ga74cb052d8ec36cbcc9708c417558ebdd" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_BANDWIDTH_FULLBAND</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>20kHz bandpass </p>
+
+</div>
+</div>
+<a class="anchor" id="ga53a2aff4dc0ee23682927ca568c422a3"></a><!-- doxytag: member="opus_defines.h::OPUS_BANDWIDTH_MEDIUMBAND" ref="ga53a2aff4dc0ee23682927ca568c422a3" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_BANDWIDTH_MEDIUMBAND</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>6kHz bandpass </p>
+
+</div>
+</div>
+<a class="anchor" id="ga607dd310958b9c7d545d005e4572d47f"></a><!-- doxytag: member="opus_defines.h::OPUS_BANDWIDTH_NARROWBAND" ref="ga607dd310958b9c7d545d005e4572d47f" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_BANDWIDTH_NARROWBAND</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>4kHz bandpass </p>
+
+</div>
+</div>
+<a class="anchor" id="ga41f86df35af0033a7361895da88671c1"></a><!-- doxytag: member="opus_defines.h::OPUS_BANDWIDTH_SUPERWIDEBAND" ref="ga41f86df35af0033a7361895da88671c1" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_BANDWIDTH_SUPERWIDEBAND</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>12kHz bandpass </p>
+
+</div>
+</div>
+<a class="anchor" id="gac698e5d1281a3632251d2a4ead48afb9"></a><!-- doxytag: member="opus_defines.h::OPUS_BANDWIDTH_WIDEBAND" ref="gac698e5d1281a3632251d2a4ead48afb9" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_BANDWIDTH_WIDEBAND</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>8kHz bandpass </p>
+
+</div>
+</div>
+<a class="anchor" id="gaeadbaa3b4b9e15d39cd1d6e7d91519e5"></a><!-- doxytag: member="opus_defines.h::OPUS_BITRATE_MAX" ref="gaeadbaa3b4b9e15d39cd1d6e7d91519e5" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_BITRATE_MAX</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Maximum bitrate. </p>
+
+</div>
+</div>
+<a class="anchor" id="gaa0c228c664b6d426f4c213e3a5350889"></a><!-- doxytag: member="opus_defines.h::OPUS_SIGNAL_MUSIC" ref="gaa0c228c664b6d426f4c213e3a5350889" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_SIGNAL_MUSIC   3002</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Signal being encoded is music. </p>
+
+</div>
+</div>
+<a class="anchor" id="ga085a116fed816373d3b9eae28df49404"></a><!-- doxytag: member="opus_defines.h::OPUS_SIGNAL_VOICE" ref="ga085a116fed816373d3b9eae28df49404" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define OPUS_SIGNAL_VOICE   3001</td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Signal being encoded is voice. </p>
+
+</div>
+</div>
+</div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Defines</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<hr class="footer"/><address class="footer"><small>Generated on Thu Sep 22 2011 22:12:06 for Opus by 
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
+</body>
+</html>
More information about the commits
mailing list