# 媒体

# 开始录音

# 使用说明

启动语音录制。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.startRecord({
  onSuccess: function (result) {
    //支持最长为300秒（包括）的音频录制，默认60秒(包括)。
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
startRecord({...});

# 参数说明

参数	参数类型	必须	说明
maxDuration	Number	否	可选参数，录音最大时长，单位：秒，必须为整数，范围[1,300]。

# 返回说明

无

# 调试

device.audio.startRecord

# 开始录音V2 v4.1.4-beta2

# 使用说明

启动语音录制。

与原版差异：原版为返回资源id，V2以base64形式返回文件。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.startRecord_v2({
  onSuccess: function (result) {
    //支持最长为300秒（包括）的音频录制，默认60秒(包括)。
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
startRecord_v2({...});

# 参数说明

参数	参数类型	必须	说明
maxDuration	Number	否	可选参数，录音最大时长，单位：秒，必须为整数，范围[1,300]。

# 返回说明

无

# 调试

device.audio.startRecord_v2

# 停止录音

# 使用说明

停止语音录制，同时将录制的语音上传到服务端，返回音频资源的 MediaID。返回的 MediaID，可用于本地播放和音频下载。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.stopRecord({
  onSuccess: function(result) {
    result.mediaId; // 返回音频的MediaID，可用于本地播放和音频下载
    result.duration; // 返回音频的时长，单位：秒
  },
  onFail: function(err) {}
});

// 按需加载调用方式，参数与全量引入相同
stopRecord({...});

# 参数说明

无

# 返回说明

无

# 调试

device.audio.stopRecord

# 停止录音V2 v4.1.4-beta2

# 使用说明

停止语音录制，返回录音文件数据流 base64 后的字符串。与原版差异：原版为返回资源id，V2以base64形式返回文件。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.stopRecord_v2({
  onSuccess: function(result) {
    result.content; // 返回音频数据流 base64 后的字符串
    result.duration; // 返回音频的时长，单位：秒
  },
  onFail: function(err) {}
});

// 按需加载调用方式，参数与全量引入相同
stopRecord_v2({...});

# 参数说明

无

# 返回说明

无

# 调试

device.audio.stopRecord_v2

# 监听录音自动停止

# 使用说明

当语音录制时间超过 60 秒时，钉钉会自动停止语音录制，同时将录制的语音上传到服务端，返回音频资源的 MediaID。推荐在调用 dd.device.audio.startRecord 前设置监听录音自动停止的回调。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.onRecordEnd({
  onSuccess: function(result) {
    result.mediaId; // 停止播放音频MediaID
    result.duration; // 返回音频的时长，单位：秒
  },
  onFail: function(err) {}
});

// 按需加载调用方式，参数与全量引入相同
onRecordEnd({...});

# 参数说明

无

# 返回说明

无

# 调试

device.audio.onRecordEnd

# 监听录音自动停止V2 v4.1.4-beta2

# 使用说明

当语音录制时间超过最大录音时长时，会自动停止语音录制。推荐在调用 dd.device.audio.startRecord_v2 前设置监听录音自动停止的回调。与原版差异：原版为返回资源id，V2以base64形式返回文件。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.onRecordEnd_v2({
  onSuccess: function(result) {
    result.content; // 返回音频数据流 base64 后的字符串
    result.duration; // 返回音频的时长，单位：秒
  },
  onFail: function(err) {}
});

// 按需加载调用方式，参数与全量引入相同
onRecordEnd_v2({...});

# 参数说明

无

# 返回说明

无

# 调试

device.audio.onRecordEnd_v2

# 下载音频

# 使用说明

使用 yy.device.audio.stopRecord 或者 yy.device.audio.onRecordEnd 获取的 MediaId 下载音频资源。下载完成后返回音频在本地的 MediaId。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.download({
  mediaId : "@lATOCLhLfc46kUl8zlUmRlM",
  onSuccess: function (result) {
    result.localAudioId;
    /*{}*/
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
downloadAudio({...});

# 参数说明

参数	参数类型	必传	说明
mediaId	String	是	音频在服务端的标识

# 返回说明

无

# 调试

device.audio.download

# 播放音频

# 使用说明

播放音频，在播放语音前可以使用 yy.device.audio.startRecord 开启录音，通过 yy.device.audio.stopRecord、yy.device.audio.onRecordEnd 获取录制的音频的 MediaId 或者通过 yy.device.audio.download 下载服务端音频资源获取 localAudioId。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.play({
  localAudioId : "localAudioId",
  onSuccess: function (result) {
    /*{}*/
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
playAudio({...});

# 参数说明

参数	参数类型	必传	说明
localAudioId	String	是	音频在设备本地的标识

# 返回说明

无

# 调试

device.audio.play

# 暂停播放音频

# 使用说明

暂停正在播放的语音

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.pause({
  localAudioId : "localAudioId",
  onSuccess: function (result) {
    /*
        {}
        */
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
pauseAudio({...});

# 参数说明

参数	参数类型	必传	说明
localAudioId	String	是	正在播放的音频的本地标识

# 返回说明

无

# 调试

device.audio.pause

# 停止播放音频

# 使用说明

停止播放音频

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	否

// 全量引入调用方式
yy.device.audio.stop({
  localAudioId : "localAudioId",
  onSuccess: function (result) {
    /*
      {}
      */
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
stopAudio({...});

# 参数说明

参数	参数类型	必传	说明
localAudioId	String	是	处于播放或者暂停状态的语音的本地标识

# 返回说明

无

# 调试

device.audio.stop

# 监听播放自动停止

# 使用说明

语音播放完毕时自动调用该方法设置的回调，并返回音频的的本地标识。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.onPlayEnd({
  onSuccess: function (result) {
    /*
        {}
        */
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
onPlayEnd({...});

# 参数说明

无

# 返回说明

无

# 调试

device.audio.onPlayEnd

# 恢复暂停播放的语音

# 使用说明

恢复播放处于暂停状态的语音。

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	是

// 全量引入调用方式
yy.device.audio.resume({
  onSuccess: function (result) {
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
resumeAudio({...});

# 参数说明

参数	参数类型	必传	说明
localAudioId	String	是	处于暂停状态的语音的本地标识

# 返回说明

无

# 调试

device.audio.resume

# 二维码扫描 v2.1.0

# 使用说明

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	不需要

yy.biz.util.scan({
  type: String,
  onSuccess: function (result) {
    //onSuccess将在点击完成之后回调
    /*{
            value: "2015-02-10"
        }
        */
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
scan({...});

# 参数说明

参数	参数类型	必传	说明
type	String	是	type 为 qrCode(二维码)、barCode（仅条形码）、all(全部)，默认 all。 hideAlbum int类型，传1是隐藏相册，传0或者不传就不隐藏 autoZoom int类型，传1是开启自动缩放，传0或者不传就不开启自动缩放

# 返回说明

参数	说明
text	扫码内容

# 调试

biz.util.scan

# 摄像头拍照 v4.0.9-beta3

# 使用说明

Android	iOS	PC	是否需要鉴权
支持	支持	不支持	不需要

yy.biz.util.takePicture({
  isFront: true,
  onSuccess: function (result) {
    /*{
        value: '照片地址'
      }
      */
  },
  onFail: function (err) {},
});

// 按需加载调用方式，参数与全量引入相同
takePicture({...});

# 参数说明

参数	参数类型	必传	说明
isFront	Boolean	否	true: 前置摄像头 false: 后置摄，默认 false

# 返回说明

参数	说明
value	照片地址

# 调试

biz.util.takePicture

← UI 组件导航栏 →