API OVERVIEW
Creating instances and event callback.
函数列表 | 描述 |
Destroy the TUIRoomEngine instance (singleton mode) | |
After create a TUIRoomEngine instance, you should login with sdkAppId, userId and userSig then you can call TUIRoomEngine instance and other function. | |
Log out of your account. If you are in the room, there will be active leaving room and destroying resource operations. | |
Update user name an avatar for logged-in user. | |
Return the basic information of the logged-in user, including nickname and avatar. | |
Update user basic information for logged-in user. | |
Set event observer. | |
Remove event observer. |
Room APIs.
函数列表 | 描述 |
Create a room. | |
Dismiss the room. | |
Enter a room. | |
Enter a room. | |
Enter a room. | |
Exit the room. | |
Connect to other room. | |
Disconnect other room. | |
Get room information. | |
Update room name (only support for administrators or room owner) | |
Update room seat mode (only support for administrators or room owner) | |
Update room password. |
Local user view rendering, video management.
函数列表 | 描述 |
Set the render view for current user. | |
Open the local camera. | |
Close the local camera. | |
Start pushing local videos, default enabled. | |
Stop pushing local videos. | |
Update local video encoding quality settings. | |
Set the encoding parameters of the video. | |
Set the video encoder resolution mode (horizontal resolution or vertical resolution) | |
Turn on gravity sensing mode. (only availble on mobile OS and the camera capture scene inside the SDK) | |
Start screen sharing (only available on mobile OS) | |
Start screen sharing (only available on Mac OS) | |
Stop screen sharing. | |
Get the sharable screens and windows (only available on Mac OS) | |
Select the screen or window to share (only available on Mac OS) |
Local User Audio Management.
函数列表 | 描述 |
Open local microphone. | |
Turn off the local microphone. | |
Update local audio encoding quality settings. | |
Mute publishing the local audio stream. | |
Unmute publishing the local audio stream. |
Remote user view rendering and video management.
函数列表 | 描述 |
Set the render view for remote user. | |
Start playing the remote user's video. | |
Stop playing the remote user's video. | |
Mute the remote user's audio stream. |
User information in the room.
函数列表 | 描述 |
Get the list of users in the room. | |
Get user information. |
User management in the room.
函数列表 | 描述 |
Change user role (only support for administrators or room owner) | |
Kick the remote user out of the room (only support for administrators or room owner) | |
Add a tag for the user (only support for administrators or room owner) | |
Remove tag for user (only support for room owner) | |
Get user information in the room based on the tag. | |
Set custom information for room users. |
User speech management in the room.
函数列表 | 描述 |
The owner or administrator control that all users whether can open device. For example: all users are prohibited from opening the microphone(only available in the conference scenario) | |
Request the remote user to open the media device (only support for administrators or room owner, the device type does not support SCREEN_SHARING) | |
Close remote user media devices (only support for administrators or room owner) | |
Request to open the local media device (available to general users, the device type does not support SCREEN_SHARING) |
Seat management in the room.
函数列表 | 描述 |
Set the maximum number of seat (only available before entering room and when creating room) | |
Get seat list. | |
Lock the seat (only support for administrators or room owner, including location lock, audio status lock and video status lock) | |
Take the seat | |
Leave the seat | |
Move to seat | |
Owner/Administrator invite users to take the seat. | |
Owner/Administrator kick the user off the seat. | |
Owner/Administrator get the request list of users who have applied to take the seat in the room. |
Message
函数列表 | 描述 |
Disable the ability of remote users to send messages (only support for administrators or room owner) | |
Disable the ability of all users to send messages (only support for administrators or room owner) |
Request Management.
函数列表 | 描述 |
Cancel request. | |
Response request. |
Advanced Features.
函数列表 | 描述 |
Set the beauty level. | |
Set whitening level | |
Get the extension. | |
Get device management class. |
Debug related.
函数列表 | 描述 |
Call experimental APIs. |
Error event callback.
函数列表 | 描述 |
Error event callback. |
Login status event callback.
函数列表 | 描述 |
The current user was kicked offline. | |
The current user signature is expired. |
Event callback in the room.
函数列表 | 描述 |
The name of the room has changed. | |
The status of disable to open microphone has changed for all users. | |
The status of disable to open camera has changed for all users. | |
The status of disable to open screen sharing has changed for all users. | |
The status of disable to send message has changed for all users. | |
Room was dismissed. | |
The current user has been kicked out of the room. | |
The room seat mode has changed. | |
The count of user in the room has changed. | |
Room was dismissed. |
User event callback in the room.
函数列表 | 描述 |
Remote user entered room. | |
Remote user left room. | |
User role has changed. | |
The status of the user has video has changed. | |
The status of the user has audio streaming has changed. | |
User volume changed. | |
The status of disable to send message has changed for user. | |
The user network status changed. | |
Screen sharing stopped. | |
User role changed. |
Seat event callback in the room.
函数列表 | 描述 |
The maximum count of seats in the room changed (only available in conference rooms) | |
Seat list changed. | |
The user was kicked off the seat. | |
Recevied user was kicked off the seat. |
Request event callback.
函数列表 | 描述 |
Receive request message. | |
Received a cancelled request. | |
Receive a request to be processed by other administrator/owner. | |
Received a cancelled request. | |
Receive a request to be processed by other administrator/owner. |
Deprecated callbacks.
函数列表 | 描述 |
Room was dismissed. | |
User role has changed. | |
The user was kicked off the seat. | |
Received a cancelled request. | |
Receive a request to be processed by other administrator/owner. | |
Local device added. | |
Room was dismissed. | |
Room speech mode changed. | |
User role changed. | |
Recevied user was kicked off the seat. | |
Received a cancelled request. | |
Receive a request to be processed by other administrator/owner. | |
Received normal text message. | |
Receive custom message. |
Device management APIs.
函数列表 | 描述 |
Query whether the front camera is being used (only availiable for mobile OS) | |
Switch to the front/rear camera (only availiable for mobile OS) | |
Query whether automatic face detection is supported (only availiable for mobile OS) | |
Enable auto focus (only availiable for mobile OS) | |
Enable/Disable flash, i.e., the torch mode (only availiable for mobile OS) | |
Set the audio route (only availiable for mobile OS) | |
Set event callback. | |
Start camera test (only availiable for desktop OS) | |
End camera testing (only availiable for desktop OS) | |
Start microphone testing (only availiable for desktop OS) | |
End microphone testing (only availiable for desktop OS) | |
Start speaker testing (only availiable for desktop OS) | |
End speaker testing (only availiable for desktop OS) | |
Get the device list (only availiable for desktop OS) | |
Set the device to use (only availiable for desktop OS) | |
Get the device currently in use (only availiable for desktop OS) |
