CCShortVideo

立即使用

概述

封装了获得场景视频的短视频sdk,开发者可通过此SDK录制、编辑短视频

接口

openView

添加预览控件,录制视频前需要先添加预览控件

openView({params}, callback(ret, err))

params

rect:

  • 类型:JSON对象类型
  • 描述:预览控件位置
  • 内部字段:
    {
      x:,         //数字类型;控件左上角x坐标,默认值0
      y:,        //数字类型;控件左上角y坐标,默认值0
      w:,       //数字类型;控件宽,默认值:屏幕宽
      h:,        //数字类型;控件高,默认值:屏幕高
    }
    

type:

  • 类型:数字类型
  • 描述:显示分辨率;(仅支持iOS)
  • 默认:3
    • 0:352x288
    • 1:640x480
    • 2:1280x720
    • 3:1920x1080
    • 4:3840x2160

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:模块依附于当前 window

fixed:

  • 类型:布尔类型
  • 描述:(可选项)是否将模块视图固定到窗口上,不跟随窗口上下滚动
  • 默认值:true(不随之滚动)

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常回调
  • 内部字段
    {
    status:,        //布尔类型,是否添加成功
    }
    

err:

  • 类型:JSON对象类型
  • 描述:错误回调
  • 内部字段
    {
    msg:'',        //字符串类型;错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.openView({

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

可用性

Android、iOS系统

可提供的1.0.0及更高版本

closeView

移除预览控件

closeView({params}, callback(ret, err))

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常回调
  • 内部字段
    {
    status:,        //布尔类型,是否添加成功
    }
    

err:

  • 类型:JSON对象类型
  • 描述:错误回调
  • 内部字段
    {
    msg:'',        //字符串类型;错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.closeView({

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

可用性

Android、iOS系统

可提供的1.0.0及更高版本

setBeautyWhiteValue (仅支持iOS)

设置美白

setBeautyWhiteValue({params}, callback(ret, err))

params

value:

  • 类型:数字类型
  • 描述:(可选项)美白程度
  • 取值范围:0-100
  • 默认:0

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.setBeautyWhiteValue({
    value:'',
},function(ret, err) {
});

可用性

iOS系统

可提供的1.0.0及更高版本

setBeautySkinValue (仅支持iOS)

设置磨皮

setBeautySkinValue({params}, callback(ret, err))

params

value:

  • 类型:数字类型
  • 描述:(可选项)磨皮程度
  • 取值范围:0-100
  • 默认:0

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.setBeautySkinValue({
    value:'',
},function(ret, err) {
});

可用性

iOS系统

可提供的1.0.0及更高版本

setFilter (仅支持iOS)

设置滤镜

setFilter({params}, callback(ret, err))

params

value:

  • 类型:字符串类型
  • 描述:(可选项)滤镜类型
  • 默认:'无'
    • '清新'
    • '淡雅'
    • '白皙'
    • '复古'
    • '微光'
    • '无'

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.setFilter({
    value:'',
},function(ret, err) {
});

可用性

iOS系统

可提供的1.0.0及更高版本

startRecord

开始录制

startRecord({params}, callback(ret, err))

params

width:

  • 类型:数字类型
  • 描述:(可选项)录制宽; (只支持安卓)
  • 默认值:9:16宽度

height:

  • 类型:数字类型
  • 描述:(可选项)录制高; (只支持安卓)
  • 默认值:9:16高度

size:

  • 类型:数字类型
  • 描述:(可选项)视频输出尺寸比例 ;(只支持iOS)
  • 默认值:0
    • 0:(9:16)
    • 1:(3:4)
    • 2:(1:1)

videoPath:

  • 类型:字符串类型
  • 描述:视频存储位置,支持fs路径; (只支持安卓)
  • 示例:‘fs://video1.mp4’

recordTime:

  • 类型:数字类型
  • 描述:(可选项)录制时长(毫秒);(只支持安卓)

beautySkinValue:

  • 类型:数字类型
  • 描述:(可选项)磨皮程度; (只支持安卓)
  • 取值范围:0-100
  • 默认:50

beautyWhiteValue:

  • 类型:数字类型
  • 描述:(可选项)美白程度;(只支持安卓)
  • 取值范围:0-100
  • 默认:50

filter:

  • 类型:字符串类型
  • 描述:(可选项)滤镜;(只支持安卓)
  • 默认:无
  • 取值范围:
          ‘fairytale’:清新
          ‘calm’:淡雅
          ‘hudson’:白皙
          ‘earlybird’:复古
          ‘healthy’:微光
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.startRecord({
    videoPath:'',
},function(ret, err) {
});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

stopRecord

停止录制

stopRecord({params}, callback(ret))

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常数据返回
  • 内部字段:
    {
      videoPath:,   //字符串类型;录制的视频路径  (仅支持iOS)
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.stopRecord({
},function(ret) {
});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

setRecordListener (只支持安卓)

录制事件监听

setRecordListener({params}, callback(ret, err))

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常数据返回
  • 内部字段:
    {
      status:,   //布尔类型;是否为正常数据
      eventType:'',   //字符串类型;返回事件类型
                  ‘cameraOpened’:摄像头开启
                  ‘recordStarted’:开始录制
                  ‘recordFinish’:结束录制
                  ‘recordProgress’:录制进度更新
                  ‘fpsCallback’:fps回调
      recordTime:,   //数字类型,已录制时间,eventType为‘recordProgress’时返回
      fps:,      //小数类型;fps,eventType为‘fpsCallback’时返回
    }
    

err:

  • 类型:JSON对象类型
  • 描述:返回错误信息
  • 内部字段:
    {
    msg:'',      //字符串类型;错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.setRecordListener({
},function(ret, err) {
});

可用性

Android

可提供的1.0.0及更高版本

combineVideo

合并视频,已录制多段视频合并

combineVideo({params}, callback(ret, err))

params

videoPath:

  • 类型:字符串类型
  • 描述:视频路径,支持fs路径 ;(仅支持安卓)
  • 示例:‘fs://fina1.mp4’

pathArray:

  • 类型:数组类型
  • 描述:被合并的视频路径数组;大于等于2个视频路径(仅支持iOS)
[
   '', //被合并的视频路径;支持fs://和widget://
   '',
   ''
]

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常数据返回
  • 内部字段:

    {
      status:,   //布尔类型;是否为正常数据
      videoPath:'', //字符串类型;合并后的视频路径;在status为true时有值(仅支持iOS)
      eventType:'',   //字符串类型;返回事件类型 ;(仅支持安卓)
                  ‘start’:开始合并
                  ‘progress’:合并进度更新
                  ‘finish’:合并结束
      current:,   //数字类型,已合并时间,eventType为‘progress’时返回;(仅支持安卓)
      sum:,      //数字类型;总时间,eventType为‘progress’时返回;(仅支持安卓)
      success:,  //布尔类型;是否成功,eventType为‘finish’时返回;(仅支持安卓)
    }
    

    err:

  • 类型:JSON对象类型

  • 描述:返回错误信息
  • 内部字段:
    {
    msg:'',      //字符串类型;错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.combineVideo({
    videoPath:'',
},function(ret, err) {
});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

removeLastSubVideo (只支持安卓)

移除最后一段视频

removeLastSubVideo({params}, callback(ret, err))

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.removeLastSubVideo({
},function(ret, err) {
});

可用性

Android系统

可提供的1.0.0及更高版本

removeAllSubVideo (只支持安卓)

移除所有视频

removeAllSubVideo({params}, callback(ret, err))

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.removeAllSubVideo({
},function(ret, err) {
});

可用性

Android系统

可提供的1.0.0及更高版本

getNumberOfSubVideo (只支持安卓)

获取已缓存几段视频

getNumberOfSubVideo({params}, callback(ret, err))

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回
  • 内部字段:
    {
    status:,     //布尔类型;是否正常返回
    number:,  //数字类型;视频段数
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.getNumberOfSubVideo({
},function(ret, err) {
});

可用性

Android系统

可提供的1.0.0及更高版本

switchCamera

镜头切换

switchCamera({params}, callback(ret, err))

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.switchCamera({
},function(ret, err) {
});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

flashLight (只支持iOS)

开关闪光灯(前置摄像头不打开闪光灯)

flashLight({params}, callback(ret, err))

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.flashLight({
},function(ret, err) {
});

可用性

iOS系统

可提供的1.0.0及更高版本

videoBeauty (仅支持安卓)

视频美化

videoBeauty({params}, callback(ret, err))

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径

outPutPath:

  • 类型:字符串类型
  • 描述:美化完后输出路径,支持fs路径

beautySkinValue:

  • 类型:数字类型
  • 描述:(可选项)磨皮程度
  • 取值范围:0-100

beautyWhiteValue:

  • 类型:数字类型
  • 描述:(可选项)美白程度
  • 取值范围:0-100

filter:

  • 类型:字符串类型
  • 描述:(可选项)滤镜
  • 取值范围:
          ‘fairytale’:清新
          ‘calm’:淡雅
          ‘hudson’:白皙
          ‘earlybird’:复古
          ‘healthy’:微光
          ‘none’:无滤镜
    

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段

    {
      status:,     //布尔类型;是否成功
    }
    

    err:

  • 类型:JSON对象类型

  • 描述:返回错误数据
  • 内部字段
    {
      msg:'',     //字符串类型;是否错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.videoBeauty({
    videoPath:'',
    outPutPath:'',
},function(ret, err) {
});

可用性

Android系统

可提供的1.0.0及更高版本

cutVideo

视频剪辑

cutVideo({params}, callback(ret, err))

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径

outPutPath:

  • 类型:字符串类型
  • 描述:美化完后输出路径,支持fs路径 ;(仅支持安卓)

videoSize:

  • 类型:JSON对象类型
  • 描述:裁剪区域;(仅支持iOS)
  • 内部字段:
    {
      w:,       //数字类型;裁剪区域宽度;默认值:控件宽度
      h:,        //数字类型;裁剪区域高度;默认值:控件高度
    }
    

videoPoint:

  • 类型:JSON对象类型
  • 描述:裁剪起点;(仅支持iOS)
  • 内部字段:
    {
      x:,       //数字类型;裁剪起点x坐标;默认值:0
      y:,        //数字类型;裁剪起点y坐标;默认值:0
    }
    

videoRate:

  • 类型:数字类型
  • 描述:视频倍速;(仅支持iOS)
  • 默认:1

startPosition:

  • 类型:数字类型
  • 描述:开始裁剪位置,(毫秒)

endPosition:

  • 类型:数字类型
  • 描述:结束裁剪位置(毫秒)

width:

  • 类型:数字类型
  • 描述:输出视频宽度;(仅支持安卓)

height:

  • 类型:数字类型
  • 描述:输出视频高度;(仅支持安卓)

x:

  • 类型:数字类型
  • 描述:x轴偏移位置;(仅支持安卓)

y:

  • 类型:数字类型
  • 描述:y轴偏移位置;(仅支持安卓)

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段

    {
      status:,     //布尔类型;是否成功回调
      eventType:'',  //字符串类型;回调事件;(仅支持安卓)
                  ‘start’:开始裁剪
                  ‘finish’:裁剪结束
                  ‘fail’:发生错误
      errorCode:,    //数字类型,错误码;(仅支持安卓)
      errorMsg:'',   //字符串类型,错误信息;(仅支持安卓)
      outPutPath:''  //裁剪后的输出路径;(仅支持iOS)
    }
    

    err:

  • 类型:JSON对象类型

  • 描述:返回错误数据
  • 内部字段
    {
      msg:'',     //字符串类型;是否错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.cutVideo({
    videoPath:'',
    outPutPath:'',
},function(ret, err) {
});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

