📄 codec___8h.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>BlueLab: codec_.h File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>codec_.h File Reference</h1>Control the gain on the audio CODEC. <a href="#_details">More...</a><p><h2>Functions</h2><ul><li><a class="el" href="csrtypes_8h.html#a4">uint16</a> <a class="el" href="codec___8h.html#a0">CodecInputGainRange</a> (void)<dl class="el"><dd class="mdescRight">Returns the range of valid values that CodecSetInputGainX can use. <a href="#a0"></a><br></dl><li><a class="el" href="csrtypes_8h.html#a4">uint16</a> <a class="el" href="codec___8h.html#a1">CodecOutputGainRange</a> (void)<dl class="el"><dd class="mdescRight">Returns the range of valid values that CodecSetOutputGainX can use. <a href="#a1"></a><br></dl><li>void <a class="el" href="codec___8h.html#a2">CodecSetOutputGainA</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a>)<dl class="el"><dd class="mdescRight">Sets the output gain on channel A. <a href="#a2"></a><br></dl><li>void <a class="el" href="codec___8h.html#a3">CodecSetOutputGainB</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a>)<dl class="el"><dd class="mdescRight">Sets the output gain on channel B (if present). <a href="#a3"></a><br></dl><li>void <a class="el" href="codec___8h.html#a4">CodecSetInputGainA</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a>)<dl class="el"><dd class="mdescRight">Sets the input gain on channel A. <a href="#a4"></a><br></dl><li>void <a class="el" href="codec___8h.html#a5">CodecSetInputGainB</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a>)<dl class="el"><dd class="mdescRight">Sets the input gain on channel B (if present). <a href="#a5"></a><br></dl><li>void <a class="el" href="codec___8h.html#a6">CodecSetSideToneGain</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> gain)<dl class="el"><dd class="mdescRight">Set the side tone gain. <a href="#a6"></a><br></dl><li>void <a class="el" href="codec___8h.html#a7">CodecSetRawInputGainA</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> analogue, <a class="el" href="csrtypes_8h.html#a4">uint16</a> digital)<dl class="el"><dd class="mdescRight">Sets the raw analogue and digital input gains for the codec. <a href="#a7"></a><br></dl><li>void <a class="el" href="codec___8h.html#a8">CodecSetRawInputGainB</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> analogue, <a class="el" href="csrtypes_8h.html#a4">uint16</a> digital)<dl class="el"><dd class="mdescRight">Sets the raw analogue and digital input gains for the codec channel B if present. <a href="#a8"></a><br></dl><li>void <a class="el" href="codec___8h.html#a9">CodecSetRawOutputGainA</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> analogue, <a class="el" href="csrtypes_8h.html#a4">uint16</a> digital)<dl class="el"><dd class="mdescRight">Sets the raw analogue and digital output gains for the codec. <a href="#a9"></a><br></dl><li>void <a class="el" href="codec___8h.html#a10">CodecSetRawOutputGainB</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> analogue, <a class="el" href="csrtypes_8h.html#a4">uint16</a> digital)<dl class="el"><dd class="mdescRight">Sets the raw analogue and digital output gains for the codec channel B if present. <a href="#a10"></a><br></dl><li>void <a class="el" href="codec___8h.html#a11">CodecEnableMicInputGainA</a> (<a class="el" href="csrtypes_8h.html#a9">bool</a> enable)<dl class="el"><dd class="mdescRight">Enables additional input gain. <a href="#a11"></a><br></dl><li>void <a class="el" href="codec___8h.html#a12">CodecEnableMicInputGainB</a> (<a class="el" href="csrtypes_8h.html#a9">bool</a> enable)<dl class="el"><dd class="mdescRight">Enables additional gain on input channel B if present. <a href="#a12"></a><br></dl><li>void <a class="el" href="codec___8h.html#a13">CodecOutputStageAEnableLowPower</a> (<a class="el" href="csrtypes_8h.html#a9">bool</a> enable)<dl class="el"><dd class="mdescRight">Enables or disables low power mode for the codec channel A output stage. <a href="#a13"></a><br></dl><li>void <a class="el" href="codec___8h.html#a14">CodecOutputStageBEnableLowPower</a> (<a class="el" href="csrtypes_8h.html#a9">bool</a> enable)<dl class="el"><dd class="mdescRight">Enables or disables low power mode for the codec channel B output stage. <a href="#a14"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Control the gain on the audio CODEC. <p>Legal values for CodecSetInputGainX are from 0 up to, and not including, the value returned by CodecInputGainRange<p>Legal values for CodecSetOutputGainX are from 0 up to, and not including, the value returned by CodecOutputGainRange<p>If a device has an internal stereo codec then A and B are the left and right channels respectively.<p>If a device has an internal mono codec then A controls it, and B is ignored.<p>If a device has no internal codec then the output gain uses A and the input gain is ignored.<hr><h2>Function Documentation</h2><a class="anchor" name="a0" doxytag="codec_.h::CodecInputGainRange" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> CodecInputGainRange </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Returns the range of valid values that CodecSetInputGainX can use. <p> </td> </tr></table><a class="anchor" name="a1" doxytag="codec_.h::CodecOutputGainRange" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> CodecOutputGainRange </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Returns the range of valid values that CodecSetOutputGainX can use. <p> </td> </tr></table><a class="anchor" name="a2" doxytag="codec_.h::CodecSetOutputGainA" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void CodecSetOutputGainA </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Sets the output gain on channel A. <p> </td> </tr></table><a class="anchor" name="a3" doxytag="codec_.h::CodecSetOutputGainB" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void CodecSetOutputGainB </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Sets the output gain on channel B (if present). <p> </td> </tr></table><a class="anchor" name="a4" doxytag="codec_.h::CodecSetInputGainA" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void CodecSetInputGainA </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Sets the input gain on channel A. <p> </td> </tr></table><a class="anchor" name="a5" doxytag="codec_.h::CodecSetInputGainB" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void CodecSetInputGainB </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Sets the input gain on channel B (if present). <p> </td> </tr></table><a class="anchor" name="a6" doxytag="codec_.h::CodecSetSideToneGain" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void CodecSetSideToneGain </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname1" valign="top" nowrap> <em>gain</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Set the side tone gain. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>gain</em> </td><td>The gain to use.</td></tr> </table></dl>The side-tone hardware is only present on certain BlueCore variants.<p>Valid gain values are from 0 to 7.<p>For BlueCore4-headset the gain values are mapped as follows.<p>gain dB 0 -32.6 1 -30.1 2 -26.6 3 -24.1 4 -20.6 5 -18.1 6 -14.5 7 -12.0 </td> </tr></table><a class="anchor" name="a7" doxytag="codec_.h::CodecSetRawInputGainA" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void CodecSetRawInputGainA </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname" nowrap> <em>analogue</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname" nowrap> <em>digital</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Sets the raw analogue and digital input gains for the codec. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -