aghfp_8h.html

BlueLab3 bluetooth API 说明文档

<dl class="el"><dd class="mdescRight">Initialise an instance of the AGHFP library.  <a href="#a97"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a98">AghfpSlcConnect</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, const <a class="el" href="structbdaddr.html">bdaddr</a> *bd_addr)
<dl class="el"><dd class="mdescRight">Initiate the creation of a Service Level Connection.  <a href="#a98"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a99">AghfpSlcConnectResponse</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a9">bool</a> response, const <a class="el" href="structbdaddr.html">bdaddr</a> *bd_addr)
<dl class="el"><dd class="mdescRight">Respond to an AGHFP_SLC_CONNECT_IND message from the HF.  <a href="#a99"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a100">AghfpSlcDisconnect</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<dl class="el"><dd class="mdescRight">Initiate the disconnection of an Service Level Connection for a particular profile instance (aghfp).  <a href="#a100"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a101">AghfpAudioTransferConnection</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a148">aghfp_audio_transfer_direction</a> direction, <a class="el" href="connection_8h.html#a324">sync_pkt_type</a> packet_type, const <a class="el" href="structaghfp__audio__params.html">aghfp_audio_params</a> *audio_params)
<dl class="el"><dd class="mdescRight">Transfer the audio connection either from the AG to the HF/HS or vice versa.  <a href="#a101"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a102">AghfpAudioConnect</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="connection_8h.html#a324">sync_pkt_type</a> packet_type, const <a class="el" href="structaghfp__audio__params.html">aghfp_audio_params</a> *audio_params)
<dl class="el"><dd class="mdescRight">Request a SCO/eSCO connection.  <a href="#a102"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a103">AghfpAudioConnectResponse</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a9">bool</a> response, <a class="el" href="connection_8h.html#a324">sync_pkt_type</a> packet_type, const <a class="el" href="structaghfp__audio__params.html">aghfp_audio_params</a> *audio_params)
<dl class="el"><dd class="mdescRight">Respond to a request for a SCO/eSCO connection.  <a href="#a103"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a104">AghfpAudioDisconnect</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<dl class="el"><dd class="mdescRight">Shutdown a SCO/eSCO connection.  <a href="#a104"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a105">AghfpSendServiceIndicator</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a149">aghfp_service_availability</a> availability)
<dl class="el"><dd class="mdescRight">Send a service indicator to the HF.  <a href="#a105"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a106">AghfpSendCallIndicator</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a150">aghfp_call_status</a> status)
<dl class="el"><dd class="mdescRight">Send a call indicator to the HF.  <a href="#a106"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a107">AghfpSendCallSetupIndicator</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a151">aghfp_call_setup_status</a> status)
<dl class="el"><dd class="mdescRight">Send a call setup indicator to the HF.  <a href="#a107"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a108">AghfpSendCallHeldIndicator</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a152">aghfp_call_held_status</a> status)
<dl class="el"><dd class="mdescRight">Send a call held indicator to the HF.  <a href="#a108"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a109">AghfpSendSignalIndicator</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> level)
<dl class="el"><dd class="mdescRight">Send a signal strength indicator to the HF.  <a href="#a109"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a110">AghfpSendRoamIndicator</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a153">aghfp_roam_status</a> status)
<dl class="el"><dd class="mdescRight">Send a roaming status indicator to the HF.  <a href="#a110"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a111">AghfpSendBattChgIndicator</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> level)
<dl class="el"><dd class="mdescRight">Send a battery charge indicator to the HF.  <a href="#a111"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a112">AghfpSendRingAlert</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<dl class="el"><dd class="mdescRight">Send a ring alert to the HF.  <a href="#a112"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a113">AghfpSendCallerId</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a8">uint8</a> type_number, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_number, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *number, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_string, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *string)
<dl class="el"><dd class="mdescRight">Send caller ID to the HF.  <a href="#a113"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a114">AghfpInBandRingToneEnable</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a9">bool</a> enable)
<dl class="el"><dd class="mdescRight">Tell the HF that inband ring tones have been enabled/disabled.  <a href="#a114"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a115">AghfpSendCallWaitingNotification</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a8">uint8</a> type_number, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_number, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *number, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_string, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *string)
<dl class="el"><dd class="mdescRight">Tell the HF that there is a call waiting, while this is already an incoming call.  <a href="#a115"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a116">AghfpVoiceRecognitionEnable</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a9">bool</a> enable)
<dl class="el"><dd class="mdescRight">Tell the HF to activate/deactivate its voice recognition function.  <a href="#a116"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a117">AghfpSendPhoneNumberForVoiceTag</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_number, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *number)
<dl class="el"><dd class="mdescRight">Send a phone number to the HF in response to a AT+BNIP request.  <a href="#a117"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a118">AghfpSetRemoteMicrophoneGain</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a8">uint8</a> gain)
<dl class="el"><dd class="mdescRight">Set microphone gain on the HF.  <a href="#a118"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a119">AghfpSetRemoteSpeakerVolume</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a8">uint8</a> volume)
<dl class="el"><dd class="mdescRight">Set speaker gain on the HF.  <a href="#a119"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a120">AghfpSendResponseHoldState</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a154">aghfp_response_hold_state</a> state)
<dl class="el"><dd class="mdescRight">Respond to a response and hold read current status from the HF.  <a href="#a120"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a121">AghfpConfirmResponseHoldState</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a154">aghfp_response_hold_state</a> state)
<dl class="el"><dd class="mdescRight">Respond to a response and hold set command from the HF.  <a href="#a121"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a122">AghfpSendSubscriberNumber</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="structaghfp__subscriber__info.html">aghfp_subscriber_info</a> *sub)
<li>void <a class="el" href="aghfp_8h.html#a123">AghfpSendSubscriberNumbersComplete</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<li>void <a class="el" href="aghfp_8h.html#a124">AghfpSendCurrentCall</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="structaghfp__call__info.html">aghfp_call_info</a> *call)
<li>void <a class="el" href="aghfp_8h.html#a125">AghfpSendCurrentCallsComplete</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<li>void <a class="el" href="aghfp_8h.html#a126">AghfpSendNetworkOperator</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a8">uint8</a> mode, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_operator, <a class="el" href="csrtypes_8h.html#a8">uint8</a> *operator)
<li>void <a class="el" href="aghfp_8h.html#a127">AghfpSendUserSpecificData</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_data, <a class="el" href="csrtypes_8h.html#a8">uint8</a> *data)
<dl class="el"><dd class="mdescRight">Allow the client to send an arbitrary string to the remote end.  <a href="#a127"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a128">AghfpSendError</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<dl class="el"><dd class="mdescRight">Send <br>
 to the remote end.  <a href="#a128"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a129">AghfpSendOk</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<dl class="el"><dd class="mdescRight">Send <br>
 to the remote end.  <a href="#a129"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a130">AghfpSetServiceState</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a9">bool</a> service_state)
