ccAPI

概述

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 对象
• 内部字段：

{    

videoId:'',   //videoId，视频id
progress:'',  //上传的进度（仅iOS支持）
range:,      //数字类型，已上传status为‘uploading’返回（仅android支持）
size:,          //数字类型；总大小，status为‘uploading’返回（仅android支持）
status:'' ,   //上传状态
    - 'fail'   //失败
    - 'finish' //完成
    - 'none'   //未开始上传
    - 'readying' //准备中
    - 'uploading' //上传中
    - 'pause'     //暂停
    - 'backFinish' //后台任务完成时回调（仅iOS支持）
    - 'cancle'    //取消上传回调（仅andriod支持）
 error:{               //JSON对象类型，上传过程中出现错误回调，（仅android支持）
     errorCode:,  //数字类型，错误码 
    errorMsg:'',   //字符串类型，错误信息
 }   
}

示例代码

    var name = api.require('ccAPI');
    name.upLoad({
        userId:'49A00C16A49F8DBC',
        apiKey:'Np3YTJcjFfILw04PH1P7e5JWumf9es0j',
        videoTitle:'title',
        videoDescription:'描述',
        videoTag:'2222',
        videoPath:'widget://res/uu.mp4'
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

pause

暂停上传

pause({params})

params

videoId：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

continue

继续上传

continue({params})

params

videoId：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

delete

删除上传

delete({params})

params

videoId：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openPlayer

打开播放器

openPlayer({params}, callback(ret))

params

userId：

• 类型：字符串类型
• 描述：用户id

videoId：

• 类型：字符串类型
• 描述：视频id

key：

• 类型：字符串类型
• 描述：key值

verificationCode：

• 类型：字符串类型
• 描述：验证信息（仅android支持）

support：

• 类型：字符串类型
• 描述：获取播放地址时，若账号支持hls，填@"1"会返回m3u8下载地址。获取下载地址时，请填@"0"（仅iOS支持）

mediatype：

• 类型：字符串类型
• 描述：1为视频 2为音频 0为视频+音频 若不传该参数默认为视频
• 默认：1

setOfflineVideoPath：

• 类型：字符串类型
• 描述：（可选项）加密视频文件地址（仅android支持）

audioPlay：

• 类型：布尔类型
• 描述：（可选项）是否是音频播放（仅android支持）
• 默认值：false

rect：

• 类型：JSON 对象
• 描述：（可选项）模块的位置及尺寸
• 内部字段：

{
    x: 0,   //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：0
    y: 0,   //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：0
    w: 320, //（可选项）数字类型；模块的宽度；默认：所属的 Window 或 Frame 的宽度
    h: 300  //（可选项）数字类型；模块的高度；默认：w的3/4
}

looping：

• 类型：布尔类型
• 描述：是否循环播放（仅iOS支持）
• 默认：false

muted：

• 类型：布尔类型
• 描述：是否静音（仅iOS支持）
• 默认：false

videoProtect：

• 类型：布尔类型
• 描述：是否开启防录屏
• 默认：false

playInBackground：

• 类型：布尔类型
• 描述：是否允许后台播放（仅iOS支持）
• 默认：false

timeOutLoad：

• 类型：数字类型
• 描述：视频加载超时时间（仅iOS支持）
• 默认：30 秒

isLocalVideo：

• 类型：布尔类型类型
• 描述：是否播放本地视频；（true为本地视频，false为网络视频）（仅iOS支持）
• 默认：false

fixedOn：

• 类型：字符串类型
• 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）（仅android支持）
• 默认：模块依附于当前 window

fixed:

• 类型：布尔类型
• 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动（仅android支持）
• 默认值：true（不随之滚动）

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；打开成功还是失败
duration:'',  //字符串类型；总时长；
nowTime:'',  //字符串类型；当前播放时长；

}

示例代码

    var name = api.require('ccAPI');
    name.openPlayer({

        userID:'391E6E3340A00767',
        videoID:'2477AD327B256E5C9C33DC5901307461',
        key:'T8WdOUuvFEiOsou1xjDr4U73v12M7iNa',
        support:'0',
        mediatype:'0',
        rect:
        {
            x:0,
            y:0,
            w:300,
            h:200
        },
        looping:false,
        muted:false,
        videoProtect:false,
        playInBackground:false,
        timeOutLoad:30,

    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

close

关闭播放器

close(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.close({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

playerPause

暂停播放器

playerPause(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.playerPause({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

playerPlay

播放播放器

playerPlay(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.playerPlay({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

repeatPlay

重播

repeatPlay(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.repeatPlay({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

setPlayerRate

设置播放倍速

setPlayerRate({params},callback(ret))

params

rate：

• 类型：字符串类型
• 描述：播放的倍速
• 默认：1

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.setPlayerRate({
        rate:2
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

seekTo

拖拽到XX秒

seekTo({params},callback(ret))

params

time：

• 类型：数字类型
• 描述：拖拽到XX秒播放

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.seekTo({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

setVolume

设置音量

setVolume({params},callback(ret))

params

volume：

• 类型：字符串类型
• 描述：音量值
• 取值范围：[0,100]

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.setVolume({
        volume:1
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

fadeInVolume (只支持iOS)

加大音量

fadeInVolume(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.fadeInVolume({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

iOS系统

可提供的1.0.0及更高版本

fadeOutVolume (只支持iOS)

减小音量

fadeOutVolume(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.fadeOutVolume({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

iOS系统

可提供的1.0.0及更高版本

screenShot

获取当前播放器的截图

screenShot(callback(ret))

param

imgPath

• 类型：字符串类型
• 描述：截图存放路径，支持fs,原生路径

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.screenShot({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

full

播放器全屏

full(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.full({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

cancleFull

播放器取消全屏

cancleFull(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.cancleFull({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

downLoadinit

下载视频初始化

downLoadinit(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{    

status:,   //布尔类型；成功还是失败

}

示例代码

    var name = api.require('ccAPI');
    name.downLoadinit({
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

downLoadVideo

下载

downLoadVideo({params}, callback(ret))

params

userId：

• 类型：字符串类型
• 描述：用户id

videoId：

• 类型：字符串类型
• 描述：视频id

key：

• 类型：字符串类型
• 描述：key值

verificationCode：

• 类型：字符串类型
• 描述：（可选项）验证信息（仅android支持）

downloadPath：

• 类型：字符串类型
• 描述：存储路径，支持fs,原生路径，例：‘fs://’（仅android支持）

fileName：

• 类型：字符串类型
• 描述：文件名（仅android支持）

downloadMode：

• 类型：数字类型
• 描述：（可选项）下载模式（仅android支持）
• 取值范围：0：音视频，1：视频，2：音频
• 默认值：1

definition：

• 类型：数字类型
• 描述：（可选项）要下载的清晰度（仅android支持）

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{ 

status:,   //布尔类型；打开成功还是失败
error:,    //字符串类型；错误
progress:, //数字类型；下载进度（仅iOS支持）
size:,     //数字类型；视频大小     （仅iOS支持）
remainingTime:,//数字类型；剩余时间（仅iOS支持）
userId:,  //字符串；（仅iOS支持）
videoId:, //字符串类型；
mediaType:, //字符串类型；文件类型； 1 视频 2 音频（仅iOS支持）
filePath:, //字符串类型；存储路径（仅iOS支持）
fileName:, //字符串类型；文件名（仅iOS支持）
downloadURL:,//字符串类型；下载地址（仅iOS支持）
state:, //字符串类型；下载状态；100表示等待中，200表示下载中，300表示下载暂停，400表示下载完成
backgroundDownLoadEnd:,//布尔类型；后台下载成功还是失败（仅iOS支持）
start:,        //数字类型；下载进度回调返回（仅android支持）
end:,         //数字类型；下载进度回调返回（仅android支持）
hasCancel:,     //布尔类型；是否取消
}

示例代码

    var name = api.require('ccAPI');
    name.downLoadVideo({
        userId:'391E6E3340A00767',
        videoId:'2477AD327B256E5C9C33DC5901307461',
        key:'T8WdOUuvFEiOsou1xjDr4U73v12M7iNa',
        downloadPath:'',
        fileName:'',
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统、iOS系统

可提供的1.0.0及更高版本

downLoadPause

暂停下载

downLoadPause({params}, callback(ret))

params

videoId：

• 类型：字符串类型
• 描述：视频id

示例代码

    var name = api.require('ccAPI');
    name.downLoadPause({
        videoId:'2477AD327B256E5C9C33DC5901307461',
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统、iOS系统

可提供的1.0.0及更高版本

downLoadResume

恢复下载

downLoadResume({params}, callback(ret))

params

videoId：

• 类型：字符串类型
• 描述：视频id

示例代码

    var name = api.require('ccAPI');
    name.downLoadResume({
        videoId:'2477AD327B256E5C9C33DC5901307461',
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统、iOS系统

可提供的1.0.0及更高版本

downLoadDelete

删除某个下载任务以及本地缓存

downLoadDelete({params}, callback(ret))

params

videoId：

• 类型：字符串类型
• 描述：视频id

示例代码

    var name = api.require('ccAPI');
    name.downLoadDelete({
        videoId:'2477AD327B256E5C9C33DC5901307461',
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统、iOS系统

可提供的1.0.0及更高版本

suspendAllDownload

暂停全部任务

suspendAllDownload({params}, callback(ret))

params

videoId：

• 类型：字符串类型
• 描述：视频id

示例代码

    var name = api.require('ccAPI');
    name.suspendAllDownload({
        videoId:'2477AD327B256E5C9C33DC5901307461',
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

Android系统、iOS系统

可提供的1.0.0及更高版本

deleteAllDownload

删除全部任务

deleteAllDownload({params}, callback(ret))

params

videoId：

• 类型：字符串类型
• 描述：视频id

示例代码

    var name = api.require('ccAPI');
    name.deleteAllDownload({
        videoId:'2477AD327B256E5C9C33DC5901307461',
    }, function(ret) {
        if (ret) {
           alert(JSON.stringify(ret));
        }
    });

可用性

iOS系统

可提供的1.0.0及更高版本