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

The information of the current user in the meeting. More...

#include <MobileRTCMeetingUserInfo.h>

Inherits NSObject.

Instance Methods

(BOOL) - isVirtualNameTagEnabled
 Query if the participant enabled virtual name tag.
 
(NSArray< MobileRTCVirtualNameTag * > *_Nullable) - getVirtualNameTagArray
 Query the virtual name tag roster infomation.
 
(nullable NSArray< MobileRTCGrantCoOwnerAssetsInfo * > *) - getGrantCoOwnerAssetsInfo
 Query the granted assets info when assign a co-owner.
 

Properties

NSUInteger userID
 The ID of user.
 
NSString *_Nullable persistentId
 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.
 
BOOL isMySelf
 Determine if the information corresponds to the current user.
 
NSString *_Nullable customerKey
 The customer key that need the app intergrated with sdk 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 user.
 
NSString *_Nullable avatarPath
 The path to store the head portrait.
 
MobileRTCVideoStatus *_Nullable videoStatus
 User's video status in the meeting.
 
MobileRTCAudioStatus *_Nullable audioStatus
 User's audio status in the meeting.
 
BOOL handRaised
 The user raised his hand.
 
BOOL hasCamera
 Query if the participant has a camera.
 
BOOL inWaitingRoom
 User enter the waiting room when joins the meeting.
 
BOOL isCohost
 Query if the current user is the co-host.
 
BOOL isHost
 Query if the current user is the host.
 
BOOL isH323User
 Query if the current user is h323 user.
 
BOOL isPureCallInUser
 Query if the current user is Telephone user.
 
BOOL isSharingPureComputerAudio
 Query 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
 Determine if user is interpreter.
 
BOOL isSignLanguageInterpreter
 Determine whether the user specified by the current information is a sign language interpreter or not.
 
NSString *_Nullable interpreterActiveLanguage
 Get interpreter active language.
 
BOOL isRawLiveStreaming
 Determine whether the user has started a raw live stream.
 
BOOL hasRawLiveStreamPrivilege
 Determine whether the user has raw live stream privilege.
 
BOOL isClosedCaptionSender
 Determine whether the user corresponding to the current information is the sender of Closed Caption or not.
 
BOOL isProductionStudioUser
 
BOOL isCompanionModeUser
 Determine whether the user specified by the current information in companion mode or not.
 
NSInteger productionStudioParent
 
BOOL isInWebinarBackstage
 Determine whether the user specified by the current information is in the webinar backstage or not.
 
BOOL isBotUser
 Determine whether the user specified by the current information is bot user or not.
 
NSString *_Nullable botAppName
 Get the bot app name.
 

Detailed Description

The information of the current user in the meeting.

Definition at line 108 of file MobileRTCMeetingUserInfo.h.

Method Documentation

◆ getGrantCoOwnerAssetsInfo

- (nullable NSArray< MobileRTCGrantCoOwnerAssetsInfo * > *) 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 MobileRTCGrantCoOwnerAssetsInfo object.
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.

◆ getVirtualNameTagArray

- (NSArray< MobileRTCVirtualNameTag * > *_Nullable) getVirtualNameTagArray

Query the virtual name tag roster infomation.

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

◆ isVirtualNameTagEnabled

- (BOOL) isVirtualNameTagEnabled

Query if the participant enabled virtual name tag.

Returns
YES means enabled. Otherwise not.

Property Documentation

◆ audioStatus

- (MobileRTCAudioStatus* _Nullable) audioStatus
readwritenonatomicretain

User's audio status in the meeting.

Definition at line 140 of file MobileRTCMeetingUserInfo.h.

◆ avatarPath

- (NSString* _Nullable) avatarPath
readwritenonatomiccopy

The path to store the head portrait.

Definition at line 132 of file MobileRTCMeetingUserInfo.h.

◆ botAppName

- (NSString* _Nullable) botAppName
readwritenonatomiccopy

Get the bot app name.

Definition at line 239 of file MobileRTCMeetingUserInfo.h.

◆ customerKey

- (NSString* _Nullable) customerKey
readwritenonatomiccopy

The customer key that need the app intergrated with sdk 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 124 of file MobileRTCMeetingUserInfo.h.

◆ emojiFeedbackType

- (MobileRTCEmojiFeedbackType) emojiFeedbackType
readwritenonatomicassign

The emoji feedback type from the user.

Definition at line 176 of file MobileRTCMeetingUserInfo.h.

◆ handRaised

- (BOOL) handRaised
readwritenonatomicassign

The user raised his hand.

Definition at line 144 of file MobileRTCMeetingUserInfo.h.

◆ hasCamera

- (BOOL) hasCamera
readwritenonatomicassign