changeVideoSpeed (仅支持安卓)

视频变速

changeVideoSpeed({params}, callback(ret, err))

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径

outPutPath:

  • 类型:字符串类型
  • 描述:美化完后输出路径,支持fs路径

speed:

  • 类型:小数类型
  • 描述:变速倍率
  • 取值范围:0.5-2.0

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段

    {
      status:,     //布尔类型;是否成功回调
      eventType:'',  //字符串类型;回调事件
                  ‘start’:开始
                  ‘finish’:结束
                  ‘fail’:发生错误
      errorCode:,    //数字类型,错误码
      errorMsg:'',   //字符串类型,错误信息
    }
    

    err:

  • 类型:JSON对象类型

  • 描述:返回错误数据
  • 内部字段
    {
      msg:'',     //字符串类型;是否错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.changeVideoSpeed({
    videoPath:'',
    outPutPath:'',
    speed:1,
},function(ret, err) {
});

可用性

Android系统

可提供的1.0.0及更高版本

addMusicAndSticker (只支持安卓)

添加音乐、贴纸和气泡文字

addMusicAndSticker({params}, callback(ret, err))

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径

outPutPath:

  • 类型:字符串类型
  • 描述:美化完后输出路径,支持fs路径

musicSet:

  • 类型:JSON对象类型
  • 描述:(可选项)音乐设置
  • 内部字段:

    {
      musicPath:'',    //字符串类型;音乐路径 支持fs路径
      startPos:,        //数字类型;音乐开始位置 (秒)
      oriVolume:,    //小数类型;原生大小,取值范围 0-1
      musVolume:,  //小数类型;音乐大小,取值范围0-1
    }
    

    stickerSet:

  • 类型:JSON数组类型

  • 描述:(可选项)贴纸,气泡文字设置
  • 内部字段
    [
    {
      startShow:,     //数字类型;开始显示秒(秒)
      endShow:,     //数字类型;结束显示时间(秒)
      x:,      //数字类型;x轴偏移位置
      y:,      //数字类型;y轴偏移位置
      stickerPath:'',     //贴纸或气泡文字路径
    },
    ]
    

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段

    {
      status:,     //布尔类型;是否成功回调
      eventType:'',  //字符串类型;回调事件
                  ‘start’:开始
                  ‘finish’:结束
                  ‘fail’:发生错误
      errorCode:,    //数字类型,错误码
      errorMsg:'',   //字符串类型,错误信息
    }
    

    err:

  • 类型:JSON对象类型

  • 描述:返回错误数据
  • 内部字段
    {
      msg:'',     //字符串类型;是否错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.addMusicAndSticker({
    videoPath:'',
    outPutPath:'',
},function(ret, err) {
});