<dl class="el"><dd class="mdescRight">Set the current network service availability.  <a href="#a130"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a131">AghfpSetCallerIdDetails</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a8">uint8</a> type_number, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_number, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *number, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_string, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *string)
<dl class="el"><dd class="mdescRight">Sets caller id details for +CLIP notifications.  <a href="#a131"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a132">AghfpSetRingRepeatInterval</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> interval)
<dl class="el"><dd class="mdescRight">Configure the time interval between repeating RING indications.  <a href="#a132"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a133">AghfpCallCreate</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a160">aghfp_call_type</a> call_type, <a class="el" href="csrtypes_8h.html#a9">bool</a> in_band)
<dl class="el"><dd class="mdescRight">Initiate/transfer a call to a HS/HF device using an existing audio connection.  <a href="#a133"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a134">AghfpCallCreateAudio</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="aghfp_8h.html#a160">aghfp_call_type</a> call_type, <a class="el" href="csrtypes_8h.html#a9">bool</a> in_band, <a class="el" href="connection_8h.html#a324">sync_pkt_type</a> packet_type, const <a class="el" href="structaghfp__audio__params.html">aghfp_audio_params</a> *audio_params)
<dl class="el"><dd class="mdescRight">Initiate/transfer a call to a HS/HF device and setup an audio connection.  <a href="#a134"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a135">AghfpCallAnswer</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<dl class="el"><dd class="mdescRight">Enables AG to answer a call.  <a href="#a135"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a136">AghfpCallRemoteAnswered</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp)
<dl class="el"><dd class="mdescRight">Informs Call Manager that the remote party has answered the outgoing call.  <a href="#a136"></a><br></dl><li>void <a class="el" href="aghfp_8h.html#a137">AghfpCallTerminate</a> (<a class="el" href="aghfp_8h.html#a1">AGHFP</a> *aghfp, <a class="el" href="csrtypes_8h.html#a9">bool</a> keep_sink)
<dl class="el"><dd class="mdescRight">Rejects a call being setup (incoming/outgoing) or terminates an existing call.  <a href="#a137"></a><br></dl></ul>
<h2>Typedefs</h2>
<ul>
<li>typedef __AGHFP <a class="el" href="aghfp_8h.html#a1">AGHFP</a>
<dl class="el"><dd class="mdescRight">The AGHFP profile structure.  <a href="#a1"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Header file for the Audio Gateway Hands Free Profile library. 
<p>
This file documents the Audio Gateway Hands Free Profile library API for BlueLab3.<hr><h2>Define Documentation</h2>
<a class="anchor" name="a0" doxytag="aghfp.h::AGHFP_MESSAGE_BASE" ></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"> #define AGHFP_MESSAGE_BASE&nbsp;&nbsp;&nbsp;0x6300          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Define the types for the upstream messages sent from the Aghfp profile library to the application. 
<p>
    </td>
  </tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="a1" doxytag="aghfp.h::AGHFP" ></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"> typedef struct __AGHFP <a class="el" href="aghfp_8h.html#a1">AGHFP</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The AGHFP profile structure. 
