ccAPI

upLoad pause continue delete

概述

ccAPI简介

ccAPI模块封装了Huode scene(获得场景视频)的音视频上传功能

固件要求

iOS:8.0及以上

模块接口

upLoad

视频录制

upLoad({params}, callback(ret))

params

userId:

  • 类型:字符串类型
  • 描述:账号ID。

apiKey:

  • 类型:字符串类型
  • 描述:秘钥。

videoTitle:

  • 类型:字符串类型
  • 描述:视频标题。

videoDescription:

  • 类型:字符串类型
  • 描述:视频描述。

videoTag:

  • 类型:字符串类型
  • 描述:视频标签。

videoPath:

  • 类型:字符串类型
  • 描述:视频路径 ; 支持widget://和fs://(android仅支持fs)

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. videoId:'', //videoId,视频id
  3. progress:'', //上传的进度(仅iOS支持)
  4. range:, //数字类型,已上传status为‘uploading’返回(仅android支持)
  5. size:, //数字类型;总大小,status为‘uploading’返回(仅android支持)
  6. status:'' , //上传状态
  7. - 'fail' //失败
  8. - 'finish' //完成
  9. - 'none' //未开始上传
  10. - 'readying' //准备中
  11. - 'uploading' //上传中
  12. - 'pause' //暂停
  13. - 'backFinish' //后台任务完成时回调(仅iOS支持)
  14. - 'cancle' //取消上传回调(仅andriod支持)
  15. error:{ //JSON对象类型,上传过程中出现错误回调,(仅android支持)
  16. errorCode:, //数字类型,错误码
  17. errorMsg:'', //字符串类型,错误信息
  18. }
  19. }

示例代码

  1. var name = api.require('ccAPI');
  2. name.upLoad({
  3. userId:'49A00C16A49F8DBC',
  4. apiKey:'Np3YTJcjFfILw04PH1P7e5JWumf9es0j',
  5. videoTitle:'title',
  6. videoDescription:'描述',
  7. videoTag:'2222',
  8. videoPath:'widget://res/uu.mp4'
  9. }, function(ret) {
  10. if (ret) {
  11. alert(JSON.stringify(ret));
  12. }
  13. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

pause

暂停上传

pause({params})

params

videoId:

  • 类型:字符串类型
  • 描述:视频id。

示例代码

  1. var name = api.require('ccAPI');
  2. name.pause();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

continue

继续上传

continue({params})

params

videoId:

  • 类型:字符串类型
  • 描述:视频id。

示例代码

  1. var name = api.require('ccAPI');
  2. name.continue();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

delete

删除上传

delete({params})

params

videoId:

  • 类型:字符串类型
  • 描述:视频id。

示例代码

  1. var name = api.require('ccAPI');
  2. name.delete();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本