SWRA769 august   2023 CC2564C

 

  1.   1
  2.   Abstract
  3.   Trademarks
  4. 1Demo Application
  5. 2Running the Bluetooth Code
  6. 3Server Set-Up Using HFP Demo Application
  7. 4Client Set-Up on the Demo Application
  8. 5Example: Audio Gateway with a Commercial Headset
  9. 6Application Commands
    1. 6.1  Generic Access Profile Commands
    2. 6.2  Help (DisplayHelp)
    3. 6.3  Inquiry
    4. 6.4  Pair
    5. 6.5  End Pairing
    6. 6.6  PIN Code Response
    7. 6.7  Pass Key Response
    8. 6.8  User Confirmation Response
    9. 6.9  Set Discoverability Mode
    10. 6.10 Set Connectability Mode
    11. 6.11 Set Pairability Mode
    12. 6.12 Change Simple Pairing Parameters
    13. 6.13 Get Local Address
    14. 6.14 Set Local Name
    15. 6.15 Get Local Name
    16. 6.16 Set Class of Device
    17. 6.17 Get Class of Device
    18. 6.18 Get Remote Name
  10. 7Hands-Free Profile Commands
    1. 7.1  Service Discovery
    2. 7.2  Open Audio Gateway Client
    3. 7.3  Manage Audio
    4. 7.4  Update Control Indicators
    5. 7.5  Call Waiting
    6. 7.6  Set Voice Recognition Activation
    7. 7.7  Set Speaker Gain
    8. 7.8  Set Microphone Gain
    9. 7.9  Disable Remote Sound Enhancement
    10. 7.10 Send Caller ID Notification
    11. 7.11 Set Ring Indication
    12. 7.12 Ring Indication
    13. 7.13 Send Incoming Call State
    14. 7.14 Close AG Client
    15. 7.15 Send Operator Info
    16. 7.16 Send Sub Number
    17. 7.17 Send Call List
  11. 8References
  12. 9Revision History

7.9 Disable Remote Sound Enhancement

Note: This function can be performed only when a valid Service Level Connection exist but no Audio Connection exists.

Description

The following function is responsible for disabling Sound Enhancement on the Remote Device. This function returns zero on successful execution and a negative value on all errors. This function can be performed only when a valid Service Level Connection exist but no Audio Connection exists.

Parameters

Including parameters is not necessary when using this command. A parameter has no effect on the outcome of DisableRemoteSoundEnhancement.

Command Call Examples

"DisableRemoteSoundEnhancement"

Possible Return Values

  • (0) Command sent successfully
  • (-2) BTPS_ERROR_INVALID_BLUETOOTH_STACK_ID
  • (-4) FUNCTION_ERROR
  • (-8) INVALID_STACK_ID_ERROR
  • (-1000) BTHFRE_ERROR_INVALID_PARAMETER
  • (-1001) BTHFRE_ERROR_NOT_INITIALIZED
  • (-1002) BTHFRE_ERROR_INVALID_BLUETOOTH_STACK_ID
  • (-1003) BTHFRE_ERROR_LIBRARY_INITIALIZATION_ERROR
  • (-1004) BTHFRE_ERROR_INSUFFICIENT_RESOURCES
  • (-1005) BTHFRE_ERROR_INVALID_OPERATION
  • (-1006) BTHFRE_ERROR_INVALID_CODEC_ID

API Call

HFRE_Disable_Remote_Echo_Cancelation_Noise_Reduction(BluetoothStackID, CurrentClientPortID)

API Call

BTPSAPI_DECLARATION int BTPSAPI HFRE_Disable_Remote_Echo_Cancelation_Noise_Reduction(unsigned int BluetoothStackID, unsigned int HFREPortID)

Description of API

This function is responsible for Disabling Echo Cancelation and Noise Reduction on the Remote Device. This function can be performed by both the Hands-Free unit and the AudioGateway for which a valid Service Level Connection exist but no Audio Connection exists. This function accepts the Bluetooth Stack ID as the input parameters for which the HFRE PortID is valid as well as the HFRE Port ID. This function returns zero if successful or a negative return error code if there was an error.

Note:

Enabling this feature once disbled is not possible because the specification provides no means to re-enable this feature. This feature remains disabled until the current Service Level Connection has been dropped.