1# 使用TonePlayer开发音频播放功能(仅对系统应用开放)
2
3TonePlayer<sup>9+</sup>提供播放和管理DTMF（Dual Tone Multi Frequency，双音多频）音调的方法，包括各种系统监听音调、专有音调，如拨号音、通话回铃音等。主要工作是将需要生成音调的[ToneType](../../reference/apis-audio-kit/js-apis-audio-sys.md#tonetype9)类型，通过自带算法生成多个不同频率的正弦波叠加形成声音数据，通过[AudioRenderer](../../reference/apis-audio-kit/js-apis-audio.md#audiorenderer8)进行播放，同时对播放任务进行管理。包含加载DTMF音调配置、启动DTMF音调播放、停止当前正在播放的音调、释放与此TonePlayer对象关联的资源等流程。详细API说明请参考[TonePlayer API文档](../../reference/apis-audio-kit/js-apis-audio-sys.md#toneplayer9)。
4
5
6## 支持的播放音调类型
7
8播放音调类型[ToneType](../../reference/apis-audio-kit/js-apis-audio-sys.md#tonetype9)信息（如下表所示），可通过"audio.ToneType.指定类型" 作为参数调用load()方法加载指定类型的音调资源。
9
10| 播放音调类型 | 值 | 说明 |
11| -------- | -------- | -------- |
12| TONE_TYPE_DIAL_0 | 0 | 键0的DTMF音。 |
13| TONE_TYPE_DIAL_1 | 1 | 键1的DTMF音。 |
14| TONE_TYPE_DIAL_2 | 2 | 键2的DTMF音。 |
15| TONE_TYPE_DIAL_3 | 3 | 键3的DTMF音。 |
16| TONE_TYPE_DIAL_4 | 4 | 键4的DTMF音。 |
17| TONE_TYPE_DIAL_5 | 5 | 键5的DTMF音。 |
18| TONE_TYPE_DIAL_6 | 6 | 键6的DTMF音。 |
19| TONE_TYPE_DIAL_7 | 7 | 键7的DTMF音。 |
20| TONE_TYPE_DIAL_8 | 8 | 键8的DTMF音。 |
21| TONE_TYPE_DIAL_9 | 9 | 键9的DTMF音。 |
22| TONE_TYPE_DIAL_S | 10 | 键\*的DTMF音。 |
23| TONE_TYPE_DIAL_P | 11 | 键\#的DTMF音。 |
24| TONE_TYPE_DIAL_A | 12 | 键A的DTMF音。 |
25| TONE_TYPE_DIAL_B | 13 | 键B的DTMF音。 |
26| TONE_TYPE_DIAL_C | 14 | 键C的DTMF音。 |
27| TONE_TYPE_DIAL_D | 15 | 键D的DTMF音。 |
28| TONE_TYPE_COMMON_SUPERVISORY_DIAL | 100 | 呼叫监管音调，拨号音。 |
29| TONE_TYPE_COMMON_SUPERVISORY_BUSY | 101 | 呼叫监管音调，忙。 |
30| TONE_TYPE_COMMON_SUPERVISORY_CONGESTION | 102 | 呼叫监管音调，拥塞。 |
31| TONE_TYPE_COMMON_SUPERVISORY_RADIO_ACK | 103 | 呼叫监管音调，无线电&nbsp;ACK。 |
32| TONE_TYPE_COMMON_SUPERVISORY_RADIO_NOT_AVAILABLE | 104 | 呼叫监管音调，无线电不可用。 |
33| TONE_TYPE_COMMON_SUPERVISORY_CALL_WAITING | 106 | 呼叫监管音调，呼叫等待。 |
34| TONE_TYPE_COMMON_SUPERVISORY_RINGTONE | 107 | 呼叫监管音调，铃声。 |
35| TONE_TYPE_COMMON_PROPRIETARY_BEEP | 200 | 专有声调，一般蜂鸣声。 |
36| TONE_TYPE_COMMON_PROPRIETARY_ACK | 201 | 专有声调，ACK。 |
37| TONE_TYPE_COMMON_PROPRIETARY_PROMPT | 203 | 专有声调，PROMPT。 |
38| TONE_TYPE_COMMON_PROPRIETARY_DOUBLE_BEEP | 204 | 专有声调，双重蜂鸣声。 |
39
40
41## 开发步骤及注意事项
42
43以下步骤描述了TonePlayer接口实现播放功能流程：
44
451. 创建DTMF播放器 ，获取tonePlayer实例。
46
47```ts
48import { audio } from '@kit.AudioKit';
49
50let audioRendererInfo: audio.AudioRendererInfo = {
51  usage : audio.StreamUsage.STREAM_USAGE_DTMF,
52  rendererFlags : 0
53};
54
55async function createTonePlayer() {
56  let tonePlayerPromise = await audio.createTonePlayer(audioRendererInfo);
57}
58```
59
602. 加载指定类型DTMF音调配置。
61
62```ts
63async function load() {
64  await tonePlayerPromise.load(audio.ToneType.TONE_TYPE_DIAL_0);
65}
66```
67
683. 启动DTMF音调播放。
69
70```ts
71async function start() {
72  await tonePlayerPromise.start();
73}
74```
75
764. 停止当前正在播放的音调。
77
78```ts
79async function stop() {
80  await tonePlayerPromise.stop();
81}
82```
83
845. 释放与此TonePlayer对象关联的资源。
85
86```ts
87async function release() {
88  await tonePlayerPromise.release();
89}
90```
91
92在接口未按此正常调用时序调用时，接口会返回错误码6800301 NAPI_ERR_SYSTEM。
93
94
95## 完整示例
96
97参考以下示例，点击键盘拨号按键，并启动对应的DTMF音调播放。
98
99为保证UI线程不被阻塞，大部分TonePlayer调用都是异步的。对于每个API均提供了callback函数和Promise函数，以下示例均采用Promise函数，更多方式可参考API文档[TonePlayer](../../reference/apis-audio-kit/js-apis-audio-sys.md#toneplayer9)。
100
101
102```ts
103import { audio } from '@kit.AudioKit';
104import { BusinessError } from '@kit.BasicServicesKit';
105
106let timerPro : number;
107// promise调用方式
108async function testTonePlayerPromise(type: audio.ToneType) {
109  console.info('testTonePlayerPromise start');
110  if (timerPro) clearTimeout(timerPro);
111  let tonePlayerPromise: audio.TonePlayer;
112  let audioRendererInfo: audio.AudioRendererInfo = {
113    usage : audio.StreamUsage.STREAM_USAGE_DTMF,
114    rendererFlags : 0
115  };
116  timerPro = setTimeout(async () => {
117    try {
118      console.info('testTonePlayerPromise: createTonePlayer');
119      // 创建DTMF播放器
120      tonePlayerPromise = await audio.createTonePlayer(audioRendererInfo);
121      console.info('testTonePlayerPromise: createTonePlayer-success');
122      console.info(`testTonePlayerPromise: load type: ${type}`);
123      // 加载type类型音调
124      await tonePlayerPromise.load(type);
125      console.info('testTonePlayerPromise: load-success');
126      console.info(`testTonePlayerPromise: start type: ${type}`);
127      // 启动DTMF音调播放
128      await tonePlayerPromise.start();
129      console.info('testTonePlayerPromise: start-success');
130      console.info(`testTonePlayerPromise: stop type: ${type}`);
131      setTimeout(async()=>{
132        // 停止当前正在播放的音调
133        await tonePlayerPromise.stop();
134        console.info('testTonePlayerPromise: stop-success');
135        console.info(`testTonePlayerPromise: release type: ${type}`);
136        // 释放与此TonePlayer对象关联的资源
137        await tonePlayerPromise.release();
138        console.info('testTonePlayerPromise: release-success');
139      }, 30)
140    } catch(err) {
141      let error = err as BusinessError;
142      console.error(`testTonePlayerPromise err : ${error}`);
143    }
144  }, 200)
145};
146
147async function testTonePlayer() {
148   testTonePlayerPromise(audio.ToneType.TONE_TYPE_DIAL_0);
149}
150```
151