tencent cloud

文档反馈

Android

最后更新时间:2022-11-17 16:50:16

    TXUGCRecord

    短视频录制基础接口

    API 描述
    getInstance 获取录制实例
    setVideoRecordListener 设置录制回调接口
    release 释放资源
    setVideoProcessListener 设置自定义图像处理回调( 精简版不支持)

    录制效果设置相关函数

    API 描述
    setWatermark 设置全局水印( 精简版不支持)
    getBeautyManager 获取美颜管理对象

    摄像头,麦克风相关函数

    API 描述
    startCameraSimplePreview 启动摄像头预览,简化参数
    startCameraCustomPreview 启动摄像头预览,自定义参数
    setVideoResolution 设置录制分辨率
    setVideoBitrate 设置录制比特率
    stopCameraPreview 停止摄像头预览
    switchCamera 切换前后摄像头
    setMicVolume 设置麦克风的音量大小
    toggleTorch toggleTorch,打开闪关灯
    getMaxZoom 获取摄像头支持的最大焦距,此方法同时可以检查是否支持变焦
    setZoom 设置焦距
    setFocusPosition 设置手动聚焦
    setVideoRenderMode 设置视频渲染模式

    录制相关函数

    API 描述
    startRecord 开始视频录制,SDK 内部会自动生成视频路经和视频封面,在 ITXVideoRecordListener 里面返回
    startRecord 开始视频录制
    startRecord 开始视频录制
    stopRecord 停止视频录制
    pauseRecord 暂停视频录制
    resumeRecord 继续视频录制
    setAspectRatio 设置宽高比
    setRecordSpeed 录制速度( 精简版不支持)
    setMute 设置静音
    setHomeOrientation 设置 home 键方向
    setRenderRotation 设置渲染方向

    背景音相关函数

    API 描述
    setReverb 设置混响( 精简版不支持)
    setVoiceChangerType 设置变声( 精简版不支持)
    setBGM 设置背景音乐文件( 精简版不支持)
    setBGMNofify 设置背景音乐播放回调接口( 精简版不支持)
    playBGMFromTime 播放背景音乐( 精简版不支持)
    stopBGM 停止播放背景音乐( 精简版不支持)
    pauseBGM 暂停播放背景音乐( 精简版不支持)
    resumeBGM 继续播放背景音乐( 精简版不支持)
    seekBGM 定位 BGM 开始结束时间( 精简版不支持)
    setBGMVolume 设置背景音乐的音量大小( 精简版不支持)
    getMusicDuration 获取音乐文件时长( 精简版不支持)

    截图相关函数

    API 描述
    snapshot 设置短视频预处理回调

    废弃接口

    API 描述
    setMotionTmpl setMotionTmpl 设置动效文件( 仅支持企业版和企业版 Pro)
    setMotionMute 设置动效是否静音( 仅支持企业版和企业版 Pro)
    setGreenScreenFile 设置绿幕文件(仅支持企业版 Pro)
    setFaceVLevel 设置V脸(仅支持企业版 Pro)
    setFaceShortLevel 设置短脸(仅支持企业版 Pro 和企业版 Pro EX)
    setChinLevel 设置下巴长度(仅支持企业版 Pro 和企业版 Pro EX)
    setNoseSlimLevel 设置瘦鼻效果(仅支持企业版 Pro 和企业版 Pro EX)
    setEyeScaleLevel 设置大眼效果(仅支持企业版 Pro 和企业版 Pro EX)
    setFaceScaleLevel 设置瘦脸效果(仅支持企业版 Pro)
    setBeautyStyle 设置美颜类型
    setBeautyDepth 设置美颜美白效果级别
    setFilter 设置指定素材滤镜特效
    setFilter 设置组合滤镜特效
    setSpecialRatio 设置滤镜效果程度

    TXUGCPartsManager

    多段录制相关函数

    API 描述
    TXUGCPartsManager 视频片段管理器
    setPartsManagerObserver 设置视频片段处理回调
    removePartsManagerObserver 删除视频片段处理回调
    addClipInfo 添加视频片段到队列尾部
    insertPart 插入视频片段
    getDuration 获取所有分段的总时长
    getPartsPathList 获取本次录制所有片段的路径
    deleteLastPart 删除最后一段分段
    deletePart 删除指定分段
    deleteAllParts 删除所有分段

    VideoCustomProcessListener

    视频处理自定义监听接口

    API 描述
    onTextureCustomProcess 纹理处理回调接口
    onDetectFacePoints 五官检测点回调
    onTextureDestroyed 纹理释放回调接口

    ITXVideoRecordListener

    短视频预览回调接口

    API 描述
    onRecordEvent 短视频录制事件通知
    onRecordProgress 短视频录制进度
    onRecordComplete 短视频录制完成

    ITXSnapshotListener

    截图回调接口

    API 描述
    onSnapshot 截图回调通知

    ITXBGMNotify

    背景音事件回调接口

    API 描述
    onBGMStart 音乐播放开始的回调通知
    onBGMProgress 音乐播放进度的回调通知
    onBGMComplete 音乐播放结束的回调通知

    TXRecordCommon

    短视频录制关键类型定义

    API 描述
    TXRecordResult 录制结果
    TXUGCSimpleConfig 固定录制参数
    TXUGCCustomConfig 自定义录制参数

    错误码

    录制结果回调错误码

    符号 含义
    RECORD_RESULT_OK 0 回调录制成功或者暂停(停止)接口返回成功
    RECORD_RESULT_OK_LESS_THAN_MINDURATION 1 回调录制成功,时长小于最小值
    RECORD_RESULT_OK_REACHED_MAXDURATION 2 回调录制成功,时长达到最大值
    RECORD_RESULT_FAILED -1 回调录制失败
    RECORD_RESULT_SUSPEND_FOR_NO_TASK -2 暂停(或停止)中止,没有录制的任务
    RECORD_RESULT_FILE_ERR -3 录制文件不存在或者长度为0,一般开始和暂停(或停止)之间的间隔时间太短导致,用户可不用关心
    RECORD_RESULT_COMPOSE_SET_SRC_PATH_ERR -4 回调合成的视频路径有误,通过 mTXUGCPartsManager.getPartsPathList() 查看文件是否为空或长度为0
    RECORD_RESULT_COMPOSE_SET_DST_PATH_ERR -5 回调合成的视频目标路径有误,检查目标路径是否为空
    RECORD_RESULT_COMPOSE_START_ERR -6 回调合成启动失败,上一次合成还未结束
    RECORD_RESULT_COMPOSE_CANCEL -7 回调合成取消
    RECORD_RESULT_COMPOSE_VERIFY_FAIL -8 回调合成校验失败,文件不存在文件长度为0视频参数与其他视频不一致
    RECORD_RESULT_COMPOSE_INTERNAL_ERR -9 回调合成失败,内部错误

    开始录制的返回错误码

    符号 含义
    START_RECORD_OK 0 开始录制
    START_RECORD_ERR_IS_IN_RECORDING -1 开始录制时存在未完成的任务,existing uncompleted record task
    START_RECORD_ERR_VIDEO_PATH_IS_EMPTY -2 开始录制时视频文件路径为空
    START_RECORD_ERR_API_IS_LOWER_THAN_18 -3 版本小于18
    START_RECORD_ERR_NOT_INIT -4 开始录制时还未初始化结束
    START_RECORD_ERR_LICENCE_VERIFICATION_FAILED -5 License 校验失败