tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
实时音视频
    文档
    Download PDF

    API 概览

    最后更新时间：2024-11-29 15:41:57
    下载PDF

      TRTCCloud

      基础方法

      API
      描述
      创建 TRTCCloud 单例。
      销毁 TRTCCloud单例。
      设置事件监听
      移除事件监听

      房间相关接口函数

      API
      描述
      enterRoom
      进入房间，若房间不存在，系统将自动创建一个新房间。
      exitRoom
      离开房间。
      切换角色，仅适用于直播场景（TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM）。
      切换房间。
      请求跨房通话（主播 PK）。
      退出跨房通话。
      设置音视频数据接收模式，需要在进房前设置才能生效。

      CDN 相关接口函数

      API
      描述
      开始发布媒体流。
      更新发布媒体流。
      停止发布媒体流。

      视频相关接口函数

      API
      描述
      开启本地视频的预览画面。
      更新本地视频预览画面。
      停止本地视频采集及预览。
      暂停/恢复推送本地的视频数据。
      开始显示远端视频画面。
      更新远端用户的视频渲染控件。
      停止显示远端视频画面，同时不再拉取该远端用户的视频数据流。
      停止显示所有远端视频画面，同时不再拉取远端用户的视频数据流。
      暂停/恢复接收指定的远端视频流。
      暂停/恢复接收所有远端视频流。
      设置视频编码器相关参数。
      设置网络流控相关参数。
      设置本地图像的渲染模式。
      设置远端图像相关参数。
      开启大小画面双路编码模式。
      选定观看指定 uid 的大画面或小画面。
      视频画面截图。
      设置重力感应的适应模式。

      音频相关接口函数

      API
      描述
      开启本地音频的采集和上行。
      关闭本地音频的采集和上行。
      静音/取消静音本地的音频。
      静音/取消静音指定的远端用户的声音。
      静音/取消静音所有用户的声音。
      设定某一个远端用户的声音播放音量
      设置 SDK 采集音量。
      获取 SDK 采集音量。
      设置 SDK 播放音量。
      获取 SDK 播放音量。
      启用音量大小提示。
      开始本地媒体录制，同时包含音频与视频数据。
      停止本地媒体录制。

      设备管理接口

      API
      描述
      获取设备管理模块。接口详情见设备管理接口文档

      音乐特效和人声特效

      API
      描述
      获取音效管理类 TXAudioEffectManager，用于管理BGM，短音效和人声特效。接口详情见音效管理文档
      启用系统音频采集。
      停止系统音频采集。
      设置系统音频采集的音量。

      辅流相关接口函数

      API
      描述
      启动屏幕分享
      停止屏幕采集
      暂停屏幕分享
      恢复屏幕分享
      枚举可分享的屏幕和窗口（该接口仅支持 Windows ）
      选取要分享的屏幕或窗口（该接口仅支持 Windows）
      设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）

      自定义采集和自定义渲染

      API
      描述
      启用/关闭视频自定义采集模式。
      向 SDK 投送自己采集的视频帧。
      启用/关闭音频自定义采集模式。
      向 SDK 投送自己采集的音频数据。
      启用/关闭自定义音轨。

      自定义消息发送

      API
      描述
      发送自定义消息给房间内所有用户。
      将小数据量的自定义数据嵌入视频帧中。

      网络测试

      API
      描述
      开始进行网络测速（视频通话期间请勿测试，以免影响通话质量）。
      停止服务器测速。

      Log 相关接口函数

      API
      描述
      获取 SDK 版本信息。
      设置 Log 输出级别。
      启用或禁用控制台日志打印。
      启用或禁用 Log 的本地压缩。
      修改日志保存路径。
      设置日志回调。
      显示调试信息浮层(可以展示音视频信息和事件信息)。
      调用实验性 API。

      TRTCCloudListener

      腾讯云视频通话功能的事件回调接口。

      错误事件和警告事件

      API
      描述
      onError
      错误回调，表示 SDK 不可恢复的错误，一定要监听并分情况给用户适当的界面提示。
      onWarning
      警告回调，用于告知您一些非严重性问题，例如出现卡顿或者可恢复的解码失败。

      房间事件回调

      API
      描述
      已加入房间的回调。
      离开房间的事件回调。
      切换角色的事件回调。
      切换房间 (switchRoom) 的结果回调。
      请求跨房通话（主播 PK）的结果回调。
      结束跨房通话（主播 PK）的结果回调。

      成员事件回调

      API
      描述
      有用户加入当前房间。
      有用户离开当前房间。
      远端用户是否存在可播放的主路画面（一般用于摄像头）。
      远端用户是否存在可播放的辅路画面（一般用于屏幕分享）。
      远端用户是否存在可播放的音频数据。
      开始渲染本地或远程用户的首帧画面。
      开始播放远程用户的首帧音频（本地声音暂不通知）。
      首帧本地视频数据已经被送出。
      首帧本地音频数据已经被送出。
      远端视频状态变化的事件回调。
      远端音频状态变化的事件回调。
      用户视频大小发生改变回调。

      本地录制和本地截图的事件回调

      API
      描述
      当本地录制任务已经开始时，SDK会通过这个回调通知。
      当本地录制任务正在进行时，SDK会定期通过这个回调通知用户。
      当你启用分段录制时，SDK会在每次完成一个片段时通过这个回调通知你。
      当本地录制任务已经结束时，SDK会通过这个回调通知你。
      本地截图完成的事件回调。

      统计和质量回调

      API
      描述
      网络质量，该回调每2秒触发一次，统计当前网络的上行和下行质量。
      技术指标统计回调。
      网速测试的结果回调。

      服务器事件回调

      API
      描述
      SDK 跟服务器的连接断开。
      SDK 尝试重新连接到服务器。
      SDK 跟服务器的连接恢复。

      硬件设备事件回调

      API
      描述
      摄像头准备就绪。
      麦克风准备就绪。
      用于提示音量大小的回调，包括每个 userId 的音量和远端总音量。
      当前麦克风的系统采集音量发生变化。
      当前系统的播放音量发生变化。
      系统声音采集是否被成功开启的事件回调（仅适用于桌面系统）。
      麦克风测试音量的回调
      扬声器测试音量的回调

      自定义消息的接收回调

      API
      描述
      收到自定义消息回调。
      自定义消息丢失回调。
      收到 SEI 消息的回调。

      CDN 旁路转推回调

      API
      描述
      设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 startPublishMediaStream() 接口。
      设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 updatePublishMediaStream() 接口。
      设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 stopPublishMediaStream() 接口。
      RTMP/RTMPS 推流状态发生改变回调。

      屏幕分享回调

      API
      描述
      当屏幕分享开始时，SDK 会通过此回调通知
      当屏幕分享调用 pauseScreenCapture() 暂停时，SDK 会通过此回调通知。
      当屏幕分享调用 resumeScreenCapture() 恢复时，SDK 会通过此回调通知。
      当屏幕分享停止时，SDK 会通过此回调通知。
      屏幕分享的目标窗口被遮挡的事件回调（仅适用于 Windows 操作系统）

      更多事件回调

      TRTC 日志回调

      API
      描述
      onLog
      本地 LOG 的打印回调

      播放背景音乐的回调接口

      API
      描述
      onStart
      音乐播放开始的回调通知。
      音乐播放进度的回调通知。
      音乐播放结束的回调通知。

      背景音乐预加载事件回调

      API
      描述
      背景音乐预加载进度。
      背景音乐预加载出错。

      设备通断状态改变回调

      API
      描述
      本地设备的通断状态发生变化（仅适用于桌面系统）

      TXAudioEffectManager

      API
      描述
      启用耳返，使本地用户可以听到自己的声音。
      设置耳返音量
      设置语音混响效果（KTV、小房间、大会堂、低沉、洪亮等效果）
      设置语音变声效果（萝莉、大叔、重金属、朋克等效果）
      设置麦克风语音音量
      设置语音音调。
      设置背景音乐的事件回调接口。
      开始播放背景音乐
      停止播放背景音乐
      暂停播放背景音乐
      恢复播放背景音乐
      设置全局背景音乐的本地和远程音量
      设置背景音乐的远程音量。主播可以使用此 API 设置远程观众听到的背景音乐的音量。
      设置背景音乐的本地音量。主播可以使用此 API 设置本地背景音乐的音量。
      调整背景音乐的音调
      调整背景音乐的速度
      获取背景音乐的当前播放进度（毫秒）
      获取背景音乐文件的总时长（毫秒）
      设置背景音乐的播放进度（毫秒）
      调整搓碟的变速效果
      设置预加载事件回调
      预加载背景音乐
      获取背景音乐的音轨数量
      指定背景音乐的播放音轨

      TXDeviceManager

      API
      描述
      设置是否使用前置摄像头
      切换摄像头（前置/后置）
      获取摄像头的最大缩放倍数
      设置摄像头的缩放因子（焦距）
      查询设备是否支持自动识别人脸位置
      设置是否启用面部位置自动识别
      设置摄像头对焦位置
      启用/禁用闪光灯，也就是手电筒模式
      设置音频路由，即使用听筒或者扬声器
      获取指定类型的设备列表
      设置当前要使用的设备
      获取当前正在使用的设备
      设置当前设备的音量
      获取当前设备的音量
      设置当前设备的静音状态
      查询当前设备的静音状态
      设置 SDK 使用的音频设备根据跟随系统默认设备（仅适用于桌面端）
      开始摄像头测试（仅适用于桌面端）
      结束摄像头测试（仅适用于桌面端）
      开始麦克风测试（仅适用于桌面端）
      开始麦克风测试（仅适用于桌面端）
      停止麦克风测试（仅适用于桌面端）
      开始扬声器测试（仅适用于桌面端）
      停止扬声器测试（仅适用于桌面端）
      设置 Windows 系统音量混合器中当前进程的音量
      获取 Windows 系统音量混合器中当前进程的音量
      设置 Windows 系统音量混合器中当前进程的静音状态
      获取 Windows 系统音量混合器中当前进程的静音状态
      设置摄像头采集偏好
      设置 onDeviceChanged 事件回调

      枚举定义

      枚举类型
      描述
      使用场景
      音频帧内容格式
      音频回调数据操作模式
      音质
      音频录制内容类型
      播放状态变化原因
      音视频播放状态
      媒体录制类型
      设置重力感应的适配模式（仅适用于移动端）
      媒体录制类型。
      日志级别
      发布模式
      网络质量
      角色
      屏幕共享目标类型（仅限桌面）
      本地视频截图的数据源
      速度测试场景
      视频数据传输方式
      视频图像填充模式
      视频镜像类型
      视频像素格式
      图像质量偏好
      视频分辨率
      视频宽高比模式
      视频图像旋转方向
      视频流类型
      水印图像源类型
      混响特效
      变声特效
      音频路由（即声音的播放模式）
      设备类型（仅适用于桌面平台）
      设备操作
      摄像头采集偏好

      类型定义

      结构体类型
      描述
      音频帧数据
      自定义音频回调的格式参数
      音量评估及其他相关参数设置
      存储窗口缩略图和图标的结构
      本地媒体文件录制参数
      本地音视频指标
      网络带宽限制参数
      房间进入参数
      发布到腾讯云或第三方 CDN 的目标 URL
      发布目标
      网络质量
      远程音视频指标
      视频图像的渲染参数
      屏幕共享的高级控制参数
      屏幕共享的目标信息（仅限桌面）
      屏幕窗口列表
      网络速度测试参数
      网络速度测试结果
      网络和性能指标
      编码参数
      转码参数
      房间切换参数
      视频纹理数据
      TRTCUser
      要发布流的用户
      视频编码参数
      视频帧信息
      转码流的视频布局
      音量
      水印布局
      背景音乐的播放控制信息
      摄像头采集参数
      音视频设备的相关信息（仅适用于桌面平台）

      视频渲染组件

      API
      描述
      视频视图窗口，用于显示本地视频、远程视频或辅流。
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款