id |
String |
No |
The unique identifier of a user in a room can be specified when calling the joinroom API, or it can be automatically generated by the SDK. Only one user with the same ID can exist in the same room |
nickname |
String |
Yes |
The nickname of a user in a room. Specified when calling the joinroom API |
role |
Number |
Yes |
User role. This attribute is determined by the room password passed when calling the joinroom API. Different room passwords correspond to different user roles |
hasaudio |
Boolean |
No |
Whether the user has an audio device. This property's initial value is determined by whether the system has an audio device |
hasvideo |
Boolean |
No |
Whether the user has a video device. This property's initial value is determined by whether the system has a video device |
publishstate |
Number |
No |
The publishing status of the user's audio and video. For specific possible values, please refer to the Audio and Video Publishing Status. When a user publishes or unpublishes audio and video, this property will be automatically changed in the SDK. Users should not modify this property actively. It should only be used as a basis for judging the publishing status |
tk_maincamera |
String |
No |
[Generated in multi-video mode] The main camera device ID. This property value is specified by the videoinputDeviceid in the setDevices API |
tk_ip |
String |
No |
The user's IP address |
tk_area |
String |
No |
The user's region |
tk_carrier |
String |
No |
he user's network operator |
servername |
String |
No |
The user's server route |
tk_disablevideo |
Boolean |
No |
The user's camera disabled status |
tk_disableaudio |
Boolean |
No |
The user's microphone disabled status |
tk_screenstate |
Number |
No |
The screen-sharing publishing status of the user. For specific possible values, please refer to the Desktop Sharing Publishing Status. When a user publishes or unpublishes screen sharing, this property will be automatically updated in the SDK. Users should not modify this property directly. It should only be used as a basis for determining the screen-sharing publishing status |
tk_mediafilestate |
Number |
NO |
The media file publishing status of the user. For specific possible values, please refer to the Media File Publishing Status. When a user publishes a local media file using the Tuoke Cloud client, this property will be automatically updated in the SDK. Users should not modify this property directly. It should only be used as a basis for determining the media file publishing status |