@polyv/chat-image-upload-sdk

保利威聊天室图片上传 SDK

功能概述

本项目是保利威直播聊天室图片上传的逻辑层 SDK。开发人员可以使用本 SDK 接入聊天室图片上传功能，或者基于本 SDK 定制开发图片上传界面。

使用

安装

npm i -S @polyv/chat-image-upload-sdk

引入

在线文件引入方式

// 根据版本号引入JS版本。
<script src="https://websdk.videocc.net/chat-image-upload-sdk/x.x.x/lib/polyv-chat-image-upload.umd.js"></script>
<script>
const { PolyvChatImageUpload } = window.PolyvChatImageUpload;
</script>

import 方式引入（推荐）

import { ChatImageUpload } from '@polyv/chat-image-upload-sdk';

初始化

const uploadCtx = new ChatImageUpload({
  channelId,
  source: 'white-board',
  onChange: (chatImage) => {
    // 此方法会返回上传的状态，可以根据返回的状态进行业务调整
    console.log(chatImage.status);
  }
});

使用流程

调用uploadCtx.choiceImageFile方法调出系统文件选择窗口，选择成功后，会进入成功回调函数，在回调函数中调用uploadCtx.joinWaitQueue加入上传队列， 上传的状态会在生成实例时传入的onChange方法中回调

uploadCtx.choiceImageFile({
  success: (chatImages) => {
    this.uploadCtx.joinWaitQueue(chatImages);
  },
  fail: (data) => {
    console.log(data);
  },
});