实时音视频 API 概览

媒体录制类型 Copyright (c) 2026 Tencent. All rights reserved.
﻿
Module:   TXLiteAVSDK
Function: API 概览与分类索引
Version: 13.5
﻿
腾讯云 TRTC Flutter SDK（tencent_rtc_sdk）的接口总览。本文按功能归类列出全部接口、回调与类型，点击名称可跳转到对应的详细说明。
文档一览
文档
说明
﻿TRTCCloud﻿
主功能接口：房间、音视频、屏幕分享、CDN 发布等。
﻿TRTCCloudListener﻿
事件回调：房间事件、音视频状态、质量统计等。
﻿TRTCCloudDef﻿
关键类型定义：枚举、参数类与统计数据类。
﻿TXDeviceManager﻿
设备管理：摄像头、麦克风、扬声器、音频路由。
﻿TXAudioEffectManager﻿
音效管理：背景音乐、耳返、混响与变声。
﻿AITranscriberManager﻿
AI 能力：实时语音转录与翻译。
获取各管理类实例的方式：
TXDeviceManager deviceManager = trtcCloud.getDeviceManager();
TXAudioEffectManager audioEffectManager = trtcCloud.getAudioEffectManager();
AITranscriberManager transcriberManager = trtcCloud.getAITranscriberManager();
按场景索引
我想做什么
相关接口
进入 / 离开房间
﻿enterRoom、​exitRoom、​switchRoom﻿
直播场景切换主播 / 观众
﻿switchRole﻿
开启摄像头并让他人看到
﻿startLocalPreview、​setVideoEncoderParam﻿
观看他人的画面
﻿onUserVideoAvailable、​startRemoteView﻿
开启麦克风并让他人听到
﻿startLocalAudio、​muteLocalAudio﻿
屏幕分享
﻿startScreenCapture、​getScreenCaptureSources﻿
美颜
﻿setBeautyStyle﻿
播放背景音乐 / K 歌
﻿startPlayMusic、​enableVoiceEarMonitor﻿
切换摄像头 / 扬声器等设备
﻿switchCamera、​setCurrentDevice﻿
推流到直播 CDN / 云端混流
﻿startPublishMediaStream﻿
房间内收发自定义信令
﻿sendCustomCmdMsg、​sendSEIMsg﻿
显示音量条 / 声波
﻿enableAudioVolumeEvaluation、​onUserVoiceVolume﻿
监控通话质量
﻿onNetworkQuality、​onStatistics﻿
进房前测网速
﻿startSpeedTest﻿
本地录制通话内容
﻿startLocalRecording﻿
实时语音转文字 / 翻译
﻿startRealtimeTranscriber﻿
排查问题 / 提工单
﻿showDebugView、​setLogDirPath、​setLogCallback﻿
TRTCCloud 主功能接口
详见 ​TRTCCloud。
实例与事件回调
API
描述
﻿sharedInstance﻿
创建 TRTCCloud 实例（单例模式）。
﻿destroySharedInstance﻿
销毁 TRTCCloud 实例（单例模式）。
﻿registerListener﻿
添加 TRTC 事件回调。
﻿unRegisterListener﻿
移除 TRTC 事件回调。
房间相关接口
API
描述
﻿enterRoom﻿
进入房间。
﻿exitRoom﻿
离开房间。
﻿switchRole﻿
切换角色。
﻿switchRoom﻿
切换房间。
﻿connectOtherRoom﻿
请求跨房通话。
﻿disconnectOtherRoom﻿
退出跨房通话。
﻿setDefaultStreamRecvMode﻿
设置订阅模式（需要在进房前设置才能生效）。
CDN 发布与混流
API
描述
﻿startPublishMediaStream﻿
开始发布媒体流。
﻿updatePublishMediaStream﻿
更新发布媒体流。
﻿stopPublishMediaStream﻿
停止发布媒体流。
视频相关接口
API
描述
﻿startLocalPreview﻿
开启本地摄像头的预览画面。
﻿updateLocalView﻿
更新本地摄像头的预览画面。
﻿stopLocalPreview﻿
停止摄像头预览。
﻿muteLocalVideo﻿
暂停/恢复发布本地的视频流。
﻿startRemoteView﻿
订阅远端用户的视频流，并绑定视频渲染控件。
﻿updateRemoteView﻿
更新远端用户的视频渲染控件。
﻿stopRemoteView﻿
停止订阅远端用户的视频流，并释放渲染控件。
﻿stopAllRemoteView﻿
停止订阅所有远端用户的视频流，并释放全部渲染资源。
﻿setVideoMuteImage﻿
设置本地画面被暂停期间的替代图片（暂不支持 Windows / macOS）。
﻿setWatermark﻿
添加水印（暂不支持 Windows / macOS）。
﻿muteRemoteVideoStream﻿
暂停/恢复订阅远端用户的视频流。
﻿muteAllRemoteVideoStreams﻿
暂停/恢复订阅所有远端用户的视频流。
﻿setVideoEncoderParam﻿
设置视频编码器的编码参数。
﻿setVideoEncoderMirror﻿
设置编码器输出的画面镜像模式。
﻿setNetworkQosParam﻿
设置网络质量控制的相关参数。
﻿setLocalRenderParams﻿
设置本地画面的渲染参数。
﻿setRemoteRenderParams﻿
设置远端画面的渲染模式。
﻿enableSmallVideoStream﻿
开启大小画面双路编码模式。
﻿setRemoteVideoStreamType﻿
切换指定远端用户的大小画面。
﻿snapshotVideo﻿
视频画面截图（暂不支持 Windows / macOS）。
﻿setGravitySensorAdaptiveMode﻿
设置重力感应的适配模式（仅移动端）。
音频相关接口
API
描述
﻿startLocalAudio﻿
开启本地音频的采集和发布。
﻿stopLocalAudio﻿
停止本地音频的采集和发布。
﻿muteLocalAudio﻿
暂停/恢复发布本地的音频流。
﻿muteRemoteAudio﻿
暂停/恢复播放远端的音频流。
﻿muteAllRemoteAudio﻿
暂停/恢复播放所有远端用户的音频流。
﻿setRemoteAudioVolume﻿
设定某一个远端用户的声音播放音量。
﻿setAudioCaptureVolume﻿
设定本地音频的采集音量。
﻿getAudioCaptureVolume﻿
获取本地音频的采集音量。
﻿setAudioPlayoutVolume﻿
设定远端音频的播放音量。
﻿getAudioPlayoutVolume﻿
获取远端音频的播放音量。
﻿enableAudioVolumeEvaluation﻿
启用音量大小提示。
﻿startLocalRecording﻿
开启本地媒体录制。
﻿stopLocalRecording﻿
停止本地媒体录制。
设备、美颜与音效
API
描述
﻿getDeviceManager﻿
获取设备管理类（TXDeviceManager）。
﻿setBeautyStyle﻿
设置美颜、美白、红润等特效。
﻿getAudioEffectManager﻿
获取音效管理类（TXAudioEffectManager）。
﻿startSystemAudioLoopback﻿
开启系统声音采集（仅 Windows）。
﻿stopSystemAudioLoopback﻿
停止系统声音采集（仅 Windows）。
﻿setSystemAudioLoopbackVolume﻿
设置系统声音的采集音量（仅 Windows）。
屏幕分享
API
描述
﻿startScreenCapture﻿
启动屏幕分享。
﻿startScreenCaptureByReplaykit﻿
通过 ReplayKit 启动屏幕分享（仅 iOS）。
﻿stopScreenCapture﻿
停止屏幕分享。
﻿pauseScreenCapture﻿
暂停屏幕分享。
﻿resumeScreenCapture﻿
恢复屏幕分享。
﻿getScreenCaptureSources﻿
枚举可分享的屏幕和窗口（仅桌面系统）。
﻿selectScreenCaptureTarget﻿
选取要分享的屏幕或窗口（仅桌面系统）。
﻿addExcludedShareWindow﻿
将指定窗口加入屏幕分享的排除列表（仅桌面系统）。
﻿removeExcludedShareWindow﻿
将指定窗口从排除列表移除（仅桌面系统）。
﻿removeAllExcludedShareWindow﻿
将所有窗口从排除列表移除（仅桌面系统）。
﻿addIncludedShareWindow﻿
将指定窗口加入屏幕分享的包含列表（仅桌面系统）。
﻿removeIncludedShareWindow﻿
将指定窗口从包含列表移除（仅桌面系统）。
﻿removeAllIncludedShareWindow﻿
将全部窗口从包含列表移除（仅桌面系统）。
﻿setSubStreamEncoderParam﻿
设置屏幕分享（即辅路）的视频编码参数。
自定义采集与自定义消息
API
描述
﻿enableCustomAudioCapture﻿
启用音频自定义采集模式。
﻿sendCustomAudioData﻿
向 SDK 投送自己采集的音频数据。
﻿setAudioFrameCallback﻿
设置音频数据回调。
﻿sendCustomCmdMsg﻿
使用 UDP 通道发送自定义消息给房间内所有用户。
﻿sendSEIMsg﻿
使用 SEI 通道发送自定义消息给房间内所有用户。
网络测试
API
描述
﻿startSpeedTest﻿
开始进行网速测试（进房前使用）。
﻿stopSpeedTest﻿
停止网络测速。
调试相关接口
API
描述
﻿getSDKVersion﻿
获取 SDK 版本信息。
﻿setLogLevel﻿
设置 Log 输出级别。
﻿setConsoleEnabled﻿
启用/禁用控制台日志打印。
﻿setLogCompressEnabled﻿
启用/禁用日志的本地压缩。
﻿setLogDirPath﻿
设置本地日志的保存路径。
﻿setLogCallback﻿
设置日志回调。
﻿showDebugView﻿
显示仪表盘。
﻿callExperimentalAPI﻿
调用实验性接口。
AI 能力
API
描述
﻿getAITranscriberManager﻿
获取 AI 转录管理类（AITranscriberManager）。
TRTCCloudListener 事件回调
详见 ​TRTCCloudListener。
错误与警告事件
回调
描述
﻿onError﻿
错误事件回调。
﻿onWarning﻿
警告事件回调。
房间事件
回调
描述
﻿onEnterRoom﻿
进入房间成功与否的事件回调。
﻿onExitRoom﻿
离开房间的事件回调。
﻿onSwitchRole﻿
切换角色的事件回调。
﻿onSwitchRoom﻿
切换房间的结果回调。
﻿onConnectOtherRoom﻿
请求跨房通话的结果回调。
﻿onDisconnectOtherRoom﻿
结束跨房通话的结果回调。
用户与音视频流事件
回调
描述
﻿onRemoteUserEnterRoom﻿
有用户加入当前房间。
﻿onRemoteUserLeaveRoom﻿
有用户离开当前房间。
﻿onUserVideoAvailable﻿
某远端用户发布/取消了主路视频画面。
﻿onUserSubStreamAvailable﻿
某远端用户发布/取消了辅路视频画面。
﻿onUserAudioAvailable﻿
某远端用户发布/取消了自己的音频。
﻿onFirstVideoFrame﻿
SDK 开始渲染自己本地或远端用户的首帧画面。
﻿onFirstAudioFrame﻿
SDK 开始播放远端用户的首帧音频。
﻿onSendFirstLocalVideoFrame﻿
自己本地的首个视频帧已被发布出去。
﻿onSendFirstLocalAudioFrame﻿
自己本地的首个音频帧已被发布出去。
﻿onRemoteVideoStatusUpdated﻿
远端视频状态变化的事件回调。
﻿onRemoteAudioStatusUpdated﻿
远端音频状态变化的事件回调。
﻿onUserVideoSizeChanged﻿
远端视频分辨率变化的事件回调。
网络与技术指标统计
回调
描述
﻿onNetworkQuality﻿
网络质量的实时统计回调。
﻿onStatistics﻿
音视频技术指标的实时统计回调。
﻿onSpeedTestResult﻿
网速测试的结果回调。
与云端连接情况
回调
描述
﻿onConnectionLost﻿
SDK 与云端的连接已经断开。
﻿onTryToReconnect﻿
SDK 正在尝试重新连接到云端。
﻿onConnectionRecovery﻿
SDK 与云端的连接已经恢复。
硬件设备事件
回调
描述
﻿onCameraDidReady﻿
摄像头准备就绪。
﻿onMicDidReady﻿
麦克风准备就绪。
﻿onAudioRouteChanged﻿
当前音频路由发生变化。
﻿onUserVoiceVolume﻿
音量大小的反馈回调。
﻿onAudioDeviceCaptureVolumeChanged﻿
当前麦克风的系统采集音量发生变化（桌面系统）。
﻿onAudioDevicePlayoutVolumeChanged﻿
当前系统的播放音量发生变化（桌面系统）。
﻿onSystemAudioLoopbackError﻿
系统声音采集是否被成功开启的事件回调（仅桌面系统）。
﻿onTestMicVolume﻿
测试麦克风时的音量回调。
﻿onTestSpeakerVolume﻿
测试扬声器时的音量回调。
自定义消息的接收事件
回调
描述
﻿onRecvCustomCmdMsg﻿
收到自定义消息的事件回调。
﻿onMissCustomCmdMsg﻿
自定义消息丢失的事件回调。
﻿onRecvSEIMsg﻿
收到 SEI 消息的回调。
CDN 相关事件
回调
描述
﻿onStartPublishMediaStream﻿
开始发布媒体流的事件回调。
﻿onUpdatePublishMediaStream﻿
更新媒体流的事件回调。
﻿onStopPublishMediaStream﻿
停止媒体流的事件回调。
﻿onCdnStreamStateChanged﻿
RTMP/RTMPS 推流状态发生改变回调。
屏幕分享相关事件
回调
描述
﻿onScreenCaptureStarted﻿
屏幕分享开启的事件回调。
﻿onScreenCapturePaused﻿
屏幕分享暂停的事件回调。
﻿onScreenCaptureResumed﻿
屏幕分享恢复的事件回调。
﻿onScreenCaptureStopped﻿
屏幕分享停止的事件回调。
﻿onScreenCaptureCovered﻿
屏幕分享的目标窗口被遮挡的事件回调（仅 Windows）。
本地录制与本地截图事件
回调
描述
﻿onLocalRecordBegin﻿
本地录制任务已经开始的事件回调。
﻿onLocalRecording﻿
本地录制任务正在进行中的进展事件回调。
﻿onLocalRecordFragment﻿
录制分片结束的事件回调。
﻿onLocalRecordComplete﻿
本地录制任务已经结束的事件回调。
﻿onSnapshotComplete﻿
本地截图完成的事件回调。
TXDeviceManager 设备管理
详见 ​TXDeviceManager。
移动端设备接口
API
描述
﻿isFrontCamera﻿
查询当前是否使用前置摄像头（仅移动端）。
﻿switchCamera﻿
切换前置或后置摄像头（仅移动端）。
﻿getCameraZoomMaxRatio﻿
获取摄像头的最大缩放倍数（仅移动端）。
﻿setCameraZoomRatio﻿
设置摄像头的缩放倍数（仅移动端）。
﻿isAutoFocusEnabled﻿
查询是否支持自动识别人脸位置（仅移动端）。
﻿enableCameraAutoFocus﻿
开启自动对焦功能（仅移动端）。
﻿setCameraFocusPosition﻿
设置摄像头的对焦位置（仅移动端）。
﻿enableCameraTorch﻿
开启/关闭闪光灯，即手电筒模式（仅移动端）。
﻿setAudioRoute﻿
设置音频路由（仅移动端）。
桌面端设备接口
API
描述
﻿getDevicesList﻿
获取设备列表（仅桌面端）。
﻿setCurrentDevice﻿
设置当前要使用的设备（仅桌面端）。
﻿getCurrentDevice﻿
获取当前正在使用的设备（仅桌面端）。
﻿setCurrentDeviceVolume﻿
设置当前设备的音量（仅桌面端）。
﻿getCurrentDeviceVolume﻿
获取当前设备的音量（仅桌面端）。
﻿setCurrentDeviceMute﻿
设置当前设备的静音状态（仅桌面端）。
﻿getCurrentDeviceMute﻿
查询当前设备是否静音（仅桌面端）。
﻿enableFollowingDefaultAudioDevice﻿
设置 SDK 使用的音频设备跟随系统默认设备（仅桌面端）。
设备测试（桌面端）
API
描述
﻿startCameraDeviceTest﻿
开始摄像头测试（仅桌面端）。
﻿stopCameraDeviceTest﻿
结束摄像头测试（仅桌面端）。
﻿startMicDeviceTest﻿
开始麦克风测试（仅桌面端）。
﻿startMicDeviceTestAndPlayback﻿
开始麦克风测试，并可指定是否回放麦克风声音（仅桌面端）。
﻿stopMicDeviceTest﻿
结束麦克风测试（仅桌面端）。
﻿startSpeakerDeviceTest﻿
开始扬声器测试（仅桌面端）。
﻿stopSpeakerDeviceTest﻿
结束扬声器测试（仅桌面端）。
Windows 音量合成器
API
描述
﻿setApplicationPlayVolume﻿
设置 Windows 系统音量合成器中当前进程的音量（仅 Windows）。
﻿getApplicationPlayVolume﻿
获取 Windows 系统音量合成器中当前进程的音量（仅 Windows）。
﻿setApplicationMuteState﻿
设置 Windows 系统音量合成器中当前进程的静音状态（仅 Windows）。
﻿getApplicationMuteState﻿
获取 Windows 系统音量合成器中当前进程的静音状态（仅 Windows）。
通用接口
API
描述
﻿setCameraCaptureParam﻿
设置摄像头采集偏好。
﻿setDeviceObserver﻿
设置设备状态变化回调。
TXAudioEffectManager 音效管理
详见 ​TXAudioEffectManager。
人声相关接口
API
描述
﻿enableVoiceEarMonitor﻿
开启耳返。
﻿setVoiceEarMonitorVolume﻿
设置耳返音量。
﻿setVoiceReverbType﻿
设置人声的混响效果。
﻿setVoiceChangerType﻿
设置人声的变声特效。
﻿setVoiceCaptureVolume﻿
设置语音音量。
﻿setVoicePitch﻿
设置语音音调。
背景音乐播放
API
描述
﻿setMusicObserver﻿
设置背景音乐的事件回调。
﻿startPlayMusic﻿
开始播放背景音乐。
﻿stopPlayMusic﻿
停止播放背景音乐。
﻿pausePlayMusic﻿
暂停播放背景音乐。
﻿resumePlayMusic﻿
恢复播放背景音乐。
背景音乐音量、音调与速度
API
描述
﻿setAllMusicVolume﻿
设置所有背景音乐的本地音量和远端音量。
﻿setMusicPublishVolume﻿
设置某一首背景音乐的远端音量。
﻿setMusicPlayoutVolume﻿
设置某一首背景音乐的本地音量。
﻿setMusicPitch﻿
调整背景音乐的音调高低。
﻿setMusicSpeedRate﻿
调整背景音乐的变速效果。
﻿setMusicScratchSpeedRate﻿
调整搓碟的变速效果。
背景音乐进度与音轨
API
描述
﻿getMusicCurrentPosInMS﻿
获取背景音乐的播放进度（单位：毫秒）。
﻿getMusicDurationInMS﻿
获取背景音乐的总时长（单位：毫秒）。
﻿seekMusicToPosInTime﻿
设置背景音乐的播放进度（单位：毫秒）。
﻿getMusicTrackCount﻿
获取背景音乐的音轨数量。
﻿setMusicTrack﻿
指定背景音乐的播放音轨。
背景音乐预加载
API
描述
﻿setPreloadObserver﻿
设置预加载的事件回调。
﻿preloadMusic﻿
预加载背景音乐。
AITranscriberManager AI 转录
详见 ​AITranscriberManager。
API
描述
﻿startRealtimeTranscriber﻿
开始实时转录。
﻿stopRealtimeTranscriber﻿
停止实时转录。
﻿pauseReceivingMessage﻿
暂停接收转录消息。
﻿resumeReceivingMessage﻿
恢复接收转录消息。
﻿addListener﻿
添加转录事件回调。
﻿removeListener﻿
移除转录事件回调。
TRTCCloudDef 类型定义
详见 ​TRTCCloudDef。
房间与角色
类型
描述
﻿TRTCAppScene﻿
应用场景。
﻿TRTCRoleType﻿
用户角色。
﻿TRTCParams﻿
进房参数。
﻿TRTCSwitchRoomConfig﻿
切换房间参数。
视频编码与渲染
类型
描述
﻿TRTCVideoResolution﻿
视频分辨率。
﻿TRTCVideoResolutionMode﻿
视频宽高比模式。
﻿TRTCVideoStreamType﻿
视频流类型。
﻿TRTCVideoFillMode﻿
视频画面填充模式。
﻿TRTCVideoRotation﻿
视频画面旋转方向。
﻿TRTCVideoMirrorType﻿
视频镜像类型。
﻿TRTCVideoQosPreference﻿
画质偏好。
﻿TRTCGSensorMode﻿
重力感应适配模式（仅移动端）。
﻿TRTCVideoEncParam﻿
视频编码参数。
﻿TRTCNetworkQosParam﻿
网络带宽限制参数。
﻿TRTCRenderParams﻿
视频画面渲染参数。
音频
类型
描述
﻿TRTCAudioQuality﻿
声音音质。
﻿TRTCAudioRecordingContent﻿
音频录制内容类型。
﻿TRTCAudioFrameOperationMode﻿
音频回调数据操作模式。
﻿TRTCAudioFrameFormat﻿
音频帧内容格式。
﻿TRTCAudioVolumeEvaluateParams﻿
音量评估相关参数。
﻿TRTCAudioFrameCallbackFormat﻿
自定义音频回调的格式参数。
﻿TRTCVolumeInfo﻿
音量大小。
美颜与水印
类型
描述
﻿TRTCBeautyStyle﻿
美颜（磨皮）算法。
﻿TRTCWaterMarkSrcType﻿
水印图片的源类型。
屏幕分享
类型
描述
﻿TRTCScreenCaptureSourceType﻿
屏幕分享目标类型（仅桌面端）。
﻿TRTCScreenCaptureSourceInfo﻿
屏幕分享目标信息（仅桌面端）。
﻿TRTCScreenCaptureSourceList﻿
屏幕窗口列表。
﻿TRTCScreenCaptureProperty﻿
屏幕分享的高级控制参数。
﻿TRTCImageBuffer﻿
窗口缩略图与图标的存储结构。
CDN 发布与混流
类型
描述
﻿TRTCPublishMode﻿
媒体流发布模式。
﻿TRTCUser﻿
参与发布的用户信息。
﻿TRTCPublishCdnUrl﻿
CDN 转推的目标地址。
﻿TRTCPublishTarget﻿
媒体流发布的目标配置。
﻿TRTCVideoLayout﻿
转码流中每一路视频画面的布局。
﻿TRTCWatermark﻿
转码流中水印的布局。
﻿TRTCStreamEncoderParam﻿
媒体流编码输出参数。
﻿TRTCStreamMixingConfig﻿
云端混流配置参数。
本地录制与截图
类型
描述
﻿TRTCSnapshotSourceType﻿
本地视频截图的数据源。
﻿TRTCLocalRecordType﻿
本地媒体录制类型。
﻿TRTCLocalRecordingParams﻿
本地媒体录制参数。
质量统计与网络测速
类型
描述
﻿TRTCQuality﻿
网络质量。
﻿TRTCAVStatusType﻿
音视频播放状态。
﻿TRTCAVStatusChangeReason﻿
播放状态变化的原因。
﻿TRTCSpeedTestScene﻿
网络测速场景。
﻿TRTCQualityInfo﻿
网络质量信息。
﻿TRTCLocalStatistics﻿
本地音视频统计指标。
﻿TRTCRemoteStatistics﻿
远端音视频统计指标。
﻿TRTCStatistics﻿
网络和性能的汇总统计指标。
﻿TRTCSpeedTestParams﻿
网络测速参数。
﻿TRTCSpeedTestResult﻿
网络测速结果。
自定义采集与渲染
类型
描述
﻿TRTCVideoPixelFormat﻿
视频像素格式。
﻿TRTCVideoBufferType﻿
视频数据传递方式。
﻿TRTCTexture﻿
视频纹理数据。
﻿TRTCVideoFrame﻿
视频帧信息。
﻿TRTCAudioFrame﻿
音频帧数据。
日志与基础结构
类型
描述
﻿TRTCLogLevel﻿
日志级别。
﻿TRTCRect﻿
矩形区域坐标。
﻿TRTCSize﻿
尺寸（宽高）。
其他回调类
类型
描述
﻿TRTCLogCallback﻿
日志回调，通过 ​setLogCallback 设置。
﻿TXDeviceObserver﻿
设备状态变化回调，通过 ​setDeviceObserver 设置。
﻿TXMusicPlayObserver﻿
背景音乐播放事件回调，通过 ​setMusicObserver 设置。
﻿TXMusicPreloadObserver﻿
背景音乐预加载事件回调，通过 ​setPreloadObserver 设置。
﻿AITranscriberListener﻿
AI 实时转录事件回调，通过 ​addListener 设置。

