iOS API Doc
Instance Methods | Properties | List of all members
MobileRTCMeetingService Class Reference

The method is an implementation for client to start/join a meeting. More...

#import <MobileRTCMeetingService.h>

Inheritance diagram for MobileRTCMeetingService:

Instance Methods

(MobileRTCMeetError) - startMeetingWithDictionary:
 Start a meeting with parameters in the dictionary. More...
 
(MobileRTCMeetError) - startMeetingWithStartParam:
 Start a meeting with MobileRTCMeetingStartParam parameter. More...
 
(MobileRTCMeetError) - joinMeetingWithDictionary:
 Use it to join a meeting with parameters in a dictionary. More...
 
(MobileRTCMeetError) - handZoomWebUrl:
 Start or join a ZOOM meeting with zoom web url. More...
 
(MobileRTCMeetingState) - getMeetingState
 Get the current meeting state.
More...
 
(void) - leaveMeetingWithCmd:
 End/Leave the current meeting. More...
 
(UIView *) - meetingView
 This method will return the view of meeting UI, which provide an access which allow customer to add their own view in the meeting UI. More...
 
(BOOL) - isDirectAppShareMeeting
 Query if the current meeting is enabled with App share. More...
 
(void) - appShareWithView:
 Share a content. More...
 
(void) - appShareWithReplayKit
 Share content with ReplayKit. More...
 
(BOOL) - startAppShare
 Set to enable App share. More...
 
(void) - stopAppShare
 Set to stop App share.
 
(BOOL) - isStartingShare
 Notify the current user if he is sharing. More...
 
(BOOL) - isViewingShare
 Notify the current user if he is viewing the share. More...
 
(BOOL) - isAnnotationOff
 Notify the current user if he can annotate. More...
 
(BOOL) - suspendSharing:
 suspend sharing. More...
 
(MobileRTCAudioType) - myAudioType
 Get the in-meeting audio type of the current user. More...
 
(BOOL) - connectMyAudio:
 Set whether to connect the audio in the meeting. More...
 
(MobileRTCAudioOutput) - myAudioOutputDescription
 Set to retrieve the audio output type of the current user. More...
 
(BOOL) - isMyAudioMuted
 Query if the audio of the current user is muted. More...
 
(BOOL) - canUnmuteMyAudio
 Query if the user can unmute his audio. More...
 
(BOOL) - isMuteOnEntryOn
 Query if is enabled to mute attendees when they join the meeting. More...
 
(BOOL) - muteOnEntry:
 Set if attendees join the meeting with audio muted. More...
 
(BOOL) - isUserAudioMuted:
 Query if the user's audio is muted. More...
 
(BOOL) - muteUserAudio:withUID:
 Set whether to mute user's audio. More...
 
(BOOL) - muteAllUserAudio:
 Set to mute audio of all attendees. More...
 
(BOOL) - unmuteAllUserAudio
 Set to unmute audio of all attendees. More...
 
(BOOL) - isSupportedVOIP
 Query if the meeting supports VoIP. More...
 
(BOOL) - isPlayChimeOn
 Query if chime is enabled when user joins/leaves meeting. More...
 
(BOOL) - playChime:
 Set whether chime are enabled when the user joins/leaves meeting. More...
 
(MobileRTCAudioError) - muteMyAudio:
 Set to mute the audio of the current user. More...
 
(MobileRTCAudioError) - switchMyAudioSource
 Set to switch audio source of the current user.
 
(void) - resetMeetingAudioSession
 Reset Meeting Audio Session including Category and Mode.
 
(void) - resetMeetingAudioForCallKitHeld
 Reset Meeting Audio Session including Category and Mode. When the call comes in or goes out, click hold or swap in the dial-up UI to restore the zoom sound.
 
(BOOL) - isChatDisabled
 Query if the chat is disabled in the meeting. More...
 
(BOOL) - isPrivateChatDisabled
 Query if it is able to send private chat in the meeting. More...
 
(BOOL) - changeAttendeeChatPriviledge:
 set Attendee Chat Priviledge when in-meeting More...
 
(MobileRTCMeetingChatPriviledgeType) - getAttendeeChatPriviledge
 get Attendee Chat Priviledge when in-meeting More...
 
(nullable MobileRTCMeetingChat *) - meetingChatByID:
 Get in-meeting chat message. More...
 
(MobileRTCSendChatError) - sendChatToUser:WithContent:
 Send chat message to the specified user in the meeting. More...
 
(MobileRTCSendChatError) - sendChatToGroup:WithContent:
 Send message to group in the meeting. More...
 
(void) - customizeMeetingTitle:
 Set to customize the meeting title/topic which will be displayed in the meeting bar. More...
 
(BOOL) - isDialOutSupported
 Query if user can dial out in the meeting. More...
 
(BOOL) - isDialOutInProgress
 Query if there is any outgoing call in process. More...
 
(BOOL) - dialOut:isCallMe:withName:
 Start to dial out. More...
 
(BOOL) - cancelDialOut:
 Cancel to dial out. More...
 
(BOOL) - isCallRoomDeviceSupported
 Query if it is able to Call Room device(H.323). More...
 
(BOOL) - isCallingRoomDevice
 Query if it is in process to call room device. More...
 
(BOOL) - cancelCallRoomDevice
 Cancel to call room device. More...
 
(nullable NSArray *) - getIPAddressList
 Get an array of IP Addresses of room device which is used for calling. More...
 
(nullable NSString *) - getH323MeetingPassword
 Get the password of the meeting running on H.323 device. More...
 
(nullable NSArray *) - getRoomDeviceList
 Get room devices that can be called. More...
 
(BOOL) - sendPairingCode:WithMeetingNumber:
 Get the pairing code when the room device call in. More...
 
(BOOL) - callRoomDevice:
 The user calls out to invite the room device. More...
 
(NSUInteger) - getParticipantID
 Get Participant ID. More...
 
(nullable MobileRTCCallCountryCode *) - getDialInCurrentCountryCode
 Get countrycode for the current user's locale. More...
 
(nullable NSArray *) - getDialInAllCountryCodes
 Get all countrycodes. More...
 