<p>
    </td>
  </tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="a138" doxytag="aghfp.h::aghfp_supported_features" ></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="aghfp_8h.html#a138">aghfp_supported_features</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<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="a138a2" doxytag="aghfp_three_way_calling" ></a>aghfp_three_way_calling</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a138a3" doxytag="aghfp_nrec_function" ></a>aghfp_nrec_function</em>&nbsp;</td><td>
Device supports three way call control. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a138a4" doxytag="aghfp_voice_recognition" ></a>aghfp_voice_recognition</em>&nbsp;</td><td>
Device implements noise reduction / echo cancellation. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a138a5" doxytag="aghfp_inband_ring" ></a>aghfp_inband_ring</em>&nbsp;</td><td>
Device supports voice recognition. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a138a6" doxytag="aghfp_attach_phone_number" ></a>aghfp_attach_phone_number</em>&nbsp;</td><td>
Device can send inband ring tones. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a138a7" doxytag="aghfp_incoming_call_reject" ></a>aghfp_incoming_call_reject</em>&nbsp;</td><td>
Device can attach a phone number to a voice tag. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a138a8" doxytag="aghfp_enhanced_call_status" ></a>aghfp_enhanced_call_status</em>&nbsp;</td><td>
Device implements incoming call reject. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a138a9" doxytag="aghfp_enhanced_call_control" ></a>aghfp_enhanced_call_control</em>&nbsp;</td><td>
Setting this flag indicates that this device implements enhanced call status. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a138a10" doxytag="aghfp_extended_error_codes" ></a>aghfp_extended_error_codes</em>&nbsp;</td><td>
Setting this flag indicates that this device implements enhanced call control. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a139" doxytag="aghfp.h::aghfp_profile" ></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="aghfp_8h.html#a139">aghfp_profile</a>          </td>
        </tr>
      </table>