codec_8h.html

BlueLab3 bluetooth API 说明文档

    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> enum <a class="el" href="codec_8h.html#a45">codec_channel</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The codecs channel being referred to, left, right or both. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a45a9" doxytag="left_ch" ></a>left_ch</em>&nbsp;</td><td>
The left channel of the codec. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a45a10" doxytag="right_ch" ></a>right_ch</em>&nbsp;</td><td>
The right channel of the codec. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a45a11" doxytag="left_and_right_ch" ></a>left_and_right_ch</em>&nbsp;</td><td>
The left and right channel of the codec. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a46" doxytag="codec.h::codec_status_code" ></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"> enum <a class="el" href="codec_8h.html#a46">codec_status_code</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The status codes returned to the client application to indicate the status of a requested operation. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a46a12" doxytag="codec_success" ></a>codec_success</em>&nbsp;</td><td>
The requested codec operation was a success. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a13" doxytag="codec_fail" ></a>codec_fail</em>&nbsp;</td><td>
The requested codec operation was a failure. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a14" doxytag="codec_invalid_sample_rates" ></a>codec_invalid_sample_rates</em>&nbsp;</td><td>
The requested operation supplied invalid sample rates for this codec. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a15" doxytag="codec_invalid_configuration" ></a>codec_invalid_configuration</em>&nbsp;</td><td>
The requested operation supplied an invalid configuration. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a16" doxytag="codec_not_supported" ></a>codec_not_supported</em>&nbsp;</td><td>
The requested operation was not supported for this codec. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a47" doxytag="codec.h::codec_type" ></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"> enum <a class="el" href="codec_8h.html#a47">codec_type</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The codec being used. 
<p>
Returned to the client application on initialisation of the codec library. <dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a47a17" doxytag="codec_none" ></a>codec_none</em>&nbsp;</td><td>
The type of codec is not specified. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a18" doxytag="codec_wm8731" ></a>codec_wm8731</em>&nbsp;</td><td>
The codec is the Wolfson Wm8731. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a19" doxytag="codec_csr_internal" ></a>codec_csr_internal</em>&nbsp;</td><td>
The codec is the CSR internal. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a48" doxytag="codec.h::sample_freq" ></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"> enum <a class="el" href="codec_8h.html#a48">sample_freq</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The possible sample rates that the ADCs and DACs can be configured to. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a48a20" doxytag="sample8kHz" ></a>sample8kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a21" doxytag="sample11_025kHz" ></a>sample11_025kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a22" doxytag="sample16kHz" ></a>sample16kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a23" doxytag="sample22_25kHz" ></a>sample22_25kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a24" doxytag="sample24kHz" ></a>sample24kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a25" doxytag="sample32kHz" ></a>sample32kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a26" doxytag="sample44_1kHz" ></a>sample44_1kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a27" doxytag="sample48kHz" ></a>sample48kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a28" doxytag="sample88_2kHz" ></a>sample88_2kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a29" doxytag="sample96kHz" ></a>sample96kHz</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a30" doxytag="sampleNotUsed" ></a>sampleNotUsed</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a49" doxytag="codec.h::input_type" ></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"> enum <a class="el" href="codec_8h.html#a49">input_type</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Type of input to the codec ADCs that will be used. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a49a31" doxytag="mic_input" ></a>mic_input</em>&nbsp;</td><td>
The input to the codec is microphone. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a49a32" doxytag="line_input" ></a>line_input</em>&nbsp;</td><td>
The input to the codec is line. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a49a33" doxytag="no_input" ></a>no_input</em>&nbsp;</td><td>
No input to the codec. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a34" doxytag="codec.h::CodecInitWolfson" ></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 CodecInitWolfson           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>appTask</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="structwolfson__init__params.html">wolfson_init_params</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>init</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initialise the Wolfson Codec. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>appTask</em>&nbsp;</td><td>The current application task. </td></tr>
    <tr><td></td><td valign=top><em>init</em>&nbsp;</td><td>The initialisation parameters to setup the codec with.</td></tr>
  </table>
</dl>
CODEC_INIT_CFM message will be received by the application.     </td>
  </tr>
</table>
<a class="anchor" name="a35" doxytag="codec.h::CodecInitCsrInternal" ></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 CodecInitCsrInternal           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>appTask</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initialise the CSR Internal Codec. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>appTask</em>&nbsp;</td><td>The current application task.</td></tr>
  </table>
</dl>
CODEC_INIT_CFM message will be received by the application.     </td>
  </tr>
</table>
<a class="anchor" name="a36" doxytag="codec.h::CodecConfigure" ></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 CodecConfigure           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>codecTask</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="structcodec__config__params.html">codec_config_params</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>config</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Configure the Codec with the supplied parameters. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>codecTask</em>&nbsp;</td><td>The codec task that was returned with the CODEC_INIT_CFM message.</td></tr>
    <tr><td></td><td valign=top><em>config</em>&nbsp;</td><td>The configuration parameters to setup the codec with.</td></tr>
  </table>
</dl>
CODEC_CONFIGURE_CFM message will be received by the application.     </td>
  </tr>
</table>