tuikit::TUIRoomEngine* createTUIRoomEngine();
void destroyTUIRoomEngine(tuikit::TUIRoomEngine* roomEngine);
Parameter | Type | Meaning |
roomEngine | tuikit::TUIRoomEngine* | TUIRoomEngine Instance Pointer, this pointer can only be obtained through the CreateTUIRoomEngine Interface. |
static void login(int sdkAppId, const char* userId, const char* userSig, TUICallback* callback);
Parameter | Type | Meaning |
sdkAppId | int | SDKAppID of Tencent Cloud communication application |
userId | const char* | User ID for Differentiate different users |
userSig | const char* | UserSig for Tencent Cloud flow authentication |
callback | TUICallback* | API Callback for notifying the success or failure of the interface call |
static void logout(TUICallback* callback);
static void SetSelfInfo(const char* userName, const char* avatarUrl, TUICallback* callback);
Parameter | Type | Meaning |
userName | const char* | User Name |
avatarUrl | const char* | User avatar URL address |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
static TUILoginUserInfo GetSelfInfo();
virtual void AddObserver(TUIRoomObserver* observer) = 0;
Parameter | Type | Meaning |
observer | TUIRoomObserver* | Callback Instance Pointer, you can get various event notifications (such as: Error Code, Remote User Enter Room, Audio and Video Status Parameters, etc.) through TUIRoomObserver. |
virtual void removeObserver(TUIRoomObserver* observer) = 0;
Parameter | Type | Meaning |
observer | TUIRoomObserver* | TUIRoomEngine Event Callback |
virtual void createRoom(const TUIRoomInfo& roomInfo, TUICallback* callback) = 0;
Parameter | Type | Meaning |
roomInfo | const TUIRoomInfo& | Room data |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void destroyRoom(TUICallback* callback) = 0;
Parameter | Type | Meaning |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void enterRoom(const char* roomId, TUIValueCallback<TUIRoomInfo>* callback) = 0;
Parameter | Type | Meaning |
roomId | const char* | Room ID |
callback | TUIValueCallback<TUIRoomInfo>* | Get the entered Room data Callback |
virtual void exitRoom(bool syncWaiting, TUICallback* callback) = 0;
Parameter | Type | Meaning |
syncWaiting | bool | Whether to synchronize leaving the room |
callback | TUICallback* | Leave Room Result Callback |
virtual TUIRequest connectOtherRoom(const char* roomId, const char* userId, int timeout, TUIRequestCallback* callback) = 0;
Parameter | Type | Meaning |
roomId | const char* | Room ID |
userId | const char* | User ID |
timeout | int | Time |
callback | TUIRequestCallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void disConnectOtherRoom(TUICallback* callback) = 0;
Parameter | Type | Meaning |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void fetchRoomInfo(TUIValueCallback<TUIRoomInfo>* callback) = 0;
Parameter | Type | Meaning |
callback | TUIValueCallback<TUIRoomInfo>* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void updateRoomNameByAdmin(const char* roomName, TUICallback* callback) = 0;
Parameter | Type | Meaning |
roomName | const char* | Room ID |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void updateRoomSpeechModeByAdmin(TUISpeechMode mode, TUICallback* callback) = 0;
Parameter | Type | Meaning |
mode | TUISpeechMode | Management mode |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void setLocalVideoView(TUIVideoStreamType streamType, const TUIVideoView& view) = 0;
Parameter | Type | Meaning |
streamType | TUIVideoStreamType | Local streams type |
view | const TUIVideoView& | To be rendered view, Video Rendering on this view |
virtual void openLocalCamera(bool isFront, TUIVideoQuality quality, TUICallback* callback) = 0;
Parameter | Type | Meaning |
isFront | bool | Is it a front Camera (Invalid on Windows) |
quality | TUIVideoQuality | Video Quality |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void closeLocalCamera() = 0;
virtual void updateVideoQuality(TUIVideoQuality quality) = 0;
Parameter | Type | Meaning |
quality | TUIVideoQuality | Video Quality |
virtual void startScreenSharing(const TUISourceId& sourceId, TUICallback* callback) = 0;
Parameter | Type | Meaning |
sourceId | const TUISourceId& | Handle of the Screen Sharing window or screen, which can be obtained by calling GetScreenSharingTargetList |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void stopScreenSharing() = 0;
virtual void getScreenSharingTargetList(TUIListCallback<TUIShareTarget>* list) = 0;
Parameter | Type | Meaning |
list | TUIListCallback<TUIShareTarget>* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void selectScreenSharingTarget(const TUISourceId& sourceId) = 0;
Parameter | Type | Meaning |
sourceId | const TUISourceId& | Screen Sharing window or screen handle, can call GetScreenSharingTargetList to get. |
virtual void startPushLocalVideo() = 0;
virtual void stopPushLocalVideo() = 0;
virtual void openLocalMicrophone(TUIAudioQuality quality, TUICallback* callback) = 0;
Parameter | Type | Meaning |
quality | TUIAudioQuality | Audio Quality |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void closeLocalMicrophone() = 0;
virtual void updateAudioQuality(TUIAudioQuality quality) = 0;
Parameter | Type | Meaning |
quality | TUIAudioQuality | Audio Quality |
virtual void startPushLocalAudio() = 0;
virtual void stopPushLocalAudio() = 0;
virtual void setRemoteVideoView(const char* userId, TUIVideoStreamType streamType, const TUIVideoView& view) = 0;
Parameter | Type | Meaning |
userId | const char* | Remote User ID |
streamType | TUIVideoStreamType | Stream Type |
view | const TUIVideoView& | const TUIVideoView& Rendering Window Handle |
virtual void startPlayRemoteVideo(const char* userId, TUIVideoStreamType streamType, TUIPlayCallback* callback) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
streamType | TUIVideoStreamType | User streams type |
callback | TUIPlayCallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void stopPlayRemoteVideo(const char* userId, TUIVideoStreamType streamType) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
streamType | TUIVideoStreamType | User streams type |
virtual void muteRemoteAudioStream(const char* userId, bool isMute) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
isMute | bool | Whether to mute |
virtual void getUserList(uint64_t nextSequence, TUIValueCallback<TUIUserListResult>* callback) = 0;
Parameter | Type | Meaning |
nextSequence | uint64_t | Pagination Fetch Flag, fill in 0 for the first Fetch, if the nextSeq in the Callback is not 0, you need to do Pagination, pass in the nextSeq to Fetch again until the nextSeq in the Callback is 0 |
callback | TUIValueCallback<TUIUserListResult>* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void getUserInfo(const char* userId, TUIValueCallback<TUIUserInfo>* callback) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
callback | TUIValueCallback<TUIUserInfo>* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void changeUserRole(const char* userId, TUIRole role, TUICallback* callback) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
role | TUIRole | User Role |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void kickRemoteUserOutOfRoom(const char* userId, TUICallback* callback) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void disableDeviceForAllUserByAdmin(TUIMediaDevice device, bool isDisable, TUICallback* callback) = 0;
Parameter | Type | Meaning |
device | TUIMediaDevice | Device |
isDisable | bool | Whether to Disable |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual TUIRequest openRemoteDeviceByAdmin(const char* userId, TUIMediaDevice device, int timeout, TUIRequestCallback* callback) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
device | TUIMediaDevice | Device |
timeout | int | Timeout in seconds, if set to 0, SDK will not do timeout detection and will not trigger timeout Callback |
callback | TUIRequestCallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void closeRemoteDeviceByAdmin(const char* userId, TUIMediaDevice device, TUICallback* callback) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
device | TUIMediaDevice | Device |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual TUIRequest applyToAdminToOpenLocalDevice(TUIMediaDevice device, int timeout, TUIRequestCallback* callback) = 0;
Parameter | Type | Meaning |
device | TUIMediaDevice | Device |
timeout | int | Timeout in seconds, if set to 0, SDK will not do timeout detection and will not trigger timeout Callback |
callback | TUIRequestCallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void setMaxSeatCount(uint32_t maxSeatCount, TUICallback* callback) = 0;
Parameter | Type | Meaning |
maxSeatCount | uint32_t | Maximum number of seats |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void getSeatList(TUIListCallback<TUISeatInfo>* callback) = 0;
Parameter | Type | Meaning |
callback | TUIListCallback<TUISeatInfo>* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void lockSeatByAdmin(int seatIndex, const TUISeatLockParams& lockParams, TUICallback* callback) = 0;
Parameter | Type | Meaning |
seatIndex | int | Seat number |
lockParams | TUISeatLockParams | Lock microphone parameter |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual TUIRequest takeSeat(int seatIndex, int timeout, TUIRequestCallback* callback) = 0;
Parameter | Type | Meaning |
seatIndex | int | Seat number |
timeout | int | Timeout in seconds, if set to 0, SDK will not do timeout detection and will not trigger timeout Callback |
callback | TUIRequestCallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void leaveSeat(TUICallback* callback) = 0;
Parameter | Type | Meaning |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual TUIRequest takeUserOnSeatByAdmin(int seatIndex, const char* userId, int timeout, TUIRequestCallback* callback) = 0;
Parameter | Type | Meaning |
seatIndex | int | Seat number |
userId | const char* | User ID |
timeout | int | Timeout in seconds, if set to 0, SDK will not do timeout detection and will not trigger timeout Callback |
callback | TUIRequestCallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void kickUserOffSeatByAdmin(int seatIndex, const char* userId, TUICallback* callback) = 0;
Parameter | Type | Meaning |
seatIndex | int | Seat number |
userId | const char* | User ID |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void sendTextMessage(const char* message, TUICallback* callback) = 0;
Parameter | Type | Meaning |
message | const char* | Text message Content |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void sendCustomMessage(const char* message, TUICallback* callback) = 0;
Parameter | Type | Meaning |
message | const char* | Custom message Content |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void disableSendingMessageByAdmin(const char* userId, bool isDisable, TUICallback* callback) = 0;
Parameter | Type | Meaning |
userId | const char* | User ID |
isDisable | bool | Whether to Disable |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void disableSendingMessageForAllUser(bool isDisable, TUICallback* callback) = 0;
Parameter | Type | Meaning |
isDisable | bool | Whether to Disable |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void cancelRequest(const char* requestId, TUICallback* callback) = 0;
Parameter | Type | Meaning |
requestId | const char* | Request ID |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void responseRemoteRequest(const char* requestId, bool agree, TUICallback* callback) = 0;
Parameter | Type | Meaning |
requestId | const char* | Request ID |
agree | bool | Whether to agree |
callback | TUICallback* | Callback of API, used to Notify the Success or Failure of the API call |
virtual void* getTRTCCloud() = 0;
virtual liteav::ITXDeviceManager* getDeviceManager() = 0;
virtual liteav::ITXAudioEffectManager* getAudioEffectManager() = 0;
Was this page helpful?