User information interface. More...

#include <meeting_participants_ctrl_interface.h>

Public Member Functions
virtual const zchar_t *	GetUserName ()=0
	Gets the username matched with the current user information.

virtual bool	IsHost ()=0
	Determines whether the member corresponding with the current information is the host or not.

virtual unsigned int	GetUserID ()=0
	Gets the user ID matched with the current user information.

virtual const zchar_t *	GetAvatarPath ()=0
	Gets the avatar file path matched with the current user information.

virtual const zchar_t *	GetPersistentId ()=0
	Gets the user persistent ID matched with the current user information.

virtual const zchar_t *	GetCustomerKey ()=0
	Gets the customer_key matched with the current user information.

virtual bool	IsVideoOn ()=0
	Determines the video status of the user specified by the current information.

virtual bool	IsAudioMuted ()=0
	Determines the audio status of the user specified by the current information.

virtual AudioType	GetAudioJoinType ()=0
	Gets the audio type of the user specified by the current information when joining the meeting.

virtual bool	IsMySelf ()=0
	Determines whether the current information corresponds to the user himself or not.

virtual bool	IsInWaitingRoom ()=0
	Determines whether the user specified by the current information is in the waiting room or not.

virtual bool	IsRaiseHand ()=0
	Determines whether the user specified by the current information raises hand or not.

virtual UserRole	GetUserRole ()=0
	Gets the type of role of the user specified by the current information.

virtual bool	IsPurePhoneUser ()=0
	Determines whether the user corresponding to the current information joins the meeting by telephone or not.

virtual int	GetAudioVoiceLevel ()=0
	Gets the mic level of the user corresponding to the current information.

virtual bool	IsClosedCaptionSender ()=0
	Determines whether the user corresponding to the current information is the sender of Closed Caption or not.

virtual bool	IsTalking ()=0
	Determines whether the user specified by the current information is talking or not.

virtual bool	IsH323User ()=0
	Determines whether the user specified by the current information is H323 user or not.

virtual WebinarAttendeeStatus *	GetWebinarAttendeeStatus ()=0
	Gets the webinar status of the user specified by the current information.

virtual RecordingStatus	GetLocalRecordingStatus ()=0
	Gets the local recording status.

virtual bool	IsRawLiveStreaming ()=0
	Determines whether the user has started a raw live stream.

virtual bool	HasRawLiveStreamPrivilege ()=0
	Determines whether the user has raw live stream privilege.

virtual bool	HasCamera ()=0
	Query if the participant has a camera.

virtual bool	IsProductionStudioUser ()=0
	Determines whether the user is production studio user.

virtual bool	IsInWebinarBackstage ()=0
	Determines whether the user specified by the current information is in the webinar backstage or not.

virtual unsigned int	GetProductionStudioParent ()=0
	Gets the parent user ID of the production studio user.

virtual bool	IsBotUser ()=0
	Determines whether the user specified by the current information is bot user or not.

virtual const zchar_t *	GetBotAppName ()=0
	Gets the bot app name.

virtual bool	IsVirtualNameTagEnabled ()=0
	Query if the participant enabled virtual name tag.

virtual IList< ZoomSDKVirtualNameTag > *	GetVirtualNameTagList ()=0
	Query the virtual name tag roster infomation.

virtual IList< GrantCoOwnerAssetsInfo > *	GetGrantCoOwnerAssetsInfo ()=0
	Query the granted assets info when assign a co-owner.

virtual bool	IsAudioOnlyUser ()=0
	Determines whether the specified user is an audio only user.

virtual	~IUserInfo ()

Detailed Description

User information interface.

Definition at line 80 of file meeting_participants_ctrl_interface.h.

Constructor & Destructor Documentation

◆ ~IUserInfo()

virtual IUserInfo::~IUserInfo ( )

inlinevirtual

Definition at line 313 of file meeting_participants_ctrl_interface.h.

313{};

Member Function Documentation

◆ GetAudioJoinType()

virtual AudioType IUserInfo::GetAudioJoinType ( )

pure virtual

Gets the audio type of the user specified by the current information when joining the meeting.

Returns: If the function succeeds, it returns the type of audio when the user joins the meeting.

◆ GetAudioVoiceLevel()