(nullable NSArray *) - getDialInCallCodesWithCountryId:
 Get to the countrycode specified by countryId. More...
 
(BOOL) - dialInCall:
 Make a phone call to access your voice. More...
 
(BOOL) - isMeetingHost
 Query if the current user is the host of the meeting. More...
 
(BOOL) - isMeetingCoHost
 Query if the current user is the co-host of the meeting. More...
 
(BOOL) - isMeetingLocked
 Notify if the meeting is locked by host. Once the meeting is locked, other users out of the meeting can no longer join it. More...
 
(BOOL) - isShareLocked
 Notify if the share is locked by host. Once the meeting is locked by the host/co-host, other user can not share except the host/co-host. More...
 
(BOOL) - isCMREnabled
 Notify if the cloud recording is enabled. More...
 
(BOOL) - isCMRInProgress
 Notify if the cloud recording is in progress. More...
 
(BOOL) - isCMRPaused
 Notify if the cloud recording is paused. More...
 
(BOOL) - resumePauseCMR
 Set to pause/resume cloud recording in the meeting. More...
 
(void) - turnOnCMR:
 Set to turn on/off the cloud recording in the meeting. More...
 
(BOOL) - handleE2EMeetingKey:withLeaveMeeting:
 Set custom meeting session key. More...
 
(BOOL) - isExternalMeeting
 Query if the meeting is external or not. More...
 
(BOOL) - isInternalMeeting
 Query if the meeting is internal or not. More...
 
(BOOL) - isFailoverMeeting
 Query if the meeting is failover. More...
 
(BOOL) - isWebinarMeeting
 Query if the meeting is Webinar. More...
 
(BOOL) - lockMeeting:
 Set to lock the meeting. More...
 
(BOOL) - lockShare:
 Set to lock the share. More...
 
(MobileRTCNetworkQuality) - queryNetworkQuality:withDataFlow:
 Check in-meeting network status. More...
 
(BOOL) - presentMeetingChatViewController:userId:
 Set to present Zoom original Meeting Chat ViewController. More...
 
(BOOL) - presentParticipantsViewController:
 Set to present Zoom original Participants ViewController. More...
 
(BOOL) - configDSCPWithAudioValue:VideoValue:
 Configure DSCP values for audio and video. More...
 
(BOOL) - hideFullPhoneNumberForPureCallInUser:
 Set to hide the Full Phone Number of purely Call-in User. More...
 
(BOOL) - startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:
 Set to start Live Stream. More...
 
(nullable NSDictionary *) - getLiveStreamURL
 Get live stream server URL. More...
 
(BOOL) - stopLiveStream
 Set to stop live streaming. More...
 
(BOOL) - showMobileRTCMeeting:
 Set to show UI of meeting. More...
 
(BOOL) - hideMobileRTCMeeting:
 Set to hide the UI of meeting. More...
 
(BOOL) - isQAEnabled
 Query if Q&A is enabled. More...
 
(BOOL) - presentQAViewController:
 Set to present Zoom original Q&A ViewController. More...
 
(void) - showMeetingControlBar
 If you add a full-screen view to our zoom meeting UI, you can display the control bar by this method when the control bar is hidden. More...
 
(BOOL) - changeName:withUserID:
 Set to change user's screen name in meeting. More...
 
(nullable NSArray *) - getInMeetingUserList
 Get all the users in the meeting. More...
 
(nullable NSArray *) - getWebinarAttendeeList
 Get all the attendees in the webinar. More...
 
(nullable MobileRTCMeetingUserInfo *) - userInfoByID:
 Get user information in the meeting. More...
 
(nullable MobileRTCMeetingWebinarAttendeeInfo *) - attendeeInfoByID:
 Get attendees' information in the webinar. More...
 
(BOOL) - makeHost:
 Assign a user as the host in meeting. More...
 
(BOOL) - removeUser:
 Remove a user from the meeting. More...
 
(NSUInteger) - myselfUserID
 Get the ID of the current user in the meeting. More...
 
(NSUInteger) - activeUserID
 Get the ID of the active user in the meeting. More...
 
(NSUInteger) - activeShareUserID
 Get the ID of user who is sharing in the meeting. More...
 
(BOOL) - isSameUser:compareTo:
 Judge if the two IDs from different sessions are of the same user. More...
 
(BOOL) - isHostUser:
 Query if the user is host. More...
 
(BOOL) - isMyself:
 Query if the ID is the current user's.
More...
 
(BOOL) - raiseMyHand
 Raise hand of the current user. More...
 
(BOOL) - lowerHand:
 Put hands down of the current user. More...
 
(BOOL) - lowerAllHand
 Set to put all users' hands down. More...
 
(BOOL) - claimHostWithHostKey:
 Set to claim to be a host by host key. More...
 
(BOOL) - assignCohost:
 Assign a user as co-host in meeting. More...
 
(BOOL) - revokeCoHost:
 Revoke co-host role of another user in meeting. More...
 
(BOOL) - canBeCoHost:
 Query if the user can be assigned as co-host in meeting. More...
 
(BOOL) - isSendingMyVideo
 Query if the user is sending video.
More...
 
(BOOL) - canUnmuteMyVideo
 Query if user can unmute his video himself. More...
 
(MobileRTCVideoError) - muteMyVideo:
 Set to mute video of the current user. More...
 
(BOOL) - isUserSpotlighted:
 Query if user's video is spotlighted. Once the user's video is spotlighted, it will show only the specified video in the meeting instead of active user's.
More...
 
(BOOL) - spotlightVideo:withUser:
 Set whether to spotlight user's video. More...
 
(BOOL) - isUserPinned:
 Query if the user's video is pinned. More...
 
(BOOL) - pinVideo:withUser:
 Set whether to pin user's video or not. More...
 
(BOOL) - isUserVideoSending:
 Query if user's video is being sent. More...
 
(BOOL) - stopUserVideo:
 Set to stop user's video. More...
 
(BOOL) - askUserStartVideo:
 Host can use this function to demand user to start video. More...
 
(CGSize) - getUserVideoSize:
 Get the size of user's video. More...
 
