tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
实时音视频
    文档
    Download PDF

    API 概览

    最后更新时间：2024-08-22 11:54:17
    下载PDF

      TRTCCloud

      基础方法

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

      房间相关接口函数

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

      CDN 相关接口函数

      API
      描述
      开始向腾讯云的直播 CDN 推流。
      停止向腾讯云的直播 CDN 推流。
      开始向友商云的直播 CDN 转推。
      停止向非腾讯云地址转推。
      设置云端的混流转码参数。
      开始发布媒体流。
      更新发布媒体流。
      停止发布媒体流。

      视频相关接口函数

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

      音频相关接口函数

      API
      描述
      开启本地音频的采集和上行。
      关闭本地音频的采集和上行。
      静音/取消静音本地的音频。
      设置音频路由。
      静音/取消静音指定的远端用户的声音。
      静音/取消静音所有用户的声音。
      设定某一个远端用户的声音播放音量
      设置 SDK 采集音量。
      获取 SDK 采集音量。
      设置 SDK 播放音量。
      获取 SDK 播放音量。
      启用音量大小提示。
      开始录音。
      停止录音。
      设置通话时使用的系统音量类型。
      启用系统音频采集。
      停止系统音频采集。
      设置系统音频采集的音量。

      设备管理接口

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

      美颜滤镜相关接口函数

      API
      描述
      获取美颜管理对象。接口详情见美颜管理文档
      添加水印。

      自定义采集和自定义渲染

      API
      描述
      设置本地视频的自定义渲染回调
      设置远端视频自定义渲染回调
      取消自定义的渲染回调
      启用/禁用自定义视频处理
      设置自定义音频数据回调

      音乐特效和人声特效

      API
      描述
      获取音效管理类 TXAudioEffectManager，用于管理BGM，短音效和人声特效。接口详情见音效管理文档

      辅流相关接口函数

      API
      描述
      启动屏幕分享
      停止屏幕采集
      暂停屏幕分享
      恢复屏幕分享
      枚举可分享的屏幕和窗口（该接口仅支持 Windows ）
      选取要分享的屏幕或窗口（该接口仅支持 Windows）

      自定义消息发送

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

      网络测试

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

      Log 相关接口函数

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

      TRTCCloudListener

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

      错误事件和警告事件

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

      房间事件回调

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

      成员事件回调

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

      录制任务回调

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

      播放背景音乐的回调接口

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

      统计和质量回调

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

      服务器事件回调

      API
      描述
      SDK 跟服务器的连接断开。
      SDK 尝试重新连接到服务器。
      SDK 跟服务器的连接恢复。
      网速测试的结果回调。
      服务器测速的结果回调（已废弃）

      硬件设备事件回调

      API
      描述
      摄像头准备就绪。
      麦克风准备就绪。
      用于提示音量大小的回调，包括每个 userId 的音量和远端总音量。
      本地设备连接和断开的回调
      麦克风测试音量的回调
      扬声器测试音量的回调
      音频路由改变的回调（仅限移动设备）

      自定义消息的接收回调

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

      CDN 旁路转推回调

      API
      描述
      开始向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 startPublishing() 接口。
      停止向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 stopPublishing() 接口。
      启动旁路推流到 CDN 完成的回调。
      停止旁路推流到 CDN 完成的回调。
      设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口。
      设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 startPublishMediaStream() 接口。
      设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 updatePublishMediaStream() 接口。
      设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 stopPublishMediaStream() 接口。

      屏幕分享回调

      API
      描述
      当屏幕分享开始时，SDK 会通过此回调通知
      当屏幕分享调用 pauseScreenCapture() 暂停时，SDK 会通过此回调通知。
      当屏幕分享调用 resumeScreenCapture() 恢复时，SDK 会通过此回调通知。
      当屏幕分享停止时，SDK 会通过此回调通知。

      截图回调

      API
      描述
      截图完成时回调。

      TXAudioEffectManager

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

      TXBeautyManager

      API
      描述
      设置美颜滤镜类型
      setFilter
      指定素材滤镜效果
      设置滤镜强度
      设置美颜滤镜强度
      设置亮白滤镜强度
      启用清晰度增强
      设置红润滤镜强度

      TXDeviceManager

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

      关键类型定义

      类名
      描述
      关键类型定义变量。
      进房参数。
      切换房间参数参数。
      视频编码参数。
      网络流控相关参数。
      远端图像参数。
      云端混流中每一路子画面的位置信息。
      云端混流（转码）配置。
      变声类型定义（萝莉、大叔、重金属、外国人...）。
      变声类型定义（KTV、小房间、大会堂、低沉、洪亮...）。
      音乐和人声设置接口参数。
      录音参数。
      录制参数
      CDN转推参数。
      本地视频使用外部纹理渲染的参数
      远程视频使用外部纹理渲染的参数
      视频使用外部纹理渲染的参数
      媒体流发布模式
      配置将实时音视频（TRTC）流发布到腾讯云或第三方 CDN
      TRTCUser
      TRTC 用户的信息，主要包含用户ID和用户所在的房间号
      配置 TRTC 流的发布目标
      发布流的相关编码设置，包含分辨率、帧率、关键帧间隔等等
      Rect
      用于描述一些视图的坐标
      TRTC 视频视图显示模式的枚举，包括填充模式和适应模式
      TRTC 所提供的不同的视频流类型
      TRTC 混流转码时的视频布局属性配置，包括位置、大小、图层等
      TRTC 水印功能的属性配置
      TRTC 混流转码的相关设置，包括背景颜色、背景图像、所有要混合的视频和音频流的信息以及水印设置等。
      音视频帧数据类，用于处理和传输音频数据。
      屏幕窗口列表。
      屏幕分享的目标信息（仅适用于桌面系统）
      TRTC 屏幕分享图标信息以及 mute image 垫片
      屏幕分享的进阶控制参数
      屏幕共享目标类型（仅桌面）

      视频渲染组件

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

      废弃接口

      API
      描述
      开始进行网络测速（视频通话期间请勿测试，以免影响通话质量）。
      
      联系我们

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

      联系我们
      技术支持

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

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