virtual int IUserInfo::GetAudioVoiceLevel ( )

pure virtual

Gets the mic level of the user corresponding to the current information.

Returns: If the function succeeds, it returns the mic level of the user.

◆ GetAvatarPath()

virtual const zchar_t * IUserInfo::GetAvatarPath ( )

pure virtual

Gets the avatar file path matched with the current user information.

Returns: If the function succeeds, it returns the avatar file path. Otherwise, this function fails and returns nullptr.

◆ GetBotAppName()

virtual const zchar_t * IUserInfo::GetBotAppName ( )

pure virtual

Gets the bot app name.

Returns: If the function succeeds, it returns the bot app name. Otherwise, this function fails and returns nullptr.

◆ GetCustomerKey()

virtual const zchar_t * IUserInfo::GetCustomerKey ( )

pure virtual

Gets the customer_key matched with the current user information.

Returns: If the function succeeds, it returns the customer_key. Otherwise, this function fails and returns nullptr.

Note: If you assign a customer_key for a user in the start or join meeting parameter, the value you assigned will be returned. Otherwise, an empty string will be returned.

◆ GetGrantCoOwnerAssetsInfo()

virtual IList< GrantCoOwnerAssetsInfo > * IUserInfo::GetGrantCoOwnerAssetsInfo ( )

pure virtual

Query the granted assets info when assign a co-owner.

Returns: If the function succeeds, it returns the list of user's grant assets info.

Note: If not granted any assets privilege, the default configuration of the web will be queried. If has granted assets privilege, the result after granting will be queried.

◆ GetLocalRecordingStatus()

virtual RecordingStatus IUserInfo::GetLocalRecordingStatus ( )

pure virtual

Gets the local recording status.

Returns: The status of the local recording status.

◆ GetPersistentId()

virtual const zchar_t * IUserInfo::GetPersistentId ( )

pure virtual

Gets the user persistent ID matched with the current user information.

Returns: If the function succeeds, it returns the user persistent ID. Otherwise, this function fails and returns nullptr.

◆ GetProductionStudioParent()

virtual unsigned int IUserInfo::GetProductionStudioParent ( )

pure virtual

Gets the parent user ID of the production studio user.

Note: Just production studio user has parent.

◆ GetUserID()

virtual unsigned int IUserInfo::GetUserID ( )

pure virtual

Gets the user ID matched with the current user information.

Returns: If the function succeeds, it returns the user ID. Otherwise, this function returns ZERO(0).

Note: Valid for both normal user and webinar attendee.

◆ GetUserName()

virtual const zchar_t * IUserInfo::GetUserName ( )

pure virtual

Gets the username matched with the current user information.

Returns: If the function succeeds, it returns the username. Otherwise, this function fails and returns nullptr.

Note: Valid for both normal user and webinar attendee.

◆ GetUserRole()

virtual UserRole IUserInfo::GetUserRole ( )

pure virtual

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

Returns: If the function succeeds, it returns the role of the user.

◆ GetVirtualNameTagList()

virtual IList< ZoomSDKVirtualNameTag > * IUserInfo::GetVirtualNameTagList ( )

pure virtual

Query the virtual name tag roster infomation.

Returns: If the function succeeds, it return the list of user's virtual name tag roster info.

◆ GetWebinarAttendeeStatus()

virtual WebinarAttendeeStatus * IUserInfo::GetWebinarAttendeeStatus ( )

pure virtual

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

Returns: If the function succeeds, it returns the status of the specified user. Otherwise, this function fails and returns nullptr.

◆ HasCamera()

virtual bool IUserInfo::HasCamera ( )

pure virtual

Query if the participant has a camera.

Returns: true if the user has a camera. Otherwise, false.

◆ HasRawLiveStreamPrivilege()

virtual bool IUserInfo::HasRawLiveStreamPrivilege ( )

pure virtual

Determines whether the user has raw live stream privilege.

Returns: true if the specified user has raw live stream privilege. Otherwise, false.

◆ IsAudioMuted()

virtual bool IUserInfo::IsAudioMuted ( )

pure virtual

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

Returns: true if the audio status is muted. Otherwise, false.

◆ IsAudioOnlyUser()

virtual bool IUserInfo::IsAudioOnlyUser ( )

pure virtual

