Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
us.zoom.sdk.InMeetingUserInfo Interface Reference

User information object in Zoom meeting. More...

Data Structures

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

Public Member Functions

long getUserId ()
 Gets the user's ID.
String getCustomerKey ()
 Gets the user's customer key.
String getUserName ()
 Gets the user's name.
boolean isRaisedHand ()
 Determines whether the hand is raised.
String getAvatarPath ()
 Gets the avatar path.
boolean isInWaitingRoom ()
 Determines whether the participant is in the waiting room.
InMeetingUserRole getInMeetingUserRole ()
 Gets the user's role in the Zoom meeting.
VideoStatus getVideoStatus ()
 Gets the user's video status in the Zoom meeting.
boolean hasCamera ()
 Determines whether the participant has a camera.
AudioStatus getAudioStatus ()
 Gets the user's audio status in the Zoom meeting.
WebinarAttendeeStatus getWebinarAttendeeStatus ()
 Gets the attendee's status in the webinar.
boolean isH323User ()
 Determines whether the user is an H.323 user.
boolean isPureCallInUser ()
 Determines whether the user is a telephone user.
String getPersistentId ()
 Gets the user's 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 is discarded.
boolean isRawLiveStreaming ()
 Determines whether the user has started a raw live stream.
boolean hasRawLiveStreamPrivilege ()
 Determines whether the user has raw live stream privilege.
boolean isHost ()
 Determines whether the member corresponding to the current information is the host.
boolean isMySelf ()
 Determines whether the current information corresponds to the user themselves.
boolean isClosedCaptionSender ()
 Determines whether the user corresponding to the current information is the sender of closed caption.
boolean isInterpreter ()
 Determines whether the user specified by the current information is an interpreter.
boolean isSignLanguageInterpreter ()
 Determines whether the user specified by the current information is a sign language interpreter.
String getInterpreterActiveLanguage ()
 Gets the active language if the user is an interpreter.
boolean isProductionStudioUser ()
 Determines whether the user is a production studio user.
long getProductionStudioParent ()
 Gets the ID of the parent user of this production user.
List< GrantCoOwnerAssetsInfo > getGrantCoOwnerAssetsInfo ()
 Gets the granted assets info when assigning a co-owner.
MobileRTCEmojiFeedbackType getEmojiFeedbackType ()
 Gets the emoji feedback type from the user.
boolean isInWebinarBackstage ()
 Determines whether the user specified by the current information is in the webinar backstage.
boolean isBotUser ()
 Determines whether the user specified by the current information is a robot user.
String getBotAppName ()
 Gets the bot app name.
boolean isVirtualNameTagEnabled ()
 Determines whether the participant has enabled virtual name tag.
List< ZoomSDKVirtualNameTag > getVirtualNameTagList ()
 Gets the virtual name tag roster information.
boolean isCompanionModeUser ()
 Determines whether the user specified by the current information is in companion mode.
boolean isAudioOnlyUser ()
 Determines whether the specified user is an audio only user.

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 8 of file InMeetingUserInfo.java.

Member Function Documentation

◆ getAudioStatus()

AudioStatus us.zoom.sdk.InMeetingUserInfo.getAudioStatus ( )

Gets the user's audio status in the Zoom meeting.

Returns
If the function succeeds, it returns the user's audio status. Otherwise, this function fails and returns null.

◆ getAvatarPath()

String us.zoom.sdk.InMeetingUserInfo.getAvatarPath ( )

Gets the avatar path.

Returns
If the function succeeds, it returns the avatar path. Otherwise, this function fails and returns null.

◆ getBotAppName()

String us.zoom.sdk.InMeetingUserInfo.getBotAppName ( )

Gets the bot app name.

Returns
If the function succeeds, it returns the robot brand name. Otherwise, this function fails and returns null.

◆ getCustomerKey()

String us.zoom.sdk.InMeetingUserInfo.getCustomerKey ( )

Gets the user's customer key.

Returns
If the function succeeds, it returns the user's customer key. Otherwise, this function fails and returns null.

◆ getEmojiFeedbackType()

MobileRTCEmojiFeedbackType us.zoom.sdk.InMeetingUserInfo.getEmojiFeedbackType ( )

Gets the emoji feedback type from the user.

Returns
If the function succeeds, it returns the emoji feedback type. Otherwise, this function fails and returns null.

◆ getGrantCoOwnerAssetsInfo()

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

Gets the granted assets info when assigning a co-owner.

Returns
If the function succeeds, it returns the list of the user's granted assets info. Otherwise, this function fails and returns null.
Note
If no assets privilege is granted, 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 ( )

Gets the user's role in the Zoom meeting.

Returns
If the function succeeds, it returns the user's role. Otherwise, this function fails and returns null.

◆ getInterpreterActiveLanguage()

String us.zoom.sdk.InMeetingUserInfo.getInterpreterActiveLanguage ( )

Gets the active language if the user is an interpreter.

Returns
If the function succeeds, it returns the active language abbreviation. Otherwise, this function fails and returns null.

◆ getPersistentId()

String us.zoom.sdk.InMeetingUserInfo.getPersistentId ( )

Gets the user's 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 is discarded.

Returns
If the function succeeds, it returns the user's persistent ID. Otherwise, this function fails and returns null.