(BOOL) - isBackCamera
 Query if user is using back camera. More...
 
(MobileRTCCameraError) - switchMyCamera
 Set to Switch the camera of the current user in local device. More...
 
(BOOL) - hasPromptAndDePromptPrivilige
 Query if the user has the privilege to prompt or demote users in the webinar. More...
 
(BOOL) - promptAttendee2Panelist:
 Prompt Attendee to Panelist in Webinar. More...
 
(BOOL) - dePromptPanelist2Attendee:
 Demote the panelist to attendee. More...
 
(BOOL) - allowAttendeeChat:
 Allow attendee to chat. More...
 
(BOOL) - isAllowAttendeeTalk:
 Query if attendee is allowed to talk in Webinar Meeting. More...
 
(BOOL) - allowAttenddeTalk:allow:
 Allow attendee to talk in webinar. More...
 
(BOOL) - isAllowPanelistStartVideo
 Query if Panelist can start video in Webinar Meeting. More...
 
(BOOL) - allowPanelistStartVideo:
 Allow Panelist to start video in Webinar. More...
 
(BOOL) - isAllowAskQuestionAnonymously
 Query if it is allowed to ask question anonymously in webinar. More...
 
(BOOL) - allowAskQuestionAnonymously:
 Set if it is enabled to ask questions anonymously. More...
 
(BOOL) - isAllowAttendeeViewAllQuestion
 Query if attendee is allowed to view all question. More...
 
(BOOL) - allowAttendeeViewAllQuestion:
 Allow attendee to view all question. More...
 
(BOOL) - isAllowAttendeeUpVoteQuestion
 Query if attendee is allowed to submit questions. More...
 
(BOOL) - allowAttendeeUpVoteQuestion:
 Allow attendee to submit questions. More...
 
(BOOL) - isAllowAttendeeAnswerQuestion
 Query if attendee is allowed to answer questions. More...
 
(BOOL) - allowAttendeeAnswerQuestion:
 Allow attendee to answer question. More...
 

Properties

id< MobileRTCMeetingServiceDelegatedelegate
 Callback of receiving meeting events.

 
id< MobileRTCCustomizedUIMeetingDelegatecustomizedUImeetingDelegate
 Callback of receiving meeting events for custom UI.
 

Detailed Description

The method is an implementation for client to start/join a meeting.

Warning
The meeting service allows only one concurrent operation at a time, which means, only one API call is in progress at any given time.

Method Documentation

◆ activeShareUserID()

- (NSUInteger) activeShareUserID

Get the ID of user who is sharing in the meeting.

Returns
The ID of user who is sharing in the meeting.

Provided by category MobileRTCMeetingService(User).

◆ activeUserID()

- (NSUInteger) activeUserID

Get the ID of the active user in the meeting.

Returns
Active user ID.

Provided by category MobileRTCMeetingService(User).

◆ allowAskQuestionAnonymously:()

- (BOOL) allowAskQuestionAnonymously: (BOOL)  enable

Set if it is enabled to ask questions anonymously.

Parameters
EnableEnable/Disable to ask questions anonymously.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run this function.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttenddeTalk:allow:()

- (BOOL) allowAttenddeTalk: (NSUInteger)  userID
allow: (BOOL)  enable 

Allow attendee to talk in webinar.

Parameters
userIdThe ID of user to be allowed
enableEnable/Disable to talk
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeAnswerQuestion:()

- (BOOL) allowAttendeeAnswerQuestion: (BOOL)  enable

Allow attendee to answer question.

Parameters
EnableAllow/Disallow attendee to answer question.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeChat:()

- (BOOL) allowAttendeeChat: (MobileRTCChatAllowAttendeeChat)  privilegeType

Allow attendee to chat.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeUpVoteQuestion:()

- (BOOL) allowAttendeeUpVoteQuestion: (BOOL)  enable

Allow attendee to submit questions.

Parameters
EnableAllow/Disallow attendee to submit question.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeViewAllQuestion:()

- (BOOL) allowAttendeeViewAllQuestion: (BOOL)  enable

Allow attendee to view all question.

Parameters
EnableEnable/Disable attendee to view all questions.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run this function.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowPanelistStartVideo:()

- (BOOL) allowPanelistStartVideo: (BOOL)  enable

Allow Panelist to start video in Webinar.

Parameters
enableEnable/Disable Panelist to start video.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ appShareWithReplayKit()

- (void) appShareWithReplayKit

Share content with ReplayKit.

Warning
Available only for iOS 11 version minimum.
Once the interface has been called, the view will be updated 2.5s later than the operation. ReplayKit won't send the view out if the UI content does not change.

Provided by category MobileRTCMeetingService(AppShare).

◆ appShareWithView:()

- (void) appShareWithView: (nonnull id)  view

Share a content.

Parameters
viewThe view shared.
Warning
view, recommend to pass a single UIView's object, such as UIView, UIImageView or WKWebView.
It is not recommended to pass UIView after add subview WKWebView or UIImageView.

Provided by category MobileRTCMeetingService(AppShare).

◆ askUserStartVideo:()

- (BOOL) askUserStartVideo: (NSUInteger)  userID

Host can use this function to demand user to start video.

Parameters
userIDThe ID of user who needs to turn on video in meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only host can run the function in the meeting.

Provided by category MobileRTCMeetingService(Video).

◆ assignCohost:()

- (BOOL) assignCohost: (NSUInteger)  userID

Assign a user as co-host in meeting.

Returns
YES means that the method is called successfully, otherwise not.
Warning
The co-host cannot be assigned as co-host by himself. And the user should have the power to assign the role.

Provided by category MobileRTCMeetingService(User).

◆ attendeeInfoByID:()

- (nullable MobileRTCMeetingWebinarAttendeeInfo*) attendeeInfoByID: (NSUInteger)  userId

Get attendees' information in the webinar.

Parameters
userIdattendee's ID in meeting.
Returns
attendee info, a MobileRTCMeetingWebinarAttendeeInfo object.

Provided by category MobileRTCMeetingService(User).

◆ callRoomDevice:()

