TRTCCloud class

TRTC 视频通话功能的主要API类

Constructors

TRTCCloud()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

callExperimentalAPI(String jsonStr) Future<void>
调用实验性 API
connectOtherRoom(String param) Future<void>
请求跨房通话,让两个不同的房间可以进行音视频流分享(比如"主播PK"场景)
disconnectOtherRoom() Future<void>
退出跨房通话
enableAudioVolumeEvaluation(int intervalMs) Future<void>
开启麦克风音量检测功能
enableCustomVideoProcess(bool enable) Future<int?>
启用/禁用自定义视频处理
enableEncSmallVideoStream(bool enable, TRTCVideoEncParam smallVideoEncParam) Future<int?>
启用大小图双路编码模式,方便不同网络情况下的用户订阅不同的画面
enterRoom(TRTCParams param, int scene) Future<void>
进入一个音视频通话房间(以下简称"进入房间")。
exitRoom() Future<void>
退出当前音视频通话房间。
getAudioCaptureVolume() Future<int?>
获取本地音频的采集音量
getAudioEffectManager() TXAudioEffectManager
获取音效管理类 TXAudioEffectManager,用于对背景音乐、短音效以及人生特效进行设置
getAudioPlayoutVolume() Future<int?>
获取远端音频的播放音量
getBeautyManager() TXBeautyManager
获取美颜滤镜管理对象,可以修改美颜、滤镜、红润等参数
getDeviceManager() TXDeviceManager
获取设备管理模块,用于管理摄像头、麦克风和扬声器等音视频相关设备
getSDKVersion() Future<String?>
获取当前使用的 TRTC SDK 的版本信息
muteAllRemoteAudio(bool mute) Future<void>
暂停/恢复播放所有远端用户的音频流
muteAllRemoteVideoStreams(bool mute) Future<void>
暂停/恢复订阅所有远程视频流
muteLocalAudio(bool mute) Future<void>
暂停/恢复发布本地的音频流,也即静音/取消静音
muteLocalVideo(bool mute) Future<void>
暂停/恢复发布本地视频流
muteRemoteAudio(String userId, bool mute) Future<void>
暂停/恢复播放指定远程用户的音频流
muteRemoteVideoStream(String userId, bool mute) Future<void>
暂停/恢复订阅指定远程视频流
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pauseScreenCapture() Future<void>
暂停屏幕共享
registerListener(ListenerValue func) → void
设置 TRTC 事件监听器,用户可以通过它从 TRTCCloud 获取各种状态通知
resumeScreenCapture() Future<void>
恢复屏幕共享
sendCustomCmdMsg(int cmdID, String data, bool reliable, bool ordered) Future<bool?>
使用 UDP 通道向房间中的所有用户发送自定义消息
sendSEIMsg(String data, int repeatCount) Future<bool?>
使用 trtc 的 SEI 通道将自定义消息发送给房间内的所有用户
setAudioCaptureVolume(int volume) Future<void>
设定本地音频的采集音量
setAudioFrameListener(TRTCAudioFrameListener? listener) Future<void>
设置自定义音频数据回调
setAudioPlayoutVolume(int volume) Future<void>
设置远端音频的播放音量
setConsoleEnabled(bool enabled) Future<void>
启用或禁用控制台日志打印
setDefaultStreamRecvMode(bool autoRecvAudio, bool autoRecvVideo) Future<void>
设置音视频数据接收模式,在进房前设置才生效
setGSensorMode(int mode) Future<void>
设置 G-sensor 的适配模式,即重力感应的适配模式
setLocalRenderParams(TRTCRenderParams renderParams) Future<void>
设置本地画面的渲染模式
setLocalVideoRenderListener(CustomLocalRender param) Future<int?>
设置本地视频的自定义渲染回调。将跳过 SDK 自己的渲染过程并将采集到的数据回调出来,允许用户自己完成画面渲染
setLogCompressEnabled(bool enabled) Future<void>
启用或禁用本地日志压缩
setLogDirPath(String path) Future<void>
修改日志存储路径
setLogLevel(int level) Future<void>
设置日志输出级别
setMixTranscodingConfig(TRTCTranscodingConfig? config) Future<void>
设置云端混流的排版布局和转码参数
setNetworkQosParam(TRTCNetworkQosParam param) Future<void>
设置 QoS 参数,QoS参数可以决定网络的质量调控策略
setRemoteAudioVolume(String userId, int volume) Future<void>
设定某一个远端用户的声音播放音量
setRemoteRenderParams(String userId, int streamType, TRTCRenderParams renderParams) Future<void>
设置远端画面的渲染模式
setRemoteVideoRenderListener(CustomRemoteRender param) Future<int?>
设置远端视频自定义渲染回调。SDK 将会跳过原来的渲染流程,并将收到的数据回调出来,此时需要您自己完成画面渲染。
setRemoteVideoStreamType(String userId, int streamType) Future<int?>
切换指定远端用户所订阅的大小画面
setSystemAudioLoopbackVolume(int volume) Future<void>
设置系统音频捕获的音量
setVideoEncoderMirror(bool mirror) Future<void>
设置编码器输出图像的镜像模式
setVideoEncoderParam(TRTCVideoEncParam param) Future<void>
设置视频编码器参数,以调整画面质量
setVideoEncoderRotation(int rotation) Future<void>
设置视频编码器输出图像的方向(即远程用户观看和服务器录制的视频画面)
setVideoMuteImage(String? assetUrl, int fps) Future<int?>
设置本地画面被暂停期间的替代图片,以取代无视频流时用户进房看到的黑屏画面
setWatermark(String assetUrl, int streamType, double x, double y, double width) Future<void>
在指定的位置添加水印
showDebugView(int showType) Future<void>
显示调试信息浮层(可以展示音视频信息和事件信息)
snapshotVideo(String? userId, int streamType, int sourceType, String path) Future<void>
视频画面截图
startAudioRecording(TRTCAudioRecordingParams param) Future<int?>
开始音频录制,将当前所有音频混合并录制到一个文件中。
startLocalAudio(int quality) Future<void>
开启本地麦克风采集,并将音频流发布到当前的房间中,同时可以设置音质。
startLocalPreview(bool frontCamera, int? viewId) Future<void>
开启本地摄像头以预览画面,只有当 enterRoom 被调用后才会开启视频推流(如果已调用,则会自动开始视频推流)
startLocalRecording(TRTCLocalRecordingParams param) Future<void>
开始本地媒体录制,同时包含音频与视频数据
startPublishCDNStream(TRTCPublishCDNParam param) Future<void>
开始向非腾讯云 CDN 上发布音视频流
startPublishing(String streamId, int streamType) Future<void>
开始向腾讯云直播 CDN 上发布音视频流
startPublishMediaStream({required TRTCPublishTarget target, TRTCStreamEncoderParam? params, TRTCStreamMixingConfig? config}) Future<void>
开始发布媒体流。调用此 API 后,TRTC 服务器将把本地用户的流中继到 CDN(经过转码或不经过转码),或转码并发布到 TRTC 房间。
startRemoteView(String userId, int streamType, int? viewId) Future<void>
订阅远端用户的视频流,同时绑定视频渲染控件
startScreenCapture(int streamType, TRTCVideoEncParam encParams, {String shareUserId = '', String shareUserSig = '', String appGroup = ''}) Future<void>
开始桌面屏幕共享,抓取用户屏幕中的内容并将其分享给同房间中的其他用户
startSpeedTest(int sdkAppId, String userId, String userSig) Future<void>
开始网络速度测试,视频通话期间应避免进行以确保通话质量
startSystemAudioLoopback() Future<void>
启用系统音频采集
stopAllRemoteView() Future<void>
停止订阅所有远端用户的视频流,并释放全部渲染资源
stopAudioRecording() Future<void>
停止音频录制
stopLocalAudio() Future<void>
禁用本地音频采集和上行
stopLocalPreview() Future<void>
停止本地视频采集和预览
stopLocalRecording() Future<void>
停止本地媒体录制
stopPublishCDNStream() Future<void>
停止向非腾讯云 CDN 上发布音视频流
stopPublishing() Future<void>
停止向腾讯云直播 CDN 上推送音视频流
stopPublishMediaStream(String taskId) Future<void>
停止发布通过 startPublishMediaStream 启动的任务
stopRemoteView(String userId, int streamType) Future<void>
停止订阅远端用户的视频流,同时释放渲染控件
stopScreenCapture() Future<void>
停止屏幕共享
stopSpeedTest() Future<void>
停止网络测速
stopSystemAudioLoopback() Future<void>
停止系统音频采集
switchRole(int role) Future<void>
切换用户角色(仅适用于直播场景 TRTCCloudDef.TRTC_APP_SCENE_LIVETRTCCloudDef.TRTC_APP_SCENE_VOICE_CHATROOM
switchRoom(TRTCSwitchRoomConfig config) Future<void>
切换房间,允许用户快速从一个房间切换到另一个房间
toString() String
A string representation of this object.
inherited
unRegisterListener(ListenerValue func) → void
移除 TRTC 事件回调
unregisterTexture(int textureID) Future<void>
取消自定义的渲染回调
updateLocalView(int viewId) Future<void>
更新本地视频预览画面
updatePublishMediaStream({required String taskId, required TRTCPublishTarget target, TRTCStreamEncoderParam? encoderParam, TRTCStreamMixingConfig? mixingConfig}) Future<void>
修改发布参数,更新通过 startPublishMediaStream 启动的发布任务的参数
updateRemoteView(String userId, int streamType, int viewId) Future<void>
更新远端用户的视频渲染控件

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

listener ↔ TRTCCloudListenerObj?
getter/setter pair

Static Methods

destroySharedInstance() Future<void>
销毁一个 TRTCCloud 单例
getPlatformVersion() Future<String?>
sharedInstance() Future<TRTCCloud?>
创建一个 TRTCCloud 单例,用于实现进房、预览、推流、拉流等功能