直播 SDK
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>直播 SDK>客户端 API>Android>API 概览

API 概览

最近更新时间：2024-10-09 10:20:51

我的收藏

本页目录：

API OVERVIEW

V2 推流器相关接口

函数列表
描述
释放 V2TXLivePusher 资源
设置推流器回调
设置本地摄像头预览 View
设置本地摄像头预览镜像
设置视频编码镜像
设置本地摄像头预览画面的旋转角度
设置本地摄像头预览画面的填充模式
打开本地摄像头
关闭本地摄像头
打开麦克风
关闭麦克风
开启图片推流
关闭图片推流
开启屏幕采集
关闭屏幕采集
暂停推流器的音频流
恢复推流器的音频流
暂停推流器的视频流
恢复推流器的视频流
开始音视频数据推流
停止推送音视频数据
当前推流器是否正在推流中
设置推流音频质量
设置推流视频编码参数
获取音效管理对象
获取美颜管理对象
获取设备管理对象
截取推流过程中的本地画面
设置推流器水印。默认情况下，水印不开启
启用采集音量大小提示
开启/关闭自定义视频处理
开启/关闭自定义视频采集
开启/关闭自定义音频采集
在自定义视频采集模式下，将采集的视频数据发送到SDK
在自定义音频采集模式下，将采集的音频数据发送到SDK
开启/关闭对经过前处理后的本地音频帧的监听回调
发送 SEI 消息
打开系统声音采集
关闭系统声音采集
显示仪表盘。
调用 V2TXLivePusher 的高级 API 接口。
设置云端的混流转码参数
开始录制音视频流
停止录制音视频流
启用人声检测

直播推流器事件回调

函数列表
描述
直播推流器错误通知，推流器出现错误时，会回调该通知
直播推流器警告通知
首帧音频采集完成的回调通知
首帧视频采集完成的回调通知
麦克风采集音量值回调
推流器连接状态回调通知
直播推流器统计数据回调
截图回调
SDK 内部的 OpenGL 环境的创建通知
本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调
自定义视频处理回调
SDK 内部的 OpenGL 环境的销毁通知
设置云端的混流转码参数的回调，对应于 setMixTranscodingConfig 接口
当屏幕分享开始时，SDK 会通过此回调通知
当屏幕分享停止时，SDK 会通过此回调通知
录制任务开始的事件回调
录制任务正在进行中的进展事件回调
录制任务已经结束的事件回调
调用 enableVoiceActivityDetection 开启人声检测之后，当主播开始或结束说话时，会收到这个回调通知。

直播播放器事件回调

函数列表
描述
直播播放器错误通知，播放器出现错误时，会回调该通知
直播播放器警告通知
直播播放器分辨率变化通知
已经成功连接到服务器
视频播放事件
音频播放事件
视频加载事件
音频加载事件
播放器音量大小回调
直播播放器统计数据回调
截图回调
自定义视频渲染回调
音频数据回调
收到 SEI 消息的回调，发送端通过 V2TXLivePusher 中的 sendSeiMessage 来发送 SEI 消息
分辨率无缝切换回调
录制任务开始的事件回调
录制任务正在进行中的进展事件回调
录制任务已经结束的事件回调

V2 播放器相关接口

函数列表
描述
设置播放器回调
设置播放器的视频渲染 View，该控件负责显示视频内容
设置播放器画面的旋转角度
设置画面的填充模式
开始播放音视频流
停止播放音视频流
播放器是否正在播放中
暂停播放器的音频流
恢复播放器的音频流
暂停播放器的视频流
恢复播放器的视频流
设置播放器音量
设置播放器缓存自动调整的最小和最大时间 ( 单位：秒 )
直播流无缝切换，支持 FLV 和 LEB
获取码流信息
启用播放音量大小提示
截取播放过程中的视频画面
开启/关闭对视频帧的监听回调
开启/关闭对音频数据的监听回调
开启接收 SEI 消息
是否显示播放器状态信息的调试浮层
调用 V2TXLivePlayer 的高级 API 接口
开始录制音视频流
停止录制音视频流

V2TXLive 高级接口

函数列表
描述
获取 SDK 版本号
设置 V2TXLivePremier 回调接口
设置 Log 的配置信息
设置 SDK 接入环境
设置 SDK 的授权 License
设置 SDK socks5 代理配置
开启/关闭对音频采集数据的监听回调（可读写）
开启/关闭对最终系统要播放出的音频数据的监听回调
开启/关闭耳返音频数据的监听回调
设置 userId
调用实验性 API 接口

V2TXLive 高级回调接口

函数列表
描述
自定义 Log 输出回调接口
setLicence 接口回调
本地麦克风采集到的音频数据回调
将各路待播放音频混合之后并在最终提交系统播放之前的数据回调
耳返的音频数据

背景音乐预加载事件回调

函数列表
描述
背景音乐预加载进度
背景音乐预加载出错

背景音乐的播放事件回调

函数列表
描述
背景音乐开始播放
背景音乐的播放进度
背景音乐已经播放完毕

人声相关的特效接口

函数列表
描述
开启耳返
设置耳返音量
设置人声的混响效果
设置人声的变声特效
设置语音音量
设置语音音调

背景音乐的相关接口

函数列表
描述
设置背景音乐的事件回调接口
开始播放背景音乐
停止播放背景音乐
暂停播放背景音乐
恢复播放背景音乐
设置所有背景音乐的本地音量和远端音量的大小
设置某一首背景音乐的远端音量的大小
设置某一首背景音乐的本地音量的大小
调整背景音乐的音调高低
调整背景音乐的变速效果
获取背景音乐的播放进度（单位：毫秒）
获取背景音乐的总时长（单位：毫秒）
设置背景音乐的播放进度（单位：毫秒）
调整搓碟的变速效果
设置预加载事件回调
预加载背景音乐
获取背景音乐的音轨数量
指定背景音乐的播放音轨

美颜相关接口

函数列表
描述
设置美颜（磨皮）算法
设置美颜级别
设置美白级别
开启清晰度增强
设置红润级别
设置色彩滤镜效果
设置色彩滤镜的强度
设置绿幕背景视频
设置大眼级别
设置瘦脸级别
设置 V 脸级别
设置下巴拉伸或收缩
设置短脸级别
设置窄脸级别
设置瘦鼻级别
设置亮眼级别
设置牙齿美白级别
设置祛皱级别
设置祛眼袋级别
设置法令纹去除级别
设置发际线调整级别
设置眼距
设置眼角调整级别
设置嘴型调整级别
设置鼻翼调整级别
设置鼻子位置
设置嘴唇厚度
设置脸型
选择 AI 动效挂件
是否在动效素材播放时静音

设备操作接口

函数列表
描述
判断当前是否为前置摄像头（仅适用于移动端）
切换前置或后置摄像头（仅适用于移动端）
获取摄像头的最大缩放倍数（仅适用于移动端）
设置摄像头的缩放倍数（仅适用于移动端）
查询是否支持自动识别人脸位置（仅适用于移动端）
开启自动对焦功能（仅适用于移动端）
设置摄像头的对焦位置（仅适用于移动端）
开启/关闭闪光灯，也就是手电筒模式（仅适用于移动端）
设置音频路由（仅适用于移动端）
设置摄像头的曝光参数，取值范围从-1到1
设置摄像头采集偏好

弃用接口

函数列表
描述
设置系统音量类型（仅适用于移动端）
中国站
文档反馈
文档活动
message-icon联系我们
目录