可用性

Android系统

可提供的1.0.0及更高版本

addMusic (只支持iOS)

添加音乐

addMusic({params}, callback(ret))

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径和widget路径

audioPath:

  • 类型:字符串类型
  • 描述:要插入的音频路径,支持fs路径和widget路径

originalVolume:

  • 类型:数字类型
  • 描述:原生音频的音量;取值范围 0-1
  • 默认:0.5

insertVolume:

  • 类型:数字类型
  • 描述:设置音频的音量;取值范围 0-1
  • 默认:0.5

startPosition:

  • 类型:数字类型
  • 描述:开始裁剪位置,(毫秒)

endPosition:

  • 类型:数字类型
  • 描述:结束裁剪位置(毫秒)

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段
    {
      status:,     //布尔类型;是否成功回调
      outPutPath:'' ,//字符串类型;视频输出的路径
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.addMusic({


},function(ret) {
});

可用性

iOS系统

可提供的1.0.0及更高版本

addSticker (只支持iOS)

添加贴纸

addSticker({params}, callback(ret))

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径和widget路径

stickerImages:

  • 类型:JSON数组类型
  • 描述:贴纸数组
  • 内部字段
    [
    {
      stickerPath:'',     //贴纸路径
    },
    ]
    

stickerImagePoints:

  • 类型:JSON数组类型
  • 描述:贴纸的位置数组
  • 内部字段
    [
    {
      x:,     //贴纸的x坐标;参数为百分比(所占视频位置的百分比);
      y:,     //贴纸的y坐标;参数为百分比(所占视频位置的百分比);
    },
    ]
    

stickerImageSizes:

  • 类型:JSON数组类型
  • 描述:贴纸的大小数组
  • 内部字段
    [
    {
      w:,     //贴纸的宽度;参数为百分比(所占视频位置的百分比);
      h:,     //贴纸的高度;参数为百分比(所占视频位置的百分比);
    },
    ]
    

rotateAngles:

  • 类型:JSON数组类型
  • 描述:贴纸旋转弧度数组
  • 内部字段
    [
    {
      rotate:,     //数字类型;贴纸的旋转弧度
    },
    ]
    

timeRanges:

  • 类型:JSON数组类型
  • 描述:贴纸的时间范围数组
  • 内部字段
    [
    {
      startPoint:,     //贴图显示的起始时间;(毫秒)
      endPoint:,     //贴纸显示的结束时间;(毫秒)
    },
    ]
    

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段
    {
      status:,     //布尔类型;是否成功回调
      outPutPath:'' ,//字符串类型;视频输出的路径
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.addSticker({


},function(ret) {
});

可用性

iOS系统

可提供的1.0.0及更高版本

addAirBubbles (只支持iOS)

添加气泡文字

addAirBubbles({params}, callback(ret))

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径和widget路径

stickerImages:

  • 类型:JSON数组类型
  • 描述:气泡文字数组
  • 内部字段
    [
    {
      stickerPath:'',     //贴纸路径
    },
    ]
    

stickerImagePoints:

  • 类型:JSON数组类型
  • 描述:气泡文字的位置数组
  • 内部字段
    [
    {
      x:,     //贴纸的x坐标;参数为百分比(所占视频位置的百分比);
      y:,     //贴纸的y坐标;参数为百分比(所占视频位置的百分比);
    },
    ]
    

stickerImageSizes:

  • 类型:JSON数组类型
  • 描述:气泡文字的大小数组
  • 内部字段
    [
    {
      w:,     //贴纸的宽度;参数为百分比(所占视频位置的百分比);
      h:,     //贴纸的高度;参数为百分比(所占视频位置的百分比);
    },
    ]
    

rotateAngles:

  • 类型:JSON数组类型
  • 描述:气泡文字旋转弧度数组
  • 内部字段
    [
    {
      rotate:,     //数字类型;贴纸的旋转弧度
    },
    ]
    

timeRanges:

  • 类型:JSON数组类型
  • 描述:气泡文字的时间范围数组
  • 内部字段
    [
    {
      startPoint:,     //贴图显示的起始时间;(毫秒)
      endPoint:,     //贴纸显示的结束时间;(毫秒)
    },
    ]
    

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段
    {
      status:,     //布尔类型;是否成功回调
      outPutPath:'' ,//字符串类型;视频输出的路径
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.addAirBubbles({


},function(ret) {
});

可用性

iOS系统

可提供的1.0.0及更高版本

changeVideoSize (仅支持安卓)

为视频添加黑边合成新视频

changeVideoSize({params}, callback(ret, err))

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径

outPutPath:

  • 类型:字符串类型
  • 描述:美化完后输出路径,支持fs路径

videoWidth:

  • 类型:数字类型
  • 描述:原始视频宽度

videoHeight:

  • 类型:数字类型
  • 描述:原始视频高度

outVideoWidth:

  • 类型:数字类型
  • 描述:输出视频宽度

outVideoHeight:

  • 类型:数字类型
  • 描述:输出视频高度

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段

    {
      status:,     //布尔类型;是否成功回调
      eventType:'',  //字符串类型;回调事件
                  ‘start’:开始
                  ‘finish’:结束
                  ‘fail’:发生错误
      errorCode:,    //数字类型,错误码
      errorMsg:'',   //字符串类型,错误信息
    }
    

    err:

  • 类型:JSON对象类型

  • 描述:返回错误数据
  • 内部字段
    {
      msg:'',     //字符串类型;是否错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.changeVideoSize({
    videoPath:'',
    outPutPath:'',
    videoWidth:,
    videoHeight:,
    outVideoWidth:,
    outVideoHeight:,
},function(ret, err) {
});

可用性

Android系统

可提供的1.0.0及更高版本

preEffect (仅支持安卓)

视频特效预览

preEffect({params}, callback(ret, err))

params

rect:

  • 类型:JSON对象类型
  • 描述:预览控件位置
  • 内部字段:
    {
      x:,         //数字类型;控件左上角x坐标,默认值0
      y:,        //数字类型;控件左上角y坐标,默认值0
      w:,       //数字类型;控件宽,默认值:屏幕宽
      h:,        //数字类型;控件高,默认值:屏幕高
    }
    

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:模块依附于当前 window

fixed:

  • 类型:布尔类型
  • 描述:(可选项)是否将模块视图固定到窗口上,不跟随窗口上下滚动
  • 默认值:true(不随之滚动)

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径

effectS:

  • 类型:JSON数组类型
  • 描述:特效参数
  • 内部字段:
    [
    {
      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 (仅支持安卓)

移除视频特效预览

rmPreEffect({params}, callback(ret, err))

callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常返回数据
  • 内部字段:
    {
    status:,       //布尔类型  是否成功
    }
    

err:

  • 类型:JSON对象类型
  • 描述:返回错误数据
  • 内部字段:
    {
      msg:'',   //字符串类型;错误信息
    }
    

示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.rmPreEffect({
},function(ret, err) {
});

可用性

Android系统

可提供的1.0.0及更高版本

applyEffect (仅支持安卓)

生成特效视频

applyEffect({params}, callback(ret, err))

params

videoPath:

  • 类型:字符串类型
  • 描述:要编辑的视频路径,支持fs路径

outPath:

  • 类型:字符串类型
  • 描述:生成视频路径,支持fs路径

effectS:

  • 类型:JSON数组类型
  • 描述:特效参数
  • 内部字段:
    [
    {
      type:,   //数字类型;特效类型,0:抖动,1:闪屏,2:幻觉,3:毛刺,4:缩放
      startTime:,  //数字类型;开始时间(毫秒)
      endTime:,  //数字类型;结束时间(毫秒)
    },
    ]
    

    callback(ret,err)

ret:

  • 类型:JSON对象类型
  • 描述:正常回调
  • 内部字段
    {
    status:,        //布尔类型,是否正常返回
    eventType:'',    //字符串类型;回调事件
                      ‘completed’:成功
                      ‘canceled’:取消
                      ‘progress’:'进度'
    progress:,  //小数类型;进度,当eventType为‘progress’时返回
    }
    

err:

  • 类型:JSON对象类型
  • 描述:错误回调
  • 内部字段
    {
    msg:'',        //字符串类型;错误信息
    }
    

    示例代码

var CCShortVideo= api.require('CCShortVideo');
CCShortVideo.applyEffect({
    videoPath:'',
    outPath:'',
    effectS:[

    ]

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

可用性

Android系统

可提供的1.0.0及更高版本