更新记录

1.0.1(2023-07-10)

  • 修复 Vue3 下上传时报错问题

1.0.0(2023-05-29)

  • 支持对云存储图片、视频媒体资源管理

平台兼容性

阿里云 腾讯云 支付宝云
Vue2 Vue3
App 快应用 微信小程序 支付宝小程序 百度小程序 字节小程序 QQ小程序
HBuilderX 3.7.1 × × × × ×
钉钉小程序 快手小程序 飞书小程序 京东小程序
× × × ×
H5-Safari Android Browser 微信浏览器(Android) QQ浏览器(Android) Chrome IE Edge Firefox PC-Safari
×

uni-admin插件通用教程:

uni-admin是一套基于uniCloud的开源应用管理端系统。详见:uni-admin 基础框架
本插件是uni-admin系统的扩展插件,为开发者的admin系统添加功能。
需先确保本机有uni-admin项目,然后将此插件导入到uni-admin项目下。
如本机没有uni-admin项目,需要先在HBuilderX中新建项目 -> uni-app项目 -> 选择uni-admin模板。
如本机的uni-admin项目版本过老,可能无法使用新插件,需及时升级本机的uni-admin项目。详见uni-admin项目更新日志


媒体库

管理上传的云存储图片、视频等媒体资源,支持对资源上传、删除、查看等操作。

功能点

  • 支持阿里云与腾讯云云存储。
  • 对媒体资源管理,支持上传、删除、查看等操作。
  • 可作为图片选择器使用,支持插入图片到编辑器中。

如何使用

从插件市场中导入媒体库插件至uni-admin中。

如果还未使用过uni-admin,请先在HBuilderX新建项目时选择uni-admin项目。并需要了解uni-admin的相关知识。

导入uni-media-library后,运行启动uni-admin,在web管理后台,点击左侧菜单栏的菜单管理,添加“媒体库”菜单。

如下图所示:

导入后刷新页面,在uni-admin左侧菜单,可看到媒体库的菜单项,点击即可进入。

前端组件使用

媒体库可做为独立的组件使用,例如文章封面可以通过媒体库组件来选择图片,不需要每次都重新上传图片。

基本用法

uni-media-library 组件符合 easycom 组件规范,可以直接在页面中使用 uni-media-library 标签,以使用媒体库组件。

<template>
  <uni-media-library></uni-media-library>
</template>

API

UniMediaLibrary Props

属性名 类型 默认值 说明
mode String manager 媒体库展示模式;manager: 管理模式,picker: 选择模式
media-tabs Array ['all', 'image', 'video'] 允许展示那种类型的媒体资源tab
selected-count Number - 最大选择数量,仅在mode为picker时有效

UniMediaLibrary Events

事件名 说明 返回值
onInsert 在picker模式下,选择图片插入后触发事件 Array\<SelectedMediaItems>

SelectedMediaItems 说明

属性名 类型 默认值 说明
type String - 媒体资源类型
src String - 媒体资源地址
cover String - 媒体资源封面;如媒体类型是视频时返回视频封面(腾讯云没有封面)
alt String - 用于图片加载失败时的替代文字;常用于插入富文本编辑器时使用

云对象 (uni-media-library-co)

在 uni-media-library-co 云对象中实现了对媒体资源的上报与删除功能。

配置@co-config

uni-media-library的云端配置文件统一使用uni-config-center管理。

初次使用时,新建配置文件, 路径为 uni_modules/uni-config-center/uniCloud/cloudfunctions/common/uni-config-center/uni-media-library/config.json,用于配置uni-media-library相关信息,完整配置如下:

注意:以下注释仅用于对字段进行描述,复制时请删除注释。

{
  "cropMediaAssets": false, // 是否对媒体库的图片进行裁剪
}

媒体资源上报接口

接口名:report

接口形式

await uniMediaLibrary.report({
  src,
  cover,
  type,
  originalName,
  fileType,
  size,
  resolution,
  duration,
  uploadUser,
})

