1# Using TonePlayer for Audio Playback (for System Applications Only) 2 3TonePlayer<sup>9+</sup> provides APIs for playing and managing Dual Tone Multi Frequency (DTMF) tones, such as dial tones, ringback tones, supervisory tones, and proprietary tones. The main task of the TonePlayer is to generate sine waves of different frequencies by using the built-in algorithm based on the [ToneType](../reference/apis/js-apis-audio.md#tonetype9) and add the sine waves to create a sound. The sound can then be played by using the [AudioRenderer](../reference/apis/js-apis-audio.md#audiorenderer8), and the playback task can also be managed by using the [AudioRenderer](../reference/apis/js-apis-audio.md#audiorenderer8). The full process includes loading the DTMF tone configuration, starting DTMF tone playing, stopping the playback, and releasing the resources associated with the **TonePlayer** object. For details about the APIs, see the [TonePlayer API Reference](../reference/apis/js-apis-audio.md#toneplayer9). 4 5 6## Supported Tone Types 7 8The table below lists the supported [ToneType](../reference/apis/js-apis-audio.md#tonetype9)s. You can call **load()** with **audio.ToneType.*type*** as a parameter to load the tone resource of the specified type. 9 10| Tone Type| Value| Description| 11| -------- | -------- | -------- | 12| TONE_TYPE_DIAL_0 | 0 | DTMF tone of key 0.| 13| TONE_TYPE_DIAL_1 | 1 | DTMF tone of key 1.| 14| TONE_TYPE_DIAL_2 | 2 | DTMF tone of key 2.| 15| TONE_TYPE_DIAL_3 | 3 | DTMF tone of key 3.| 16| TONE_TYPE_DIAL_4 | 4 | DTMF tone of key 4.| 17| TONE_TYPE_DIAL_5 | 5 | DTMF tone of key 5.| 18| TONE_TYPE_DIAL_6 | 6 | DTMF tone of key 6.| 19| TONE_TYPE_DIAL_7 | 7 | DTMF tone of key 7.| 20| TONE_TYPE_DIAL_8 | 8 | DTMF tone of key 8.| 21| TONE_TYPE_DIAL_9 | 9 | DTMF tone of key 9.| 22| TONE_TYPE_DIAL_S | 10 | DTMF tone of the star key (*).| 23| TONE_TYPE_DIAL_P | 11 | DTMF tone of the pound key (#).| 24| TONE_TYPE_DIAL_A | 12 | DTMF tone of key A.| 25| TONE_TYPE_DIAL_B | 13 | DTMF tone of key B.| 26| TONE_TYPE_DIAL_C | 14 | DTMF tone of key C.| 27| TONE_TYPE_DIAL_D | 15 | DTMF tone of key D.| 28| TONE_TYPE_COMMON_SUPERVISORY_DIAL | 100 | Supervisory tone - dial tone.| 29| TONE_TYPE_COMMON_SUPERVISORY_BUSY | 101 | Supervisory tone - busy.| 30| TONE_TYPE_COMMON_SUPERVISORY_CONGESTION | 102 | Supervisory tone - congestion.| 31| TONE_TYPE_COMMON_SUPERVISORY_RADIO_ACK | 103 | Supervisory tone - radio path acknowledgment.| 32| TONE_TYPE_COMMON_SUPERVISORY_RADIO_NOT_AVAILABLE | 104 | Supervisory tone - radio path not available.| 33| TONE_TYPE_COMMON_SUPERVISORY_CALL_WAITING | 106 | Supervisory tone - call waiting tone.| 34| TONE_TYPE_COMMON_SUPERVISORY_RINGTONE | 107 | Supervisory tone - ringing tone.| 35| TONE_TYPE_COMMON_PROPRIETARY_BEEP | 200 | Proprietary tone - beep tone.| 36| TONE_TYPE_COMMON_PROPRIETARY_ACK | 201 | Proprietary tone - ACK.| 37| TONE_TYPE_COMMON_PROPRIETARY_PROMPT | 203 | Proprietary tone - PROMPT.| 38| TONE_TYPE_COMMON_PROPRIETARY_DOUBLE_BEEP | 204 | Proprietary tone - double beep tone.| 39 40 41## How to Develop 42 43To implement audio playback with the TonePlayer, perform the following steps: 44 451. Create a **TonePlayer** instance. 46 47 ```ts 48 import audio from '@ohos.multimedia.audio'; 49 50 let audioRendererInfo: audio.AudioRendererInfo = { 51 usage : audio.StreamUsage.STREAM_USAGE_DTMF, 52 rendererFlags : 0 53 }; 54 async function createTonePlayer() { 55 let tonePlayerPromise = await audio.createTonePlayer(audioRendererInfo); 56 } 57 ``` 58 592. Load the DTMF tone configuration of the specified type. 60 61 ```ts 62 async function load() { 63 await tonePlayerPromise.load(audio.ToneType.TONE_TYPE_DIAL_0); 64 } 65 ``` 66 673. Start DTMF tone playing. 68 69 ```ts 70 async function start() { 71 await tonePlayerPromise.start(); 72 } 73 ``` 74 754. Stop the tone that is being played. 76 77 ```ts 78 async function stop() { 79 await tonePlayerPromise.stop(); 80 } 81 ``` 82 835. Release the resources associated with the **TonePlayer** instance. 84 85 ```ts 86 async function release() { 87 await tonePlayerPromise.release(); 88 } 89 ``` 90 91If the APIs are not called in the preceding sequence, the error code **6800301 NAPI_ERR_SYSTEM** is returned. 92 93 94## Sample Code 95 96Refer to the following code to play the DTMF tone when the dial key on the keyboard is pressed. 97 98To prevent the UI thread from being blocked, most **TonePlayer** calls are asynchronous. Each API provides the callback and promise functions. The following examples use the promise functions. For more information, see [TonePlayer](../reference/apis/js-apis-audio.md#toneplayer9). 99 100 101```ts 102import audio from '@ohos.multimedia.audio'; 103import { BusinessError } from '@ohos.base'; 104 105let timerPro : number; 106// Promise mode. 107async function testTonePlayerPromise(type: audio.ToneType) { 108 console.info('testTonePlayerPromise start'); 109 if (timerPro) clearTimeout(timerPro); 110 let tonePlayerPromise: audio.TonePlayer; 111 let audioRendererInfo: audio.AudioRendererInfo = { 112 usage : audio.StreamUsage.STREAM_USAGE_DTMF, 113 rendererFlags : 0 114 }; 115 timerPro = setTimeout(async () => { 116 try { 117 console.info('testTonePlayerPromise: createTonePlayer'); 118 // Create a DTMF player. 119 tonePlayerPromise = await audio.createTonePlayer(audioRendererInfo); 120 console.info('testTonePlayerPromise: createTonePlayer-success'); 121 console.info(`testTonePlayerPromise: load type: ${type}`); 122 // Load the tone configuration of the specified type. 123 await tonePlayerPromise.load(type); 124 console.info('testTonePlayerPromise: load-success'); 125 console.info(`testTonePlayerPromise: start type: ${type}`); 126 // Start DTMF tone playing. 127 await tonePlayerPromise.start(); 128 console.info('testTonePlayerPromise: start-success'); 129 console.info(`testTonePlayerPromise: stop type: ${type}`); 130 setTimeout(async()=>{ 131 // Stop the tone that is being played. 132 await tonePlayerPromise.stop(); 133 console.info('testTonePlayerPromise: stop-success'); 134 console.info(`testTonePlayerPromise: release type: ${type}`); 135 // Release the resources associated with the TonePlayer instance. 136 await tonePlayerPromise.release(); 137 console.info('testTonePlayerPromise: release-success'); 138 }, 30) 139 } catch(err) { 140 let error = err as BusinessError; 141 console.error(`testTonePlayerPromise err : ${error}`); 142 } 143 }, 200) 144}; 145 146async function testTonePlayer() { 147 testTonePlayerPromise(audio.ToneType.TONE_TYPE_DIAL_0); 148} 149 150``` 151