tencent cloud

短视频 SDK

动态与公告
产品动态
关于短视频 SDK “startPlay”接口名变更的公告
产品简介
产品概述
产品功能
应用场景
基本概念
购买指南
价格总览
退款说明
免费测试
License 指引
新增与续期 License
配置查看 License
Demo 体验
SDK 下载
SDK 下载
发布日志(App)
含 UI 集成方案
小视频 App
源码解读(iOS)
源码解读(Android)
不含 UI 集成方案
SDK 集成
拍照和录制
预览裁剪和拼接
上传和播放
美颜特效
高级功能和特效
API 文档
短视频编辑
短视频录制
技术支持
错误码表
功能答疑
常见问题
上传常见问题
Android 编译问题
Android 常见问题
iOS 常见问题
License 常见问题
UGSV 政策
隐私政策
数据处理和安全协议

iOS

PDF
聚焦模式
字号
最后更新时间: 2025-04-01 17:14:10

TXUGCRecord

实例化

API
描述
实例化

摄像头、麦克风相关逻辑

API
描述
开始画面预览
开始画面预览
切换视频录制分辨率,startCamera 之后调用有效
设置视频渲染模式,startCamera 之后调用有效
切换视频录制码率
setZoom
调整焦距,startCamera 之后调用有效
切换前后摄像头,startCamera 之后调用有效
打开闪关灯,startCamera 之后调用有效
结束画面预览
setVideoRenderMirrorType:(TXVideoRenderMirrorType)mirrorType
(11.0版本添加),设置渲染镜像类型

录制相关逻辑

API
描述
设置横竖屏录制
设置预览视频方向
设置视频录制比例
设置录制速率(精简版不支持)
setMute
设置是否静音录制
开始录制短视频,SDK 内部会自动生成视频路径
开始录制短视频
开始录制短视频
暂停录制短视频
暂停录制短视频
恢复录制短视频
结束录制短视频
使用其他播放器预览视频的时候,请先调用 pauseAudioSession
重启 SDK 内部的 AudioSession
setVideoEncoderMirror:(BOOL)isMirror
(11.0版本添加),设置视频编码镜像

录制效果设置相关逻辑

API
描述
设置全局水印(精简版不支持)
获取美颜管理对象
设置美颜美白效果级别(已废弃)使用TXBeautyManager相关接口
setFilter
设置指定素材滤镜特效(已废弃)使用TXBeautyManager相关接口
setFilter
设置两个滤镜效果(精简版不支持)(已废弃)使用TXBeautyManager相关接口
设置滤镜效果程度(已废弃)使用TXBeautyManager相关接口
设置大眼级别(已废弃)
设置瘦脸级别(已废弃)
设置 V 脸(已废弃)
设置下巴拉伸或收缩(已废弃)
设置短脸(已废弃)
设置瘦鼻(已废弃)
设置绿幕文件(已废弃)
设置动效(已废弃)
设置动效静音(已废弃)

背景音相关逻辑

API
描述
setBGM
设置背景音乐文件(精简版不支持)
设置背景音乐文件(精简版不支持)
设置背景音乐是否循环播放(精简版不支持)
播放背景音乐(精简版不支持)
stopBGM
停止播放背景音乐(精简版不支持)
pauseBGM
暂停播放背景音乐(精简版不支持)
resumeBGM
继续播放背景音乐(精简版不支持)
设置麦克风的音量大小
设置背景音乐的音量大小
设置混响效果(精简版不支持)
设置变声类型(精简版不支持)
snapshot
截图/拍照,startCamera 之后调用有效(精简版不支持)

TXUGCRecordListener

短视频录制回调

API
描述
短视频录制进度
短视频录制完成
短视频录制事件通知(暂未使用)

TXUGCRecordTypeDef

视频录制关键类型定义

API
描述
录制参数定义
录制参数类
录制结果

枚举类型说明

API
描述
录制视频质量类型
录制分辨率类型
视频渲染模式类型
录制视频比例类型
录制视频速率
横竖屏录制类型
编码方式
混响效果
变声类型
美颜类型
音频采样率
录制结果错误码

错误码

录制结果错误码定义

符号
含义
UGC_RECORD_RESULT_OK
0
录制成功(业务层主动结束录制),会生成最终视频
UGC_RECORD_RESULT_OK_INTERRUPT
1
录制成功(因为进后台,或则闹钟,电话打断等自动结束录制),会生成最终视频
UGC_RECORD_RESULT_OK_UNREACH_MINDURATION
2
录制成功(录制时长未达到设置的最小时长),会生成最终视频
UGC_RECORD_RESULT_OK_BEYOND_MAXDURATION
3
录制成功(录制时长超过设置的最大时长),会生成最终视频
UGC_RECORD_RESULT_FAILED
1001
录制失败,不会生成最终视频

开始录制的返回错误码

含义
-1
正在录制短视频
-2
初始化失败
-3
摄像头打开失败(可能是没有权限)
-4
麦克风打开失败(可能是没有权限)
-5
licence 验证失败
-6
videoPath 为空
-7
coverPath 为空

录制事件码

含义
1
暂停录制
2
恢复录制
3
摄像头打开失败
4
麦克风打开失败
5
分段录制视频生成事件
6
录制启动事件

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