# 废弃的Interface (AudioPlayer, deprecated)

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer替代。

音频播放管理类，用于管理和播放音频媒体。在调用AudioPlayer的方法前，需要先通过createAudioPlayer()构建一个AudioPlayer实例。

#### 导入模块

```
import { media } from '@kit.MediaKit';
```

#### 属性(deprecated)

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

| 名称 | 类型 | 只读 | 可选 | 说明 |
| --- | --- | --- | --- | --- |
| src | string | 否 | 否 | 音频媒体URI，支持当前主流的音频格式(m4a、aac、mp3、ogg、wav、amr)。 支持路径示例： 1. fd类型播放：fd://xx 2. http网络播放:  3. https网络播放:  4. hls网络播放路径： 需要权限： ohos.permission.READ_MEDIA 或 ohos.permission.INTERNET。 |
| fdSrc9+ | AVFileDescriptor | 否 | 否 | 音频媒体文件描述，使用场景：应用中的音频资源被连续存储在同一个文件中。 使用示例： 假设一个连续存储的音乐文件: 音乐1(地址偏移:0，字节长度:100) 音乐2(地址偏移:101，字节长度:50) 音乐3(地址偏移:151，字节长度:150) 1. 播放音乐1：AVFileDescriptor { fd = 资源句柄; offset = 0; length = 100; } 2. 播放音乐2：AVFileDescriptor { fd = 资源句柄; offset = 101; length = 50; } 3. 播放音乐3：AVFileDescriptor { fd = 资源句柄; offset = 151; length = 150; } 假设是一个独立的音乐文件: 请使用src=fd://xx |
| loop | boolean | 否 | 否 | 音频循环播放属性，设置为'true'表示循环播放。 |
| audioInterruptMode9+ | audio.InterruptMode | 否 | 是 | 音频焦点模型。 |
| currentTime | number | 是 | 否 | 音频的当前播放位置，单位为毫秒（ms）。 |
| duration | number | 是 | 否 | 音频时长，单位为毫秒（ms）。 |
| state | AudioState | 是 | 否 | 可以查询音频播放的状态，该状态不可作为调用play/pause/stop等状态切换的触发条件。 |

#### play(deprecated)

play(): void

开始播放音频资源，需在'dataLoad'事件成功触发后，才能调用。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.play替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**示例：**

```
audioPlayer.on('play', () => {    // 设置'play'事件回调。
  console.info('audio play called');
});
audioPlayer.play();
```

#### pause(deprecated)

pause(): void

暂停播放音频资源。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.pause替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**示例：**

```
audioPlayer.on('pause', () => {    // 设置'pause'事件回调。
  console.info('audio pause called');
});
audioPlayer.pause();
```

#### stop(deprecated)

stop(): void

停止播放音频资源。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.stop替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**示例：**

```
audioPlayer.on('stop', () => {    // 设置'stop'事件回调。
  console.info('audio stop called');
});
audioPlayer.stop();
```

#### reset(deprecated)

reset(): void

重置播放音频资源。

从API version 7开始支持，从API version 9开始废弃，建议使用AVPlayer.reset替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**示例：**

```
audioPlayer.on('reset', () => {    // 设置'reset'事件回调。
  console.info('audio reset called');
});
audioPlayer.reset();
```

#### seek(deprecated)

seek(timeMs: number): void

跳转到指定播放位置。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.seek替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**参数：**

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围[0, duration]。 |

**示例：**

```
audioPlayer.on('timeUpdate', (seekDoneTime: number) => {    // 设置'timeUpdate'事件回调。
  if (seekDoneTime == null) {
    console.error('Failed to seek');
    return;
  }
  console.info('Succeeded in seek. seekDoneTime: ' + seekDoneTime);
});
audioPlayer.seek(30000);    // seek到30000ms的位置。
```

#### setVolume(deprecated)

setVolume(vol: number): void

设置音量。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.setVolume替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**参数：**

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 |

**示例：**

```
audioPlayer.on('volumeChange', () => {    // 设置'volumeChange'事件回调。
  console.info('audio volumeChange called');
});
audioPlayer.setVolume(1);    // 设置音量到100%。
```

#### release(deprecated)

release(): void

释放音频资源。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.release替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**示例：**