文档	说明
TRTCCloud	主功能接口：房间、音视频、屏幕分享、CDN 发布等。
TRTCCloudListener	事件回调：房间事件、音视频状态、质量统计等。
TRTCCloudDef	关键类型定义：枚举、参数类与统计数据类。
TXDeviceManager	设备管理：摄像头、麦克风、扬声器、音频路由。
TXAudioEffectManager	音效管理：背景音乐、耳返、混响与变声。
AITranscriberManager	AI 能力：实时语音转录与翻译。

我想做什么	相关接口
进入 / 离开房间	enterRoom、exitRoom、switchRoom
直播场景切换主播 / 观众	switchRole
开启摄像头并让他人看到	startLocalPreview、setVideoEncoderParam
观看他人的画面	onUserVideoAvailable、startRemoteView
开启麦克风并让他人听到	startLocalAudio、muteLocalAudio
屏幕分享	startScreenCapture、getScreenCaptureSources
美颜	setBeautyStyle
播放背景音乐 / K 歌	startPlayMusic、enableVoiceEarMonitor
切换摄像头 / 扬声器等设备	switchCamera、setCurrentDevice
推流到直播 CDN / 云端混流	startPublishMediaStream
房间内收发自定义信令	sendCustomCmdMsg、sendSEIMsg
显示音量条 / 声波	enableAudioVolumeEvaluation、onUserVoiceVolume
监控通话质量	onNetworkQuality、onStatistics
进房前测网速	startSpeedTest
本地录制通话内容	startLocalRecording
实时语音转文字 / 翻译	startRealtimeTranscriber
排查问题 / 提工单	showDebugView、setLogDirPath、setLogCallback

API	描述
sharedInstance	创建 TRTCCloud 实例（单例模式）。
destroySharedInstance	销毁 TRTCCloud 实例（单例模式）。
registerListener	添加 TRTC 事件回调。
unRegisterListener	移除 TRTC 事件回调。

API	描述
enterRoom	进入房间。
exitRoom	离开房间。
switchRole	切换角色。
switchRoom	切换房间。
connectOtherRoom	请求跨房通话。
disconnectOtherRoom	退出跨房通话。
setDefaultStreamRecvMode	设置订阅模式（需要在进房前设置才能生效）。

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

API	描述
startLocalPreview	开启本地摄像头的预览画面。
updateLocalView	更新本地摄像头的预览画面。
stopLocalPreview	停止摄像头预览。
muteLocalVideo	暂停/恢复发布本地的视频流。
startRemoteView	订阅远端用户的视频流，并绑定视频渲染控件。
updateRemoteView	更新远端用户的视频渲染控件。
stopRemoteView	停止订阅远端用户的视频流，并释放渲染控件。
stopAllRemoteView	停止订阅所有远端用户的视频流，并释放全部渲染资源。
setVideoMuteImage	设置本地画面被暂停期间的替代图片（暂不支持 Windows / macOS）。
setWatermark	添加水印（暂不支持 Windows / macOS）。
muteRemoteVideoStream	暂停/恢复订阅远端用户的视频流。
muteAllRemoteVideoStreams	暂停/恢复订阅所有远端用户的视频流。
setVideoEncoderParam	设置视频编码器的编码参数。
setVideoEncoderMirror	设置编码器输出的画面镜像模式。
setNetworkQosParam	设置网络质量控制的相关参数。
setLocalRenderParams	设置本地画面的渲染参数。
setRemoteRenderParams	设置远端画面的渲染模式。
enableSmallVideoStream	开启大小画面双路编码模式。
setRemoteVideoStreamType	切换指定远端用户的大小画面。
snapshotVideo	视频画面截图（暂不支持 Windows / macOS）。
setGravitySensorAdaptiveMode	设置重力感应的适配模式（仅移动端）。

