Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingUserInfo.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7
12@interface MobileRTCVideoStatus : NSObject
13
17@property (nonatomic, assign) BOOL isSending;
18
22@property (nonatomic, assign) BOOL isReceiving;
23
27@property (nonatomic, assign) BOOL isSource;
28
29@end
30
42
47@interface MobileRTCAudioStatus : NSObject
48
52@property (nonatomic, assign) BOOL isMuted;
53
58@property (nonatomic, assign) BOOL isTalking;
59
63@property (nonatomic, assign) MobileRTCAudioType audioType;
64
65@end
66
71@interface MobileRTCVirtualNameTag : NSObject
72
76@property (nonatomic, assign) NSInteger tagID;
77
81@property (nonatomic, copy) NSString * _Nullable tagName;
82@end
83
90
94@property (nonatomic, assign, readonly) MobileRTCDGrantCoOwnerAssetsType type;
95
100@property (nonatomic, assign, readonly) BOOL isAssetsLocked;
101
105@property (nonatomic, assign) BOOL isGranted;
106
107@end
108
109
114@interface MobileRTCMeetingUserInfo : NSObject
115
119@property (nonatomic, assign) NSUInteger userID;
120
124@property (nonatomic, copy) NSString* _Nullable persistentId;
125
129@property (nonatomic, assign) BOOL isMySelf;
130
134@property (nonatomic, copy) NSString* _Nullable customerKey;
135
139@property (nonatomic, copy) NSString* _Nullable userName;
140
144@property (nonatomic, copy) NSString* _Nullable avatarPath;
145
149@property (nonatomic, retain) MobileRTCVideoStatus* _Nullable videoStatus;
150
154@property (nonatomic, retain) MobileRTCAudioStatus* _Nullable audioStatus;
155
159@property (nonatomic, assign) BOOL handRaised;
160
164@property (nonatomic, assign) BOOL hasCamera;
165
169@property (nonatomic, assign) BOOL inWaitingRoom;
170
174@property (nonatomic, assign) BOOL isCohost;
175
179@property (nonatomic, assign) BOOL isHost;
180
184@property (nonatomic, assign) BOOL isH323User;
185
189@property (nonatomic, assign) BOOL isPureCallInUser;
190
194@property (nonatomic, assign) BOOL isSharingPureComputerAudio;
195
199@property (nonatomic, assign) MobileRTCEmojiFeedbackType emojiFeedbackType;
200
204@property (nonatomic, assign) MobileRTCUserRole userRole;
205
209@property (nonatomic, assign) BOOL isInterpreter;
210
214@property (nonatomic, assign) BOOL isSignLanguageInterpreter;
215
219@property (nonatomic, copy) NSString* _Nullable interpreterActiveLanguage;
220
224@property (nonatomic, assign) BOOL isRawLiveStreaming;
225
229@property (nonatomic, assign) BOOL hasRawLiveStreamPrivilege;
230
234@property (nonatomic, assign) BOOL isClosedCaptionSender;
235
239@property (nonatomic, assign) BOOL isProductionStudioUser;
240
244@property (nonatomic, assign) BOOL isCompanionModeUser;
245
249@property (nonatomic, assign) NSInteger productionStudioParent;
250
254@property (nonatomic, assign) BOOL isInWebinarBackstage;
255
259@property (nonatomic, assign) BOOL isBotUser;
260
264@property (nonatomic, copy) NSString* _Nullable botAppName;
265
271
277
284
290
291@end
292
298
302@property (nonatomic, assign) NSUInteger userID;
303
307@property (nonatomic, assign) BOOL isMySelf;
308
312@property (nonatomic, copy) NSString * _Nullable userName;
313
317@property (nonatomic, assign) MobileRTCUserRole userRole;
318
322@property (nonatomic, assign) BOOL handRaised;
323
327@property (nonatomic, assign) BOOL isAttendeeCanTalk;
328
332@property (nonatomic, retain) MobileRTCAudioStatus* _Nullable audioStatus;
333
334@end
MobileRTCDGrantCoOwnerAssetsType
Enumeration of co-owner assets type.
MobileRTCUserRole
Enumeration of user roles.
MobileRTCEmojiFeedbackType
Enumeration of emoji feedback types.
MobileRTCAudioType
Enumeration of the type of a user's audio connection.
@ MobileRTCAudioType_None
@ MobileRTCAudioType_VoIP
@ MobileRTCAudioType_Telephony
A class that contains audio status of the current user in the meeting.
BOOL isTalking
Indicates if the current user is speaking.
MobileRTCAudioType audioType
The audio type of the current meeting.
BOOL isMuted
Indicates if the audio of the current user is muted.
A class that provides properties to specify and manage the privileges associated with different types...
MobileRTCDGrantCoOwnerAssetsType type
Gets the asset type.
BOOL isAssetsLocked
Indicates if the asset is locked.
BOOL isGranted
Gets or sets if the asset is granted.
A class that contains information of the current user in the meeting.
nullable NSArray< MobileRTCGrantCoOwnerAssetsInfo * > * getGrantCoOwnerAssetsInfo()
Queries the granted assets info when assigning a co-owner.
NSString *_Nullable persistentId
Gets the user persistent ID matched with the current user information. This ID persists for the durat...
BOOL isSharingPureComputerAudio
Indicates if the user is sharing only the sounds of computer.
BOOL hasCamera
Indicates if the participant has a camera.
BOOL isVirtualNameTagEnabled()
Queries if the participant enabled virtual name tag.
MobileRTCAudioStatus *_Nullable audioStatus
The user's audio status in the meeting.
NSString *_Nullable userName
The screen name of the user.
NSString *_Nullable interpreterActiveLanguage
Gets the interpreter active language.
BOOL isInWebinarBackstage
Determines whether the user specified by the current information is in the webinar backstage.
BOOL isPureCallInUser
Indicates if the current user is a telephone user.
BOOL isMySelf
Determines if the information corresponds to the current user.
BOOL hasRawLiveStreamPrivilege
Determines whether the user has raw live stream privilege.
BOOL isAudioOnlyUser()
Determines whether the specified user is an audio only user.
BOOL isCohost
Indicates if the current user is the co-host.
MobileRTCVideoStatus *_Nullable videoStatus
The user's video status in the meeting.
BOOL isProductionStudioUser
Indicates whether the user is a production studio user.
BOOL isClosedCaptionSender
Determines whether the user corresponding to the current information is the sender of Closed Caption.
BOOL isCompanionModeUser
Determines whether the user specified by the current information is in companion mode.
MobileRTCEmojiFeedbackType emojiFeedbackType
The emoji feedback type from the user.
BOOL isH323User
Indicates if the current user is an H.323 user.
BOOL isInterpreter
Determines if the user is an interpreter.
NSString *_Nullable avatarPath
The path to store the head portrait.
NSInteger productionStudioParent
The ID of the parent user of this production user.
NSString *_Nullable botAppName
Gets the bot app name.
BOOL isHost
Indicates if the current user is the host.
NSString *_Nullable customerKey
The customer key that the app integrated with SDK needs to specify. The SDK will set this value when ...
BOOL isRawLiveStreaming
Determines whether the user has started a raw live stream.
BOOL isBotUser
Determines whether the user specified by the current information is a bot user.
MobileRTCUserRole userRole
The type of role of the user specified by the current information.
NSArray< MobileRTCVirtualNameTag * > *_Nullable getVirtualNameTagArray()
Queries the virtual name tag roster information.
BOOL isSignLanguageInterpreter
Determines whether the user specified by the current information is a sign language interpreter.
BOOL handRaised
Indicates if the user raised their hand.
BOOL inWaitingRoom
Indicates if the user entered the waiting room when joining the meeting.
A class that contains information of a user in the webinar.
BOOL handRaised
Indicates if the user raised their hand.
BOOL isAttendeeCanTalk
Indicates if the attendee can talk.
MobileRTCAudioStatus *_Nullable audioStatus
The user's audio status in the webinar meeting.
BOOL isMySelf
Determines if the information corresponds to the current user.
MobileRTCUserRole userRole
The type of role of the user specified by the current information.
NSString *_Nullable userName
The screen name of the user.
A class that contains video status of the current user in the meeting.
BOOL isSending
Indicates if the user is sending video.
BOOL isSource
Indicates if the camera is connected to the current meeting.
BOOL isReceiving
Indicates if the user is receiving video.
A class that represents a virtual name tag.
NSString *_Nullable tagName
The tag name.
NSInteger tagID
The tag ID. tagID is the unique identifier. The range of tagID is 0-1024.