hfp_8h.html

BlueLab3 bluetooth API 说明文档

<dl class="el"><dd class="mdescRight">Answer an incoming call.  <a href="#a111"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a112">HfpRejectCall</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Reject an incoming call.  <a href="#a112"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a113">HfpTerminateCall</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Hang up an active call or terminate an outgoing call process before it has been completed.  <a href="#a113"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a114">HfpDialNumber</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp, <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">Issue a request to the AG to dial the supplied number.  <a href="#a114"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a115">HfpDialMemoryLocation</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_memory_location, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *memory_location)
<dl class="el"><dd class="mdescRight">Issue a request to the AG to dial from the the supplied memory_location (the HFP specification defines the command but it is AG implementation dependent how this is implemented).  <a href="#a115"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a116">HfpLastNumberRedial</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Issue a request to the AG to perform a last number redial.  <a href="#a116"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a117">HfpSendSpeakerVolume</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> volume)
<dl class="el"><dd class="mdescRight">Request to send the local speaker setting (volume) to the AG.  <a href="#a117"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a118">HfpSendMicrophoneVolume</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> volume)
<dl class="el"><dd class="mdescRight">Request to send the local microphone setting (volume) to the AG.  <a href="#a118"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a119">HfpRequestNumberForVoiceTag</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Request a number from the AG to attach to a voice tag.  <a href="#a119"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a120">HfpSendDtmf</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp, <a class="el" href="csrtypes_8h.html#a8">uint8</a> dtmf)
<dl class="el"><dd class="mdescRight">Request to transmit a DTMF code to the AG.  <a href="#a120"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a121">HfpCallWaitingEnableNotification</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp, <a class="el" href="csrtypes_8h.html#a9">bool</a> enable)
<dl class="el"><dd class="mdescRight">Enable /disable call waiting notification from the AG.  <a href="#a121"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a122">HfpMultipleCallsReleaseHeldOrRejectWaiting</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Depending on the state of the calls either release all held calls or set User Determined User Busy (UDUB) for a waiting call.  <a href="#a122"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a123">HfpMultipleCallsReleaseActiveAcceptOther</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Release all active calls (if any) and accept the other (held or waiting) call.  <a href="#a123"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a124">HfpMultipleCallsReleaseSpecifiedAcceptOther</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> call_idx)
<dl class="el"><dd class="mdescRight">Release all active calls (if any) and accept the other (held or waiting) call.  <a href="#a124"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a125">HfpMultipleCallsHoldActiveAcceptOther</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Place all active calls (if any) on hold and accept the other (held or waiting) call.  <a href="#a125"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a126">HfpMultipleCallsRequestPrivateHoldOther</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp, <a class="el" href="csrtypes_8h.html#a4">uint16</a> call_idx)
<dl class="el"><dd class="mdescRight">Place all active calls (if any) on hold and accept the other (held or waiting) call.  <a href="#a126"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a127">HfpMultipleCallsAddHeldCall</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Add the held call to the conversation.  <a href="#a127"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a128">HfpMultipleCallsExplicitCallTransfer</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Connect the two external calls and disconnect the subscriber from the conversation (Explicit Call Transfer).  <a href="#a128"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a129">HfpDisableNrEc</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Request the AG to disable its Noise Reduction (NR) / Echo Cancellation (EC) functions.  <a href="#a129"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a130">HfpSendHsButtonPress</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Request to send a headset profile compliant button press to the AG.  <a href="#a130"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a131">HfpGetSubscriberNumbers</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Request to obtain list of subscriber numbers from the AG.  <a href="#a131"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a132">HfpGetResponseHoldStatus</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Requests the current response hold state of the AG.  <a href="#a132"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a133">HfpHoldIncomingCall</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Requests that the AG places the current incoming call on hold.  <a href="#a133"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a134">HfpAcceptHeldIncomingCall</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Requests that the AG accepts the currently held incoming call.  <a href="#a134"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a135">HfpRejectHeldIncomingCall</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Requests that the AG rejects the currently held incoming call.  <a href="#a135"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a136">HfpGetCurrentCalls</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Requests list of current calls from the AG.  <a href="#a136"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a137">HfpGetNetworkOperator</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Requests the Network Operator selection mode and name from the AG.  <a href="#a137"></a><br></dl><li>void <a class="el" href="hfp_8h.html#a138">HfpEnableExtendedErrors</a> (<a class="el" href="hfp_8h.html#a8">HFP</a> *hfp)
<dl class="el"><dd class="mdescRight">Requests that the AG sends out extended AT error reporting codes.  <a href="#a138"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Header file for the Hands Free Profile library. 
<p>
This file documents the Hands Free Profile library API for BlueLab3.<hr><h2>Define Documentation</h2>
<a class="anchor" name="a0" doxytag="hfp.h::HFP_NREC_FUNCTION" ></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 HFP_NREC_FUNCTION&nbsp;&nbsp;&nbsp;(1)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Setting this flag indicates that this device implements noise reduction / echo cancellation. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="hfp.h::HFP_THREE_WAY_CALLING" ></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 HFP_THREE_WAY_CALLING&nbsp;&nbsp;&nbsp;(1&lt;&lt;1)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Setting this flag indicates that this device supports three way call control. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="hfp.h::HFP_CLI_PRESENTATION" ></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 HFP_CLI_PRESENTATION&nbsp;&nbsp;&nbsp;(1&lt;&lt;2)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Setting this flag indicates that this device can display calling line identification information. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a3" doxytag="hfp.h::HFP_VOICE_RECOGNITION" ></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 HFP_VOICE_RECOGNITION&nbsp;&nbsp;&nbsp;(1&lt;&lt;3)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Setting this flag indicates that this device can enable voice recognition on the AG. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a4" doxytag="hfp.h::HFP_REMOTE_VOL_CONTROL" ></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 HFP_REMOTE_VOL_CONTROL&nbsp;&nbsp;&nbsp;(1&lt;&lt;4)          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Setting this flag indicates that the AG can control this device's local volume. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a5" doxytag="hfp.h::HFP_ENHANCED_CALL_STATUS" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">