setBeautyWhiteValue setBeautySkinValue setFilter
startRecord
stopRecord
setRecordListener
combineVideo
removeLastSubVideo
removeAllSubVideo
switchCamera
flashLight
videoBeauty cutVideo changeVideoSpeed addMusicAndSticker addMusic addSticker addAirBubbles
封装了获得场景视频的短视频sdk,开发者可通过此SDK录制、编辑短视频
添加预览控件,录制视频前需要先添加预览控件
openView({params}, callback(ret, err))
rect:
{
x:, //数字类型;控件左上角x坐标,默认值0
y:, //数字类型;控件左上角y坐标,默认值0
w:, //数字类型;控件宽,默认值:屏幕宽
h:, //数字类型;控件高,默认值:屏幕高
}
type:
fixedOn:
fixed:
ret:
{
status:, //布尔类型,是否添加成功
}
err:
{
msg:'', //字符串类型;错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.openView({
},function(ret, err) {
});
Android、iOS系统
可提供的1.0.0及更高版本
移除预览控件
closeView({params}, callback(ret, err))
ret:
{
status:, //布尔类型,是否添加成功
}
err:
{
msg:'', //字符串类型;错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.closeView({
},function(ret, err) {
});
Android、iOS系统
可提供的1.0.0及更高版本
设置美白
setBeautyWhiteValue({params}, callback(ret, err))
value:
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.setBeautyWhiteValue({
value:'',
},function(ret, err) {
});
iOS系统
可提供的1.0.0及更高版本
设置磨皮
setBeautySkinValue({params}, callback(ret, err))
value:
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.setBeautySkinValue({
value:'',
},function(ret, err) {
});
iOS系统
可提供的1.0.0及更高版本
设置滤镜
setFilter({params}, callback(ret, err))
value:
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.setFilter({
value:'',
},function(ret, err) {
});
iOS系统
可提供的1.0.0及更高版本
开始录制
startRecord({params}, callback(ret, err))
width:
height:
size:
videoPath:
recordTime:
beautySkinValue:
beautyWhiteValue:
filter:
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.startRecord({
videoPath:'',
},function(ret, err) {
});
Android、iOS系统
可提供的1.0.0及更高版本
停止录制
stopRecord({params}, callback(ret))
ret:
{
videoPath:, //字符串类型;录制的视频路径 (仅支持iOS)
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.stopRecord({
},function(ret) {
});
Android、iOS系统
可提供的1.0.0及更高版本
录制事件监听
setRecordListener({params}, callback(ret, err))
ret:
{
status:, //布尔类型;是否为正常数据
eventType:'', //字符串类型;返回事件类型
‘cameraOpened’:摄像头开启
‘recordStarted’:开始录制
‘recordFinish’:结束录制
‘recordProgress’:录制进度更新
‘fpsCallback’:fps回调
recordTime:, //数字类型,已录制时间,eventType为‘recordProgress’时返回
fps:, //小数类型;fps,eventType为‘fpsCallback’时返回
}
err:
{
msg:'', //字符串类型;错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.setRecordListener({
},function(ret, err) {
});
Android
可提供的1.0.0及更高版本
合并视频,已录制多段视频合并
combineVideo({params}, callback(ret, err))
videoPath:
pathArray:
[
'', //被合并的视频路径;支持fs://和widget://
'',
''
]
ret:
{
status:, //布尔类型;是否为正常数据
videoPath:'', //字符串类型;合并后的视频路径;在status为true时有值(仅支持iOS)
eventType:'', //字符串类型;返回事件类型 ;(仅支持安卓)
‘start’:开始合并
‘progress’:合并进度更新
‘finish’:合并结束
current:, //数字类型,已合并时间,eventType为‘progress’时返回;(仅支持安卓)
sum:, //数字类型;总时间,eventType为‘progress’时返回;(仅支持安卓)
success:, //布尔类型;是否成功,eventType为‘finish’时返回;(仅支持安卓)
}
err:
{
msg:'', //字符串类型;错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.combineVideo({
videoPath:'',
},function(ret, err) {
});
Android、iOS系统
可提供的1.0.0及更高版本
移除最后一段视频
removeLastSubVideo({params}, callback(ret, err))
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.removeLastSubVideo({
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
移除所有视频
removeAllSubVideo({params}, callback(ret, err))
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.removeAllSubVideo({
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
获取已缓存几段视频
getNumberOfSubVideo({params}, callback(ret, err))
ret:
{
status:, //布尔类型;是否正常返回
number:, //数字类型;视频段数
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.getNumberOfSubVideo({
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
镜头切换
switchCamera({params}, callback(ret, err))
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.switchCamera({
},function(ret, err) {
});
Android、iOS系统
可提供的1.0.0及更高版本
开关闪光灯(前置摄像头不打开闪光灯)
flashLight({params}, callback(ret, err))
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.flashLight({
},function(ret, err) {
});
iOS系统
可提供的1.0.0及更高版本
视频美化
videoBeauty({params}, callback(ret, err))
videoPath:
outPutPath:
beautySkinValue:
beautyWhiteValue:
filter:
ret:
{
status:, //布尔类型;是否成功
}
err:
{
msg:'', //字符串类型;是否错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.videoBeauty({
videoPath:'',
outPutPath:'',
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
视频剪辑
cutVideo({params}, callback(ret, err))
videoPath:
outPutPath:
videoSize:
{
w:, //数字类型;裁剪区域宽度;默认值:控件宽度
h:, //数字类型;裁剪区域高度;默认值:控件高度
}
videoPoint:
{
x:, //数字类型;裁剪起点x坐标;默认值:0
y:, //数字类型;裁剪起点y坐标;默认值:0
}
videoRate:
startPosition:
endPosition:
width:
height:
x:
y:
ret:
{
status:, //布尔类型;是否成功回调
eventType:'', //字符串类型;回调事件;(仅支持安卓)
‘start’:开始裁剪
‘finish’:裁剪结束
‘fail’:发生错误
errorCode:, //数字类型,错误码;(仅支持安卓)
errorMsg:'', //字符串类型,错误信息;(仅支持安卓)
outPutPath:'' //裁剪后的输出路径;(仅支持iOS)
}
err:
{
msg:'', //字符串类型;是否错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.cutVideo({
videoPath:'',
outPutPath:'',
},function(ret, err) {
});
Android、iOS系统
可提供的1.0.0及更高版本
视频变速
changeVideoSpeed({params}, callback(ret, err))
videoPath:
outPutPath:
speed:
ret:
{
status:, //布尔类型;是否成功回调
eventType:'', //字符串类型;回调事件
‘start’:开始
‘finish’:结束
‘fail’:发生错误
errorCode:, //数字类型,错误码
errorMsg:'', //字符串类型,错误信息
}
err:
{
msg:'', //字符串类型;是否错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.changeVideoSpeed({
videoPath:'',
outPutPath:'',
speed:1,
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
添加音乐、贴纸和气泡文字
addMusicAndSticker({params}, callback(ret, err))
videoPath:
outPutPath:
musicSet:
{
musicPath:'', //字符串类型;音乐路径 支持fs路径
startPos:, //数字类型;音乐开始位置 (秒)
oriVolume:, //小数类型;原生大小,取值范围 0-1
musVolume:, //小数类型;音乐大小,取值范围0-1
}
stickerSet:
[
{
startShow:, //数字类型;开始显示秒(秒)
endShow:, //数字类型;结束显示时间(秒)
x:, //数字类型;x轴偏移位置
y:, //数字类型;y轴偏移位置
stickerPath:'', //贴纸或气泡文字路径
},
]
ret:
{
status:, //布尔类型;是否成功回调
eventType:'', //字符串类型;回调事件
‘start’:开始
‘finish’:结束
‘fail’:发生错误
errorCode:, //数字类型,错误码
errorMsg:'', //字符串类型,错误信息
}
err:
{
msg:'', //字符串类型;是否错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.addMusicAndSticker({
videoPath:'',
outPutPath:'',
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
添加音乐
addMusic({params}, callback(ret))
videoPath:
audioPath:
originalVolume:
insertVolume:
startPosition:
endPosition:
ret:
{
status:, //布尔类型;是否成功回调
outPutPath:'' ,//字符串类型;视频输出的路径
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.addMusic({
},function(ret) {
});
iOS系统
可提供的1.0.0及更高版本
添加贴纸
addSticker({params}, callback(ret))
videoPath:
stickerImages:
[
{
stickerPath:'', //贴纸路径
},
]
stickerImagePoints:
[
{
x:, //贴纸的x坐标;参数为百分比(所占视频位置的百分比);
y:, //贴纸的y坐标;参数为百分比(所占视频位置的百分比);
},
]
stickerImageSizes:
[
{
w:, //贴纸的宽度;参数为百分比(所占视频位置的百分比);
h:, //贴纸的高度;参数为百分比(所占视频位置的百分比);
},
]
rotateAngles:
[
{
rotate:, //数字类型;贴纸的旋转弧度
},
]
timeRanges:
[
{
startPoint:, //贴图显示的起始时间;(毫秒)
endPoint:, //贴纸显示的结束时间;(毫秒)
},
]
ret:
{
status:, //布尔类型;是否成功回调
outPutPath:'' ,//字符串类型;视频输出的路径
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.addSticker({
},function(ret) {
});
iOS系统
可提供的1.0.0及更高版本
添加气泡文字
addAirBubbles({params}, callback(ret))
videoPath:
stickerImages:
[
{
stickerPath:'', //贴纸路径
},
]
stickerImagePoints:
[
{
x:, //贴纸的x坐标;参数为百分比(所占视频位置的百分比);
y:, //贴纸的y坐标;参数为百分比(所占视频位置的百分比);
},
]
stickerImageSizes:
[
{
w:, //贴纸的宽度;参数为百分比(所占视频位置的百分比);
h:, //贴纸的高度;参数为百分比(所占视频位置的百分比);
},
]
rotateAngles:
[
{
rotate:, //数字类型;贴纸的旋转弧度
},
]
timeRanges:
[
{
startPoint:, //贴图显示的起始时间;(毫秒)
endPoint:, //贴纸显示的结束时间;(毫秒)
},
]
ret:
{
status:, //布尔类型;是否成功回调
outPutPath:'' ,//字符串类型;视频输出的路径
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.addAirBubbles({
},function(ret) {
});
iOS系统
可提供的1.0.0及更高版本
为视频添加黑边合成新视频
changeVideoSize({params}, callback(ret, err))
videoPath:
outPutPath:
videoWidth:
videoHeight:
outVideoWidth:
outVideoHeight:
ret:
{
status:, //布尔类型;是否成功回调
eventType:'', //字符串类型;回调事件
‘start’:开始
‘finish’:结束
‘fail’:发生错误
errorCode:, //数字类型,错误码
errorMsg:'', //字符串类型,错误信息
}
err:
{
msg:'', //字符串类型;是否错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.changeVideoSize({
videoPath:'',
outPutPath:'',
videoWidth:,
videoHeight:,
outVideoWidth:,
outVideoHeight:,
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
视频特效预览
preEffect({params}, callback(ret, err))
rect:
{
x:, //数字类型;控件左上角x坐标,默认值0
y:, //数字类型;控件左上角y坐标,默认值0
w:, //数字类型;控件宽,默认值:屏幕宽
h:, //数字类型;控件高,默认值:屏幕高
}
fixedOn:
fixed:
videoPath:
effectS:
[
{
type:, //数字类型;特效类型,0:抖动,1:闪屏,2:幻觉,3:毛刺,4:缩放
startTime:, //数字类型;开始时间(毫秒)
endTime:, //数字类型;结束时间(毫秒)
},
]
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.preEffect({
rect:{
x:,
y:,
w:,
h:,
},
videoPath:'',
effectS:[
]
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
移除视频特效预览
rmPreEffect({params}, callback(ret, err))
ret:
{
status:, //布尔类型 是否成功
}
err:
{
msg:'', //字符串类型;错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.rmPreEffect({
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本
生成特效视频
applyEffect({params}, callback(ret, err))
videoPath:
outPath:
effectS:
[
{
type:, //数字类型;特效类型,0:抖动,1:闪屏,2:幻觉,3:毛刺,4:缩放
startTime:, //数字类型;开始时间(毫秒)
endTime:, //数字类型;结束时间(毫秒)
},
]
ret:
{
status:, //布尔类型,是否正常返回
eventType:'', //字符串类型;回调事件
‘completed’:成功
‘canceled’:取消
‘progress’:'进度'
progress:, //小数类型;进度,当eventType为‘progress’时返回
}
err:
{
msg:'', //字符串类型;错误信息
}
var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.applyEffect({
videoPath:'',
outPath:'',
effectS:[
]
},function(ret, err) {
});
Android系统
可提供的1.0.0及更高版本