程序包 ohos.bluetooth

类 HandsFreeAudioGateway

java.lang.Object

ohos.bluetooth.HandsFreeAudioGateway

所有已实现的接口:

ProfileBase

public final class HandsFreeAudioGateway
extends Object
implements ProfileBase

Manages HandsFreeAudioGateway (HFP AG) profiles.

The static method getProfile(ohos.app.Context) is used to obtain HandsFreeAudioGateway instances.

从以下版本开始:

1

字段概要

字段

限定符和类型	字段	说明
static String	EVENT_AUDIO_STATE_UPDATE	The event indicates audio state change.
static int	SCO_STATE_CONNECTED	Indicates that an SCO link has been set up with the peer device.
static int	SCO_STATE_CONNECTING	Indicates that an SCO link is being set up with the peer device.
static int	SCO_STATE_DISCONNECTED	Indicates that no SCO link has been set up with the peer device.

从接口继承的字段 ohos.bluetooth.ProfileBase

A2DP, A2DP_SINK, CONNECT_STRATEGY_ALLOW, CONNECT_STRATEGY_AUTO, CONNECT_STRATEGY_DISALLOW, CONNECT_STRATEGY_UNKNOWN, GATT, GATT_SERVER, HFP, HFP_UNIT, MAP_SERVER, PBAP_CLIENT, PBAP_SERVER, PROFILE_PARAM_CUR_STATE, PROFILE_PARAM_PRE_STATE, SOCKET_MANAGER, STATE_CONNECTED, STATE_CONNECTING, STATE_DISCONNECTED, STATE_DISCONNECTING

方法概要

限定符和类型	方法	说明
boolean	closeVoiceRecognition(BluetoothRemoteDevice device)	Disables Bluetooth voice recognition and the Bluetooth audio channel.
boolean	connectSco()	Create an audio channel connection.
boolean	disconnectSco()	Disconnect an audio channel connection.
List<BluetoothRemoteDevice>	getConnectedDevices()	Obtains the list of connected Bluetooth devices.
List<BluetoothRemoteDevice>	getDevicesByStates(int[] states)	Obtains the list of devices in the specified status.
int	getDeviceState(BluetoothRemoteDevice device)	Obtains the connection status of a BluetoothRemoteDevice in the current profile.
static HandsFreeAudioGateway	getProfile(Context context)	Obtains the default HandsFreeAudioGateway instance to perform an operation.
int	getScoState(BluetoothRemoteDevice device)	Obtains the status of a HandsFree SCO link between the current device and the peer device.
boolean	openVoiceRecognition(BluetoothRemoteDevice device)	Enables Bluetooth voice recognition.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

EVENT_AUDIO_STATE_UPDATE

public static final String EVENT_AUDIO_STATE_UPDATE

The event indicates audio state change.

另请参阅:

常量字段值

SCO_STATE_CONNECTED

public static final int SCO_STATE_CONNECTED

Indicates that an SCO link has been set up with the peer device.

另请参阅:

常量字段值

SCO_STATE_CONNECTING

public static final int SCO_STATE_CONNECTING

Indicates that an SCO link is being set up with the peer device.

另请参阅:

常量字段值

SCO_STATE_DISCONNECTED

public static final int SCO_STATE_DISCONNECTED

Indicates that no SCO link has been set up with the peer device.

另请参阅:

常量字段值

方法详细资料

getProfile

public static HandsFreeAudioGateway getProfile(Context context)

Obtains the default HandsFreeAudioGateway instance to perform an operation.

参数:

context - Ability context that contains package name

返回:

Returns the default HandsFreeAudioGateway instance.

getDevicesByStates

public List<BluetoothRemoteDevice> getDevicesByStates(int[] states)

从接口复制的说明: ProfileBase

Obtains the list of devices in the specified status.

指定者:

getDevicesByStates 在接口中 ProfileBase

参数:

states - Indicates the connection status, which can be ProfileBase.STATE_DISCONNECTED, ProfileBase.STATE_CONNECTING, ProfileBase.STATE_CONNECTED, or ProfileBase.STATE_DISCONNECTING.

返回:

Returns the list of BluetoothRemoteDevice matching the specified status.

getDeviceState

public int getDeviceState(BluetoothRemoteDevice device)

从接口复制的说明: ProfileBase

Obtains the connection status of a BluetoothRemoteDevice in the current profile.

指定者:

getDeviceState 在接口中 ProfileBase

参数:

device - Indicates the BluetoothRemoteDevice.

返回:

Returns the connection status, which can be ProfileBase.STATE_DISCONNECTED, ProfileBase.STATE_CONNECTING, ProfileBase.STATE_CONNECTED, or ProfileBase.STATE_DISCONNECTING.

getScoState

public int getScoState(BluetoothRemoteDevice device)

Obtains the status of a HandsFree SCO link between the current device and the peer device.

参数:

device - Indicates the peer device, which is set by BluetoothRemoteDevice.

返回:

Returns the SCO link status, which can be SCO_STATE_CONNECTED, SCO_STATE_CONNECTING, or SCO_STATE_DISCONNECTED.

openVoiceRecognition

public boolean openVoiceRecognition(BluetoothRemoteDevice device)

Enables Bluetooth voice recognition.

This method is called to establish a Bluetooth audio channel when the audio gateway receives an AT command for voice recognition from the headset.

参数:

device - Indicates the Bluetooth headset.

返回:

Returns true if Bluetooth voice recognition is enabled; returns false if no headset is connected, the connected headset does not support voice recognition, or voice recognition has already been enabled.

从以下版本开始:

3

closeVoiceRecognition

public boolean closeVoiceRecognition(BluetoothRemoteDevice device)

Disables Bluetooth voice recognition and the Bluetooth audio channel.

参数:

device - Indicates the Bluetooth headset.

返回:

Returns true if Bluetooth voice recognition is disabled; returns false if no headset is connected or voice recognition is not enabled.

从以下版本开始:

3

connectSco

public boolean connectSco()

Create an audio channel connection.

Listen event EVENT_AUDIO_STATE_UPDATE to get audio state update after calling this function.

返回:

true means the command has been sent, otherwise false.

disconnectSco

public boolean disconnectSco()

Disconnect an audio channel connection.

Listen event EVENT_AUDIO_STATE_UPDATE to get audio state update after calling this function.

返回:

true means the command has been sent, otherwise false.

getConnectedDevices

public List<BluetoothRemoteDevice> getConnectedDevices()

Obtains the list of connected Bluetooth devices.

返回:

Returns the list of connected Bluetooth devices.

从以下版本开始:

3