ZOOM Windows SDK  4.4.55968.0904
Public Member Functions | List of all members
IUserInfo Class Referenceabstract

User information interface. More...

#include <meeting_participants_ctrl_interface.h>

Public Member Functions

virtual const wchar_t * GetUserName ()=0
 Get the username matched with the current user information. More...
 
virtual const wchar_t * GetEmail ()=0
 Get the email matched with the current user information. More...
 
virtual bool IsHost ()=0
 Determine whether the member corresponding with the current information is the host or not. More...
 
virtual unsigned int GetUserID ()=0
 Get the user ID matched with the current user information. More...
 
virtual bool IsVideoOn ()=0
 Determine the video status of the user specified by the current information. More...
 
virtual bool IsAudioMuted ()=0
 Determine the audio status of the user specified by the current information. More...
 
virtual AudioType GetAudioJoinType ()=0
 Get the audio type of the user specified by the current information when joins the meeting. More...
 
virtual bool IsMySelf ()=0
 Determine whether the current information corresponds to the user himself or not. More...
 
virtual bool IsInWaitingRoom ()=0
 Determine whether the user specified by the current information is in the waiting room or not. More...
 
virtual bool IsRaiseHand ()=0
 Determine whether the user specified by the current information raises hand or not. More...
 
virtual UserRole GetUserRole ()=0
 Get the type of role of the user specified by the current information. More...
 
virtual bool IsPurePhoneUser ()=0
 Determine whether the user corresponding to the current information joins the meeting by telephone or not. More...
 
virtual int GetAudioVoiceLevel ()=0
 Get the Mic level of the user corresponding to the current information. More...
 
virtual bool IsClosedCaptionSender ()=0
 Determine whether the user corresponding to the current information is the sender of Closed Caption or not. More...
 
virtual WebinarAttendeeStatusGetWebinarAttendeeStauts ()=0
 Get the webinar status of the user specified by the current information. More...
 

Detailed Description

User information interface.

Member Function Documentation

◆ GetAudioJoinType()

virtual AudioType IUserInfo::GetAudioJoinType ( )
pure virtual

Get the audio type of the user specified by the current information when joins the meeting.

Returns
The type of audio when the user joins the meeting. For more details, see AudioType enum.

◆ GetAudioVoiceLevel()

virtual int IUserInfo::GetAudioVoiceLevel ( )
pure virtual

Get the Mic level of the user corresponding to the current information.

Returns
The mic level of the user.

◆ GetEmail()

virtual const wchar_t* IUserInfo::GetEmail ( )
pure virtual

Get the email matched with the current user information.

Returns
If the function succeeds, the return value is user email. Otherwise failed, the return value is NULL.

◆ GetUserID()

virtual unsigned int IUserInfo::GetUserID ( )
pure virtual

Get the user ID matched with the current user information.

Returns
If the function succeeds, the return value is the user ID. Otherwise failed, the return value is ZERO(0).

◆ GetUserName()

virtual const wchar_t* IUserInfo::GetUserName ( )
pure virtual

Get the username matched with the current user information.

Returns
If the function succeeds, the return value is the username. Otherwise failed, the return value is NULL.

◆ GetUserRole()

virtual UserRole IUserInfo::GetUserRole ( )
pure virtual

Get the type of role of the user specified by the current information.

Returns
The role of the user. For more details, see UserRole enum.

◆ GetWebinarAttendeeStauts()

virtual WebinarAttendeeStatus* IUserInfo::GetWebinarAttendeeStauts ( )
pure virtual

Get the webinar status of the user specified by the current information.

Returns
The status of the specified user. For more details, see WebinarAttendeeStatus structure.

◆ IsAudioMuted()

virtual bool IUserInfo::IsAudioMuted ( )
pure virtual

Determine the audio status of the user specified by the current information.

Returns
TRUE indicates that the audio status is muted.

◆ IsClosedCaptionSender()

virtual bool IUserInfo::IsClosedCaptionSender ( )
pure virtual

Determine whether the user corresponding to the current information is the sender of Closed Caption or not.

Returns
TRUE indicates that the user is the sender of Closed Caption.

◆ IsHost()

virtual bool IUserInfo::IsHost ( )
pure virtual

Determine whether the member corresponding with the current information is the host or not.

Returns
TRUE indicates the host.

◆ IsInWaitingRoom()

virtual bool IUserInfo::IsInWaitingRoom ( )
pure virtual

Determine whether the user specified by the current information is in the waiting room or not.

Returns
TRUE indicates that the specified user is in the waiting room.

◆ IsMySelf()

virtual bool IUserInfo::IsMySelf ( )
pure virtual

Determine whether the current information corresponds to the user himself or not.

Returns
TRUE indicates that the current information corresponds to the user himself.

◆ IsPurePhoneUser()

virtual bool IUserInfo::IsPurePhoneUser ( )
pure virtual

Determine whether the user corresponding to the current information joins the meeting by telephone or not.

Returns
TRUE indicates that the user joins the meeting by telephone.

◆ IsRaiseHand()

virtual bool IUserInfo::IsRaiseHand ( )
pure virtual

Determine whether the user specified by the current information raises hand or not.

Returns
TRUE indicates that the user raises hand.

◆ IsVideoOn()

virtual bool IUserInfo::IsVideoOn ( )
pure virtual

Determine the video status of the user specified by the current information.

Returns
TRUE indicates that the video is turned on.

The documentation for this class was generated from the following file: