Parameter | Type | Description |
conferenceId | String | Conference ID required for creating or joining a conference |
isCreateConference | bool | Whether it is for creating a conference (true for creating, false for joining) |
conferenceParams | Parameters related to creating or joining a conference | |
conferenceObserver | Conference status change callback listener |
ConferenceSession
class to perform related operations.Parameter | Type | Description |
isMuteMicrophone | bool | Whether to mute the microphone (default is false) |
isOpenCamera | bool | Whether to turn on the camera (default is false) |
isSoundOnSpeaker | bool | Whether to use speakers (default is true) |
name | String | Conference name (default is your conference ID, it is invalid when joining the conference) |
enableMicrophoneForAllUser | bool | Whether to enable microphone permission for all members (default is true, invalid when joining a conference) |
enableCameraForAllUser | bool | Whether to enable camera permissions for all members (default is true, invalid when joining a conference) |
enableMessageForAllUser | bool | Whether to enable the speaking permission of all members (default is true, invalid when joining a conference) |
enableSeatControl | bool | Whether to enable speaking mode on stage (default is false, invalid when joining a conference) |
onActionSuccess | VoidCallback | Callback for successful creation/joining of a conference. You can navigate to the meeting page in this callback. |
onActionError | Callback for failed creation/joining of a conference. |
factory ConferenceSession.newInstance(String id)
Parameter | Type | Description |
id | String | Conference ID required for creating or joining a conference |
Future<void> quickStart()
Future<void> join()
ConferenceSession
.Parameter | Type | Description |
isMuteMicrophone | bool | Whether to mute the microphone (default is false) |
isOpenCamera | bool | Whether to turn on the camera (default is false) |
isSoundOnSpeaker | bool | Whether to use speakers (default is true) |
name | String | Conference name (default is your conference ID, it is invalid when joining the conference) |
enableMicrophoneForAllUser | bool | Whether to enable microphone permission for all members (default is true, invalid when joining a conference) |
enableCameraForAllUser | bool | Whether to enable camera permissions for all members (default is true, invalid when joining a conference) |
enableMessageForAllUser | bool | Whether to enable the speaking permission of all members (default is true, invalid when joining a conference) |
enableSeatControl | bool | Whether to enable speaking mode on stage (default is false, invalid when joining a conference) |
onActionSuccess | VoidCallback | Callback for successful creation/joining of a conference. You can navigate to the meeting page in this callback. |
onActionError | Callback for failed creation/joining of a conference. |
Function(String conferenceId, ConferenceError error) onConferenceStarted
Parameter | Type | Description |
conferenceId | String | Conference id |
error | Error code |
Function(String conferenceId, ConferenceError error) onConferenceJoined
Parameter | Type | Description |
conferenceId | String | Conference Id |
error | Error code |
Function(String conferenceId) onConferenceFinished
Parameter | Type | Description |
conferenceId | String | Conference Id |
Function(String conferenceId) onConferenceFinished
Parameter | Type | Description |
conferenceId | String | Conference Id |
Enumeration | Value | Description |
success | 0 | Operation Successful |
errFailed | -1 | Temporarily Unclassified General Error |
errConferenceIdNotExist | -2100 | Room Does Not Exist When Entering, May Have Been Closed |
errConferenceIdInvalid | -2105 | Illegal Custom Room ID, Must Be Printable ASCII Characters (0x20-0x7e), Up to 48 Bytes Long |
errConferenceIdOccupied | -2106 | Room ID is Already in Use, Please Choose Another Room ID |
errConferenceNameInvalid | -2107 | Illegal Room Name, Maximum 30 Bytes, Must Be UTF-8 Encoding if Contains Chinese Characters |
Was this page helpful?