Joining a Meeting
Function
This API is used to join an existing meeting by using the meeting ID and password. This API can be called regardless of whether you have logged in.
Function Prototype
joinConfById(joinConfByIdInfo: JoinConfByIdInfo, onJoinConfByIdResult?: (ret: SDKERR, reason: string) => void): voidjoinConfById(joinConfByIdInfo: JoinConfByIdInfo, onJoinConfByIdResult?: (ret: SDKERR, reason: string) => void): void
Request Parameters
Parameter | Mandatory | Type | Description |
---|---|---|---|
joinConfByIdInfo | Yes | JoinConfByIdInfo | Information about joining a meeting using an ID. |
onJoinConfByIdResult | Yes | (ret: SDKERR, reason: string) => void | Callback for joining the meeting using the meeting ID. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
confId | Yes | string | Meeting ID. |
password | No | string | Meeting password. If you want to join a meeting as a host, you must enter the host password. If you want to join a meeting as a guest, enter the guest password or leave the password empty as required. |
nickName | No | string | Display name in the meeting. If you have logged in, this parameter can be left blank. In such a case, the login username is used as the display name in the meeting. If you join the meeting anonymously, specify this parameter. |
isSpeakerOff | No | boolean | Whether to disable the speaker. The options are true (yes) and false (no). |
isMicOn | No | boolean | Whether to enable the microphone. The options are true (yes) and false (no). |
isCameraOn | No | boolean | Whether to enable the camera. The options are true (yes) and false (no). |
isStopConflictConf | No | boolean | Forcibly end a meeting that conflicts with the current cloud meeting room. (Only the owner of the cloud meeting room resource has the permission.) |
Return Values
void
Callback Method Parameters
(ret: SDKERR, reason: string) => void
Parameter | Type | Description |
---|---|---|
ret | For details about SDKERR, see Error Code Reference. | Error code. |
reason | string | Error description. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot