教程 其他 框架 组件 接口

多媒体

接口声明

{ "name": "system.media" }

导入模块

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

接口定义

media.takePhoto(OBJECT)

拍摄照片

权限要求

使用相机

参数:

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

示例:

media.takePhoto({
  success: function(data) {
    console.log(`handling success: ${data.uri}`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

media.takeVideo(OBJECT)

拍摄视频

权限要求

使用相机

参数:

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

示例:

media.takeVideo({
  success: function(data) {
    console.log(`handling success: ${data.uri}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

media.pickImage(OBJECT)

选择图片

权限要求

读手机存储

参数:

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

示例:

media.pickImage({
  success: function(data) {
    console.log(`handling success: ${data.uri}`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

media.pickImages(OBJECT) 1040+

选择多张图片

权限要求

读手机存储

参数:

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

示例:

media.pickImages({
  success: function (data) {
    console.log(`handling success: ${data.uris}`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

media.pickVideo(OBJECT)

选择视频

权限要求

读手机存储

参数:

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

示例:

media.pickVideo({
  success: function(data) {
    console.log(`handling success: ${data.uri}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

media.pickVideos(OBJECT) 1040+

选择多个视频

权限要求

读手机存储

参数:

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

示例:

media.pickVideos({
  success: function (data) {
    console.log(`handling success: ${data.uris}`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

media.pickFile(OBJECT)1010+

选择文件

权限要求

读手机存储

参数:

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

示例:

media.pickFile({
  success: function(data) {
    console.log(`handling success: ${data.uri}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

media.saveToPhotosAlbum(OBJECT)1010+

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

权限要求

写手机存储

参数:

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

示例:

media.saveToPhotosAlbum({
  uri: 'internal://tmp/abc.jpg',
  success: function() {
    console.log(`save success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

media.previewImage(OBJECT)1040+

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

权限要求

写手机存储

参数:

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

示例:

media.previewImage({
   current:'http://www.xxx.com/a.jpg',
   uris:['http://www.xxx.com/a.jpg',
         'http://www.xxx.com/b.jpg',
         'http://www.xxx.com/c.jpg'],
   success: function (){
       console.log('preview success')
   },
   fail: function (data, code){
       console.log('preview fail, code = ${code}' )
   }
})

media.getRingtone(OBJECT) 1040+

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

权限要求

读手机存储

参数:

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

示例:

media.getRingtone({
  type: 'ringtone',
  success: function(data) {
    console.log(`get ringtone success title: ${data.title}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

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文件不存在

示例:

media.setRingtone({
  type: 'ringtone',
  uri: 'internal://mass/test/test.mp3',
  title: 'test',
  success: function() {
    console.log(`set ringtone success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容