Determines whether the specified user is an audio only user.

Returns: true if the specified user is an audio only user. Otherwise, false.

◆ IsBotUser()

virtual bool IUserInfo::IsBotUser ( )

pure virtual

Determines whether the user specified by the current information is bot user or not.

Note: This function return true only when using Meeting SDK with an On-Behalf token; Otherwise it will always return false.

Returns: true if the specified user is a bot user. Otherwise, false.

◆ IsClosedCaptionSender()

virtual bool IUserInfo::IsClosedCaptionSender ( )

pure virtual

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

Returns: true if the user is the sender of Closed Caption. Otherwise, false.

◆ IsH323User()

virtual bool IUserInfo::IsH323User ( )

pure virtual

Determines whether the user specified by the current information is H323 user or not.

Returns: true if the specified user is H323 user. Otherwise, false.

◆ IsHost()

virtual bool IUserInfo::IsHost ( )

pure virtual

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

Returns: true if the user is the host. Otherwise, false.

◆ IsInWaitingRoom()

virtual bool IUserInfo::IsInWaitingRoom ( )

pure virtual

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

Returns: true if the specified user is in the waiting room. Otherwise, false.

◆ IsInWebinarBackstage()

virtual bool IUserInfo::IsInWebinarBackstage ( )

pure virtual

Determines whether the user specified by the current information is in the webinar backstage or not.

Returns: true if the specified user is in the webinar backstage. Otherwise, false.

◆ IsMySelf()

virtual bool IUserInfo::IsMySelf ( )

pure virtual

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

Returns: true if the current information corresponds to the user himself. Otherwise, false.

◆ IsProductionStudioUser()

virtual bool IUserInfo::IsProductionStudioUser ( )

pure virtual

Determines whether the user is production studio user.

Returns: true if the specified user is production studio user. Otherwise, false.

◆ IsPurePhoneUser()

virtual bool IUserInfo::IsPurePhoneUser ( )

pure virtual

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

Returns: true if the user joins the meeting by telephone. Otherwise, false.

◆ IsRaiseHand()

virtual bool IUserInfo::IsRaiseHand ( )

pure virtual

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

Returns: true if the user raises hand. Otherwise, false.

◆ IsRawLiveStreaming()

virtual bool IUserInfo::IsRawLiveStreaming ( )

pure virtual

Determines whether the user has started a raw live stream.

Returns: true if the specified user has started a raw live stream. Otherwise, false.

◆ IsTalking()

virtual bool IUserInfo::IsTalking ( )

pure virtual

Determines whether the user specified by the current information is talking or not.

Returns: true if the specified user is talking. Otherwise, false.

◆ IsVideoOn()

virtual bool IUserInfo::IsVideoOn ( )

pure virtual

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

Returns: true if the video is turned on. Otherwise, false.

Note: Valid for both normal user and webinar attendee.

◆ IsVirtualNameTagEnabled()

virtual bool IUserInfo::IsVirtualNameTagEnabled ( )

pure virtual

Query if the participant enabled virtual name tag.

Returns: true if enabled. Otherwise, false.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IUserInfo()

Member Function Documentation

◆ GetAudioJoinType()

◆ GetAudioVoiceLevel()

◆ GetAvatarPath()

◆ GetBotAppName()

◆ GetCustomerKey()

◆ GetGrantCoOwnerAssetsInfo()

◆ GetLocalRecordingStatus()

◆ GetPersistentId()

◆ GetProductionStudioParent()

◆ GetUserID()

◆ GetUserName()

◆ GetUserRole()

◆ GetVirtualNameTagList()

◆ GetWebinarAttendeeStatus()

◆ HasCamera()

◆ HasRawLiveStreamPrivilege()

◆ IsAudioMuted()

◆ IsAudioOnlyUser()

◆ IsBotUser()

◆ IsClosedCaptionSender()

◆ IsH323User()

◆ IsHost()

◆ IsInWaitingRoom()

◆ IsInWebinarBackstage()

◆ IsMySelf()

◆ IsProductionStudioUser()

◆ IsPurePhoneUser()

◆ IsRaiseHand()

◆ IsRawLiveStreaming()

◆ IsTalking()

◆ IsVideoOn()

◆ IsVirtualNameTagEnabled()