tencentUGCUpload

##腾讯云点播上传

该插件可以让用户将视频、音频、封面图片等媒体文件上传到云点播的存储中，以进行后续的处理和分发等。

##论坛示例

该论坛提供了插件使用示例入口，您可以在论坛中找到使用的Demo，以及问题反馈。

##技术支持

建议先联系我们的客服，协助接入。

技术支持

我们的客服微信号: ruanyunkeji006

##接口列表

###初始化与销毁

接口列表 功能
init 初始化
destroy 销毁

###发布视频

接口列表 功能
setVideoListener 设置视频上传回调
removeVideoListener 移除视频上传回调
publishVideo 修改个人信息

###发布媒体

接口列表 功能
setMediaListener 设置视频上传监听
removeMediaListener 移除媒体上传监听
publishMedia 上传图片或媒体

##插件接口

#init

初始化

init({params}, function(ret, err))

params

userId:

  • 类型: 字符串类型
  • 描述: (必填项) 用户Id，用于区分不同的用户

signature:

  • 类型: 字符串类型
  • 描述: (可选项) 客户端上传签名

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 	// 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

##代码示例

UGCUpload.init({
    userId: 123xxx823,
    signature: 'wieixmxxxxoimqiwxm'
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

#destroy

销毁

destroy({}, function(ret, err))

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 	// 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

UGCUpload.destroy({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

#setVideoListener

设置视频上传监听器

setVideoListener({}, function(ret, err))

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 	// 布尔类型, true表示操作成功
}

or

{
    eventType: 'onPublishProgress'
}
  • 字段详情:

eventType:

  • 类型: 字符串类型
  • 描述: 事件名称， 详见 事件回调

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

UGCUpload.setVideoListener({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

#removeVideoListener

移除视频上传监听器

removeVideoListener({}, function(ret, err))

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 	// 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

UGCUpload.removeVideoListener({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

#publishVideo

发布视频

publishVideo({params}, function(ret, err))

params

signature:

  • 类型: 字符串类型
  • 描述: (必填项) 客户端上传签名

videoPath:

  • 类型: 字符串类型
  • 描述: (必填项) 本地视频文件路径

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 	// 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

UGCUpload.publishVideo({
    signature: 'eJwtzExxxxxizphb3L40HQ',
    videoPath: 'widget://file/a.mp4',
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

#setMediaListener

设置图片上传监听

setMediaListener({}, function(ret, err))

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 	// 布尔类型, true表示操作成功
}

or

{
    eventType: 'onPublishProgress'
}
  • 字段详情:

eventType:

  • 类型: 字符串类型
  • 描述: 事件名称， 详见 事件回调

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

UGCUpload.setMediaListener({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

#removeMediaListener

移除图片上传监听器

removeMediaListener({}, function(ret, err))

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 	// 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

UGCUpload.removeMediaListener({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

#publishMedia

上传图片

publishMedia({params}, function(ret, err))

params

signature:

  • 类型: 字符串类型
  • 描述: (必填项) 客户端上传签名

mediaPath:

  • 类型: 字符串类型
  • 描述: (必填项) 本地图片文件路径

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 	// 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

UGCUpload.publishMedia({
    signature: 'oweixxxxmnowei',
    mediaPath: 'widget://file/picName.png'
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

##事件回调

###视频上传回调

#onPublishProgress

进度回调

{
    eventType: 'onPublishProgress',
    uploadBytes: 1002,
    totalBytes: 500032
}

eventType:

  • 类型: 字符串类型
  • 描述: 事件名称

uploadBytes:

  • 类型: 整数类型
  • 描述: 已上传的字节数

totalBytes:

  • 类型: 整数类型
  • 描述: 总字节数

#onPublishComplete

结果回调

{
    eventType: 'onPublishComplete',
    result: ...
}

eventType:

  • 类型: 字符串类型
  • 描述: 事件名称

result:

  • 类型: 整数类型
  • 描述: 上传结果
  • 内部字段
{
    retCode: 0,
    descMsg: 'xxxx',
    videoId: 'lweiwqwxxxxoimoin', 
    videoUrl: 'https://xxx.xxx.xxx/xxxx',
    coverUrl: 'https://xxx.xxx.xxx/xxxx'
}
  • 字段详情:

retCode:

  • 类型: 整数类型
  • 描述: 结果码

descMsg:

  • 类型: 字符串类型
  • 描述: 上传失败的错误描述

videoId:

  • 类型: 字符串类型
  • 描述: 点播视频文件Id

videoUrl:

  • 类型: 字符串类型
  • 描述: 视频存储地址

coverUrl:

  • 类型: 字符串类型
  • 描述: 封面存储地址

###图片上传回调

#onMeidaPublishProgress

进度回调

{
    eventType: 'onMeidaPublishProgress',
    uploadBytes: 10，
    totalBytes: 123928
}

eventType:

  • 类型: 字符串类型
  • 描述: 事件名称

uploadBytes:

  • 类型: 整数类型
  • 描述: 已上传的字节数

totalBytes:

  • 类型: 整数类型
  • 描述: 总字节数

#onMediaPublishComplete

上传结果

{
    eventType: 'onMediaPublishComplete',
    resutl: ...
}

eventType:

  • 类型: 字符串类型
  • 描述: 事件名称

result:

  • 类型: 整数类型
  • 描述: 上传结果
  • 内部字段
{
    retCode: 0,
    descMsg: 'xxxx',
    mediaId: 'lweiwqwxxxxoimoin', 
    mediaUrl: 'https://xxx.xxx.xxx/xxxx'
}
  • 字段详情:

retCode:

  • 类型: 整数类型
  • 描述: 结果码

descMsg:

  • 类型: 字符串类型
  • 描述: 上传失败的错误描述

mediaId:

  • 类型: 字符串类型
  • 描述: 点播媒体文件文件Id

mediaUrl:

  • 类型: 字符串类型
  • 描述: 媒体资源存储地址

##更多功能

  • 视频封面、文件名指定、HTTPS上传；
  • 自动签名；
  • 断点续传；

获取更多功能和技术支持，扫码联系我们

技术支持

我们的客服微信号: ruanyunkeji006

是否仍需要帮助？ 请保持联络！
最后更新于 2023/05/12