多媒体

接口声明

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

导入模块

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

接口定义

media.takePhoto(OBJECT)

拍摄照片

权限要求

使用相机

参数：

参数名类型必填说明
successFunction否成功回调
failFunction否失败回调
cancelFunction否取消回调
completeFunction否执行结束后的回调
success 返回值：
参数名类型说明
uriString选取的文件路径
fail 返回错误代码
错误码说明
201用户拒绝，获取相机权限失败

示例：

  1. media.takePhoto({
  2.   success: function(data) {
  3.     console.log(`handling success: ${data.uri}`)
  4.   },
  5.   fail: function (data, code) {
  6.     console.log(`handling fail, code = ${code}`)
  7.   }
  8. })

media.takeVideo(OBJECT)

拍摄视频

权限要求

使用相机

参数：

参数名类型必填说明
successFunction否成功回调，参数为 {uri: 'file:///video.avi'}
failFunction否失败回调
cancelFunction否取消回调
completeFunction否执行结束后的回调
success 返回值：
参数名类型说明
uriString选取的文件路径
fail 返回错误代码
错误码说明
201用户拒绝，获取相机权限失败

示例：

  1. media.takeVideo({
  2.   success: function(data) {
  3.     console.log(`handling success: ${data.uri}`)
  4.   },
  5.   fail: function(data, code) {
  6.     console.log(`handling fail, code = ${code}`)
  7.   }
  8. })

media.pickImage(OBJECT)

选择图片

权限要求

读手机存储

参数：

参数名类型必填说明
successFunction否成功回调
failFunction否失败回调
cancelFunction否取消回调
completeFunction否执行结束后的回调
success 返回值：
参数名类型说明
uriString选取的文件路径

示例：

  1. media.pickImage({
  2.   success: function(data) {
  3.     console.log(`handling success: ${data.uri}`)
  4.   },
  5.   fail: function (data, code) {
  6.     console.log(`handling fail, code = ${code}`)
  7.   }
  8. })

media.pickImages(OBJECT) 1040+

选择多张图片

权限要求

读手机存储

参数：

参数名类型必填说明
successFunction否成功回调
failFunction否失败回调
cancelFunction否取消回调
completeFunction否执行结束后的回调
success返回值：
参数名类型说明
urisArray选取的文件路径列表

示例：

  1. media.pickImages({
  2.   success: function (data) {
  3.     console.log(`handling success: ${data.uris}`)
  4.   },
  5.   fail: function (data, code) {
  6.     console.log(`handling fail, code = ${code}`)
  7.   }
  8. })

media.pickVideo(OBJECT)

选择视频

权限要求

读手机存储

参数：

参数名类型必填说明
successFunction否成功回调
failFunction否失败回调
cancelFunction否取消回调
completeFunction否执行结束后的回调
success 返回值：
参数名类型说明
uriString选取的文件路径

示例：

  1. media.pickVideo({
  2.   success: function(data) {
  3.     console.log(`handling success: ${data.uri}`)
  4.   },
  5.   fail: function(data, code) {
  6.     console.log(`handling fail, code = ${code}`)
  7.   }
  8. })

media.pickVideos(OBJECT) 1040+

选择多个视频

权限要求

读手机存储

参数：

参数名类型必填说明
successFunction否成功回调
failFunction否失败回调
cancelFunction否取消回调
completeFunction否执行结束后的回调
success返回值：
参数名类型说明
urisArray选取的文件路径列表

示例：

  1. media.pickVideos({
  2.   success: function (data) {
  3.     console.log(`handling success: ${data.uris}`)
  4.   },
  5.   fail: function (data, code) {
  6.     console.log(`handling fail, code = ${code}`)
  7.   }
  8. })

media.pickFile(OBJECT)1010+

选择文件

权限要求

读手机存储

参数：

参数名类型必填说明
successFunction否成功回调
failFunction否失败回调
cancelFunction否取消回调
completeFunction否执行结束后的回调
success 返回值：
参数名类型说明
uriString选取的文件路径