Query if the participant has a camera.

Definition at line 148 of file MobileRTCMeetingUserInfo.h.

◆ hasRawLiveStreamPrivilege

- (BOOL) hasRawLiveStreamPrivilege
readwritenonatomicassign

Determine whether the user has raw live stream privilege.

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

Definition at line 204 of file MobileRTCMeetingUserInfo.h.

◆ interpreterActiveLanguage

- (NSString* _Nullable) interpreterActiveLanguage
readwritenonatomiccopy

Get interpreter active language.

Definition at line 193 of file MobileRTCMeetingUserInfo.h.

◆ inWaitingRoom

- (BOOL) inWaitingRoom
readwritenonatomicassign

User enter the waiting room when joins the meeting.

Definition at line 152 of file MobileRTCMeetingUserInfo.h.

◆ isBotUser

- (BOOL) isBotUser
readwritenonatomicassign

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

Definition at line 234 of file MobileRTCMeetingUserInfo.h.

◆ isClosedCaptionSender

- (BOOL) isClosedCaptionSender
readwritenonatomicassign

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

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

Definition at line 210 of file MobileRTCMeetingUserInfo.h.

◆ isCohost

- (BOOL) isCohost
readwritenonatomicassign

Query if the current user is the co-host.

Definition at line 156 of file MobileRTCMeetingUserInfo.h.

◆ isCompanionModeUser

- (BOOL) isCompanionModeUser
readwritenonatomicassign

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

Definition at line 220 of file MobileRTCMeetingUserInfo.h.

◆ isH323User

- (BOOL) isH323User
readwritenonatomicassign

Query if the current user is h323 user.

Definition at line 164 of file MobileRTCMeetingUserInfo.h.

◆ isHost

- (BOOL) isHost
readwritenonatomicassign

Query if the current user is the host.

Definition at line 160 of file MobileRTCMeetingUserInfo.h.

◆ isInterpreter

- (BOOL) isInterpreter
readwritenonatomicassign

Determine if user is interpreter.

Definition at line 184 of file MobileRTCMeetingUserInfo.h.

◆ isInWebinarBackstage

- (BOOL) isInWebinarBackstage
readwritenonatomicassign

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

Returns
YES indicates that the specified user is in the webinar backstage.

Definition at line 229 of file MobileRTCMeetingUserInfo.h.

◆ isMySelf

- (BOOL) isMySelf
readwritenonatomicassign

Determine if the information corresponds to the current user.

Definition at line 120 of file MobileRTCMeetingUserInfo.h.

◆ isProductionStudioUser

- (BOOL) isProductionStudioUser
readwritenonatomicassign
Returns
Whether the user is production studio user.

Definition at line 215 of file MobileRTCMeetingUserInfo.h.

◆ isPureCallInUser

- (BOOL) isPureCallInUser
readwritenonatomicassign

Query if the current user is Telephone user.

Definition at line 168 of file MobileRTCMeetingUserInfo.h.

◆ isRawLiveStreaming

- (BOOL) isRawLiveStreaming
readwritenonatomicassign

Determine whether the user has started a raw live stream.

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

Definition at line 199 of file MobileRTCMeetingUserInfo.h.

◆ isSharingPureComputerAudio

- (BOOL) isSharingPureComputerAudio
readwritenonatomicassign

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

Definition at line 172 of file MobileRTCMeetingUserInfo.h.

◆ isSignLanguageInterpreter

- (BOOL) isSignLanguageInterpreter
readwritenonatomicassign

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

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

Definition at line 189 of file MobileRTCMeetingUserInfo.h.

◆ persistentId

- (NSString* _Nullable) persistentId
readwritenonatomiccopy

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.

Definition at line 116 of file MobileRTCMeetingUserInfo.h.

◆ productionStudioParent

- (NSInteger) productionStudioParent
readwritenonatomicassign
Returns
The ID of the parent user of this production user.

Definition at line 224 of file MobileRTCMeetingUserInfo.h.

◆ userID

- (NSUInteger) userID
readwritenonatomicassign

The ID of user.

Definition at line 112 of file MobileRTCMeetingUserInfo.h.

◆ userName

- (NSString* _Nullable) userName
readwritenonatomiccopy

The screen name of user.

Definition at line 128 of file MobileRTCMeetingUserInfo.h.

◆ userRole

- (MobileRTCUserRole) userRole
readwritenonatomicassign

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

Definition at line 180 of file MobileRTCMeetingUserInfo.h.

◆ videoStatus

- (MobileRTCVideoStatus* _Nullable) videoStatus
readwritenonatomicretain

User's video status in the meeting.

Definition at line 136 of file MobileRTCMeetingUserInfo.h.