BluetoothHeadset Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Public API for controlling the Bluetooth Headset Service.
[Android.Runtime.Register("android/bluetooth/BluetoothHeadset", DoNotGenerateAcw=true)]
public sealed class BluetoothHeadset : Java.Lang.Object, Android.Bluetooth.IBluetoothProfile, IDisposable
[<Android.Runtime.Register("android/bluetooth/BluetoothHeadset", DoNotGenerateAcw=true)>]
type BluetoothHeadset = class
inherit Object
interface IBluetoothProfile
interface IJavaObject
interface IDisposable
interface IJavaPeerable
- Inheritance
- Attributes
- Implements
Remarks
Public API for controlling the Bluetooth Headset Service. This includes both Bluetooth Headset and Handsfree (v1.5) profiles.
BluetoothHeadset is a proxy object for controlling the Bluetooth Headset Service via IPC.
Use BluetoothAdapter#getProfileProxy to get the BluetoothHeadset proxy object. Use BluetoothAdapter#closeProfileProxy to close the service connection.
Android only supports one connected Bluetooth Headset at a time. Each method is protected with its appropriate permission.
Java documentation for android.bluetooth.BluetoothHeadset.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Fields
| Name | Description |
|---|---|
| ActionAudioStateChanged |
Intent used to broadcast the change in the Audio Connection state of the HFP profile. |
| ActionConnectionStateChanged |
Intent used to broadcast the change in connection state of the Headset profile. |
| ActionVendorSpecificHeadsetEvent |
Intent used to broadcast that the headset has posted a vendor-specific event. |
| AtCmdTypeAction |
Obsolete.
AT command type ACTION used with |
| AtCmdTypeBasic |
Obsolete.
AT command type BASIC used with |
| AtCmdTypeRead |
Obsolete.
AT command type READ used with |
| AtCmdTypeSet |
Obsolete.
AT command type SET used with |
| AtCmdTypeTest |
Obsolete.
AT command type TEST used with |
| CodecTypeCvsd |
Obsolete.
HFP codec type CVSD. |
| CodecTypeLc3Swb |
Obsolete.
HFP codec type LC3 SWB. |
| CodecTypeMsbc |
Obsolete.
HFP codec type mSBC. |
| CodecTypeUnsupported |
Obsolete.
HFP codec type is not supported or cannot be determined |
| CodecTypeVendorSpecific |
Obsolete.
HFP vendor specific codec Type |
| ExtraDisconnectedReason |
Used as an int extra field in |
| ExtraVendorSpecificHeadsetEventArgs |
A Parcelable String array extra field in |
| ExtraVendorSpecificHeadsetEventCmd |
A String extra field in |
| ExtraVendorSpecificHeadsetEventCmdType |
An int extra field in |
| StateAudioConnected |
Obsolete.
Headset state when SCO audio is connected. |
| StateAudioConnecting |
Obsolete.
Headset state when SCO audio is connecting. |
| StateAudioDisconnected |
Obsolete.
Headset state when SCO audio is not connected. |
| VendorResultCodeCommandAndroid |
A vendor-specific command for unsolicited result code. |
| VendorSpecificHeadsetEventCompanyIdCategory |
The intent category to be used with |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| ConnectedDevices |
Get connected devices for this specific profile. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState |
Gets the state flags last assigned by the runtime. (Inherited from JavaObject) |
| JniPeerMembers |
Gets the JNI metadata used to access members of this Java binding. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
Methods
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() |
Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject) |
| Equals(Object) |
Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetCodecType(BluetoothDevice) |
Get the codec type of the given HFP connected device. |
| GetConnectionState(BluetoothDevice) |
Get the current connection state of the profile For apps targeting Build.VERSION_CODES.S or or higher, this requires the Manifest.permission.BLUETOOTH_CONNECT permission which can be gained with android.app.Activity.requestPermissions(String[],int). |
| GetDevicesMatchingConnectionStates(ProfileState[]) |
Get a list of devices that match any of the given connection states. |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| IsAudioConnected(BluetoothDevice) |
Check if Bluetooth SCO audio is connected. |
| IsNoiseReductionSupported(BluetoothDevice) |
Checks whether the headset supports some form of noise reduction |
| IsVoiceRecognitionSupported(BluetoothDevice) |
Checks whether the headset supports voice recognition |
| JavaFinalize() |
Obsolete.
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SendVendorSpecificResultCode(BluetoothDevice, String, String) |
Sends a vendor-specific unsolicited result code to the headset. |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject) |
| StartVoiceRecognition(BluetoothDevice) |
Start Bluetooth voice recognition. |
| StopVoiceRecognition(BluetoothDevice) |
Stop Bluetooth Voice Recognition mode, and shut down the Bluetooth audio path. |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Marks this peer as disposed and calls |
| IJavaPeerable.Finalized() |
Marks this peer as disposed and calls |
| IJavaPeerable.JniObjectReferenceControlBlock |
Gets the native control-block pointer used by this peer. (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Stores the identity hash code supplied by the runtime. (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Replaces the stored managed peer state flags. (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject) |
| IJavaPeerable.UnregisterFromRuntime() |
Removes this instance from the runtime's Java object lookup. |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) |
Reuses a compatible managed peer or obtains a wrapper of the requested type. |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |