static TUIRoomEngine createInstance()
void destroyInstance()
static Future<TUIActionCallback> login(int sdkAppId,String userId,String userSig)
参数 | 类型 | 含义 |
sdkAppId | int | 应用信息中获取 sdkAppId 信息 |
userId | String | 用户 ID |
userSig | String |
static Future<TUIActionCallback> logout()
static Future<TUIActionCallback> setSelfInfo(String userName, String avatarURL)
参数 | 类型 | 含义 |
userName | String | 用户名 |
avatarUrl | String | 用户头像 |
static Future<TUIActionCallback> setLoginUserInfo(TUILoginUserInfo userInfo)
参数 | 类型 | 含义 |
userInfo | TUILoginUserInfo | 用户信息 |
static TUILoginUserInfo getSelfInfo()
void addObserver(TUIRoomObserver observer)
参数 | 类型 | 含义 |
observer | TUIRoomObserver | TUIRoomEngine 事件回调 |
void removeObserver(TUIRoomObserver observer)
参数 | 类型 | 含义 |
observer | TUIRoomObserver | TUIRoomEngine 事件回调 |
Future<TUIActionCallback> createRoom(TUIRoomInfo roomInfo)
参数 | 类型 | 含义 |
roomInfo | 房间基本信息 |
Future<TUIActionCallback> destroyRoom()
Future<TUIValueCallBack<TUIRoomInfo>> enterRoom(String roomId)
参数 | 类型 | 含义 |
roomId | String | 房间号,字符串类型 |
Future<TUIActionCallback> exitRoom(bool syncWaiting)
参数 | 类型 | 含义 |
syncWaiting | bool | 是否同步退出房间 |
TUIRequest connectOtherRoom(String roomId,String userId,int timeout,TUIRequestCallback? requestCallback)
参数 | 类型 | 含义 |
roomId | String | 房间 ID |
userId | String | 用户 ID |
timeout | int | 时间 |
callback | TUIRequestCallback | 连接其他房间请求回调 |
Future<TUIActionCallback> disconnectOtherRoom()
Future<TUIValueCallBack<TUIRoomInfo>> fetchRoomInfo()
Future<TUIActionCallback> updateRoomNameByAdmin(String roomName)
参数 | 类型 | 含义 |
roomName | String | 房间名称 |
Future<TUIActionCallback> updateRoomSpeechModeByAdmin(TUISpeechMode mode)
参数 | 类型 | 含义 |
mode | 房间模式 |
void setLocalVideoView(int viewId)
参数 | 类型 | 含义 |
viewId | int | 待渲染 view 指针的 int64 类型值,通过此 viewId 可转换为对应原生平台的视图,视频画面将渲染于此视图上 |
Future<TUIActionCallback> openLocalCamera(bool isFront,TUIVideoQuality quality)
参数 | 类型 | 含义 |
isFront | bool | 是否使用前置摄像头 |
quality | 视频质量 |
void closeLocalCamera()
void updateVideoQuality(TUIVideoQuality quality)
参数 | 类型 | 含义 |
quality | 视频质量 |
void updateVideoQualityEx(TUIVideoStreamType streamType, TUIRoomVideoEncoderParams params);
参数 | 类型 | 含义 |
streamType | TUIVideoStreamType | 视频流类型 |
params | TUIRoomVideoEncoderParams | 视频编码器参数 |
void setVideoResolutionMode(TUIVideoStreamType streamType, TUIResolutionMode resolutionMode);
参数 | 类型 | 含义 |
streamType | TUIVideoStreamType | 视频流类型 |
resolutionMode | TUIResolutionMode | 分辨率模式 |
void enableGravitySensor(bool enable);
参数 | 类型 | 含义 |
enable | bool | 是否开启 |
void startPushLocalVideo()
void stopPushLocalVideo()
Future<void> startScreenSharing({String appGroup = ''})
Future<void> stopScreenSharing()
Future<TUIActionCallback> openLocalMicrophone(TUIAudioQuality quality)
参数 | 类型 | 含义 |
quality | 音频质量 |
void closeLocalMicrophone()
void updateAudioQuality(TUIAudioQuality quality)
参数 | 类型 | 含义 |
quality | 音频质量 |
Future<TUIActionCallback> muteLocalAudio()
Future<TUIActionCallback> unMuteLocalAudio()
void setRemoteVideoView(String userId,TUIVideoStreamType streamType,int viewId)
参数 | 类型 | 含义 |
userId | String | 用户 ID |
streamType | 用户流类型 | |
viewId | int | 待渲染 view 指针的 int64 类型值,通过此 viewId 可转换为对应原生平台的视图,视频画面将渲染于此视图上 |
void startPlayRemoteVideo(String userId,TUIVideoStreamType streamType,TUIPlayCallback? callback)
参数 | 类型 | 含义 |
userId | String | 用户 ID |
streamType | 用户流类型 | |
callback | TUIPlayCallback? | 播放结果回调 |
void stopPlayRemoteVideo(String userId,TUIVideoStreamType streamType)
参数 | 类型 | 含义 |
userId | String | 用户 ID |
streamType | 用户流类型 |
void muteRemoteAudioStream(String userId, boolean isMute);
参数 | 类型 | 含义 |
userId | String | 用户 ID |
isMute | bool | 是否禁音 |
Future<TUIValueCallBack<TUIUserListResult>> getUserList(int nextSequence)
参数 | 类型 | 含义 |
nextSequence | int | 分页拉取标志,第一次拉取填0。回调成功如果 nextSeq 不为零,需要分页,传入 nextSeq 再次拉取,直至 callback 中 nextSeq 为0 |
Future<TUIValueCallBack<TUIUserInfo>> getUserInfo(String userId)
参数 | 类型 | 含义 |
userId | String | 根据 userId 获取该用户的详细信息 |
Future<TUIActionCallback> changeUserRole(String userId,TUIRole role)
参数 | 类型 | 含义 |
userId | String | 用户 ID |
role | 用户角色 |
Future<TUIActionCallback> kickRemoteUserOutOfRoom(String userId)
参数 | 类型 | 含义 |
userId | String | 用户 ID |
Future<TUIActionCallback> addCategoryTagForUsers(int tag, List<String> userList);
参数 | 类型 | 含义 |
tag | int | 标记类型。数字类型,大于等于 1000,您可以自定义。 |
userList | List<String> | 用户列表 |
Future<TUIActionCallback> removeCategoryTagForUsers(int tag, List<String> userList);
参数 | 类型 | 含义 |
tag | int | 类型。数字类型,大于等于 1000,您可以自定义。 |
userList | List<String> | 用户列表 |
Future<TUIValueCallBack<TUIUserListResult>> getUserListByTag(int tag, int nextSequence);
参数 | 类型 | 含义 |
tag | int | 类型。数字类型,大于等于 1000,您可以自定义。 |
nextSequence | int | 分页拉取标志,第一次拉取填0,回调成功 如果 callback 返回的数据中 nextSequence 不为零,需要分页,传入再次拉取,直至为0 |
Future<TUIActionCallback> disableDeviceForAllUserByAdmin(TUIMediaDevice device,bool isDisable)
参数 | 类型 | 含义 |
device | 设备 | |
isDisable | bool | 是否禁用 |
TUIRequest openRemoteDeviceByAdmin(String userId,TUIMediaDevice device,int timeout,TUIRequestCallback? requestCallback)
参数 | 类型 | 含义 |
userId | String | 用户 ID |
device | 设备 | |
timeout | int | 超时时间,单位秒。如果设置为 0,SDK 不会做超时检测,也不会触发超时回调 |
requestCallback | TUIRequestCallback? | 操作结果回调 |
Future<TUIActionCallback> closeRemoteDeviceByAdmin(String userId,TUIMediaDevice device)
参数 | 类型 | 含义 |
userId | String | 用户ID |
device | 设备 |
TUIRequest applyToAdminToOpenLocalDevice(TUIMediaDevice device,int timeout,TUIRequestCallback? requestCallback)
参数 | 类型 | 含义 |
device | 设备 | |
timeout | int | 超时时间,单位秒。如果设置为 0,SDK 不会做超时检测,也不会触发超时回调 |
callback | TUIRequestCallback? | 操作结果回调 |
Future<TUIActionCallback> setMaxSeatCount(int maxSeatCount)
参数 | 类型 | 含义 |
maxSeatCount | int | 最大麦位数 |
Future<TUIActionCallback> lockSeatByAdmin(int seatIndex,TUISeatLockParams lockParams)
参数 | 类型 | 含义 |
seatIndex | int | 麦位编号 |
lockParams | 锁麦参数 |
Future<TUIValueCallBack<List<TUISeatInfo>>> getSeatList()
TUIRequest takeSeat(int seatIndex,int timeout,TUIRequestCallback? requestCallback)
参数 | 类型 | 含义 |
seatIndex | int | 麦位编号 |
timeout | int | 超时时间,单位秒。如果设置为 0,SDK 不会做超时检测,也不会触发超时回调 |
requestCallback | TUIRequestCallback? | 调用接口的回调,用于通知请求的回调状态 |
Future<TUIActionCallback> leaveSeat()
TUIRequest takeUserOnSeatByAdmin(int seatIndex,String userId,int timeout,TUIRequestCallback? requestCallback)
参数 | 类型 | 含义 |
seatIndex | int | 麦位编号 |
userId | String | 用户 ID |
timeout | int | 超时时间,单位秒。如果设置为 0,SDK 不会做超时检测,也不会触发超时回调 |
requestCallback | TUIRequestCallback? | 调用接口的回调,用于通知请求的回调状态 |
Future<TUIActionCallback> kickUserOffSeatByAdmin(int seatIndex,String userId)
参数 | 类型 | 含义 |
seatIndex | int | 麦位编号 |
userId | String | 用户 ID |
Future<TUIActionCallback> sendTextMessage(String message)
参数 | 类型 | 含义 |
message | String | 文本消息内容 |
Future<TUIActionCallback> sendCustomMessage(String message)
参数 | 类型 | 含义 |
message | String | 自定义消息内容 |
Future<TUIActionCallback> disableSendingMessageByAdmin(String userId,bool isDisable)
参数 | 类型 | 含义 |
userId | String | 用户 ID |
isDisable | bool | 是否禁用 |
Future<TUIActionCallback> disableSendingMessageForAllUser(bool isDisable)
参数 | 类型 | 含义 |
isDisable | bool | 是否禁用 |
Future<TUIActionCallback> cancelRequest(String requestId)
参数 | 类型 | 含义 |
requestId | String | 请求 ID |
Future<TUIActionCallback> responseRemoteRequest(String requestId,bool agree)
参数 | 类型 | 含义 |
requestId | String | 请求 ID |
agree | bool | 是否同意 |
void callExperimentalAPI(String jsonStr);
参数 | 类型 | 含义 |
jsonStr | String | 接口信息 |
Future<int?> switchCamera(bool isFrontCamera);
参数 | 类型 | 含义 |
isFrontCamera | bool | 是否前置 |
void setBeautyLevel(int beautyStyle, int beautyLevel);
参数 | 类型 | 含义 |
beautyStyle | int | 美颜风格 |
beautyLevel | int | 美颜级别 |
void setWhitenessLevel(int whitenessLevel);
参数 | 类型 | 含义 |
whitenessLevel | int | 美白级别 |
本页内容是否解决了您的问题?