RTCRoom class abstract
房间接口
Constructors
- RTCRoom()
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- rangeAudio → RTCRangeAudio
-
获取范围语音接口实例
no setter
- roomId → String
-
获取房间 ID
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spatialAudio → RTCSpatialAudio
-
获取空间音频接口实例
no setter
Methods
-
destroy(
) → Future< void> - 退出并销毁调用 RTCVideo.createRTCRoom 所创建的房间实例。
-
joinRoom(
{required String token, required UserInfo userInfo, required RoomConfig roomConfig}) → Future< int?> - 加入房间
-
leaveRoom(
) → Future< int?> - 离开房间
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pauseAllSubscribedStream(
PauseResumeControlMediaType mediaType) → Future< int?> - 暂停接收所有来自远端的媒体流。
-
pauseForwardStreamToAllRooms(
) → Future< int?> - 暂停跨房间媒体流转发
-
publishScreen(
MediaStreamType type) → Future< int?> - 在当前所在房间内发布本地屏幕共享音视频流
-
publishStream(
MediaStreamType type) → Future< int?> - 在当前所在房间内发布本地通过摄像头/麦克风采集的媒体流
-
resumeAllSubscribedStream(
PauseResumeControlMediaType mediaType) → Future< int?> - 恢复接收来自远端的媒体流
-
resumeForwardStreamToAllRooms(
) → Future< int?> - 恢复跨房间媒体流转发
-
sendRoomBinaryMessage(
Uint8List message) → Future< int?> - 给房间内所有用户发送二进制消息
-
sendRoomMessage(
String message) → Future< int?> - 给房间内所有用户发送文本消息
-
sendUserBinaryMessage(
{required String uid, required Uint8List message, required MessageConfig config}) → Future< int?> - 给房间内指定的用户发送二进制消息
-
sendUserMessage(
{required String uid, required String message, required MessageConfig config}) → Future< int?> - 给房间内指定的用户发送文本消息
-
setAudioSelectionConfig(
AudioSelectionPriority audioSelectionPriority) → Future< int?> - 设置本端发布流在音频选路中的优先级。
-
setMultiDeviceAVSync(
String audioUid) → Future< int?> - 设置发流端音画同步
-
setRemoteRoomAudioPlaybackVolume(
int volume) → Future< int?> - 调节某个房间内所有远端用户的音频播放音量。
-
setRemoteVideoConfig(
{required String uid, required RemoteVideoConfig videoConfig}) → Future< int?> - 设置期望订阅的远端视频流的参数
-
setRoomExtraInfo(
{required String key, required String value}) → Future< int?> - 设置/更新房间附加信息，可用于标识房间状态或属性，或灵活实现各种业务逻辑。
-
setRTCRoomEventHandler(
RTCRoomEventHandler eventHandler) → void - 设置事件句柄
-
setUserVisibility(
bool enable) → Future< int?> - 设置用户可见性。未调用该接口前，本地用户默认对他人可见。
-
startForwardStreamToRooms(
List< ForwardStreamInfo> forwardStreamInfos) → Future<int?> - 开始跨房间转发媒体流
-
startSubtitle(
SubtitleConfig subtitleConfig) → Future< int?> - 识别或翻译房间内所有用户的语音，形成字幕。
-
stopForwardStreamToRooms(
) → Future< int?> - 停止跨房间媒体流转发
-
stopSubtitle(
) → Future< int?> - 关闭字幕。
-
subscribeAllStreams(
MediaStreamType type) → Future< int?> - 订阅房间内所有通过摄像头/麦克风采集的媒体流，或更新订阅选项
-
subscribeScreen(
{required String uid, required MediaStreamType type}) → Future< int?> - 订阅房间内指定的远端屏幕共享音视频流，或更新对指定远端用户的订阅选项
-
subscribeStream(
{required String uid, required MediaStreamType type}) → Future< int?> - 订阅房间内指定的通过摄像头/麦克风采集的媒体流，或更新对指定远端用户的订阅选项
-
toString(
) → String -
A string representation of this object.
inherited
-
unpublishScreen(
MediaStreamType type) → Future< int?> - 停止将本地屏幕共享音视频流发布到当前所在房间中
-
unpublishStream(
MediaStreamType type) → Future< int?> - 停止将本地摄像头/麦克风采集的媒体流发布到当前所在房间中
-
unsubscribeAllStreams(
MediaStreamType type) → Future< int?> - 取消订阅房间内所有的通过摄像头/麦克风采集的媒体流。
-
unsubscribeScreen(
{required String uid, required MediaStreamType type}) → Future< int?> - 取消订阅房间内指定的远端屏幕共享音视频流
-
unsubscribeStream(
{required String uid, required MediaStreamType type}) → Future< int?> - 取消订阅房间内指定的通过摄像头/麦克风采集的媒体流
-
updateForwardStreamToRooms(
List< ForwardStreamInfo> forwardStreamInfos) → Future<int?> - 更新跨房间媒体流转发信息
-
updateToken(
String token) → Future< int?> - 更新 Token
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited