Set to provide interfaces for meeting events. More...

#import <MobileRTCMeetingService+InMeeting.h>

Instance Methods
(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)	- isWebinarAttendee
	Query if the current user is the webinar attendee of the meeting. More...

(BOOL)	- isWebinarPanelist
	Query if the current user is the webinar panelist 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...

(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)	- isQAEnabled
	Query if Q&A is enabled. More...

(BOOL)	- presentQAViewController:
	Set to present Zoom original Q&A ViewController. More...

(NSString *_Nullable)	- getMeetingPassword
	Get current meeting's password. More...

(BOOL)	- showMinimizeMeetingFromZoomUIMeeting
	call the method to show Minimize meeting when in Zoom UI meeting. More...

(BOOL)	- backZoomUIMeetingFromMinimizeMeeting
	call the methond to back Zoom UI meeting when in minimize meeting. More...

(BOOL)	- isParticipantsRenameAllowed
	Query if the meeting is allow participants to rename themselves. More...

(void)	- allowParticipantsToRename:
	Set the meeting is allow participants to rename themselves. More...

(BOOL)	- isParticipantsUnmuteSelfAllowed
	Query if the meeting is allow participants to unmute themselves. More...

(void)	- allowParticipantsToUnmuteSelf:
	Query if the meeting is allow participants to unmute themselves. More...

Detailed Description

Set to provide interfaces for meeting events.

Method Documentation

◆ allowParticipantsToRename:()

- (void) allowParticipantsToRename: (BOOL) allow

Set the meeting is allow participants to rename themselves.

Warning: Only meeting host/co-host can call the function.; Only in-meeting can call the function.

Extends class MobileRTCMeetingService.

◆ allowParticipantsToUnmuteSelf:()

- (void) allowParticipantsToUnmuteSelf: (BOOL) allow

Query if the meeting is allow participants to unmute themselves.

Warning: Only meeting host/co-host can call the function.; Only in-meeting can call the function.

Extends class MobileRTCMeetingService.

◆ backZoomUIMeetingFromMinimizeMeeting()

- (BOOL) backZoomUIMeetingFromMinimizeMeeting

call the methond to back Zoom UI meeting when in minimize meeting.

Warning: The method only for Zoom UI

Extends class MobileRTCMeetingService.

◆ configDSCPWithAudioValue:VideoValue:()

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

Configure DSCP values for audio and video.

Parameters

audioValue	Audio values in the meeting.
videoValue	Video values in the meeting

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

Warning: The function should be invoked before meeting starts.

Extends class MobileRTCMeetingService.

◆ 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

Extends class MobileRTCMeetingService.

◆ getMeetingPassword()

- (NSString *_Nullable) getMeetingPassword

Get current meeting's password.

Returns: The current meeting's password

Extends class MobileRTCMeetingService.

◆ handleE2EMeetingKey:withLeaveMeeting:()

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

Set custom meeting session key.

Parameters

keyArray	The array of meeting session keys.
leave	YES means leaving meeting directly, otherwise not.

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

Warning: The method is optional.

Extends class MobileRTCMeetingService.

◆ hideFullPhoneNumberForPureCallInUser:()

- (BOOL) hideFullPhoneNumberForPureCallInUser: (BOOL) bHide

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

Parameters

bHide YES means hide, otherwise not.

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

Warning: The method should be invoked before meeting starts.

Extends class MobileRTCMeetingService.

◆ hideMobileRTCMeeting:()

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

Set to hide the UI of meeting.

Parameters

completion User 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]

Extends class MobileRTCMeetingService.

◆ isCMREnabled()

- (BOOL) isCMREnabled

Notify if the cloud recording is enabled.

Returns: YES means enabled, otherwise not.

Extends class MobileRTCMeetingService.

◆ isCMRInProgress()

- (BOOL) isCMRInProgress

Notify if the cloud recording is in progress.

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

Extends class MobileRTCMeetingService.

◆ isCMRPaused()

- (BOOL) isCMRPaused

Notify if the cloud recording is paused.

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

Extends class MobileRTCMeetingService.

◆ isExternalMeeting()

- (BOOL) isExternalMeeting

Query if the meeting is external or not.

Returns: YES means external, otherwise not.

Warning: The method is optional.

Extends class MobileRTCMeetingService.

◆ isFailoverMeeting()

- (BOOL) isFailoverMeeting

Query if the meeting is failover.

Returns: YES means failover, otherwise not.

Warning: The method is optional.

Extends class MobileRTCMeetingService.

◆ isInternalMeeting()

- (BOOL) isInternalMeeting

Query if the meeting is internal or not.

Returns: YES means internal, otherwise not.

Warning: The method is optional.

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

◆ isParticipantsRenameAllowed()

- (BOOL) isParticipantsRenameAllowed

Query if the meeting is allow participants to rename themselves.

Warning: Only meeting host/co-host can call the function.; Only in-meeting can call the function.

Extends class MobileRTCMeetingService.

◆ isParticipantsUnmuteSelfAllowed()

- (BOOL) isParticipantsUnmuteSelfAllowed

Query if the meeting is allow participants to unmute themselves.

Warning: Only meeting host/co-host can call the function.; Only in-meeting can call the function.

Extends class MobileRTCMeetingService.

◆ isQAEnabled()

- (BOOL) isQAEnabled

Query if Q&A is enabled.

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

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

◆ isWebinarAttendee()

- (BOOL) isWebinarAttendee

Query if the current user is the webinar attendee of the meeting.

Returns: YES means that the current user is the webinar attendee of the meeting, otherwise not.

Warning: only for webinar meeting.

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

◆ isWebinarPanelist()

- (BOOL) isWebinarPanelist

Query if the current user is the webinar panelist of the meeting.

Returns: YES means that the current user is the webinar panelist of the meeting, otherwise not.

Warning: only for webinar meeting.

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

◆ presentMeetingChatViewController:userId:()

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

Set to present Zoom original Meeting Chat ViewController.

Parameters

parentVC	which use to present ViewController.
userId	userId 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.

Extends class MobileRTCMeetingService.

◆ presentParticipantsViewController:()

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

Set to present Zoom original Participants ViewController.

Parameters

parentVC which use to present ViewController

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

Extends class MobileRTCMeetingService.

◆ presentQAViewController:()

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

Set to present Zoom original Q&A ViewController.

Parameters

parentVC which use to present ViewController

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

Extends class MobileRTCMeetingService.

◆ queryNetworkQuality:withDataFlow:()

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

Check in-meeting network status.

Parameters

type	Meeting component types, now we can only query three components network status: MobileRTCComponentType_AUDIO, MobileRTCComponentType_VIDEO and MobileRTCComponentType_AS
sending,if	YES 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.

Extends class MobileRTCMeetingService.

◆ resumePauseCMR()

- (BOOL) resumePauseCMR

Set to pause/resume cloud recording in the meeting.

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

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

◆ showMinimizeMeetingFromZoomUIMeeting()

- (BOOL) showMinimizeMeetingFromZoomUIMeeting

call the method to show Minimize meeting when in Zoom UI meeting.

Warning: The method only for Zoom UI.

Extends class MobileRTCMeetingService.

◆ showMobileRTCMeeting:()

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

Set to show UI of meeting.

Parameters

completion User 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]

Extends class MobileRTCMeetingService.

◆ startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:()

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

Set to start Live Stream.

Parameters

streamingURL	The live stream URL by which you can live the meeting.
key	Stream key offered by the third platform on which you want to live stream your meeting.
broadcastURL	The 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.

Extends class MobileRTCMeetingService.

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

Extends class MobileRTCMeetingService.

◆ turnOnCMR:()

- (void) turnOnCMR: (BOOL) on

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

Parameters

on	YES means to turn on cloud recording, otherwise not.

Extends class MobileRTCMeetingService.

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

MobileRTCMeetingService+InMeeting.h

Instance Methods

Detailed Description

Method Documentation

◆ allowParticipantsToRename:()

◆ allowParticipantsToUnmuteSelf:()

◆ backZoomUIMeetingFromMinimizeMeeting()

◆ configDSCPWithAudioValue:VideoValue:()

◆ getLiveStreamURL()

◆ getMeetingPassword()

◆ handleE2EMeetingKey:withLeaveMeeting:()

◆ hideFullPhoneNumberForPureCallInUser:()

◆ hideMobileRTCMeeting:()

◆ isCMREnabled()

◆ isCMRInProgress()

◆ isCMRPaused()

◆ isExternalMeeting()

◆ isFailoverMeeting()

◆ isInternalMeeting()

◆ isMeetingCoHost()

◆ isMeetingHost()

◆ isMeetingLocked()

◆ isParticipantsRenameAllowed()

◆ isParticipantsUnmuteSelfAllowed()

◆ isQAEnabled()

◆ isShareLocked()

◆ isWebinarAttendee()

◆ isWebinarMeeting()

◆ isWebinarPanelist()

◆ lockMeeting:()

◆ lockShare:()

◆ presentMeetingChatViewController:userId:()

◆ presentParticipantsViewController:()

◆ presentQAViewController:()

◆ queryNetworkQuality:withDataFlow:()

◆ resumePauseCMR()

◆ showMeetingControlBar()

◆ showMinimizeMeetingFromZoomUIMeeting()

◆ showMobileRTCMeeting:()

◆ startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:()

◆ stopLiveStream()

◆ turnOnCMR:()