xref: /interface/sdk-js/api/@ohos.multimedia.systemSoundManager.d.ts

/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * 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.
 */

/**
 * @file
 * @kit AudioKit
 */

import type { AsyncCallback } from './@ohos.base';
import type Context from './application/Context';
import type BaseContext from './application/BaseContext';
import type { RingtonePlayer as _RingtonePlayer } from './multimedia/ringtonePlayer';
import type { RingtoneOptions as _RingtoneOptions } from './multimedia/ringtonePlayer';
import type { SystemTonePlayer as _SystemTonePlayer } from './multimedia/systemTonePlayer';
import type { SystemToneOptions as _SystemToneOptions } from './multimedia/systemTonePlayer';

/**
 * Provides ringtone player interfaces.
 *
 * @namespace systemSoundManager
 * @syscap SystemCapability.Multimedia.SystemSound.Core
 * @systemapi
 * @since 10
 */
declare namespace systemSoundManager {
  /**
   * Enum for ringtone type.
   * @enum { number }
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 10
   */
  enum RingtoneType {
    /**
     * Default type.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 10
     * @deprecated since 11
     * @useinstead systemSoundManager.RingtoneType#RINGTONE_TYPE_SIM_CARD_0
     */
    RINGTONE_TYPE_DEFAULT = 0,

    /**
     * Ringtone type for sim card 0.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    RINGTONE_TYPE_SIM_CARD_0 = 0,

    /**
     * Multi-sim type.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 10
     * @deprecated since 11
     * @useinstead systemSoundManager.RingtoneType#RINGTONE_TYPE_SIM_CARD_1
     */
    RINGTONE_TYPE_MULTISIM = 1,

    /**
     * Ringtone type for sim card 1.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    RINGTONE_TYPE_SIM_CARD_1 = 1,
  }

  /**
   * Enum for system tone type.
   * @enum { number }
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 11
   */
  enum SystemToneType {
    /**
     * System tone type for sim card 0.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    SYSTEM_TONE_TYPE_SIM_CARD_0 = 0,

    /**
     * System tone type for sim card 1.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    SYSTEM_TONE_TYPE_SIM_CARD_1 = 1,

    /**
     * System tone type notification.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    SYSTEM_TONE_TYPE_NOTIFICATION = 32,
  }

  /**
   * Enum for tone customized type.
   * @enum {number}
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 12
   */
  enum ToneCustomizedType {
    /**
     * Pre-installed tone type.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    PRE_INSTALLED = 0,
    /**
     * Customized tone type.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    CUSTOMIZED = 1,
  }

  /**
   * Define the ringtone category.
   * @constant
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 12
   */
  const TONE_CATEGORY_RINGTONE: number;

  /**
   * Define the text message tone category.
   * @constant
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 12
   */
  const TONE_CATEGORY_TEXT_MESSAGE:number;

  /**
   * Define the notification tone category.
   * @constant
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 12
   */
  const TONE_CATEGORY_NOTIFICATION:number;

  /**
   * Define the alarm tone category.
   * @constant
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 12
   */
  const TONE_CATEGORY_ALARM:number;

  /**
   * Tone attributes.
   * @typedef ToneAttrs
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 12
   */
  interface ToneAttrs {
    /**
     * Gets title of tone.
     * @returns { string } title.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getTitle(): string;

    /**
     * Sets title of tone.
     * @param { string } title - Title of tone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    setTitle(title: string): void;

    /**
     * Gets file name of tone.
     * @returns { string } file name.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getFileName(): string;

    /**
     * Sets file name of tone.
     * @param { string } name - file name.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    setFileName(name: string): void;

    /**
     * Gets uri of tone.
     * @returns { string } uri.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getUri(): string;

    /**
     * Gets customized type of tone.
     * @returns { ToneCustomizedType } Customized type of tone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getCustomizedType(): ToneCustomizedType;

    /**
     * Sets tone category.
     * @param { number } category - tone category. This parameter can be one of {@link TONE_CATEGORY_RINGTONE},
     * {@link TONE_CATEGORY_TEXT_MESSAGE}, {@link TONE_CATEGORY_NOTIFICATION}, {@link TONE_CATEGORY_ALARM}.
     * In addition, this parameter can be result of OR logical operator of these constants.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    setCategory(category: number): void;

    /**
     * Gets tone category.
     * @returns { number } Tone category. This value can be one of {@link TONE_CATEGORY_RINGTONE},
     * {@link TONE_CATEGORY_TEXT_MESSAGE}, {@link TONE_CATEGORY_NOTIFICATION}, {@link TONE_CATEGORY_ALARM}.
     * In addition, this value can be result of OR logical operator of these constants.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getCategory(): number;
  }

  /**
   * Array of tone attributes.
   *
   * @typedef {Array<ToneAttrs>} ToneAttrsArray
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 12
   */
  type ToneAttrsArray = Array<ToneAttrs>;

