TRTCCloud class

腾讯云视频通话功能的主要接口类

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>
启用音量大小提示。
enableEncSmallVideoStream(bool enable, TRTCVideoEncParam smallVideoEncParam) Future<int?>
开启大小画面双路编码模式。
enterRoom(TRTCParams param, int scene) Future<void>
进入房间
exitRoom() Future<void>
离开房间。
getAudioCaptureVolume() Future<int?>
获取 SDK 采集音量。
getAudioEffectManager() TXAudioEffectManager
获取音效管理类 TXAudioEffectManager。
getAudioPlayoutVolume() Future<int?>
获取 SDK 播放音量
getBeautyManager() TXBeautyManager
获取美颜管理对象。
getDeviceManager() TXDeviceManager
获取设备管理模块。
getSDKVersion() Future<String?>
获取 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
设置事件监听,用户获得来自 TRTCCloud 的各种状态通知
resumeScreenCapture() Future<void>
恢复屏幕分享
sendCustomCmdMsg(int cmdID, String data, bool reliable, bool ordered) Future<bool?>
发送自定义消息给房间内所有用户
sendSEIMsg(String data, int repeatCount) Future<bool?>
将小数据量的自定义数据嵌入视频帧中
setAudioCaptureVolume(int volume) Future<void>
设置 SDK 采集音量。
setAudioPlayoutVolume(int volume) Future<void>
设置 SDK 播放音量。
setConsoleEnabled(bool enabled) Future<void>
启用或禁用控制台日志打印
setDefaultStreamRecvMode(bool autoRecvAudio, bool autoRecvVideo) Future<void>
设置音视频数据接收模式(需要在进房前设置才能生效)。
setGSensorMode(int mode) Future<void>
设置重力感应的适应模式。
setLocalRenderParams(TRTCRenderParams renderParams) Future<void>
设置本地图像的渲染模式。
setLogCompressEnabled(bool enabled) Future<void>
启用或禁用 Log 的本地压缩。
setLogDirPath(String path) Future<void>
修改日志保存路径
setLogLevel(int level) Future<void>
设置 Log 输出级别
setMixTranscodingConfig(TRTCTranscodingConfig? config) Future<void>
设置云端的混流转码参数。
setNetworkQosParam(TRTCNetworkQosParam param) Future<void>
设置网络流控相关参数。
setRemoteAudioVolume(String userId, int volume) Future<void>
设置某个远程用户的播放音量
setRemoteRenderParams(String userId, int streamType, TRTCRenderParams renderParams) Future<void>
设置远端图像相关参数。
setRemoteVideoStreamType(String userId, int streamType) Future<int?>
选定观看指定 uid 的大画面或小画面。
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, String path) Future<void>
视频画面截图。
startAudioRecording(TRTCAudioRecordingParams param) Future<int?>
开始录音。
startLocalAudio(int quality) Future<void>
开启本地音频的采集和上行,并设置音频质量。
startLocalPreview(bool frontCamera, dynamic viewId) Future<void>
开启本地视频的预览画面
startLocalRecording(TRTCLocalRecordingParams param) Future<void>
开启本地媒体录制
startPublishCDNStream(TRTCPublishCDNParam param) Future<void>
开始向友商云的直播 CDN 转推
startPublishing(String streamId, int streamType) Future<void>
开始向腾讯云的直播 CDN 推流
startRemoteView(String userId, int streamType, int viewId) Future<void>
显示远端视频或辅流
startScreenCapture(int streamType, TRTCVideoEncParam encParams, [String appGroup = '']) Future<void>
参数:
startSpeedTest(int sdkAppId, String userId, String userSig) Future<void>
开始进行网络测速(视频通话期间请勿测试,以免影响通话质量)
stopAllRemoteView() Future<void>
停止显示所有远端视频画面,同时不再拉取远端用户的视频数据流。
stopAudioRecording() Future<void>
停止录音。
stopLocalAudio() Future<void>
关闭本地音频的采集和上行。
stopLocalPreview() Future<void>
停止本地视频采集及预览。
stopLocalRecording() Future<void>
停止本地媒体录制
stopPublishCDNStream() Future<void>
停止向非腾讯云地址转推
stopPublishing() Future<void>
停止向腾讯云的直播 CDN 推流
stopRemoteView(String userId, int streamType) Future<void>
停止显示远端视频画面,同时不再拉取该远端用户的视频数据流。
stopScreenCapture() Future<void>
停止屏幕采集
stopSpeedTest() Future<void>
停止服务器测速。
switchRole(int role) Future<void>
切换角色,仅适用于直播场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM)。
switchRoom(TRTCSwitchRoomConfig config) Future<void>
切换房间
toString() String
A string representation of this object.
inherited
unRegisterListener(ListenerValue func) → void
移除消息监听。
unregisterTexture(int textureID) Future<void>
注销纹理
updateLocalView(dynamic viewId) Future<void>
更新本地视频预览画面的窗口
updateRemoteView(dynamic viewId, dynamic streamType, dynamic userId) 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 单例。