- (BOOL) callRoomDevice: (nonnull MobileRTCRoomDevice *)  device

The user calls out to invite the room device.

Parameters
deviceThe room device.
Returns
YES means the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ canBeCoHost:()

- (BOOL) canBeCoHost: (NSUInteger)  userID

Query if the user can be assigned as co-host in meeting.

Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(User).

◆ cancelCallRoomDevice()

- (BOOL) cancelCallRoomDevice

Cancel to call room device.

Returns
YES means the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ cancelDialOut:()

- (BOOL) cancelDialOut: (BOOL)  isCallMe

Cancel to dial out.

Parameters
isCallMeYES means Call Me; NO means inviting others by Phone.
Returns
YES means the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ canUnmuteMyAudio()

- (BOOL) canUnmuteMyAudio

Query if the user can unmute his audio.

Returns
YES means that he can unmute his audio, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ canUnmuteMyVideo()

- (BOOL) canUnmuteMyVideo

Query if user can unmute his video himself.

Returns
YES means able, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ changeAttendeeChatPriviledge:()

- (BOOL) changeAttendeeChatPriviledge: (MobileRTCMeetingChatPriviledgeType)  type

set Attendee Chat Priviledge when in-meeting

Returns
YES means sucessfull, otherwise not.

Provided by category MobileRTCMeetingService(Chat).

◆ changeName:withUserID:()

- (BOOL) changeName: (nonnull NSString *)  inputName
withUserID: (NSUInteger)  userId 

Set to change user's screen name in meeting.

Parameters
inputNameThe screen name displayed in meeting.
userIdUser ID.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Normal user can change his own screen name, while the host/co-host can change all attendees' names.

Provided by category MobileRTCMeetingService(User).

◆ claimHostWithHostKey:()

- (BOOL) claimHostWithHostKey: (nonnull NSString *)  hostKey

Set to claim to be a host by host key.

Parameters
hostKeyHost key.
Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(User).

◆ configDSCPWithAudioValue:VideoValue:()

- (BOOL) configDSCPWithAudioValue: (NSUInteger)  audioValue
VideoValue: (NSUInteger)  videoValue 

Configure DSCP values for audio and video.

Parameters
audioValueAudio values in the meeting.
videoValueVideo values in the meeting
Returns
YES means that the method is called successfully, otherwise not.
Warning
The function should be invoked before meeting starts.

Provided by category MobileRTCMeetingService(InMeeting).

◆ connectMyAudio:()

- (BOOL) connectMyAudio: (BOOL)  on

Set whether to connect the audio in the meeting.

Parameters
onYES means to connect, otherwise not.
Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ customizeMeetingTitle:()

- (void) customizeMeetingTitle: (NSString *)  title

Set to customize the meeting title/topic which will be displayed in the meeting bar.

Parameters
titleThe topic/title of the meeting.
Warning
User should call the method before starting or joining the meeting if he wants to reset the title/topic of the meeting.

Provided by category MobileRTCMeetingService(Customize).

◆ dePromptPanelist2Attendee:()

- (BOOL) dePromptPanelist2Attendee: (NSUInteger)  userID

Demote the panelist to attendee.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ dialInCall:()

- (BOOL) dialInCall: (nullable NSString *)  countryNumber

Make a phone call to access your voice.

Returns
YES means the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ dialOut:isCallMe:withName:()

- (BOOL) dialOut: (nonnull NSString *)  phone
isCallMe: (BOOL)  me
withName: (nullable NSString *)  username 

Start to dial out.

Parameters
phoneThe phone number of destination, you should add the country code in front of the phone number, such as +86123456789.
meYES means Call Me; NO means inviting others by Phone.
usernameThe name of the user to be called.
Returns
YES means the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ getAttendeeChatPriviledge()

- (MobileRTCMeetingChatPriviledgeType) getAttendeeChatPriviledge

get Attendee Chat Priviledge when in-meeting

Returns
the result of attendee chat priviledge;

Provided by category MobileRTCMeetingService(Chat).

◆ getDialInAllCountryCodes()

- (nullable NSArray *) getDialInAllCountryCodes

Get all countrycodes.

Returns
The array of all countrycode.

Provided by category MobileRTCMeetingService(Customize).

◆ getDialInCallCodesWithCountryId:()

- (nullable NSArray *) getDialInCallCodesWithCountryId: (nullable NSString *)  countryId

Get to the countrycode specified by countryId.

Returns
The array of countrycode.

Provided by category MobileRTCMeetingService(Customize).

◆ getDialInCurrentCountryCode()

- (nullable MobileRTCCallCountryCode *) getDialInCurrentCountryCode

Get countrycode for the current user's locale.

Returns
The object of MobileRTCCallCountryCode for user's locale.

Provided by category MobileRTCMeetingService(Customize).

◆ getH323MeetingPassword()

- (nullable NSString*) getH323MeetingPassword

Get the password of the meeting running on H.323 device.

Returns
The meeting password. If no meeting is running, it will return nil.

Provided by category MobileRTCMeetingService(Customize).

◆ getInMeetingUserList()

- (nullable NSArray*) getInMeetingUserList

Get all the users in the meeting.

Returns
user id array, each user id is a NSNumber object.
Warning
For Webinar Meeting, returned list does not include Attendee User

Provided by category MobileRTCMeetingService(User).

◆ getIPAddressList()

- (nullable NSArray*) getIPAddressList

Get an array of IP Addresses of room device which is used for calling.

Returns
The array of IP Address; if there is no existed IP Address, it will return nil.

Provided by category MobileRTCMeetingService(Customize).

◆ getLiveStreamURL()

- (nullable NSDictionary*) getLiveStreamURL

Get live stream server URL.

Returns
The dictionary of live stream URL if the function succeeds.
Warning
The function is available only for host. For Facebook Live Stream Service, fb_workplace action the key in Dictionary For Custom Live Stream Service, custom action the key in Dictionary

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMeetingState()

- (MobileRTCMeetingState) getMeetingState

Get the current meeting state.

Returns
Current meeting state.

◆ getParticipantID()

- (NSUInteger) getParticipantID

Get Participant ID.

Returns
The Participant ID.

Provided by category MobileRTCMeetingService(Customize).

◆ getRoomDeviceList()

- (nullable NSArray*) getRoomDeviceList

Get room devices that can be called.

Returns
The array of room devices. If there is no any room device. it will return nil.

Provided by category MobileRTCMeetingService(Customize).

◆ getUserVideoSize:()

- (CGSize) getUserVideoSize: (NSUInteger)  userID

Get the size of user's video.

Parameters
userIDThe ID of user in the meeting
Returns
The size of user's video.

Provided by category MobileRTCMeetingService(Video).

◆ getWebinarAttendeeList()

- (nullable NSArray*) getWebinarAttendeeList

Get all the attendees in the webinar.

Returns
user id array, each Attendee id is a NSNumber object.

Provided by category MobileRTCMeetingService(User).

◆ handleE2EMeetingKey:withLeaveMeeting:()

- (BOOL) handleE2EMeetingKey: (nonnull NSArray *)  keyArray
withLeaveMeeting: (BOOL)  leave 

Set custom meeting session key.

Parameters
keyArrayThe array of meeting session keys.
leaveYES means leaving meeting directly, otherwise not.
Returns
YES means that the method is called successfully, otherwise not.
Warning
The method is optional.

Provided by category MobileRTCMeetingService(InMeeting).

◆ handZoomWebUrl:()

- (MobileRTCMeetError) handZoomWebUrl: (nonnull NSString *)  meetingUrl

Start or join a ZOOM meeting with zoom web url.

Parameters
meetingUrlzoom web meeting url.
Returns
The state of the meeting, started or failed.

◆ hasPromptAndDePromptPrivilige()

- (BOOL) hasPromptAndDePromptPrivilige

Query if the user has the privilege to prompt or demote users in the webinar.

Returns
YES means that user owns the privilege, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ hideFullPhoneNumberForPureCallInUser:()

- (BOOL) hideFullPhoneNumberForPureCallInUser: (BOOL)  bHide

Set to hide the Full Phone Number of purely Call-in User.

Parameters
bHideYES means hide, otherwise not.
Returns
YES means that the method is called successfully, otherwise not.
Warning
The method should be invoked before meeting starts.

Provided by category MobileRTCMeetingService(InMeeting).

◆ hideMobileRTCMeeting:()

- (BOOL) hideMobileRTCMeeting: (void(^)(void))  completion

Set to hide the UI of meeting.

Parameters
completionUser can do other operations once the meeting UI hide.
Returns
YES means that the method is called successfully, otherwise not.
Warning
The method does not work if you have set mobileRTCRootController via [MobileRTC setMobileRTCRootController]

Provided by category MobileRTCMeetingService(InMeeting).

◆ isAllowAskQuestionAnonymously()

- (BOOL) isAllowAskQuestionAnonymously

Query if it is allowed to ask question anonymously in webinar.

Returns
YES means allowed, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowAttendeeAnswerQuestion()

- (BOOL) isAllowAttendeeAnswerQuestion

Query if attendee is allowed to answer questions.

Returns
YES means allowed, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowAttendeeTalk:()

- (BOOL) isAllowAttendeeTalk: (NSUInteger)  userID

Query if attendee is allowed to talk in Webinar Meeting.

Parameters
userIdThe ID of user to be allowed.
Returns
YES means allowed, otherwise not.
Warning
Only meeting host/co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowAttendeeUpVoteQuestion()

- (BOOL) isAllowAttendeeUpVoteQuestion

Query if attendee is allowed to submit questions.

Returns
YES means allowed, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowAttendeeViewAllQuestion()

- (BOOL) isAllowAttendeeViewAllQuestion

Query if attendee is allowed to view all question.

Returns
YES means allowed, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowPanelistStartVideo()

- (BOOL) isAllowPanelistStartVideo

Query if Panelist can start video in Webinar Meeting.

Returns
YES means able, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAnnotationOff()

- (BOOL) isAnnotationOff

Notify the current user if he can annotate.

Returns
YES means able, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ isBackCamera()

- (BOOL) isBackCamera

Query if user is using back camera.

Returns
YES means using Back camera, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isCallingRoomDevice()

- (BOOL) isCallingRoomDevice

Query if it is in process to call room device.

Returns
YES means calling room device in process, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ isCallRoomDeviceSupported()

- (BOOL) isCallRoomDeviceSupported

Query if it is able to Call Room device(H.323).

Returns
YES means able, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ isChatDisabled()

- (BOOL) isChatDisabled

Query if the chat is disabled in the meeting.

Returns
YES means disabled, otherwise not.

Provided by category MobileRTCMeetingService(Chat).

◆ isCMREnabled()

- (BOOL) isCMREnabled

Notify if the cloud recording is enabled.

Returns
YES means enabled, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isCMRInProgress()

- (BOOL) isCMRInProgress

Notify if the cloud recording is in progress.

Returns
YES means the cloud recording is in progress, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isCMRPaused()

- (BOOL) isCMRPaused

Notify if the cloud recording is paused.

Returns
YES means that the cloud recording is paused, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isDialOutInProgress()

- (BOOL) isDialOutInProgress

Query if there is any outgoing call in process.

Returns
YES means that there is outgoing call in process.

Provided by category MobileRTCMeetingService(Customize).

◆ isDialOutSupported()

- (BOOL) isDialOutSupported

Query if user can dial out in the meeting.

Returns
YES means able, No disable.

Provided by category MobileRTCMeetingService(Customize).

◆ isDirectAppShareMeeting()

- (BOOL) isDirectAppShareMeeting

Query if the current meeting is enabled with App share.

Returns
YES means that meeting starts by App share, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ isExternalMeeting()

- (BOOL) isExternalMeeting

Query if the meeting is external or not.

Returns
YES means external, otherwise not.
Warning
The method is optional.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isFailoverMeeting()

- (BOOL) isFailoverMeeting

Query if the meeting is failover.

Returns
YES means failover, otherwise not.
Warning
The method is optional.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isHostUser:()

- (BOOL) isHostUser: (NSUInteger)  userID

Query if the user is host.