API	描述
startLocalAudio	开启本地音频的采集和发布。
stopLocalAudio	停止本地音频的采集和发布。
muteLocalAudio	暂停/恢复发布本地的音频流。
muteRemoteAudio	暂停/恢复播放远端的音频流。
muteAllRemoteAudio	暂停/恢复播放所有远端用户的音频流。
setRemoteAudioVolume	设定某一个远端用户的声音播放音量。
setAudioCaptureVolume	设定本地音频的采集音量。
getAudioCaptureVolume	获取本地音频的采集音量。
setAudioPlayoutVolume	设定远端音频的播放音量。
getAudioPlayoutVolume	获取远端音频的播放音量。
enableAudioVolumeEvaluation	启用音量大小提示。
startLocalRecording	开启本地媒体录制。
stopLocalRecording	停止本地媒体录制。

API	描述
getDeviceManager	获取设备管理类（TXDeviceManager）。
setBeautyStyle	设置美颜、美白、红润等特效。
getAudioEffectManager	获取音效管理类（TXAudioEffectManager）。
startSystemAudioLoopback	开启系统声音采集（仅 Windows）。
stopSystemAudioLoopback	停止系统声音采集（仅 Windows）。
setSystemAudioLoopbackVolume	设置系统声音的采集音量（仅 Windows）。

API	描述
startScreenCapture	启动屏幕分享。
startScreenCaptureByReplaykit	通过 ReplayKit 启动屏幕分享（仅 iOS）。
stopScreenCapture	停止屏幕分享。
pauseScreenCapture	暂停屏幕分享。
resumeScreenCapture	恢复屏幕分享。
getScreenCaptureSources	枚举可分享的屏幕和窗口（仅桌面系统）。
selectScreenCaptureTarget	选取要分享的屏幕或窗口（仅桌面系统）。
addExcludedShareWindow	将指定窗口加入屏幕分享的排除列表（仅桌面系统）。
removeExcludedShareWindow	将指定窗口从排除列表移除（仅桌面系统）。
removeAllExcludedShareWindow	将所有窗口从排除列表移除（仅桌面系统）。
addIncludedShareWindow	将指定窗口加入屏幕分享的包含列表（仅桌面系统）。
removeIncludedShareWindow	将指定窗口从包含列表移除（仅桌面系统）。
removeAllIncludedShareWindow	将全部窗口从包含列表移除（仅桌面系统）。
setSubStreamEncoderParam	设置屏幕分享（即辅路）的视频编码参数。

API	描述
enableCustomAudioCapture	启用音频自定义采集模式。
sendCustomAudioData	向 SDK 投送自己采集的音频数据。
setAudioFrameCallback	设置音频数据回调。
sendCustomCmdMsg	使用 UDP 通道发送自定义消息给房间内所有用户。
sendSEIMsg	使用 SEI 通道发送自定义消息给房间内所有用户。

API	描述
startSpeedTest	开始进行网速测试（进房前使用）。
stopSpeedTest	停止网络测速。

API	描述
getSDKVersion	获取 SDK 版本信息。
setLogLevel	设置 Log 输出级别。
setConsoleEnabled	启用/禁用控制台日志打印。
setLogCompressEnabled	启用/禁用日志的本地压缩。
setLogDirPath	设置本地日志的保存路径。
setLogCallback	设置日志回调。
showDebugView	显示仪表盘。
callExperimentalAPI	调用实验性接口。

API	描述
getAITranscriberManager	获取 AI 转录管理类（AITranscriberManager）。

回调	描述
onError	错误事件回调。
onWarning	警告事件回调。

回调	描述
onEnterRoom	进入房间成功与否的事件回调。
onExitRoom	离开房间的事件回调。
onSwitchRole	切换角色的事件回调。
onSwitchRoom	切换房间的结果回调。
onConnectOtherRoom	请求跨房通话的结果回调。
onDisconnectOtherRoom	结束跨房通话的结果回调。

回调	描述
onRemoteUserEnterRoom	有用户加入当前房间。
onRemoteUserLeaveRoom	有用户离开当前房间。
onUserVideoAvailable	某远端用户发布/取消了主路视频画面。
onUserSubStreamAvailable	某远端用户发布/取消了辅路视频画面。
onUserAudioAvailable	某远端用户发布/取消了自己的音频。
onFirstVideoFrame	SDK 开始渲染自己本地或远端用户的首帧画面。
onFirstAudioFrame	SDK 开始播放远端用户的首帧音频。
onSendFirstLocalVideoFrame	自己本地的首个视频帧已被发布出去。
onSendFirstLocalAudioFrame	自己本地的首个音频帧已被发布出去。
onRemoteVideoStatusUpdated	远端视频状态变化的事件回调。
onRemoteAudioStatusUpdated	远端音频状态变化的事件回调。
onUserVideoSizeChanged	远端视频分辨率变化的事件回调。

回调	描述
onNetworkQuality	网络质量的实时统计回调。
onStatistics	音视频技术指标的实时统计回调。
onSpeedTestResult	网速测试的结果回调。

回调	描述
onConnectionLost	SDK 与云端的连接已经断开。
onTryToReconnect	SDK 正在尝试重新连接到云端。
onConnectionRecovery	SDK 与云端的连接已经恢复。

回调	描述
onCameraDidReady	摄像头准备就绪。
onMicDidReady	麦克风准备就绪。
onAudioRouteChanged	当前音频路由发生变化。
onUserVoiceVolume	音量大小的反馈回调。
onAudioDeviceCaptureVolumeChanged	当前麦克风的系统采集音量发生变化（桌面系统）。
onAudioDevicePlayoutVolumeChanged	当前系统的播放音量发生变化（桌面系统）。
onSystemAudioLoopbackError	系统声音采集是否被成功开启的事件回调（仅桌面系统）。
onTestMicVolume	测试麦克风时的音量回调。
onTestSpeakerVolume	测试扬声器时的音量回调。

回调	描述
onRecvCustomCmdMsg	收到自定义消息的事件回调。
onMissCustomCmdMsg	自定义消息丢失的事件回调。
onRecvSEIMsg	收到 SEI 消息的回调。

API 概览

本页目录：

文档一览

按场景索引

TRTCCloud 主功能接口

实例与事件回调

房间相关接口

CDN 发布与混流

视频相关接口

音频相关接口

设备、美颜与音效

屏幕分享