  /**
   * Create customized tone attributes.
   * @returns { ToneAttrs } Tone attributes created.
   * @throws { BusinessError } 202 - Caller is not a system application.
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 12
   */
  function createCustomizedToneAttrs(): ToneAttrs;

  /**
   * Definition of haptics feature in tone scenario.
   * @enum { number }
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 13
   */
  enum ToneHapticsFeature {
    /**
     * Standard haptics feature.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    STANDARD = 0,
    /**
     * Gentle haptics feature.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    GENTLE = 1,
  }
  /**
   * Type definition of haptics in tone scenario.
   *
   * @typedef {RingtoneType | SystemToneType} ToneHapticsType
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 13
   */
  type ToneHapticsType = RingtoneType | SystemToneType;

  /**
   * Enum for haptics mode in tone scenario.
   * @enum {number}
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 13
   */
  enum ToneHapticsMode {
    /**
     * None haptics mode.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    NONE = 0,
    /**
     * Haptics is synchronized with tone.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    SYNC = 1,

    /**
     * Haptics is out of synchronize with tone.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    NON_SYNC = 2,
  }
  /**
   * Haptics settings in tone scenario.
   * @typedef ToneHapticsSettings
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 13
   */
  interface ToneHapticsSettings {
    /**
     * Haptics mode.
     * @type { ToneHapticsMode }
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    mode: ToneHapticsMode;
    /**
     * Haptics uri. Users can set/get this parameter when {@link ToneHapticsSettings#mode} is
     * {@link ToneHapticsMode#NON_SYC}. In other cases, this uri is useless and should be ignored.
     * @type { ?string }
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    hapticsUri?: string;
  }

  /**
   * Haptics attributes in tone scenario.
   * @typedef ToneHapticsAttrs
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 13
   */
  interface ToneHapticsAttrs {
    /**
     * Get haptics uri.
     * @returns { string } Haptics uri.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    getUri(): string;

    /**
     * Get title of haptics.
     * @returns { string } Haptics title.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    getTitle(): string;

    /**
     * Get file name of haptics.
     * @returns { string } Haptics title.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    getFileName(): string;
  }

  /**
   * Type definition of tone haptics array.
   *
   * @typedef { Array<ToneHapticsAttrs> } ToneHapticsAttrsArray
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 13
   */
  type ToneHapticsAttrsArray = Array<ToneHapticsAttrs>;


  /**
   * Gets system sound manager for all type sound.
   * @returns { SystemSoundManager } SystemSoundManager instance.
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 10
   */
  function getSystemSoundManager(): SystemSoundManager;

  /**
   * System sound manager object.
   * @typedef SystemSoundManager
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 10
   */
  interface SystemSoundManager {
    /**
     * Sets the ringtone uri to system.
     * @param { Context } context - Current application context.
     * @param { string } uri - Ringtone uri to set.
     * @param { RingtoneType } type - Ringtone type to set.
     * @param { AsyncCallback<void> } callback - Callback used to return the set uri result.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 10
     * @deprecated since 11
     * @useinstead systemSoundManager.SystemSoundManager#setRingtoneUri
     */
    setSystemRingtoneUri(context: Context, uri: string, type: RingtoneType, callback: AsyncCallback<void>): void;

    /**
     * Sets the ringtone uri to system.
     * @param { Context } context - Current application context.
     * @param { string } uri - Ringtone uri to set.
     * @param { RingtoneType } type - Ringtone type to set.
     * @returns { Promise<void> } Promise used to return the set uri result.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 10
     * @deprecated since 11
     * @useinstead systemSoundManager.SystemSoundManager#setRingtoneUri
     */
    setSystemRingtoneUri(context: Context, uri: string, type: RingtoneType): Promise<void>;

