us.zoom.sdk.InMeetingUserInfo Interface Reference

User Information Object in ZOOM meeting. More...

Data Structures
interface	AudioStatus
	User's audio status in ZOOM meeting. More...
enum	InMeetingUserRole
	Enumeration of user roles. More...
interface	SDK_NETWORK_STATUS
interface	VideoStatus
	User video status in ZOOM meeting. More...
interface	WebinarAttendeeStatus
	Attendee's status in webinar. More...

Public Member Functions
long	getUserId ()
	Get the user ID.
String	getCustomerKey ()
	Get user customer key MeetingOptions.customer_key.
String	getUserName ()
	Get user name.
boolean	isRaisedHand ()
	Query if the hand is raised.
String	getAvatarPath ()
	Get the avatar path.
boolean	isInWaitingRoom ()
	Query if the participant is in the waiting room.
InMeetingUserRole	getInMeetingUserRole ()
	User roles in ZOOM meeting defined in InMeetingUserRole.
VideoStatus	getVideoStatus ()
	Get user video status in ZOOM meeting defined in VideoStatus.
boolean	hasCamera ()
	Query if the participant has a camera.
AudioStatus	getAudioStatus ()
	Get user audio status in ZOOM meeting defined in VideoStatus.
WebinarAttendeeStatus	getWebinarAttendeeStatus ()
	Get attendee status in webinar.
boolean	isH323User ()
	Query if the user is h323 user.
boolean	isPureCallInUser ()
	Query if the user is telephone user.
String	getPersistentId ()
	Get the user persistent ID matched with the current user information. This ID persists for the duration of the main meeting. Once the main meeting ends, the ID will be discarded.
boolean	isRawLiveStreaming ()
	Determine whether the user has started a raw live stream.
boolean	hasRawLiveStreamPrivilege ()
	Determine whether the user has raw live stream privilege.
boolean	isHost ()
	Determine whether the member corresponding with the current information is the host or not.
boolean	isMySelf ()
	Determine whether the current information corresponds to the user himself or not.
boolean	isClosedCaptionSender ()
	Determine whether the user corresponding to the current information is the sender of Closed Caption or not.
boolean	isInterpreter ()
	Determine whether the user specified by the current information is a interpreter or not.
boolean	isSignLanguageInterpreter ()
	Determine whether the user specified by the current information is a sign language interpreter or not.
String	getInterpreterActiveLanguage ()
	Get the active language, if the user is a interpreter.
boolean	isProductionStudioUser ()
	Returns whether the user is production studio user.
long	getProductionStudioParent ()
	Returns the ID of the parent user of this production user.
List< GrantCoOwnerAssetsInfo >	getGrantCoOwnerAssetsInfo ()
	Query the granted assets info when assign a co-owner.
MobileRTCEmojiFeedbackType	getEmojiFeedbackType ()
	The emoji feedback type from the user.
boolean	isInWebinarBackstage ()
	Determine whether the user specified by the current information is in the webinar backstage or not.
boolean	isBotUser ()
	Determine whether the user specified by the current information is robot user or not.
String	getBotAppName ()
	Get the bot app name.
boolean	isVirtualNameTagEnabled ()
	Query if the participant enabled virtual name tag.
List< ZoomSDKVirtualNameTag >	getVirtualNameTagList ()
	Query the virtual name tag roster information.
boolean	isCompanionModeUser ()
	Determine whether the user specified by the current information in companion mode or not.

Data Fields
int	Audio_Type_VoIP = 0
	The audio type in the meeting is VoIP.
int	Audio_Type_Telephony = 1
	The audio type in the meeting is telephony.
int	Audio_Type_None = 2
	No audio.

Detailed Description

User Information Object in ZOOM meeting.

Definition at line 9 of file InMeetingUserInfo.java.

Member Function Documentation

getAudioStatus()

AudioStatus us.zoom.sdk.InMeetingUserInfo.getAudioStatus

(

)

Get user audio status in ZOOM meeting defined in VideoStatus.

Returns

User audio status.

getAvatarPath()

String us.zoom.sdk.InMeetingUserInfo.getAvatarPath

(

)

Get the avatar path.

Returns

The avatar path.

getBotAppName()

String us.zoom.sdk.InMeetingUserInfo.getBotAppName

(

)

Get the bot app name.

Returns

If the function succeeds, the return value is the robot brand name.Otherwise the function fails and the return value is NULL.

getCustomerKey()

String us.zoom.sdk.InMeetingUserInfo.getCustomerKey

(

)

Get user customer key MeetingOptions.customer_key.

Returns

user's customer key

getEmojiFeedbackType()

MobileRTCEmojiFeedbackType us.zoom.sdk.InMeetingUserInfo.getEmojiFeedbackType

(

)

The emoji feedback type from the user.

Returns

the emoji feedback type.

getGrantCoOwnerAssetsInfo()

List< GrantCoOwnerAssetsInfo > us.zoom.sdk.InMeetingUserInfo.getGrantCoOwnerAssetsInfo

(

)

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. For more details, see GrantCoOwnerAssetsInfo object.

Note

If not granted any assets privilege, the default configuration of the web will be queried. If the user is granted assets privilege, the result after granting will be queried.

getInMeetingUserRole()

InMeetingUserRole us.zoom.sdk.InMeetingUserInfo.getInMeetingUserRole

(

)

User roles in ZOOM meeting defined in InMeetingUserRole.

Returns

User roles.

getInterpreterActiveLanguage()

String us.zoom.sdk.InMeetingUserInfo.getInterpreterActiveLanguage

(

)

Get the active language, if the user is a interpreter.

Returns

If success, the return value is the active language abbreviation, Otherwise the return value is null.

getPersistentId()

String us.zoom.sdk.InMeetingUserInfo.getPersistentId

(

)

Get the user persistent ID matched with the current user information. This ID persists for the duration of the main meeting. Once the main meeting ends, the ID will be discarded.

Returns

If the function succeeds, the return value is the user persistent ID. Otherwise null.

getProductionStudioParent()

long us.zoom.sdk.InMeetingUserInfo.getProductionStudioParent

(

)

Returns the ID of the parent user of this production user.

getUserId()

long us.zoom.sdk.InMeetingUserInfo.getUserId

(

)

Get the user ID.

Returns

The user ID.

getUserName()

String us.zoom.sdk.InMeetingUserInfo.getUserName

(

)

Get user name.

Returns

User name

getVideoStatus()

VideoStatus us.zoom.sdk.InMeetingUserInfo.getVideoStatus

(

)

Get user video status in ZOOM meeting defined in VideoStatus.

Returns

User video status.

getVirtualNameTagList()

List< ZoomSDKVirtualNameTag > us.zoom.sdk.InMeetingUserInfo.getVirtualNameTagList

(

)

Query the virtual name tag roster information.

Returns

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

getWebinarAttendeeStatus()

WebinarAttendeeStatus us.zoom.sdk.InMeetingUserInfo.getWebinarAttendeeStatus

(

)

Get attendee status in webinar.

Returns

The attendee status.

hasCamera()

boolean us.zoom.sdk.InMeetingUserInfo.hasCamera

(

)

Query if the participant has a camera.

Returns

True means the user has a camera.

hasRawLiveStreamPrivilege()

boolean us.zoom.sdk.InMeetingUserInfo.hasRawLiveStreamPrivilege

(

)

Determine whether the user has raw live stream privilege.

Returns

true indicates that the specified user has raw live stream privilege, otherwise false.

isBotUser()

boolean us.zoom.sdk.InMeetingUserInfo.isBotUser

(

)

Determine whether the user specified by the current information is robot user or not.

Returns

true indicates that the specified user is robot user.

isClosedCaptionSender()

boolean us.zoom.sdk.InMeetingUserInfo.isClosedCaptionSender

(

)

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.

isCompanionModeUser()

boolean us.zoom.sdk.InMeetingUserInfo.isCompanionModeUser

(

)

Determine whether the user specified by the current information in companion mode or not.

Returns

true indicates that the specified user in companion mode.

isH323User()

boolean us.zoom.sdk.InMeetingUserInfo.isH323User

(

)

Query if the user is h323 user.

Returns

true or false

isHost()

boolean us.zoom.sdk.InMeetingUserInfo.isHost

(

)

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

Returns

true indicates the host.

isInterpreter()

boolean us.zoom.sdk.InMeetingUserInfo.isInterpreter

(

)

Determine whether the user specified by the current information is a interpreter or not.

Returns

true indicates that the specified user is a interpreter, otherwise not.

isInWaitingRoom()

boolean us.zoom.sdk.InMeetingUserInfo.isInWaitingRoom

(

)

Query if the participant is in the waiting room.

Returns

TRUE means that the user is in the waiting room. FALSE not.

isInWebinarBackstage()

boolean us.zoom.sdk.InMeetingUserInfo.isInWebinarBackstage

(

)

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

Returns

true indicates that the specified user is in the webinar backstage.

isMySelf()

boolean us.zoom.sdk.InMeetingUserInfo.isMySelf

(

)

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

Returns

true indicates that the current information corresponds to the user himself.

isProductionStudioUser()

boolean us.zoom.sdk.InMeetingUserInfo.isProductionStudioUser

(

)

Returns whether the user is production studio user.

isPureCallInUser()

boolean us.zoom.sdk.InMeetingUserInfo.isPureCallInUser

(

)

Query if the user is telephone user.

Returns

true or false

isRaisedHand()

boolean us.zoom.sdk.InMeetingUserInfo.isRaisedHand

(

)

Query if the hand is raised.

Returns

TRUE means raised. FALSE not.

isRawLiveStreaming()

boolean us.zoom.sdk.InMeetingUserInfo.isRawLiveStreaming

(

)

Determine whether the user has started a raw live stream.

Returns

true indicates that the specified user has started a raw live stream, otherwise false.

isSignLanguageInterpreter()

boolean us.zoom.sdk.InMeetingUserInfo.isSignLanguageInterpreter

(

)

Determine whether the user specified by the current information is a sign language interpreter or not.

Returns

true indicates that the specified user is a sign language interpreter, otherwise false.

isVirtualNameTagEnabled()

boolean us.zoom.sdk.InMeetingUserInfo.isVirtualNameTagEnabled

(

)

Query if the participant enabled virtual name tag.

Returns

true means enabled, otherwise not.

Field Documentation

Audio_Type_None

int us.zoom.sdk.InMeetingUserInfo.Audio_Type_None = 2

No audio.

Definition at line 21 of file InMeetingUserInfo.java.

Audio_Type_Telephony

int us.zoom.sdk.InMeetingUserInfo.Audio_Type_Telephony = 1

The audio type in the meeting is telephony.

Definition at line 17 of file InMeetingUserInfo.java.

Audio_Type_VoIP

int us.zoom.sdk.InMeetingUserInfo.Audio_Type_VoIP = 0

The audio type in the meeting is VoIP.

Definition at line 13 of file InMeetingUserInfo.java.