◆ getProductionStudioParent()

long us.zoom.sdk.InMeetingUserInfo.getProductionStudioParent ( )

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

Returns
If the function succeeds, it returns the parent user's ID. Otherwise, this function fails and returns 0.

◆ getUserId()

long us.zoom.sdk.InMeetingUserInfo.getUserId ( )

Gets the user's ID.

Returns
If the function succeeds, it returns the user's ID. Otherwise, this function fails and returns 0.

◆ getUserName()

String us.zoom.sdk.InMeetingUserInfo.getUserName ( )

Gets the user's name.

Returns
If the function succeeds, it returns the user's name. Otherwise, this function fails and returns null.

◆ getVideoStatus()

VideoStatus us.zoom.sdk.InMeetingUserInfo.getVideoStatus ( )

Gets the user's video status in the Zoom meeting.

Returns
If the function succeeds, it returns the user's video status. Otherwise, this function fails and returns null.

◆ getVirtualNameTagList()

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

Gets the virtual name tag roster information.

Returns
If the function succeeds, it returns the list of the user's virtual name tag roster info. Otherwise, this function fails and returns null.

◆ getWebinarAttendeeStatus()

WebinarAttendeeStatus us.zoom.sdk.InMeetingUserInfo.getWebinarAttendeeStatus ( )

Gets the attendee's status in the webinar.

Returns
If the function succeeds, it returns the attendee's status. Otherwise, this function fails and returns null.

◆ hasCamera()

boolean us.zoom.sdk.InMeetingUserInfo.hasCamera ( )

Determines whether the participant has a camera.

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

◆ hasRawLiveStreamPrivilege()

boolean us.zoom.sdk.InMeetingUserInfo.hasRawLiveStreamPrivilege ( )

Determines whether the user has raw live stream privilege.

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

◆ isAudioOnlyUser()

boolean us.zoom.sdk.InMeetingUserInfo.isAudioOnlyUser ( )

Determines whether the specified user is an audio only user.

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

◆ isBotUser()

boolean us.zoom.sdk.InMeetingUserInfo.isBotUser ( )

Determines whether the user specified by the current information is a robot user.

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

◆ isClosedCaptionSender()

boolean us.zoom.sdk.InMeetingUserInfo.isClosedCaptionSender ( )

Determines whether the user corresponding to the current information is the sender of closed caption.

Returns
true if the user is the sender of closed caption. Otherwise, false.

◆ isCompanionModeUser()

boolean us.zoom.sdk.InMeetingUserInfo.isCompanionModeUser ( )

Determines whether the user specified by the current information is in companion mode.

Returns
true if the specified user is in companion mode. Otherwise, false.

◆ isH323User()

boolean us.zoom.sdk.InMeetingUserInfo.isH323User ( )

Determines whether the user is an H.323 user.

Returns
true if the user is an H.323 user. Otherwise, false.

◆ isHost()

boolean us.zoom.sdk.InMeetingUserInfo.isHost ( )

Determines whether the member corresponding to the current information is the host.

Returns
true if the member is the host. Otherwise, false.

◆ isInterpreter()

boolean us.zoom.sdk.InMeetingUserInfo.isInterpreter ( )

Determines whether the user specified by the current information is an interpreter.

Returns
true if the specified user is an interpreter. Otherwise, false.

◆ isInWaitingRoom()

boolean us.zoom.sdk.InMeetingUserInfo.isInWaitingRoom ( )

Determines whether the participant is in the waiting room.

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

◆ isInWebinarBackstage()

boolean us.zoom.sdk.InMeetingUserInfo.isInWebinarBackstage ( )

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

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

◆ isMySelf()

boolean us.zoom.sdk.InMeetingUserInfo.isMySelf ( )

Determines whether the current information corresponds to the user themselves.

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

◆ isProductionStudioUser()

boolean us.zoom.sdk.InMeetingUserInfo.isProductionStudioUser ( )

Determines whether the user is a production studio user.

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

◆ isPureCallInUser()

boolean us.zoom.sdk.InMeetingUserInfo.isPureCallInUser ( )

Determines whether the user is a telephone user.

Returns
true if the user is a telephone user. Otherwise, false.

◆ isRaisedHand()

boolean us.zoom.sdk.InMeetingUserInfo.isRaisedHand ( )

Determines whether the hand is raised.

Returns
true if the hand is raised. Otherwise, false.

◆ isRawLiveStreaming()

boolean us.zoom.sdk.InMeetingUserInfo.isRawLiveStreaming ( )

Determines whether the user has started a raw live stream.

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

◆ isSignLanguageInterpreter()

boolean us.zoom.sdk.InMeetingUserInfo.isSignLanguageInterpreter ( )

Determines whether the user specified by the current information is a sign language interpreter.

Returns
true if the specified user is a sign language interpreter. Otherwise, false.

◆ isVirtualNameTagEnabled()

boolean us.zoom.sdk.InMeetingUserInfo.isVirtualNameTagEnabled ( )

Determines whether the participant has enabled virtual name tag.

Returns
true if virtual name tag is enabled. Otherwise, false.

Field Documentation

◆ Audio_Type_None

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

No audio.

Definition at line 20 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 16 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 12 of file InMeetingUserInfo.java.