    /**
     * Sets the ringtone uri to system.
     * @param { BaseContext } context - Current application context.
     * @param { string } uri - Ringtone uri to set.
     * @param { RingtoneType } type - Ringtone type to set.
     * @returns { Promise<void> } Promise used to return the set uri result.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *         1.Mandatory parameters are left unspecified;
     *         2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    setRingtoneUri(context: BaseContext, uri: string, type: RingtoneType): Promise<void>;

    /**
     * Gets the ringtone uri.
     * @param { Context } context - Current application context.
     * @param { RingtoneType } type - Ringtone type to get.
     * @param { AsyncCallback<string> } callback - Callback used to return the ringtone uri maintained in system.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 10
     * @deprecated since 11
     * @useinstead systemSoundManager.SystemSoundManager#getRingtoneUri
     */
    getSystemRingtoneUri(context: Context, type: RingtoneType, callback: AsyncCallback<string>): void;

    /**
     * Gets the ringtone uri.
     * @param { Context } context - Current application context.
     * @param { RingtoneType } type - Ringtone type to get.
     * @returns { Promise<string> } Promise used to return the ringtone uri maintained in system.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 10
     * @deprecated since 11
     * @useinstead systemSoundManager.SystemSoundManager#getRingtoneUri
     */
    getSystemRingtoneUri(context: Context, type: RingtoneType): Promise<string>;

    /**
     * Gets the ringtone uri.
     * @param { BaseContext } context - Current application context.
     * @param { RingtoneType } type - Ringtone type to get.
     * @returns { Promise<string> } Promise used to return the ringtone uri maintained in system.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    getRingtoneUri(context: BaseContext, type: RingtoneType): Promise<string>;

    /**
     * Gets attributes of the default ringtone.
     * @param { BaseContext } context - Current application context.
     * @param { RingtoneType } type - Ringtone type to get.
     * @returns { Promise<ToneAttrs> } Promise used to return attributes of the default ringtone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getDefaultRingtoneAttrs(context: BaseContext, type: RingtoneType): Promise<ToneAttrs>;

    /**
     * Gets attribute list of ringtones.
     * @param { BaseContext } context - Current application context.
     * @param { RingtoneType } type - Ringtone type to get.
     * @returns { Promise<ToneAttrsArray> } Promise used to return attribute list of ringtone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getRingtoneAttrList(context: BaseContext, type: RingtoneType): Promise<ToneAttrsArray>;

    /**
     * Gets the ringtone player.
     * @param { Context } context - Current application context.
     * @param { RingtoneType } type - Ringtone type to get.
     * @param { AsyncCallback<RingtonePlayer> } callback - Callback used to return a ringtone player instance.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 10
     * @deprecated since 11
     * @useinstead systemSoundManager.SystemSoundManager#getRingtonePlayer
     */
    getSystemRingtonePlayer(context: Context, type: RingtoneType, callback: AsyncCallback<RingtonePlayer>): void;

    /**
     * Gets the ringtone player.
     * @param { Context } context - Current application context.
     * @param { RingtoneType } type - Ringtone type to get.
     * @returns { Promise<RingtonePlayer> } Promise used to return a ringtone player instance.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 10
     * @deprecated since 11
     * @useinstead systemSoundManager.SystemSoundManager#getRingtonePlayer
     */
    getSystemRingtonePlayer(context: Context, type: RingtoneType): Promise<RingtonePlayer>;

    /**
     * Gets the ringtone player.
     * @param { BaseContext } context - Current application context.
     * @param { RingtoneType } type - Ringtone type to get.
     * @returns { Promise<RingtonePlayer> } Promise used to return a ringtone player instance.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    getRingtonePlayer(context: BaseContext, type: RingtoneType): Promise<RingtonePlayer>;

    /**
     * Sets the system tone uri to system.
     * @param { BaseContext } context - Current application context.
     * @param { string } uri - Ringtone uri to set.
     * @param { SystemToneType } type - System tone type to set.
     * @returns { Promise<void> } Promise used to return the result of set system tone uri.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    setSystemToneUri(context: BaseContext, uri: string, type: SystemToneType): Promise<void>;

    /**
     * Gets the system tone uri.
     * @param { BaseContext } context - Current application context.
     * @param { SystemToneType } type - System tone type to get.
     * @returns { Promise<string> } Promise used to return the system tone maintained in system.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    getSystemToneUri(context: BaseContext, type: SystemToneType): Promise<string>;

    /**
     * Gets attributes of the default system tone.
     *
     * @param { BaseContext } context - Current application context.
     * @param { SystemToneType } type - system tone type to get.
     * @returns { Promise<ToneAttrs> } Promise used to return attributes of the default system tone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getDefaultSystemToneAttrs(context: BaseContext, type: SystemToneType): Promise<ToneAttrs>;

    /**
     * Gets attribute list of alarm tones.
     * @param { BaseContext } context - Current application context.
     * @param { SystemToneType } type - System tone type to get.
     * @returns { Promise<ToneAttrsArray> } Promise used to return attribute list of system tone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getSystemToneAttrList(context: BaseContext, type: SystemToneType): Promise<ToneAttrsArray>;

    /**
     * Gets the system tone player.
     * @param { BaseContext } context - Current application context.
     * @param { SystemToneType } type - System tone type to get.
     * @returns { Promise<SystemTonePlayer> } Promise used to return the SystemTonePlayer.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 11
     */
    getSystemTonePlayer(context: BaseContext, type: SystemToneType): Promise<SystemTonePlayer>;