Parameters
userIDThe ID of user.
Returns
YES means that the user is the host, otherwise not.

Provided by category MobileRTCMeetingService(User).

◆ isInternalMeeting()

- (BOOL) isInternalMeeting

Query if the meeting is internal or not.

Returns
YES means internal, otherwise not.
Warning
The method is optional.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingCoHost()

- (BOOL) isMeetingCoHost

Query if the current user is the co-host of the meeting.

Returns
YES means that the current user is the co-host of the meeting, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingHost()

- (BOOL) isMeetingHost

Query if the current user is the host of the meeting.

Returns
YES means that the current user is the host of the meeting, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingLocked()

- (BOOL) isMeetingLocked

Notify if the meeting is locked by host. Once the meeting is locked, other users out of the meeting can no longer join it.

Returns
YES means that the meeting is locked by host, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMuteOnEntryOn()

- (BOOL) isMuteOnEntryOn

Query if is enabled to mute attendees when they join the meeting.

Returns
YES means enabled, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isMyAudioMuted()

- (BOOL) isMyAudioMuted

Query if the audio of the current user is muted.

Returns
YES means muted, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isMyself:()

- (BOOL) isMyself: (NSUInteger)  userID

Query if the ID is the current user's.

Parameters
userIDThe ID of user to be checked.
Returns
TRUE means user himself. FALSE not.

Provided by category MobileRTCMeetingService(User).

◆ isPlayChimeOn()

- (BOOL) isPlayChimeOn

Query if chime is enabled when user joins/leaves meeting.

Returns
YES means enabled, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isPrivateChatDisabled()

- (BOOL) isPrivateChatDisabled

Query if it is able to send private chat in the meeting.

Returns
YES means disabled, otherwise not.

Provided by category MobileRTCMeetingService(Chat).

◆ isQAEnabled()

- (BOOL) isQAEnabled

Query if Q&A is enabled.

Returns
YES means that Q&A is enabled, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isSameUser:compareTo:()

- (BOOL) isSameUser: (NSUInteger)  user1
compareTo: (NSUInteger)  user2 

Judge if the two IDs from different sessions are of the same user.

Parameters
user1One user ID in meeting
user2Another user ID in meeting
Returns
YES means the same user.

Provided by category MobileRTCMeetingService(User).

◆ isSendingMyVideo()

- (BOOL) isSendingMyVideo

Query if the user is sending video.

Returns
YES means sending, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isShareLocked()

- (BOOL) isShareLocked

Notify if the share is locked by host. Once the meeting is locked by the host/co-host, other user can not share except the host/co-host.

Returns
YES means that the screen share is locked by host, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isStartingShare()

- (BOOL) isStartingShare

Notify the current user if he is sharing.

Returns
YES means that the current user is sharing, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ isSupportedVOIP()

- (BOOL) isSupportedVOIP

Query if the meeting supports VoIP.

Returns
YES means supported, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isUserAudioMuted:()

- (BOOL) isUserAudioMuted: (NSUInteger)  userID

Query if the user's audio is muted.

Parameters
userIDThe ID of user to be checked.
Returns
YES means muted, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isUserPinned:()

- (BOOL) isUserPinned: (NSUInteger)  userId

Query if the user's video is pinned.

Parameters
userIdThe ID of user whose video will be pinned in the meeting.
Returns
YES means that the user's video is pinned, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isUserSpotlighted:()

- (BOOL) isUserSpotlighted: (NSUInteger)  userId

Query if user's video is spotlighted. Once the user's video is spotlighted, it will show only the specified video in the meeting instead of active user's.

Parameters
userIdThe ID of user in meeting.
Returns
YES means spotlighted, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isUserVideoSending:()

- (BOOL) isUserVideoSending: (NSUInteger)  userID

Query if user's video is being sent.

Parameters
userIDThe ID of user whose video will be sent in meeting
Returns
YES means that the video is being sent, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isViewingShare()

- (BOOL) isViewingShare

Notify the current user if he is viewing the share.

Returns
YES means that user is viewing the share, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ isWebinarMeeting()

- (BOOL) isWebinarMeeting

Query if the meeting is Webinar.

Returns
YES means Webinar, otherwise not.
Warning
It will return NO as MobileRTCMeetingState is not equal to MobileRTCMeetingState_InMeeting.

Provided by category MobileRTCMeetingService(InMeeting).

◆ joinMeetingWithDictionary:()

- (MobileRTCMeetError) joinMeetingWithDictionary: (nonnull NSDictionary *)  dict

Use it to join a meeting with parameters in a dictionary.

Parameters
dictThe dictionary which contains the meeting parameters.
Returns
The state of the meeting, started or failed.
Warning
If app is in callkit mode, set parameter:kMeetingParam_Username to empty. CallKit lets you integrate your calling services with other call-related apps on the system.

◆ leaveMeetingWithCmd:()

- (void) leaveMeetingWithCmd: (LeaveMeetingCmd)  cmd

End/Leave the current meeting.

Parameters
cmdThe command for leaving the current meeting. Only host can end the meeting.

◆ lockMeeting:()

- (BOOL) lockMeeting: (BOOL)  lock

Set to lock the meeting.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can call the function.

Provided by category MobileRTCMeetingService(InMeeting).

◆ lockShare:()

- (BOOL) lockShare: (BOOL)  lock

Set to lock the share.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can call the function.

Provided by category MobileRTCMeetingService(InMeeting).

◆ lowerAllHand()

- (BOOL) lowerAllHand

Set to put all users' hands down.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function.

Provided by category MobileRTCMeetingService(User).

◆ lowerHand:()

- (BOOL) lowerHand: (NSUInteger)  userId

Put hands down of the current user.

Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(User).

◆ makeHost:()

- (BOOL) makeHost: (NSUInteger)  userId

Assign a user as the host in meeting.

Parameters
userIdThe ID of user who is specified as host in meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
only meeting host can run this function, and userId should not be myself.

Provided by category MobileRTCMeetingService(User).

◆ meetingChatByID:()

- (nullable MobileRTCMeetingChat*) meetingChatByID: (nonnull NSString *)  messageID

Get in-meeting chat message.