```
audioPlayer.release();
audioPlayer = undefined;
```

#### getTrackDescription(deprecated)

getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void

获取音频轨道信息。需在'dataLoad'事件成功触发后，才能调用。通过回调函数获取返回值。

从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.getTrackDescription替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**参数：**

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| callback | AsyncCallback<Array<MediaDescription>> | 是 | 回调函数。获取音频轨道信息成功时，err为undefined，data为获取到的MediaDescription数组，否则为错误对象。 |

**示例：**

```
import { BusinessError } from '@kit.BasicServicesKit';

audioPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
  if (arrList != null) {
    console.info('Succeeded in getting TrackDescription');
  } else {
    console.error(`Failed to get TrackDescription, error:${error}`);
  }
});
```

#### getTrackDescription(deprecated)

getTrackDescription(): Promise<Array<MediaDescription>>

获取音频轨道信息。需在'dataLoad'事件成功触发后，才能调用。通过Promise获取返回值。

从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.getTrackDescription替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**返回值：**

| 类型 | 说明 |
| --- | --- |
| Promise<Array<MediaDescription>> | 音频轨道信息MediaDescription数组Promise返回值。 |

**示例：**

```
import { BusinessError } from '@kit.BasicServicesKit';

audioPlayer.getTrackDescription().then((arrList: Array<media.MediaDescription>) => {
  console.info('Succeeded in getting TrackDescription');
}).catch((error: BusinessError) => {
  console.error(`Failed to get TrackDescription, error:${error}`);
});
```

#### on('bufferingUpdate')(deprecated)

on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void

开始订阅音频缓存更新事件。仅网络播放支持该订阅事件。

从API version 8开始支持，从API version 9开始废弃，建议使用AVPlayer.on('bufferingUpdate')替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**参数：**

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| type | string | 是 | 音频缓存事件回调类型，支持的事件：'bufferingUpdate'。 |
| callback | function | 是 | 音频缓存事件回调方法。 BufferingInfoTypevalue值固定为0。 |

**示例：**

```
audioPlayer.on('bufferingUpdate', (infoType: media.BufferingInfoType, value: number) => {
  console.info('audio bufferingInfo type: ' + infoType);
  console.info('audio bufferingInfo value: ' + value);
});
```

#### on('play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange')(deprecated)

on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange', callback: () => void): void

开始订阅音频播放事件。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.on('stateChange')替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**参数：**

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| type | string | 是 | 播放事件回调类型，支持的事件包括：'play' \| 'pause' \| 'stop' \| 'reset' \| 'dataLoad' \| 'finish' \| 'volumeChange'。 - 'play'：完成play()调用，音频开始播放，触发该事件。 - 'pause'：完成pause()调用，音频暂停播放，触发该事件。 - 'stop'：完成stop()调用，音频停止播放，触发该事件。 - 'reset'：完成reset()调用，播放器重置，触发该事件。 - 'dataLoad'：完成音频数据加载后触发该事件，即src属性设置完成后触发该事件。 - 'finish'：完成音频播放后触发该事件。 - 'volumeChange'：完成setVolume()调用，播放音量改变后触发该事件。 |
| callback | () => void | 是 | 播放事件回调方法。 |

**示例：**

```
import { fileIo } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';

let audioPlayer: media.AudioPlayer = media.createAudioPlayer();  // 创建一个音频播放实例。
audioPlayer.on('dataLoad', () => {            // 设置'dataLoad'事件回调，src属性设置成功后，触发此回调。
  console.info('audio set source called');
  audioPlayer.play();                       // 开始播放，并触发'play'事件回调。
});
audioPlayer.on('play', () => {                // 设置'play'事件回调。
  console.info('audio play called');
  audioPlayer.seek(30000);                  // 调用seek方法，并触发'timeUpdate'事件回调。
});
audioPlayer.on('pause', () => {               // 设置'pause'事件回调。
  console.info('audio pause called');
  audioPlayer.stop();                       // 停止播放，并触发'stop'事件回调。
});
audioPlayer.on('reset', () => {               // 设置'reset'事件回调。
  console.info('audio reset called');
  audioPlayer.release();                    // 释放播放实例资源。
  audioPlayer = undefined;
});
audioPlayer.on('timeUpdate', (seekDoneTime: number) => {  // 设置'timeUpdate'事件回调。
  if (seekDoneTime == null) {
    console.error('Failed to seek');
    return;
  }
  console.info('Succeeded in seek, and seek time is ' + seekDoneTime);
  audioPlayer.setVolume(0.5);                // 设置音量为50%，并触发'volumeChange'事件回调。
});
audioPlayer.on('volumeChange', () => {         // 设置'volumeChange'事件回调。
  console.info('audio volumeChange called');
  audioPlayer.pause();                       // 暂停播放，并触发'pause'事件回调。
});
audioPlayer.on('finish', () => {               // 设置'finish'事件回调。
  console.info('audio play finish');
  audioPlayer.stop();                        // 停止播放，并触发'stop'事件回调。
});
audioPlayer.on('error', (error: BusinessError) => {  // 设置'error'事件回调。
  console.error(`audio error called, error: ${error}`);
});

// 用户选择音频设置fd(本地播放)。
let fdPath = 'fd://';
// path路径的码流可通过"hdc file send D:\xxx\01.mp3 /data/accounts/account_0/appdata" 命令，将其推送到设备上。
let path = '/data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
fileIo.open(path).then((file) => {
  fdPath = fdPath + '' + file.fd;
  console.info('Succeeded in opening fd, fd is' + fdPath);
  audioPlayer.src = fdPath;  // 设置src属性，并触发'dataLoad'事件回调。
}, (err: BusinessError) => {
  console.error('Failed to open fd, err is' + err);
}).catch((err: BusinessError) => {
  console.error('Failed to open fd, err is' + err);
});
```

#### on('timeUpdate')(deprecated)

on(type: 'timeUpdate', callback: Callback<number>): void

开始订阅音频播放时间更新事件。处于播放状态时，每隔1s上报一次该事件。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.on('timeUpdate')替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**参数：**

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| type | string | 是 | 播放事件回调类型，支持的事件包括：'timeUpdate'。 - 'timeUpdate'：音频播放时间戳更新，开始播放后自动触发该事件。 |
| callback | Callback<number> | 是 | 播放事件回调方法。回调方法入参为更新后的时间戳。 |

**示例：**

```
audioPlayer.on('timeUpdate', (newTime: number) => {    // 设置'timeUpdate'事件回调。
  if (newTime == null) {
    console.error('Failed to do timeUpdate');
    return;
  }
  console.info('Succeeded in doing timeUpdate. seekDoneTime: ' + newTime);
});
audioPlayer.play();    // 开始播放后，自动触发时间戳更新事件。
```

#### on('audioInterrupt')(deprecated)

on(type: 'audioInterrupt', callback: (info: audio.InterruptEvent) => void): void

监听音频焦点变化事件，参考audio.InterruptEvent。

从API version 9开始支持，从API version 9开始废弃，建议使用AVPlayer.on('audioInterrupt')替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**参数：**

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| type | string | 是 | 音频焦点变化事件回调类型，支持的事件：'audioInterrupt'。 |
| callback | function | 是 | 音频焦点变化事件回调方法。 |

**示例：**

```
import { audio } from '@kit.AudioKit';

audioPlayer.on('audioInterrupt', (info: audio.InterruptEvent) => {
  console.info('audioInterrupt called,and InterruptEvent info is:' + info);
});
```

#### on('error')(deprecated)

on(type: 'error', callback: ErrorCallback): void

开始订阅音频播放错误事件，当上报error错误事件后，用户需处理error事件，退出播放操作。

从API version 6开始支持，从API version 9开始废弃，建议使用AVPlayer.on('error')替代。

**系统能力：** SystemCapability.Multimedia.Media.AudioPlayer

**参数：**

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| type | string | 是 | 播放错误事件回调类型，支持的事件包括：'error'。 - 'error'：音频播放中发生错误，触发该事件。 |
| callback | ErrorCallback | 是 | 播放错误事件回调方法。 |

**示例：**

```
import { BusinessError } from '@kit.BasicServicesKit';

audioPlayer.on('error', (error: BusinessError) => {  // 设置'error'事件回调。
  console.error(`audio error called, error: ${error}`);
});
audioPlayer.setVolume(3);  // 设置volume为无效值，触发'error'事件。
```