    /**
     * Gets attributes of the default alarm tone.
     *
     * @param { BaseContext } context - Current application context.
     * @returns { Promise<ToneAttrs> } Promise used to return attributes of the default alarm tone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getDefaultAlarmToneAttrs(context: BaseContext): Promise<ToneAttrs>;

    /**
     * Sets uri of the current alarm tone.
     *
     * @param { BaseContext } context - Current application context.
     * @param { string } uri - Alarm tone uri.
     * @returns { Promise<void> } Promise used to return result of set alarm tone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @throws { BusinessError } 20700001 - Tone type mismatch, e.g. tone of input uri is not an alarm tone.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    setAlarmToneUri(context: BaseContext, uri: string): Promise<void>;

    /**
     * Gets uri of the current alarm tone.
     *
     * @param { BaseContext } context - Current application context.
     * @returns { Promise<string> } Promise used to return uri of current alarm tone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getAlarmToneUri(context: BaseContext): Promise<string>;

    /**
     * Gets attribute list of alarm tones.
     * @param { BaseContext } context - Current application context.
     * @returns { Promise<ToneAttrsArray> } Promise used to return attribute list of system tone.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    getAlarmToneAttrList(context: BaseContext): Promise<ToneAttrsArray>;

    /**
     * Open alarm tone file.
     * @param { BaseContext } context - Current application context.
     * @param { string } uri - Uri of alarm tone to open.
     * @returns { Promise<number> } Promise used to return fd.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @throws { BusinessError } 20700001 - Tone type mismatch, e.g. tone of uri is notification instead of alarm.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    openAlarmTone(context: BaseContext, uri: string): Promise<number>

    /**
     * Close fd.
     * @param { number } fd - File descriptor to close.
     * @returns { Promise<void> } Promise used to return the result of close fd.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    close(fd: number): Promise<void>;

    /**
     * Add customized tone into ringtone library.
     * @permission ohos.permission.WRITE_RINGTONE
     * @param { BaseContext } context - Current application context.
     * @param { ToneAttrs } toneAttr - Tone attributes created by {@link createCustomizedToneAttrs}.
     * @param { string } externalUri - Tone uri in external storage.
     * @returns { Promise<string> } Tone uri after adding into ringtone library.
     * @throws { BusinessError } 201 - Permission denied.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400102 - Operation is not allowed, e.g. ringtone to add is not customized.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    addCustomizedTone(context: BaseContext, toneAttr: ToneAttrs, externalUri: string): Promise<string>;

    /**
     * Add customized tone into ringtone library.
     * @permission ohos.permission.WRITE_RINGTONE
     * @param { BaseContext } context - Current application context.
     * @param { ToneAttrs } toneAttr - Tone attributes created by {@link createCustomizedToneAttrs}.
     * @param { number } fd - File descriptor.
     * @param { number } [offset] - The offset in the file where the data to be read, in bytes. By default, the offset
     * is zero.
     * @param { number } [length] - The length in bytes of the data to be read. By default, the length is the rest of
     * bytes in the file from the offset.
     * @returns { Promise<string> } Tone uri after adding into ringtone library.
     * @throws { BusinessError } 201 - Permission denied.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400102 - Operation is not allowed, e.g. ringtone to add is not customized.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    addCustomizedTone(context: BaseContext, toneAttr: ToneAttrs, fd: number, offset?: number, length?: number)
      : Promise<string>;

    /**
     * Remove customized tone in ringtone library.
     * @permission ohos.permission.WRITE_RINGTONE
     * @param { BaseContext } context - Current application context.
     * @param { string } uri - Tone uri.
     * @returns { Promise<void> } Promise used to return removing result.
     * @throws { BusinessError } 201 - Permission denied.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400102 - Operation is not allowed, e.g. ringtone of this uri is not customized.
     * @throws { BusinessError } 5400103 - I/O error.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 12
     */
    removeCustomizedTone(context: BaseContext, uri:string): Promise<void>;