Parameters
messageIDThe ID of the message sent in the meeting.
Returns
The instance of in-meeting chat.
Warning
The method is optional.

Provided by category MobileRTCMeetingService(Chat).

◆ meetingView()

- (UIView*) meetingView

This method will return the view of meeting UI, which provide an access which allow customer to add their own view in the meeting UI.

Returns
The view of current meeting; if there is no ongoing meeting, it will return nil.
Warning
Only valid in non-custom UI(Only valid in ZOOM meeting UI).

◆ muteAllUserAudio:()

- (BOOL) muteAllUserAudio: (BOOL)  allowSelfUnmute

Set to mute audio of all attendees.

Parameters
allowSelfUnmuteYES means that attendee can unmute the audio himself, otherwise not.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function.

Provided by category MobileRTCMeetingService(Audio).

◆ muteMyAudio:()

- (MobileRTCAudioError) muteMyAudio: (BOOL)  mute

Set to mute the audio of the current user.

Parameters
muteYES means the audio is muted, otherwise not.
Returns
The result of operation, muted or not.

Provided by category MobileRTCMeetingService(Audio).

◆ muteMyVideo:()

- (MobileRTCVideoError) muteMyVideo: (BOOL)  mute

Set to mute video of the current user.

Parameters
muteYES means to mute video of the current user, otherwise not.
Returns
The result of operation.

Provided by category MobileRTCMeetingService(Video).

◆ muteOnEntry:()

- (BOOL) muteOnEntry: (BOOL)  on

Set if attendees join the meeting with audio muted.

Returns
YES means muted, otherwise not.
Warning
Only meeting host can run the function.

Provided by category MobileRTCMeetingService(Audio).

◆ muteUserAudio:withUID:()

- (BOOL) muteUserAudio: (BOOL)  mute
withUID: (NSUInteger)  userID 

Set whether to mute user's audio.

Parameters
muteYES means to mute, otherwise not.
userIDThe ID of user.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function.

Provided by category MobileRTCMeetingService(Audio).

◆ myAudioOutputDescription()

- (MobileRTCAudioOutput) myAudioOutputDescription

Set to retrieve the audio output type of the current user.

Returns
The descriptions of audio output types.

Provided by category MobileRTCMeetingService(Audio).

◆ myAudioType()

- (MobileRTCAudioType) myAudioType

Get the in-meeting audio type of the current user.

Returns
The audio type.

Provided by category MobileRTCMeetingService(Audio).

◆ myselfUserID()

- (NSUInteger) myselfUserID

Get the ID of the current user in the meeting.

Returns
The ID of the current user.

Provided by category MobileRTCMeetingService(User).

◆ pinVideo:withUser:()

- (BOOL) pinVideo: (BOOL)  on
withUser: (NSUInteger)  userId 

Set whether to pin user's video or not.

Parameters
onYES means to pin user's video, otherwise not.
userIdThe ID of user whose video will be pinned.
Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ playChime:()

- (BOOL) playChime: (BOOL)  on

Set whether chime are enabled when the user joins/leaves meeting.

Returns
YES means enabled, otherwise not.
Warning
Only meeting host/cohost can run the function when in meeting.

Provided by category MobileRTCMeetingService(Audio).

◆ presentMeetingChatViewController:userId:()

- (BOOL) presentMeetingChatViewController: (nonnull UIViewController *)  parentVC
userId: (NSInteger)  userId 

Set to present Zoom original Meeting Chat ViewController.

Parameters
parentVCwhich use to present ViewController.
userIduserId of the user you would like to chat.
Returns
YES means that the method is called successfully, otherwise not.
Warning
If userId = 0 or nil, it will send to everyone.

Provided by category MobileRTCMeetingService(InMeeting).

◆ presentParticipantsViewController:()

- (BOOL) presentParticipantsViewController: (nonnull UIViewController *)  parentVC

Set to present Zoom original Participants ViewController.

Parameters
parentVCwhich use to present ViewController
Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ presentQAViewController:()

- (BOOL) presentQAViewController: (nonnull UIViewController *)  parentVC

Set to present Zoom original Q&A ViewController.

Parameters
parentVCwhich use to present ViewController
Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ promptAttendee2Panelist:()

- (BOOL) promptAttendee2Panelist: (NSUInteger)  userID

Prompt Attendee to Panelist in Webinar.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host/co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ queryNetworkQuality:withDataFlow:()

- (MobileRTCNetworkQuality) queryNetworkQuality: (MobileRTCComponentType)  type
withDataFlow: (BOOL)  sending 

Check in-meeting network status.

Parameters
typeMeeting component types, now we can only query three components network status: MobileRTCComponentType_AUDIO, MobileRTCComponentType_VIDEO and MobileRTCComponentType_AS
sending,ifYES means that query sending data; if NO means that query receiving data
Returns
the level of network quality.
Warning
The method is optional, you can query the network quality of audio, video and sharing.

Provided by category MobileRTCMeetingService(InMeeting).

◆ raiseMyHand()

- (BOOL) raiseMyHand

Raise hand of the current user.

Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(User).

◆ removeUser:()

- (BOOL) removeUser: (NSUInteger)  userId

Remove a user from the meeting.

Parameters
userIdThe ID of user to be removed from the meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
The method is available only for the host, and the host can not remove himself.

Provided by category MobileRTCMeetingService(User).

◆ resumePauseCMR()

- (BOOL) resumePauseCMR

Set to pause/resume cloud recording in the meeting.

Returns
YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ revokeCoHost:()

- (BOOL) revokeCoHost: (NSUInteger)  userID

Revoke co-host role of another user in meeting.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function.

Provided by category MobileRTCMeetingService(User).

◆ sendChatToGroup:WithContent:()

- (MobileRTCSendChatError) sendChatToGroup: (MobileRTCChatGroup)  group
WithContent: (nonnull NSString *)  content 

Send message to group in the meeting.

Parameters
groupGroup type in the meeting, see MobileRTCChatGroup.
contentThe message to be sent.
Returns
The result of sending the message.

Provided by category MobileRTCMeetingService(Chat).

◆ sendChatToUser:WithContent:()

