yp-media-upload-service

介绍

yp-media-upload-service 用于内部使用的多媒体上传插件

安装教程

npm install yp-media-upload-service
yarn add yp-media-upload-service

使用说明

使用示例

/** 引入 */
import { ypMediaUpload } from "yp-media-upload-service"

ypMediaUpload({
  headerConfig: {
    // 请求头header 参数
    appId: 101,
    platform: "h5",
    sdkVersion: "1.0.1",
    appVersion: "1.2.3",
    system: "android",
    systemVersion: "14.1.1",
    env: "test",
  },
  paramConfig: {
    // 请求 body 参数
    entryId: 100002,
    type: 0,
    fileList: fileList,
  },
  onUploadProgress: (progressArr) => { // 上传进度（单个文件的每次上传进度更新就会触发回调一次）
    console.log(progressArr)
  },
  onSuccess: (fileItem, fileList) => { // 上传成功（单个文件上传成功后，就会触发回调一次）
    console.log(fileItem, fileList, "onSuccess")
  },
  onError: (fileItem, fileList) => { // 上传失败（单个文件上传失败后，就会触发回调一次）
    console.log(fileItem, fileList, "onError")
  },
})

}

参数说明

1. 请求头 headerConfig 参数

   参数	类型	说明	必传
   appId	number	业务应用 id 每个业务独立进行申请 DEV 环境可以用：125	- [x]
   env	string	环境变量 可选值为 'dev','test','master','release','prod' 默认值：dev	- [ ]
   timeout	number	请求超时时间 默认 10 秒	- [ ]
   source	string	来源	- [ ]
   channel	string	渠道包	- [ ]
   imei	string	imei 设备标识，H5 无法生成可以不传	- [ ]
   sdkVersion	string	多媒体 SDK 版本	- [x]
   appVersion	string	app 应用版本，应用版本。如：2.3.0	- [x]
   system	string	操作系统全部大写 IOS ANDROID WINDOWS MACOS LINUX	- [x]
   systemVersion	string	系统版本如：12.3.1	- [x]
   platform	string	IOS: ios ANDROID: android H5: 移动端 PC: 电脑端 WX_H5: 微信移动 WX_MINI: 微信小程序 BD_MINI: 字节小程序 BAIDU_MINI: 百度小程序 QQ_MINI:QQ 小程序	- [x]
   token	string	用户登录态 token	- [ ]

2. 请求 paramConfig 参数

   参数	类型	说明	必传
   entryId	number	入口场景 id，这个开发时须向有关产品或后端咨询	- [x]
   type	number	资源类型，0:图片，1 视频，2 音频	- [x]
   file	IFileListItem[]	文件数组，具体类型可参考代码内提示	- [x]
   city	string	城市	- [ ]
   address	number	水印类型，2 音频可以为空	- [ ]
   wmId	number	水印类型，2 音频可以为空	- [ ]
   wmcInfo	object	水印相关扩展信息，2 音频可以为空	- [ ]
   uid	number	鱼泡 uid	- [ ]

3. 回调方法参数

   方法	返回参数	说明	必返
   onUploadProgress	progressArr	单个文件上传进度变化时，将传入的fileList原样返回并更新每个item的persent（上传进度）	- [x]
   onSuccess	fileItem, fileList	单个文件上传成功时，回调当前成功的fileItem, 及原样返回且修改了status的fileList	- [x]
   onError	fileItem, fileList	同onSuccess一样，只是在单个文件上传失败时触发回调	- [x]