    /**
     * Get haptics settings.
     * @param { BaseContext } context - Current application context.
     * @param { ToneHapticsType } type - Tone haptics type.
     * @returns { Promise<ToneHapticsSettings> } Promise used to return results of this call.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @throws { BusinessError } 20700003 - Unsupported operation.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    getToneHapticsSettings(context: BaseContext, type: ToneHapticsType): Promise<ToneHapticsSettings>;

    /**
     * Set haptics settings.
     * @param { BaseContext } context - Current application context.
     * @param { ToneHapticsType } type - Tone haptics type.
     * @param { ToneHapticsSettings } settings - Tone haptics settings.
     * @returns { Promise<void> } Promise used to return results of this call.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400102 - Operation not allowed. For example, the input URI is not valid.
     * @throws { BusinessError } 5400103 - I/O error.
     * @throws { BusinessError } 20700003 - Unsupported operation.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    setToneHapticsSettings(context: BaseContext, type: ToneHapticsType, settings: ToneHapticsSettings): Promise<void>;

    /**
     * Get haptics list.
     * @param { BaseContext } context - Current application context.
     * @param { boolean } isSynced - The queried haptics is synchronized with tone or not.
     * @returns { Promise<ToneHapticsAttrsArray> } Promise used to return ToneHapticsAttrsArray.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400103 - I/O error.
     * @throws { BusinessError } 20700003 - Unsupported operation.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    getToneHapticsList(context: BaseContext, isSynced: boolean): Promise<ToneHapticsAttrsArray>;

    /**
     * Get attributes of haptics which is synchronized with one tone. If no haptics is found, then the attributes in
     * the returned ToneHapticsAttrs is empty.
     * @param { BaseContext } context - Current application context.
     * @param { string } toneUri - Uri of tone to query.
     * @returns { Promise<ToneHapticsAttrs> } Promise used to return ToneHapticsAttrs.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400102 - Operation not allowed. For example, the input URI is not used for tones.
     * @throws { BusinessError } 5400103 - I/O error.
     * @throws { BusinessError } 20700003 - Unsupported operation.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    getHapticsAttrsSyncedWithTone(context: BaseContext, toneUri: string): Promise<ToneHapticsAttrs>;

    /**
     * Open haptics.
     * @param { BaseContext } context - Current application context.
     * @param { string } hapticsUri - Uri of haptics to open.
     * @returns { Promise<number> } Promise used to return fd.
     * @throws { BusinessError } 202 - Caller is not a system application.
     * @throws { BusinessError } 401 - Parameter error. Possible causes:
     *                                 1.Mandatory parameters are left unspecified;
     *                                 2.Incorrect parameter types.
     * @throws { BusinessError } 5400102 - Operation not allowed. For example, the input URI is not one for haptics.
     * @throws { BusinessError } 5400103 - I/O error.
     * @throws { BusinessError } 20700003 - Unsupported operation.
     * @syscap SystemCapability.Multimedia.SystemSound.Core
     * @systemapi
     * @since 13
     */
    openToneHaptics(context: BaseContext, hapticsUri: string): Promise<number>;
  }

  /**
   * Ringtone player object.
   * @typedef { _RingtonePlayer } RingtonePlayer
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 10
   */
  type RingtonePlayer = _RingtonePlayer;

  /**
   * SystemTone player object.
   * @typedef { _SystemTonePlayer } SystemTonePlayer
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 11
   */
  type SystemTonePlayer = _SystemTonePlayer;

  /**
   * Interface for ringtone options.
   * @typedef { _RingtoneOptions } RingtoneOptions
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 10
   */
  type RingtoneOptions = _RingtoneOptions;

  /**
   * System tone options.
   * @typedef { _SystemToneOptions } SystemToneOptions
   * @syscap SystemCapability.Multimedia.SystemSound.Core
   * @systemapi
   * @since 11
   */
  type SystemToneOptions = _SystemToneOptions;
}

export default systemSoundManager;