参数说明

参数名 类型 必填 说明
src String 媒体资源地址
type String 媒体资源类型
cover String 媒体资源封面
originalName String 原始文件名
fileType String 文件类型
size Number 文件大小
resolution Object 分辨率;见Resolution说明
duration String 时长
uploadUser String 上传用户的用户id

Resolution说明

参数名 类型 必填 说明
width Number 宽度
height Number 高度

返回值

参数名 类型 说明
errCode Number 状态码

删除媒体资源

接口名:deleteMedia

接口形式

await uniMediaLibrary.deleteMedia({
  mediaIds
})

参数说明

参数名 类型 必填 说明
mediaIds Array 媒体资源id列表

返回值

参数名 类型 说明
errCode Number 状态码

注意

  • 删除媒体资源时将会同时删除云存储文件,删除后将无法恢复,请谨慎操作。

uni-media-library Schema 扩展

负责处理与媒体库资源创建时的逻辑

主要功能有:

在读取(afterRead)媒体库资源后,根据uni-media-library配置文件中的cropMediaAssets字段,对图片进行裁剪。

注意事项

优化媒体库图片加载速度

默认媒体库加载图片会加载原图展示,同时会造成不必要的CDN流量消耗,可以通过uni-media-library云对象的配置文件开启图片裁剪(cropMediaAssets),以优化图片加载速度。

具体配置参考uni-media-library-co配置

注意

根据您开通的服务空间不同,图片裁剪的功能也不同,具体如下:

  • 阿里云图片裁剪目前可免费使用,无需担心费用问题。
  • 腾讯云图片裁剪为付费服务,如使用腾讯云,建议您在使用前先了解腾讯云的计费规则,避免造成不必要的费用。

关于云存储数据处理,阿里云请参考数据处理, 腾讯云请参考数据万象

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

uni-media-library 媒体库(以下简称软件)源码使用许可协议

2022年10月

本许可协议,是数字天堂(北京)网络技术有限公司(以下简称DCloud)对其所拥有著作权的“软件”,提供的使用许可协议。

您对“软件”的复制、使用、修改及分发受本许可协议的条款的约束,如您不接受本协议,则不能使用、复制、修改本软件。

授权许可范围

a) 授予您永久性的、全球性的、免费的、非独占的、不可撤销的本软件的源码使用许可,您可以使用这些源码制作自己的应用。

b) 您只能在DCloud产品体系内使用本软件及其源码。您不能将源码修改后运行在DCloud产品体系之外的环境,比如客户端脱离uni-app,或服务端脱离uniCloud(如涉及uniCloud)。

c) DCloud未向您授权商标使用许可。您在根据本软件源码制作自己的应用时,需以自己的名义发布软件,而不是以DCloud名义发布。

d) 本协议不构成代理关系。

DCloud的责任限制 “软件”在提供时不带任何明示或默示的担保。在任何情况下,DCloud不对任何人因使用“软件”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。

您的责任限制

a) 您需要在授权许可范围内使用软件。

b) 您在分发自己的应用时,不得侵犯DCloud商标和名誉权利。

c) 您不得进行破解、反编译、套壳等侵害DCloud知识产权的行为。您不得利用DCloud系统漏洞谋利或侵害DCloud利益,如您发现DCloud系统漏洞应第一时间通知DCloud。您不得进行攻击DCloud的服务器、网络等妨碍DCloud运营的行为。未经书面许可,您不得利用DCloud的产品进行与DCloud争夺开发者的行为。

d) 如您违反本许可协议,需承担因此给DCloud造成的损失。

本协议签订地点为中华人民共和国北京市海淀区。

根据发展,DCloud可能会对本协议进行修改。修改时,DCloud会在产品或者网页中显著的位置发布相关信息以便及时通知到用户。如果您选择继续使用本框架,即表示您同意接受这些修改。

条款结束

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问