自定义采集与自定义消息

网络测试

调试相关接口

AI 能力

TRTCCloudListener 事件回调

错误与警告事件

房间事件

用户与音视频流事件

网络与技术指标统计

与云端连接情况

硬件设备事件

自定义消息的接收事件

CDN 相关事件

屏幕分享相关事件

本地录制与本地截图事件

TXDeviceManager 设备管理

移动端设备接口

桌面端设备接口

设备测试（桌面端）

Windows 音量合成器

通用接口

TXAudioEffectManager 音效管理

人声相关接口

背景音乐播放

背景音乐音量、音调与速度

背景音乐进度与音轨

背景音乐预加载

AITranscriberManager AI 转录

TRTCCloudDef 类型定义

房间与角色

视频编码与渲染

音频

美颜与水印

屏幕分享

CDN 发布与混流

本地录制与截图

质量统计与网络测速

自定义采集与渲染

日志与基础结构

其他回调类

回调	描述
onStartPublishMediaStream	开始发布媒体流的事件回调。
onUpdatePublishMediaStream	更新媒体流的事件回调。
onStopPublishMediaStream	停止媒体流的事件回调。
onCdnStreamStateChanged	RTMP/RTMPS 推流状态发生改变回调。

回调	描述
onScreenCaptureStarted	屏幕分享开启的事件回调。
onScreenCapturePaused	屏幕分享暂停的事件回调。
onScreenCaptureResumed	屏幕分享恢复的事件回调。
onScreenCaptureStopped	屏幕分享停止的事件回调。
onScreenCaptureCovered	屏幕分享的目标窗口被遮挡的事件回调（仅 Windows）。

回调	描述
onLocalRecordBegin	本地录制任务已经开始的事件回调。
onLocalRecording	本地录制任务正在进行中的进展事件回调。
onLocalRecordFragment	录制分片结束的事件回调。
onLocalRecordComplete	本地录制任务已经结束的事件回调。
onSnapshotComplete	本地截图完成的事件回调。

API	描述
isFrontCamera	查询当前是否使用前置摄像头（仅移动端）。
switchCamera	切换前置或后置摄像头（仅移动端）。
getCameraZoomMaxRatio	获取摄像头的最大缩放倍数（仅移动端）。
setCameraZoomRatio	设置摄像头的缩放倍数（仅移动端）。
isAutoFocusEnabled	查询是否支持自动识别人脸位置（仅移动端）。
enableCameraAutoFocus	开启自动对焦功能（仅移动端）。
setCameraFocusPosition	设置摄像头的对焦位置（仅移动端）。
enableCameraTorch	开启/关闭闪光灯，即手电筒模式（仅移动端）。
setAudioRoute	设置音频路由（仅移动端）。

API	描述
getDevicesList	获取设备列表（仅桌面端）。
setCurrentDevice	设置当前要使用的设备（仅桌面端）。
getCurrentDevice	获取当前正在使用的设备（仅桌面端）。
setCurrentDeviceVolume	设置当前设备的音量（仅桌面端）。
getCurrentDeviceVolume	获取当前设备的音量（仅桌面端）。
setCurrentDeviceMute	设置当前设备的静音状态（仅桌面端）。
getCurrentDeviceMute	查询当前设备是否静音（仅桌面端）。
enableFollowingDefaultAudioDevice	设置 SDK 使用的音频设备跟随系统默认设备（仅桌面端）。

API	描述
startCameraDeviceTest	开始摄像头测试（仅桌面端）。
stopCameraDeviceTest	结束摄像头测试（仅桌面端）。
startMicDeviceTest	开始麦克风测试（仅桌面端）。
startMicDeviceTestAndPlayback	开始麦克风测试，并可指定是否回放麦克风声音（仅桌面端）。
stopMicDeviceTest	结束麦克风测试（仅桌面端）。
startSpeakerDeviceTest	开始扬声器测试（仅桌面端）。
stopSpeakerDeviceTest	结束扬声器测试（仅桌面端）。

API	描述
setApplicationPlayVolume	设置 Windows 系统音量合成器中当前进程的音量（仅 Windows）。
getApplicationPlayVolume	获取 Windows 系统音量合成器中当前进程的音量（仅 Windows）。
setApplicationMuteState	设置 Windows 系统音量合成器中当前进程的静音状态（仅 Windows）。
getApplicationMuteState	获取 Windows 系统音量合成器中当前进程的静音状态（仅 Windows）。

API	描述
setCameraCaptureParam	设置摄像头采集偏好。
setDeviceObserver	设置设备状态变化回调。

API	描述
enableVoiceEarMonitor	开启耳返。
setVoiceEarMonitorVolume	设置耳返音量。
setVoiceReverbType	设置人声的混响效果。
setVoiceChangerType	设置人声的变声特效。
setVoiceCaptureVolume	设置语音音量。
setVoicePitch	设置语音音调。

API	描述
setMusicObserver	设置背景音乐的事件回调。
startPlayMusic	开始播放背景音乐。
stopPlayMusic	停止播放背景音乐。
pausePlayMusic	暂停播放背景音乐。
resumePlayMusic	恢复播放背景音乐。