- (MobileRTCSendChatError) sendChatToUser: (NSUInteger)  userID
WithContent: (nonnull NSString *)  content 

Send chat message to the specified user in the meeting.

Parameters
userIDThe ID of user who receives message in the meeting.
contentThe message to be sent.
Returns
The result of sending the message.

Provided by category MobileRTCMeetingService(Chat).

◆ sendPairingCode:WithMeetingNumber:()

- (BOOL) sendPairingCode: (nonnull NSString *)  code
WithMeetingNumber: (unsigned long long)  meetingNumber 

Get the pairing code when the room device call in.

Parameters
codeThe pairing code which enable the device connect to the meeting.
meetingNumberThe number of meeting.
Returns
YES means the method is called successfully, otherwise not.
Warning
App can invite Room System while App is in Meeting or in pre-Meeting.

Provided by category MobileRTCMeetingService(Customize).

◆ showMeetingControlBar()

- (void) showMeetingControlBar

If you add a full-screen view to our zoom meeting UI, you can display the control bar by this method when the control bar is hidden.

Warning
The zoom meeting UI is only valid, the customized UI is invalid.

Provided by category MobileRTCMeetingService(InMeeting).

◆ showMobileRTCMeeting:()

- (BOOL) showMobileRTCMeeting: (void(^)(void))  completion

Set to show UI of meeting.

Parameters
completionUser can do other operations once the meeting UI comes out.
Returns
YES means that the method is called successfully, otherwise not.
Warning
The method does not work if you have set mobileRTCRootController via [MobileRTC setMobileRTCRootController]

Provided by category MobileRTCMeetingService(InMeeting).

◆ spotlightVideo:withUser:()

- (BOOL) spotlightVideo: (BOOL)  on
withUser: (NSUInteger)  userId 

Set whether to spotlight user's video.

Parameters
onYES means to spotlight user's video; NO means that spotlight user's video will be canceled.
userIdThe ID of user whose video will be spotlighted in the meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function, and user spotlighted should not be the host himself.

Provided by category MobileRTCMeetingService(Video).

◆ startAppShare()

- (BOOL) startAppShare

Set to enable App share.

Returns
YES means starting App share successfully, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:()

- (BOOL) startLiveStreamWithStreamingURL: (nonnull NSString *)  streamingURL
StreamingKey: (nonnull NSString *)  key
BroadcastURL: (nonnull NSString *)  broadcastURL 

Set to start Live Stream.

Parameters
streamingURLThe live stream URL by which you can live the meeting.
keyStream key offered by the third platform on which you want to live stream your meeting.
broadcastURLThe URL of live stream page.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can start live Stream successfully.

Provided by category MobileRTCMeetingService(InMeeting).

◆ startMeetingWithDictionary:()

- (MobileRTCMeetError) startMeetingWithDictionary: (nonnull NSDictionary *)  dict

Start a meeting with parameters in the dictionary.

Warning
If the user type is MobileRTCUserType_APIUser, the parameters in dictionary should cover kMeetingParam_UserID, kMeetingParam_UserToken, kMeetingParam_UserType, kMeetingParam_Username, kMeetingParam_MeetingNumber; if the user type is MobileRTCUserType_ZoomUser/MobileRTCUserType_SSOUser, the parameters in dictionary should cover kMeetingParam_UserType and kMeetingParam_MeetingNumber(optional, it will be an instant meeting if user did not fill the meeting number).
Parameters
dictThe dictionary contains the meeting parameters.
Returns
The state of the meeting, started or failed.
Warning
If you start a meeting with wrong parameters, it will return MobileRTCMeetError_InvalidArguments.

◆ startMeetingWithStartParam:()

- (MobileRTCMeetError) startMeetingWithStartParam: (nonnull MobileRTCMeetingStartParam *)  param

Start a meeting with MobileRTCMeetingStartParam parameter.

Warning
For non-logged-in user, create an instance via MobileRTCMeetingStartParam4WithoutLoginUser to pass the parameters. For logged-in user, create an instance via MobileRTCMeetingStartParam4LoginlUser to pass the parameters.
Parameters
paramCreate an instance with right information via MobileRTCMeetingStartParam.
Returns
The state of the meeting, started or failed.
Warning
If you start a meeting with wrong parameters, it will return MobileRTCMeetError_InvalidArguments.

◆ stopLiveStream()

- (BOOL) stopLiveStream

Set to stop live streaming.

Returns
YES means stopping live streaming successfully, otherwise not.
Warning
The function is available only for host.

Provided by category MobileRTCMeetingService(InMeeting).

◆ stopUserVideo:()

- (BOOL) stopUserVideo: (NSUInteger)  userID

Set to stop user's video.

Parameters
userIDThe ID of other users except the host in the meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only host can run the function in the meeting.

Provided by category MobileRTCMeetingService(Video).

◆ suspendSharing:()

- (BOOL) suspendSharing: (BOOL)  suspend

suspend sharing.

Returns
YES means sucessful, otherwise not.
Warning
When the customer goes to share a content, consider the pressure of device performance, and use this method to pause share when UI changes, and resume share when UI changes stop, see WebViewController.m in sample project.

Provided by category MobileRTCMeetingService(AppShare).

◆ switchMyCamera()

- (MobileRTCCameraError) switchMyCamera

Set to Switch the camera of the current user in local device.

Returns
The result of operation.

Provided by category MobileRTCMeetingService(Video).

◆ turnOnCMR:()

- (void) turnOnCMR: (BOOL)  on

Set to turn on/off the cloud recording in the meeting.

Parameters
onYES means to turn on cloud recording, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ unmuteAllUserAudio()

- (BOOL) unmuteAllUserAudio

Set to unmute audio of all attendees.

Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function.

Provided by category MobileRTCMeetingService(Audio).

◆ userInfoByID:()

- (nullable MobileRTCMeetingUserInfo*) userInfoByID: (NSUInteger)  userId

Get user information in the meeting.

Parameters
userIdIn-meeting user ID.
Returns
User information.

Provided by category MobileRTCMeetingService(User).


The documentation for this class was generated from the following file: