Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
Instance Methods | Properties | List of all members
MobileRTCMeetingUserInfo Class Reference

A class that contains information of the current user in the meeting. More...

#include <MobileRTCMeetingUserInfo.h>

Inherits NSObject.

Instance Methods

(BOOL) - isVirtualNameTagEnabled
 Queries if the participant enabled virtual name tag.
 
(NSArray< MobileRTCVirtualNameTag * > *_Nullable) - getVirtualNameTagArray
 Queries the virtual name tag roster information.
 
(nullable NSArray< MobileRTCGrantCoOwnerAssetsInfo * > *) - getGrantCoOwnerAssetsInfo
 Queries the granted assets info when assigning a co-owner.
 
(BOOL) - isAudioOnlyUser
 Determines whether the specified user is an audio only user.
 

Properties

NSUInteger userID
 The user ID.
 
NSString *_Nullable persistentId
 Gets 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.
 
BOOL isMySelf
 Determines if the information corresponds to the current user.
 
NSString *_Nullable customerKey
 The customer key that the app integrated with SDK needs to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35.
 
NSString *_Nullable userName
 The screen name of the user.
 
NSString *_Nullable avatarPath
 The path to store the head portrait.
 
MobileRTCVideoStatus *_Nullable videoStatus
 The user's video status in the meeting.
 
MobileRTCAudioStatus *_Nullable audioStatus
 The user's audio status in the meeting.
 
BOOL handRaised
 Indicates if the user raised their hand.
 
BOOL hasCamera
 Indicates if the participant has a camera.
 
BOOL inWaitingRoom
 Indicates if the user entered the waiting room when joining the meeting.
 
BOOL isCohost
 Indicates if the current user is the co-host.
 
BOOL isHost
 Indicates if the current user is the host.
 
BOOL isH323User
 Indicates if the current user is an H.323 user.
 
BOOL isPureCallInUser
 Indicates if the current user is a telephone user.
 
BOOL isSharingPureComputerAudio
 Indicates if the user is sharing only the sounds of computer.
 
MobileRTCEmojiFeedbackType emojiFeedbackType
 The emoji feedback type from the user.
 
MobileRTCUserRole userRole
 The type of role of the user specified by the current information.
 
BOOL isInterpreter
 Determines if the user is an interpreter.
 
BOOL isSignLanguageInterpreter
 Determines whether the user specified by the current information is a sign language interpreter.
 
NSString *_Nullable interpreterActiveLanguage
 Gets the interpreter active language.
 
BOOL isRawLiveStreaming
 Determines whether the user has started a raw live stream.
 
BOOL hasRawLiveStreamPrivilege
 Determines whether the user has raw live stream privilege.
 
BOOL isClosedCaptionSender
 Determines whether the user corresponding to the current information is the sender of Closed Caption.
 
BOOL isProductionStudioUser
 Indicates whether the user is a production studio user.
 
BOOL isCompanionModeUser
 Determines whether the user specified by the current information is in companion mode.
 
NSInteger productionStudioParent
 The ID of the parent user of this production user.
 
BOOL isInWebinarBackstage
 Determines whether the user specified by the current information is in the webinar backstage.
 
BOOL isBotUser
 Determines whether the user specified by the current information is a bot user.
 
NSString *_Nullable botAppName
 Gets the bot app name.
 

Detailed Description

A class that contains information of the current user in the meeting.

Definition at line 114 of file MobileRTCMeetingUserInfo.h.

Method Documentation

◆ getGrantCoOwnerAssetsInfo

- (nullable NSArray< MobileRTCGrantCoOwnerAssetsInfo * > *) getGrantCoOwnerAssetsInfo

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

Returns
If the function succeeds, it returns an NSArray of MobileRTCGrantCoOwnerAssetsInfo objects. Otherwise, this function fails and returns nil.
Note
If not granted any assets privilege, the default configuration of the web will be queried. If assets privilege has been granted, the result after granting will be queried.

◆ getVirtualNameTagArray

- (NSArray< MobileRTCVirtualNameTag * > *_Nullable) getVirtualNameTagArray

Queries the virtual name tag roster information.

Returns
If the function succeeds, it returns an NSArray of MobileRTCVirtualNameTag objects. Otherwise, this function fails and returns nil.

◆ isAudioOnlyUser

- (BOOL) isAudioOnlyUser

Determines whether the specified user is an audio only user.

Returns
YES if the specified user is an audio only user. Otherwise, NO.

◆ isVirtualNameTagEnabled

- (BOOL) isVirtualNameTagEnabled

Queries if the participant enabled virtual name tag.

Returns
YES if enabled. Otherwise, NO.

Property Documentation

◆ audioStatus

- (MobileRTCAudioStatus* _Nullable) audioStatus
readwritenonatomicretain

The user's audio status in the meeting.

Definition at line 154 of file MobileRTCMeetingUserInfo.h.

◆ avatarPath

- (NSString* _Nullable) avatarPath
readwritenonatomiccopy

The path to store the head portrait.

Definition at line 144 of file MobileRTCMeetingUserInfo.h.

◆ botAppName

- (NSString* _Nullable) botAppName
readwritenonatomiccopy

Gets the bot app name.

Definition at line 264 of file MobileRTCMeetingUserInfo.h.

◆ customerKey

- (NSString* _Nullable) customerKey
readwritenonatomiccopy

The customer key that the app integrated with SDK needs to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35.

Definition at line 134 of file MobileRTCMeetingUserInfo.h.

◆ emojiFeedbackType

- (MobileRTCEmojiFeedbackType) emojiFeedbackType
readwritenonatomicassign

The emoji feedback type from the user.

Definition at line 199 of file MobileRTCMeetingUserInfo.h.

◆ handRaised

- (BOOL) handRaised
readwritenonatomicassign

Indicates if the user raised their hand.

Definition at line 159 of file MobileRTCMeetingUserInfo.h.

◆ hasCamera

- (BOOL) hasCamera
readwritenonatomicassign

Indicates if the participant has a camera.

Definition at line 164 of file MobileRTCMeetingUserInfo.h.

◆ hasRawLiveStreamPrivilege

- (BOOL) hasRawLiveStreamPrivilege
readwritenonatomicassign

Determines whether the user has raw live stream privilege.

Definition at line 229 of file MobileRTCMeetingUserInfo.h.

◆ interpreterActiveLanguage

- (NSString* _Nullable) interpreterActiveLanguage
readwritenonatomiccopy

Gets the interpreter active language.

Definition at line 219 of file MobileRTCMeetingUserInfo.h.

◆ inWaitingRoom

- (BOOL) inWaitingRoom
readwritenonatomicassign

Indicates if the user entered the waiting room when joining the meeting.

Definition at line 169 of file MobileRTCMeetingUserInfo.h.

◆ isBotUser

- (BOOL) isBotUser
readwritenonatomicassign

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

Definition at line 259 of file MobileRTCMeetingUserInfo.h.

◆ isClosedCaptionSender

- (BOOL) isClosedCaptionSender
readwritenonatomicassign

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

Definition at line 234 of file MobileRTCMeetingUserInfo.h.

◆ isCohost

- (BOOL) isCohost
readwritenonatomicassign

Indicates if the current user is the co-host.

Definition at line 174 of file MobileRTCMeetingUserInfo.h.

◆ isCompanionModeUser

- (BOOL) isCompanionModeUser
readwritenonatomicassign

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

Definition at line 244 of file MobileRTCMeetingUserInfo.h.

◆ isH323User

- (BOOL) isH323User
readwritenonatomicassign

Indicates if the current user is an H.323 user.

Definition at line 184 of file MobileRTCMeetingUserInfo.h.

◆ isHost

- (BOOL) isHost
readwritenonatomicassign

Indicates if the current user is the host.

Definition at line 179 of file MobileRTCMeetingUserInfo.h.

◆ isInterpreter

- (BOOL) isInterpreter
readwritenonatomicassign

Determines if the user is an interpreter.

Definition at line 209 of file MobileRTCMeetingUserInfo.h.

◆ isInWebinarBackstage

- (BOOL) isInWebinarBackstage
readwritenonatomicassign

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

Definition at line 254 of file MobileRTCMeetingUserInfo.h.

◆ isMySelf

- (BOOL) isMySelf
readwritenonatomicassign

Determines if the information corresponds to the current user.

Definition at line 129 of file MobileRTCMeetingUserInfo.h.

◆ isProductionStudioUser

- (BOOL) isProductionStudioUser
readwritenonatomicassign

Indicates whether the user is a production studio user.

Definition at line 239 of file MobileRTCMeetingUserInfo.h.

◆ isPureCallInUser

- (BOOL) isPureCallInUser
readwritenonatomicassign

Indicates if the current user is a telephone user.

Definition at line 189 of file MobileRTCMeetingUserInfo.h.

◆ isRawLiveStreaming

- (BOOL) isRawLiveStreaming
readwritenonatomicassign

Determines whether the user has started a raw live stream.

Definition at line 224 of file MobileRTCMeetingUserInfo.h.

◆ isSharingPureComputerAudio

- (BOOL) isSharingPureComputerAudio
readwritenonatomicassign

Indicates if the user is sharing only the sounds of computer.

Definition at line 194 of file MobileRTCMeetingUserInfo.h.

◆ isSignLanguageInterpreter

- (BOOL) isSignLanguageInterpreter
readwritenonatomicassign

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

Definition at line 214 of file MobileRTCMeetingUserInfo.h.

◆ persistentId

- (NSString* _Nullable) persistentId
readwritenonatomiccopy

Gets 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.

Definition at line 124 of file MobileRTCMeetingUserInfo.h.

◆ productionStudioParent

- (NSInteger) productionStudioParent
readwritenonatomicassign

The ID of the parent user of this production user.

Definition at line 249 of file MobileRTCMeetingUserInfo.h.

◆ userID

- (NSUInteger) userID
readwritenonatomicassign

The user ID.

Definition at line 119 of file MobileRTCMeetingUserInfo.h.

◆ userName

- (NSString* _Nullable) userName
readwritenonatomiccopy

The screen name of the user.

Definition at line 139 of file MobileRTCMeetingUserInfo.h.

◆ userRole

- (MobileRTCUserRole) userRole
readwritenonatomicassign

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

Definition at line 204 of file MobileRTCMeetingUserInfo.h.

◆ videoStatus

- (MobileRTCVideoStatus* _Nullable) videoStatus
readwritenonatomicretain

The user's video status in the meeting.

Definition at line 149 of file MobileRTCMeetingUserInfo.h.