2023-07-19 07:10:36 +00:00
|
|
|
/*
|
2024-09-05 07:30:03 +00:00
|
|
|
* Copyright (C) 2023-2024 Huawei Device Co., Ltd.
|
2023-07-19 07:10:36 +00:00
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2023-12-11 09:08:03 +00:00
|
|
|
/**
|
|
|
|
* @file
|
2024-01-08 07:25:39 +00:00
|
|
|
* @kit ConnectivityKit
|
2023-12-11 09:08:03 +00:00
|
|
|
*/
|
|
|
|
|
2023-11-13 03:07:41 +00:00
|
|
|
import type { AsyncCallback } from './@ohos.base';
|
2023-07-19 07:10:36 +00:00
|
|
|
import type baseProfile from './@ohos.bluetooth.baseProfile';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Provides methods to accessing bluetooth audio related capabilities.
|
|
|
|
*
|
|
|
|
* @namespace a2dp
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 10
|
|
|
|
*/
|
2024-09-05 07:30:03 +00:00
|
|
|
/**
|
|
|
|
* Provides methods to accessing bluetooth audio related capabilities.
|
|
|
|
*
|
|
|
|
* @namespace a2dp
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @crossplatform
|
|
|
|
* @since 13
|
|
|
|
*/
|
2023-07-19 07:10:36 +00:00
|
|
|
declare namespace a2dp {
|
|
|
|
/**
|
|
|
|
* Base interface of profile.
|
|
|
|
*
|
2024-06-05 02:16:55 +00:00
|
|
|
* @typedef { baseProfile.BaseProfile } BaseProfile
|
2023-07-19 07:10:36 +00:00
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 10
|
|
|
|
*/
|
|
|
|
type BaseProfile = baseProfile.BaseProfile;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* create the instance of a2dp profile.
|
|
|
|
*
|
|
|
|
* @returns { A2dpSourceProfile } Returns the instance of profile.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter.Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-07-19 07:10:36 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 10
|
|
|
|
*/
|
2024-09-05 07:30:03 +00:00
|
|
|
/**
|
|
|
|
* create the instance of a2dp profile.
|
|
|
|
*
|
|
|
|
* @returns { A2dpSourceProfile } Returns the instance of profile.
|
|
|
|
* @throws { BusinessError } 401 - Invalid parameter.Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @crossplatform
|
|
|
|
* @since 13
|
|
|
|
*/
|
2023-07-19 07:10:36 +00:00
|
|
|
function createA2dpSrcProfile(): A2dpSourceProfile;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Manager a2dp source profile.
|
|
|
|
*
|
|
|
|
* @typedef A2dpSourceProfile
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 10
|
|
|
|
*/
|
2024-09-05 07:30:03 +00:00
|
|
|
/**
|
|
|
|
* Manager a2dp source profile.
|
|
|
|
*
|
|
|
|
* @typedef A2dpSourceProfile
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @crossplatform
|
|
|
|
* @since 13
|
|
|
|
*/
|
2023-07-19 07:10:36 +00:00
|
|
|
interface A2dpSourceProfile extends BaseProfile {
|
|
|
|
/**
|
|
|
|
* Initiate an A2DP connection to a remote device.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-07-19 07:10:36 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
|
|
|
* @throws { BusinessError } 2900004 - Profile not supported.
|
2023-07-19 07:10:36 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 10
|
|
|
|
*/
|
|
|
|
connect(deviceId: string): void;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Disconnect the A2DP connection with the remote device.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-07-19 07:10:36 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
|
|
|
* @throws { BusinessError } 2900004 - Profile not supported.
|
2023-07-19 07:10:36 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 10
|
|
|
|
*/
|
|
|
|
disconnect(deviceId: string): void;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Obtains the playing state of device.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @returns { PlayingState } Returns the playing state.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-07-19 07:10:36 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
|
|
|
* @throws { BusinessError } 2900004 - Profile not supported.
|
2023-07-19 07:10:36 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 10
|
|
|
|
*/
|
|
|
|
getPlayingState(deviceId: string): PlayingState;
|
2023-11-13 03:07:41 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the device supports absolute volume.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @returns { Promise<boolean> } Returns the promise object.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
isAbsoluteVolumeSupported(deviceId: string): Promise<boolean>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the device supports absolute volume.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @param { AsyncCallback<boolean> } callback - Callback used to listen for the pairing request event.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
isAbsoluteVolumeSupported(deviceId: string, callback: AsyncCallback<boolean>): void;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the absolute volume is enabled.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @returns { Promise<boolean> } Returns the promise object.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
isAbsoluteVolumeEnabled(deviceId: string): Promise<boolean>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the absolute volume is enabled.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @param { AsyncCallback<boolean> } callback - the callback result.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
isAbsoluteVolumeEnabled(deviceId: string, callback: AsyncCallback<boolean>): void;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Turn on the absolute volume switch.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @returns { Promise<void> } Returns the promise object.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
enableAbsoluteVolume(deviceId: string): Promise<void>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Turn on the absolute volume switch..
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @param { AsyncCallback<void> } callback - the callback result.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
enableAbsoluteVolume(deviceId: string, callback: AsyncCallback<void>): void;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Turn off the absolute volume switch.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @returns { Promise<void> } Returns the promise object.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
disableAbsoluteVolume(deviceId: string): Promise<void>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Turn off the absolute volume switch..
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @param { AsyncCallback<void> } callback - the callback result.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-13 03:07:41 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
disableAbsoluteVolume(deviceId: string, callback: AsyncCallback<void>): void;
|
2023-11-15 07:27:01 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get codec information.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @returns { CodecInfo } Returns the CodecInfo.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-15 07:27:01 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-15 07:27:01 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
2023-11-15 09:09:40 +00:00
|
|
|
* @systemapi
|
2023-11-15 07:27:01 +00:00
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
getCurrentCodecInfo(deviceId: string): CodecInfo;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set codec information.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
|
|
|
* @param { CodecInfo } codecInfo - Indicates the CodecInfo.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2023-11-15 07:27:01 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2023-11-15 07:27:01 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
2023-11-15 09:09:40 +00:00
|
|
|
* @systemapi
|
2023-11-15 07:27:01 +00:00
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
setCurrentCodecInfo(deviceId: string, codecInfo: CodecInfo): void;
|
2024-03-05 01:29:05 +00:00
|
|
|
|
|
|
|
/**
|
2024-03-05 01:46:34 +00:00
|
|
|
* Restriction devices to play music within {@code duration} milliseconds of connection.
|
2024-03-05 01:29:05 +00:00
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
2024-04-10 09:38:38 +00:00
|
|
|
* @param { number } duration - Restricted duration <milliseconds>. Valid range is from 3000ms to 20000ms.
|
2024-03-05 03:49:34 +00:00
|
|
|
* @returns { Promise<void> } Returns the promise object.
|
2024-03-05 01:29:05 +00:00
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2024-03-05 01:29:05 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2024-03-05 01:29:05 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 12
|
|
|
|
*/
|
2024-03-05 03:49:34 +00:00
|
|
|
disableAutoPlay(deviceId: string, duration: number): Promise<void>;
|
2024-03-05 01:29:05 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Allow devices to automatically play music when connected.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
2024-03-05 03:49:34 +00:00
|
|
|
* @returns { Promise<void> } Returns the promise object.
|
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2024-03-05 03:49:34 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2024-03-05 03:49:34 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 12
|
|
|
|
*/
|
|
|
|
enableAutoPlay(deviceId: string): Promise<void>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Obtains the duration for which automatic playback is disabled.
|
|
|
|
*
|
|
|
|
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
|
|
|
|
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
|
2024-03-20 07:16:44 +00:00
|
|
|
* @returns { Promise<number> } Returns the duration <milliseconds>;
|
|
|
|
* If returns { @code -1 } means allow devices automatic play music when connected.
|
2024-03-05 01:29:05 +00:00
|
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
|
|
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
|
2024-06-05 02:16:55 +00:00
|
|
|
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
|
|
|
|
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
|
2024-03-05 01:29:05 +00:00
|
|
|
* @throws { BusinessError } 801 - Capability not supported.
|
|
|
|
* @throws { BusinessError } 2900001 - Service stopped.
|
2024-07-11 07:12:54 +00:00
|
|
|
* @throws { BusinessError } 2900003 - Bluetooth disabled.
|
2024-03-05 01:29:05 +00:00
|
|
|
* @throws { BusinessError } 2900099 - Operation failed.
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @systemapi
|
|
|
|
* @since 12
|
|
|
|
*/
|
2024-03-05 11:09:38 +00:00
|
|
|
getAutoPlayDisabledDuration(deviceId: string): Promise<number>;
|
2023-11-15 07:27:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Describes the codec information.
|
|
|
|
*
|
|
|
|
* @typedef CodecInfo
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
2023-11-15 10:07:05 +00:00
|
|
|
interface CodecInfo {
|
|
|
|
/**
|
|
|
|
* codec type
|
|
|
|
*
|
2024-07-24 03:15:29 +00:00
|
|
|
* @type { CodecType }
|
2023-11-15 10:07:05 +00:00
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
codecType: CodecType;
|
|
|
|
/**
|
|
|
|
* codec bits per sample.
|
|
|
|
*
|
2024-07-24 03:15:29 +00:00
|
|
|
* @type { CodecBitsPerSample }
|
2023-11-15 10:07:05 +00:00
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
codecBitsPerSample: CodecBitsPerSample;
|
|
|
|
/**
|
|
|
|
* codec channel mode.
|
|
|
|
*
|
2024-07-24 03:15:29 +00:00
|
|
|
* @type { CodecChannelMode }
|
2023-11-15 10:07:05 +00:00
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
codecChannelMode: CodecChannelMode;
|
|
|
|
/**
|
|
|
|
* codec sample rate.
|
|
|
|
*
|
2024-07-24 03:15:29 +00:00
|
|
|
* @type { CodecSampleRate }
|
2023-11-15 10:07:05 +00:00
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
codecSampleRate: CodecSampleRate;
|
2023-07-19 07:10:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The enum of a2dp playing state.
|
|
|
|
*
|
|
|
|
* @enum { number }
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 10
|
|
|
|
*/
|
|
|
|
enum PlayingState {
|
|
|
|
/**
|
|
|
|
* Not playing.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 10
|
|
|
|
*/
|
|
|
|
STATE_NOT_PLAYING,
|
|
|
|
/**
|
|
|
|
* Playing.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 10
|
|
|
|
*/
|
|
|
|
STATE_PLAYING
|
|
|
|
}
|
2023-11-15 07:27:01 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Describes the codec type.
|
|
|
|
*
|
|
|
|
* @enum { number }
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
enum CodecType {
|
|
|
|
/**
|
|
|
|
* invalid codec type.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_TYPE_INVALID = -1,
|
|
|
|
/**
|
|
|
|
* SBC - Sub-band coding.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_TYPE_SBC = 0,
|
|
|
|
/**
|
|
|
|
* AAC -Advanced Audio Coding.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_TYPE_AAC = 1,
|
|
|
|
/**
|
|
|
|
* L2HC.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
2024-08-29 02:49:11 +00:00
|
|
|
CODEC_TYPE_L2HC = 2,
|
|
|
|
/**
|
|
|
|
* L2HCST.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 13
|
|
|
|
*/
|
|
|
|
CODEC_TYPE_L2HCST = 3,
|
|
|
|
/**
|
|
|
|
* LDAC.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 13
|
|
|
|
*/
|
|
|
|
CODEC_TYPE_LDAC = 4
|
2023-11-15 07:27:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Describes the codec channel mode.
|
|
|
|
*
|
|
|
|
* @enum { number }
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
enum CodecChannelMode {
|
|
|
|
/**
|
|
|
|
* Codec channel mode none.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_CHANNEL_MODE_NONE = 0,
|
|
|
|
/**
|
|
|
|
* Codec channel mode MONO.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_CHANNEL_MODE_MONO = 1,
|
|
|
|
/**
|
|
|
|
* Codec channel mode STEREO.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_CHANNEL_MODE_STEREO = 2
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Describes the codec bits per sample.
|
|
|
|
*
|
|
|
|
* @enum { number }
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
enum CodecBitsPerSample {
|
|
|
|
/**
|
|
|
|
* Codec bits per sample none.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_BITS_PER_SAMPLE_NONE = 0,
|
|
|
|
/**
|
|
|
|
* Codec 16 bits per sample.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_BITS_PER_SAMPLE_16 = 1,
|
|
|
|
/**
|
|
|
|
* Codec 24 bits per sample.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_BITS_PER_SAMPLE_24 = 2,
|
|
|
|
/**
|
|
|
|
* Codec 32 bits per sample.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_BITS_PER_SAMPLE_32 = 3
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Describes the codec sample rate.
|
|
|
|
*
|
|
|
|
* @enum { number }
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
enum CodecSampleRate {
|
|
|
|
/**
|
|
|
|
* Codec sample rate none.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_SAMPLE_RATE_NONE = 0,
|
|
|
|
/**
|
|
|
|
* Codec sample rate 44.1k.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_SAMPLE_RATE_44100 = 1,
|
|
|
|
/**
|
|
|
|
* Codec sample rate 48k.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_SAMPLE_RATE_48000 = 2,
|
|
|
|
/**
|
|
|
|
* Codec sample rate 88.2k.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_SAMPLE_RATE_88200 = 3,
|
|
|
|
/**
|
|
|
|
* Codec sample rate 96k.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_SAMPLE_RATE_96000 = 4,
|
|
|
|
/**
|
|
|
|
* Codec sample rate 176.4k.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_SAMPLE_RATE_176400 = 5,
|
|
|
|
/**
|
|
|
|
* Codec sample rate 192k.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Communication.Bluetooth.Core
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
CODEC_SAMPLE_RATE_192000 = 6
|
|
|
|
}
|
2023-07-19 07:10:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
export default a2dp;
|