示例：

  1. media.pickFile({
  2.   success: function(data) {
  3.     console.log(`handling success: ${data.uri}`)
  4.   },
  5.   fail: function(data, code) {
  6.     console.log(`handling fail, code = ${code}`)
  7.   }
  8. })

media.saveToPhotosAlbum(OBJECT)1010+

将图片/视频保存到相册中

权限要求

写手机存储

参数：

参数名类型必填说明
uriString是源文件的 uri，文件的扩展名必须是图片或视频的扩展名
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
fail 返回错误代码：
错误码说明
201用户拒绝
202参数错误
300I/O 错误

示例：

  1. media.saveToPhotosAlbum({
  2.   uri: 'internal://tmp/abc.jpg',
  3.   success: function() {
  4.     console.log(`save success`)
  5.   },
  6.   fail: function(data, code) {
  7.     console.log(`handling fail, code = ${code}`)
  8.   }
  9. })

media.previewImage(OBJECT)1040+

预览图片，调用之后会在新打开的页面中全屏预览传入的图片，预览的过程中用户可以左右滑动浏览，可以通过双指缩放图片，可以保存图片到相册。

权限要求

写手机存储

参数：

参数名类型必填说明
currentNumber 或 String否数据类型可选择Number或者String：Number：当前显示的图片的下标，默认0；String：当前显示的图片链接，默认为uris中的第一张的地址
urisArray是需要预览的图片链接列表，同时支持网络和本地地址
successFunction否接口调用成功的回调函数
failFunction否接口调用失败的回调函数
completeFunction否接口调用结束的回调函数（调用成功、失败都会执行）

示例：

  1. media.previewImage({
  2.    current:'http://www.xxx.com/a.jpg',
  3.    uris:['http://www.xxx.com/a.jpg',
  4.          'http://www.xxx.com/b.jpg',
  5.          'http://www.xxx.com/c.jpg'],
  6.    success: function (){
  7.        console.log('preview success')
  8.    },
  9.    fail: function (data, code){
  10.        console.log('preview fail, code = ${code}' )
  11.    }
  12. })

media.getRingtone(OBJECT) 1040+

获取系统铃声。如果是获取来电铃声，双卡情况下，获取的是卡1对应的铃声。

权限要求

读手机存储

参数：

参数名类型必填说明
typeString是铃声类型，ringtone：来电，notification：通知，alarm：闹钟
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
success 返回值：
参数名类型说明
titleString铃声名称，若铃声被删除，返回空字符串。
fail 返回错误代码：
错误码说明
202参数错误，即铃声类型不对

示例：

  1. media.getRingtone({
  2.   type: 'ringtone',
  3.   success: function(data) {
  4.     console.log(`get ringtone success title: ${data.title}`)
  5.   },
  6.   fail: function(data, code) {
  7.     console.log(`handling fail, code = ${code}`)
  8.   }
  9. })

media.setRingtone(OBJECT) 1040+

设置系统铃声，目前只支持本地文件。如果是设置来电铃声，双卡情况下，卡1卡2对应的铃声都会设置。

权限要求

写手机存储。而且每次设置铃声时，都有弹框来让用户选择是否同意设置铃声。

参数：

参数名类型必填说明
uriString是铃声文件路径，只支持本地文件
typeString是铃声类型，ringtone：来电，notification：通知，alarm：闹钟
titleString否铃声名称，没有设置默认取文件名
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
fail 返回错误代码：
错误码说明
201用户拒绝
202参数错误，即铃声类型不对，目前支持的铃声类型有15种，文件后缀分别为：.mp3、 .ogg、 .oga、 .flac、 .wav、 .m4a、 .amr、 .awb、 .wma、 .aac、 .mka、 .mid、 .midi、 .smf、 .imy 。
1001文件不存在

示例：

  1. media.setRingtone({
  2.   type: 'ringtone',
  3.   uri: 'internal://mass/test/test.mp3',
  4.   title: 'test',
  5.   success: function() {
  6.     console.log(`set ringtone success`)
  7.   },
  8.   fail: function(data, code) {
  9.     console.log(`handling fail, code = ${code}`)
  10.   }
  11. })

后台运行限制

禁止使用。后台运行详细用法参见后台运行 脚本。