Meeting screen name and password handler. More...

#include <meeting_configuration_interface.h>

Public Types
enum	RequiredInfoType { REQUIRED_INFO_TYPE_NONE , REQUIRED_INFO_TYPE_Password , REQUIRED_INFO_TYPE_Password4WrongPassword , REQUIRED_INFO_TYPE_PasswordAndScreenName , REQUIRED_INFO_TYPE_ScreenName , REQUIRED_INFO_TYPE_MeetingIDAndScreenName , REQUIRED_INFO_TYPE_AVPreview }
	Enumeration of necessary information type to join the meeting. Here are more detailed structural descriptions. More...

Public Member Functions
virtual RequiredInfoType	GetRequiredInfoType ()=0
	Gets the type of required information to be completed.
virtual bool	InputMeetingPasswordAndScreenName (const zchar_t meetingPassword, const zchar_t screenName)=0
	Completes the password and screen name information.
virtual bool	InputMeetingIDAndScreenName (const zchar_t meetingID, const zchar_t screenName)=0
	Completes the meeting ID and screen name information.
virtual bool	InputMeetingScreenName (const zchar_t *screenName)=0
	Completes the screen name.
virtual void	Cancel ()=0
	Ignores the prompt of completing the information.
virtual SDKError	ConfirmPreview (const zchar_t *screenName, bool videoOn, bool audioOn)=0
	Confirms the user's display name and audio and video settings before joining the meeting.
virtual	~IMeetingPasswordAndScreenNameHandler ()

Detailed Description

Meeting screen name and password handler.

Note: If the user information is not completed, the SDK will take the instance of this class as a reference to remind the user to complete the information via IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification()callback.

Definition at line 18 of file meeting_configuration_interface.h.

Member Enumeration Documentation

◆ RequiredInfoType

enum IMeetingPasswordAndScreenNameHandler::RequiredInfoType

Enumeration of necessary information type to join the meeting. Here are more detailed structural descriptions.

Enumerator
REQUIRED_INFO_TYPE_NONE	Initialization.
REQUIRED_INFO_TYPE_Password	The user needs to enter the password when joins the meeting. Via the InputMeetingPasswordAndScreenName() to specify the password information.
REQUIRED_INFO_TYPE_Password4WrongPassword	If the password is invalid, the user needs to re-enter it. Via the InputMeetingPasswordAndScreenName() to specify the password information.
REQUIRED_INFO_TYPE_PasswordAndScreenName	The user needs to enter the screen name and the password,via the InputMeetingPasswordAndScreenName() to specify the necessary information.
REQUIRED_INFO_TYPE_ScreenName	The user needs to enter the screen name. Via the InputMeetingPasswordAndScreenName() to specify the screen name information.
REQUIRED_INFO_TYPE_MeetingIDAndScreenName	The user needs to enter the screen name and the meeting id,via the InputMeetingMeetingIDAndScreenName() to specify the necessary information.
REQUIRED_INFO_TYPE_AVPreview	The user needs to confirm audio and video status before joining the meeting.

Definition at line 25 of file meeting_configuration_interface.h.

    {
        REQUIRED_INFO_TYPE_NONE,
        REQUIRED_INFO_TYPE_Password, 
        REQUIRED_INFO_TYPE_Password4WrongPassword,
        REQUIRED_INFO_TYPE_PasswordAndScreenName,
        REQUIRED_INFO_TYPE_ScreenName,
        REQUIRED_INFO_TYPE_MeetingIDAndScreenName,
        REQUIRED_INFO_TYPE_AVPreview,
    };

Constructor & Destructor Documentation

◆ ~IMeetingPasswordAndScreenNameHandler()

virtual IMeetingPasswordAndScreenNameHandler::~IMeetingPasswordAndScreenNameHandler ( )

inlinevirtual

Definition at line 91 of file meeting_configuration_interface.h.

91{};

Member Function Documentation

◆ Cancel()

virtual void IMeetingPasswordAndScreenNameHandler::Cancel ( )

pure virtual

Ignores the prompt of completing the information.

Note: The SDK will destroy this object instance after calling this function.

◆ ConfirmPreview()

virtual SDKError IMeetingPasswordAndScreenNameHandler::ConfirmPreview	(	const zchar_t *	screenName,
		bool	videoOn,
		bool	audioOn )

pure virtual

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

Parameters

screenName	The user's display name. Can be null or empty if the display name has already been set.
videoOn	true if video is on in meeting. false otherwise.
audioOn	true if audio is on in meeting. false otherwise.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Only for custom UI.

◆ GetRequiredInfoType()

virtual RequiredInfoType IMeetingPasswordAndScreenNameHandler::GetRequiredInfoType ( )

pure virtual

Gets the type of required information to be completed.

Returns: If the function succeeds, it returns the value enumerated in RequiredInfoType enum. Otherwise, this function returns an error.

◆ InputMeetingIDAndScreenName()

virtual bool IMeetingPasswordAndScreenNameHandler::InputMeetingIDAndScreenName	(	const zchar_t *	meetingID,
		const zchar_t *	screenName )

pure virtual

Completes the meeting ID and screen name information.

Parameters

meetingID	The meeting ID.
screenName	The screen name.

Returns: true if the information is valid and accepted. Otherwise, false.

Note: The SDK will destroy the object instance after calling this function. Supplement with the correct information.

◆ InputMeetingPasswordAndScreenName()

virtual bool IMeetingPasswordAndScreenNameHandler::InputMeetingPasswordAndScreenName	(	const zchar_t *	meetingPassword,
		const zchar_t *	screenName )

pure virtual

Completes the password and screen name information.

Parameters

meetingPassword	The meeting password.
screenName	The screen name.

Returns: true if the information is valid and accepted. Otherwise, false.

Note: The SDK will destroy the object instance after calling this function. Supplement with the correct information.

◆ InputMeetingScreenName()

virtual bool IMeetingPasswordAndScreenNameHandler::InputMeetingScreenName ( const zchar_t * screenName )

pure virtual

Completes the screen name.

Parameters

screenName The screen name.

Returns: true if the screen name is valid and accepted. Otherwise, false.

Note: The SDK will destroy this object instance after calling this function. Complete the information by the correct function.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ RequiredInfoType

Constructor & Destructor Documentation

◆ ~IMeetingPasswordAndScreenNameHandler()

Member Function Documentation

◆ Cancel()

◆ ConfirmPreview()

◆ GetRequiredInfoType()

◆ InputMeetingIDAndScreenName()

◆ InputMeetingPasswordAndScreenName()

◆ InputMeetingScreenName()