# 音频 audio

# 接口声明

{ "name": "system.audio" }
1

# 导入模块

import audio from '@system.audio' 或 const audio = require('@system.audio')
1

# 接口定义

# 方法

# audio.play()

开始播放音频

# 参数

无

# 示例：
audio.play()
1

# audio.pause()

暂停播放音频

# 参数

无

# 示例：
audio.pause()
1

# audio.stop()

停止音频播放，可以通过 play 重新播放音频

# 参数

无

# 示例：
audio.stop()
1

# audio.getPlayState(OBJECT)

获取当前播放状态数据

# 参数
参数名 类型 必填 说明
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调
# success 返回值：
参数值 类型 说明
state String 播放状态,分别为'play','pause','stop'
src String 当前播放的音频媒体 uri，停止时返回空字符串
currentTime Number 当前音频的当前进度，单位秒,停止时返回-1
# 示例：
audio.getPlayState({
  success: function(data) {
    console.log(`
      handling success: state: ${data.state},
      src:${data.src}
    `)
  },
  fail: function(data, code) {
    console.log('handling fail, code=' + code)
  }
})
1
2
3
4
5
6
7
8
9
10
11

# 属性

名称 参数类型 是否可读 是否可写 必填 描述
src String 是 是 是 播放的音频媒体 uri, 支持本地绝对路径（internal://）和网络路径（https://）
currentTime Number 是 是 否 音频的当前进度，单位秒，对值设置可以调整播放进度
duration Number 是 否 否 音频文件的总时长，单位秒，未知返回 NaN
streamType String 是 是 否 指定使用音频类型，可设置的值有 music、voicecall，值为 music 时使用扬声器播放，voicecall 时使用听筒播放，默认为 music。

# 示例：

let streamType = audio.streamType
audio.streamType = 'voicecall'
1
2

# 事件

名称 描述
play 在调用 play 方法后的回调事件
pause 在调用 pause 方法后的回调事件
stop 在调用 stop 方法后的回调事件
ended 播放结束时的回调事件
error 播放发生错误时的回调事件

# 示例：

audio.onplay = function() {
  console.log(`audio pay`)
}
1
2
3