a2dp_8h.html

BlueLab3 bluetooth API 说明文档

<tr><td valign=top><em><a class="anchor" name="a46a10" doxytag="a2dp_mpeg_aac" ></a>a2dp_mpeg_aac</em>&nbsp;</td><td>
The SEP supports the MPEG-2,4 AAC codec. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a11" doxytag="a2dp_atrac" ></a>a2dp_atrac</em>&nbsp;</td><td>
The SEP supports a codec from the ATRAC family. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a12" doxytag="a2dp_vendor" ></a>a2dp_vendor</em>&nbsp;</td><td>
The SEP supports a vendor defined codec. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a47" doxytag="a2dp.h::a2dp_channel_mode" ></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="a2dp_8h.html#a47">a2dp_channel_mode</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Audio stream channel mode. 
<p>
The specification defines the following channel modes. The SNK must support all modes. It is mandatory for the SRC to support mono and at least one of the remaining three modes. <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="a47a13" doxytag="a2dp_mono" ></a>a2dp_mono</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a14" doxytag="a2dp_dual_channel" ></a>a2dp_dual_channel</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a15" doxytag="a2dp_stereo" ></a>a2dp_stereo</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a16" doxytag="a2dp_joint_stereo" ></a>a2dp_joint_stereo</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a48" doxytag="a2dp.h::a2dp_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="a2dp_8h.html#a48">a2dp_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 are returned to indicate to the Client application 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="a48a17" doxytag="a2dp_success" ></a>a2dp_success</em>&nbsp;</td><td>
Operation was successful. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a18" doxytag="a2dp_fail" ></a>a2dp_fail</em>&nbsp;</td><td>
Operation failed. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a19" doxytag="a2dp_no_resource" ></a>a2dp_no_resource</em>&nbsp;</td><td>
Not enough resources. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a20" doxytag="a2dp_bad_state" ></a>a2dp_bad_state</em>&nbsp;</td><td>
Request is not supported in the current state. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a21" doxytag="a2dp_timeout" ></a>a2dp_timeout</em>&nbsp;</td><td>
Operation timed out before completion. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a22" doxytag="a2dp_service_caps_error" ></a>a2dp_service_caps_error</em>&nbsp;</td><td>
Service capabilities passed to library are bad or incomplete. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a23" doxytag="a2dp_service_caps_incompatible" ></a>a2dp_service_caps_incompatible</em>&nbsp;</td><td>
Local and remote service capabilities are incompatible. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a24" doxytag="a2dp_rejected_by_remote_device" ></a>a2dp_rejected_by_remote_device</em>&nbsp;</td><td>
Remote device understood but rejected the operation. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a25" doxytag="a2dp_unsupported_feature" ></a>a2dp_unsupported_feature</em>&nbsp;</td><td>
Remote device does not support the requested operation. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a26" doxytag="a2dp_unknown_seid" ></a>a2dp_unknown_seid</em>&nbsp;</td><td>
SEID passed to library is unknown. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a27" doxytag="a2dp_closed_by_remote_device" ></a>a2dp_closed_by_remote_device</em>&nbsp;</td><td>
Remote device closed the stream. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a28" doxytag="a2dp_aborted" ></a>a2dp_aborted</em>&nbsp;</td><td>
Local or remote abort due to signalling breakdown. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a29" doxytag="a2dp_device_not_connected" ></a>a2dp_device_not_connected</em>&nbsp;</td><td>
Device specified is not connected. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a30" doxytag="a2dp_busy" ></a>a2dp_busy</em>&nbsp;</td><td>
The operation is already in progress. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a31" doxytag="a2dp_disconnect_link_loss" ></a>a2dp_disconnect_link_loss</em>&nbsp;</td><td>
Connection disconnected due to link loss. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a32" doxytag="a2dp_unhandled_error" ></a>a2dp_unhandled_error</em>&nbsp;</td><td>
The A2DP library has received an unrecognised error from the GAVDP library. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a33" doxytag="a2dp_unsupported_codec" ></a>a2dp_unsupported_codec</em>&nbsp;</td><td>
The requested codec does not have a decode DSP file in the file system. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a48a34" doxytag="a2dp_unsupported_sep_role" ></a>a2dp_unsupported_sep_role</em>&nbsp;</td><td>
The requested sep role is unknown/ unsupported. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a35" doxytag="a2dp.h::A2dpInit" ></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 A2dpInit           </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>theAppTask</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="structa2dp__init__params.html">a2dp_init_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>
Initialise the A2DP library. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>theAppTask</em>&nbsp;</td><td>The current application task. </td></tr>
    <tr><td></td><td valign=top><em>config</em>&nbsp;</td><td>A2DP configuration parameters.</td></tr>
  </table>
</dl>
This will initialise an A2DP library and the underlying GAVDP library depending upon the role specified within the Configuration parameters. A stream endpoint as described in the configuration will be added to the local database. This function also takes care of registering a service record for an A2DP device.<p>
A2DP_INIT_CFM message will be received indicating the result of the request to initialise the library.<p>
No further library functions should be called until the A2DP_INIT_CFM message has been received.<p>
The Class of Device is not configured within the A2DP library, this is left to the application. This is because only the application has device wide knowledge.     </td>
  </tr>
</table>
<a class="anchor" name="a36" doxytag="a2dp.h::A2dpAddSep" ></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 A2dpAddSep           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="a2dp_8h.html#a2">A2DP</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>a2dp</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="structa2dp__sep__config.html">a2dp_sep_config</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>
Add a Stream Endpoint to the local database. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>a2dp</em>&nbsp;</td><td>The profile instance which will be used. </td></tr>
    <tr><td></td><td valign=top><em>config</em>&nbsp;</td><td>The SEP configuration properties and the service capability parameters are parsed and recorded. Providing there are resources to store the configuration parameters and the service capabilities are valid an A2DP_ADD_SEP_CFM will be sent to the specified task with a successful status code. </td></tr>
    <tr><td></td><td valign=top><em>codec</em>&nbsp;</td><td>Specifies the codec type for the SEP being registered. The A2DP library will check if it has a DSP decoder file for this codec and if it does not have one it will return an error to the application otherwise it will proceed with registering the SEP.</td></tr>
  </table>
</dl>
A2DP_ADD_SEP_CFM message will be received by the application.     </td>
  </tr>
</table>
<a class="anchor" name="a37" doxytag="a2dp.h::A2dpOpen" ></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 A2dpOpen           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="a2dp_8h.html#a2">A2DP</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>a2dp</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="a2dp_8h.html#a46">a2dp_sep_type</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>sep_type</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="structbdaddr.html">bdaddr</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>bd_addr</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>
Call to initiate a media connection from a local SEP to a remote device. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>a2dp</em>&nbsp;</td><td>The profile instance which will be used. </td></tr>
    <tr><td></td><td valign=top><em>sep_type</em>&nbsp;</td><td>The SEP type we wish to use for this AV connection. Must be one of the SEPs previously registered. </td></tr>
    <tr><td></td><td valign=top><em>bd_addr</em>&nbsp;</td><td>The Bluetooth address of the remote device.</td></tr>
  </table>
</dl>
A2DP_OPEN_CFM message will be received by the application.     </td>
  </tr>
</table>
<a class="anchor" name="a38" doxytag="a2dp.h::A2dpClose" ></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 A2dpClose           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="a2dp_8h.html#a2">A2DP</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>a2dp</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>media_sink</em></td>
        </tr>
        <tr>
          <td></td>