Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCJoinMeetingInfoHandler Class Reference

Interface for handling user input when joining a meeting requires additional information. More...

#include <MobileRTCJoinMeetingInfoHandler.h>

Inherits NSObject.

Instance Methods

(MobileRTCSDKError- inputDisplayName:password:
 Inputs the display name and meeting password to continue joining the meeting.
(MobileRTCSDKError- confirmPreview:videoOn:audioOn:
 Confirms the user's display name and audio and video settings before joining the meeting.
(void) - cancel
 Cancels the attempt to join the meeting.

Properties

MobileRTCJoinMeetingInfo info
 Gets the type of information required to join the meeting.

Detailed Description

Interface for handling user input when joining a meeting requires additional information.

Definition at line 13 of file MobileRTCJoinMeetingInfoHandler.h.

Method Documentation

◆ cancel

- (void) cancel

Cancels the attempt to join the meeting.

References cancel.

Referenced by cancel.

◆ confirmPreview:videoOn:audioOn:

- (MobileRTCSDKError) confirmPreview: (NSString *_Nullable) screenName
videoOn: (BOOL) videoOn
audioOn: (BOOL) audioOn 

Confirms the user's display name and audio and video settings before joining the meeting.

Parameters
screenNameThe user's display name. Can be null or empty if the display name has already been set.
videoOnYES if video is on in meeting. NO otherwise.
audioOnYES if audio is on in meeting. NO otherwise.
Returns
If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.
Note
Only for custom UI.

◆ inputDisplayName:password:

- (MobileRTCSDKError) inputDisplayName: (NSString *_Nullable) displayName
password: (NSString *_Nullable) password 

Inputs the display name and meeting password to continue joining the meeting.

Parameters
displayNameThe display name to show in the meeting.
passwordThe meeting password.
Returns
If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Property Documentation

◆ info

- (MobileRTCJoinMeetingInfo) info
readnonatomicassign

Gets the type of information required to join the meeting.

Definition at line 18 of file MobileRTCJoinMeetingInfoHandler.h.