Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingUserInfo Class Reference

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

#import <MobileRTCMeetingUserInfo.h>

Inherits NSObject.

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 *_Nonnull userName
 The screen name of user.
 
NSString *_Nonnull avatarPath
 The path to store the head portrait.
 
MobileRTCVideoStatus *_Nonnull videoStatus
 User's video status in the meeting.
 
MobileRTCAudioStatus *_Nonnull 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.
 
MobileRTCFeedbackType feedbackType
 The feedback type from the user.
 
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.
 

Detailed Description

The information of the current user in the meeting.

Definition at line 117 of file MobileRTCMeetingUserInfo.h.

Property Documentation

◆ audioStatus

- (MobileRTCAudioStatus* _Nonnull) audioStatus
readwritenonatomicretain

User's audio status in the meeting.

Definition at line 149 of file MobileRTCMeetingUserInfo.h.

◆ avatarPath

- (NSString* _Nonnull) avatarPath
readwritenonatomicretain

The path to store the head portrait.

Definition at line 141 of file MobileRTCMeetingUserInfo.h.

◆ customerKey

- (NSString* _Nullable) customerKey
readwritenonatomicretain

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 133 of file MobileRTCMeetingUserInfo.h.

◆ emojiFeedbackType

- (MobileRTCEmojiFeedbackType) emojiFeedbackType
readwritenonatomicassign

The emoji feedback type from the user.

Definition at line 189 of file MobileRTCMeetingUserInfo.h.

◆ feedbackType

- (MobileRTCFeedbackType) feedbackType
readwritenonatomicassign

The feedback type from the user.

Definition at line 185 of file MobileRTCMeetingUserInfo.h.

◆ handRaised

- (BOOL) handRaised
readwritenonatomicassign

The user raised his hand.

Definition at line 153 of file MobileRTCMeetingUserInfo.h.

◆ hasCamera

- (BOOL) hasCamera
readwritenonatomicassign

Query if the participant has a camera.

Definition at line 157 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 217 of file MobileRTCMeetingUserInfo.h.

◆ interpreterActiveLanguage

- (NSString* _Nullable) interpreterActiveLanguage
readwritenonatomicretain

Get interpreter active language.

Definition at line 206 of file MobileRTCMeetingUserInfo.h.

◆ inWaitingRoom

- (BOOL) inWaitingRoom
readwritenonatomicassign

User enter the waiting room when joins the meeting.

Definition at line 161 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 223 of file MobileRTCMeetingUserInfo.h.

◆ isCohost

- (BOOL) isCohost
readwritenonatomicassign

Query if the current user is the co-host.

Definition at line 165 of file MobileRTCMeetingUserInfo.h.

◆ isH323User

- (BOOL) isH323User
readwritenonatomicassign

Query if the current user is h323 user.

Definition at line 173 of file MobileRTCMeetingUserInfo.h.

◆ isHost

- (BOOL) isHost
readwritenonatomicassign

Query if the current user is the host.

Definition at line 169 of file MobileRTCMeetingUserInfo.h.

◆ isInterpreter

- (BOOL) isInterpreter
readwritenonatomicassign

Determine if user is interpreter.

Definition at line 197 of file MobileRTCMeetingUserInfo.h.

◆ isMySelf

- (BOOL) isMySelf
readwritenonatomicassign

Determine if the information corresponds to the current user.

Definition at line 129 of file MobileRTCMeetingUserInfo.h.

◆ isPureCallInUser

- (BOOL) isPureCallInUser
readwritenonatomicassign

Query if the current user is Telephone user.

Definition at line 177 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 212 of file MobileRTCMeetingUserInfo.h.

◆ isSharingPureComputerAudio

- (BOOL) isSharingPureComputerAudio
readwritenonatomicassign

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

Definition at line 181 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 202 of file MobileRTCMeetingUserInfo.h.

◆ persistentId

- (NSString* _Nullable) persistentId
readwritenonatomicretain

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 125 of file MobileRTCMeetingUserInfo.h.

◆ userID

- (NSUInteger) userID
readwritenonatomicassign

The ID of user.

Definition at line 121 of file MobileRTCMeetingUserInfo.h.

◆ userName

- (NSString* _Nonnull) userName
readwritenonatomicretain

The screen name of user.

Definition at line 137 of file MobileRTCMeetingUserInfo.h.

◆ userRole

- (MobileRTCUserRole) userRole
readwritenonatomicassign

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

Definition at line 193 of file MobileRTCMeetingUserInfo.h.

◆ videoStatus

- (MobileRTCVideoStatus* _Nonnull) videoStatus
readwritenonatomicretain

User's video status in the meeting.

Definition at line 145 of file MobileRTCMeetingUserInfo.h.