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.

(BOOL)	- isMeetingCoHost
	Query if the current user is the co-host of the meeting.

(BOOL)	- isWebinarAttendee
	Query if the current user is the webinar attendee of the meeting.

(BOOL)	- isWebinarPanelist
	Query if the current user is the webinar panelist of the meeting.

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

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

(BOOL)	- isCMREnabled
	Notify if the cloud recording is enabled.

(BOOL)	- isCMRInProgress
	Notify if the cloud recording is in progress.

(BOOL)	- isCMRPaused
	Notify if the cloud recording is paused.

(BOOL)	- resumePauseCMR
	Set to pause/resume cloud recording in the meeting.

(void)	- turnOnCMR:
	Set to turn on/off the cloud recording in the meeting.

(MobileRTCRecordingStatus)	- getCloudRecordingStatus
	Get current cloud recording.

(MobileRTCSDKError)	- requestStartCloudRecording
	Send a request to ask the host to start cloud recording.

(BOOL)	- isSmartRecordingEnabled
	Determine if the smart recording feature is enabled in the meeting.

(BOOL)	- isFailoverMeeting
	Query if the meeting is failover.

(MobileRTCMeetingType)	- getMeetingType
	Get the type of current meeting.

(BOOL)	- isWebinarMeeting
	Query if the meeting is Webinar.

(BOOL)	- lockMeeting:
	Set to lock the meeting.

(BOOL)	- lockShare:
	Set to lock the share.

(MobileRTCNetworkQuality)	- queryNetworkQuality:withDataFlow:
	Check in-meeting network status.

(BOOL)	- presentMeetingChatViewController:userId:
	Set to present Zoom original Meeting Chat ViewController.

(BOOL)	- presentParticipantsViewController:
	Set to present Zoom original Participants ViewController.

(BOOL)	- configDSCPWithAudioValue:VideoValue:
	Configure DSCP values for audio and video.

(BOOL)	- startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:
	Set to start Live Stream.

(nullable NSDictionary *)	- getLiveStreamURL
	Get live stream server URL.

(BOOL)	- stopLiveStream
	Set to stop live streaming.

(BOOL)	- isRawLiveStreamSupported

(MobileRTCSDKError)	- canStartRawLiveStream

(MobileRTCSDKError)	- requestRawLiveStreaming:broadcastName:

(MobileRTCSDKError)	- startRawLiveStreaming:broadcastName:

(MobileRTCSDKError)	- stopRawLiveStream
	Stop a rawData live stream.

(MobileRTCSDKError)	- removeRawLiveStreamPrivilege:
	Remove the raw live stream privilege.

(NSArray< MobileRTCRawLiveStreamInfo * > *_Nullable)	- getRawLiveStreamingInfoList

(NSArray< NSNumber * > *_Nullable)	- getRawLiveStreamPrivilegeUserList

(BOOL)	- showMobileRTCMeeting:
	Set to show UI of meeting.

(BOOL)	- hideMobileRTCMeeting:
	Set to hide the UI of meeting.

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

(void)	- switchToActiveSpeaker
	Switch to active scene.The sequence of video frames is { drive scene(only iPhone), active scene, gallery scene(if has)}.

(void)	- switchToVideoWall
	Switch to gallery scene.The sequence of video frames is { drive scene(only iPhone), active scene, gallery scene(if has)}.

(void)	- switchToDriveScene
	Switch to drive scene.The sequence of video frames is { drive scene(only iPhone), active scene, gallery scene(if has)}.

(MobileRTCANNError)	- showAANPanelInView:originPoint:
	show app signaling pannel in designated position of container view.

(MobileRTCANNError)	- hideAANPanel
	hide app signaling pannel.

(MobileRTCSDKError)	- showDynamicNoticeForAICompanionPanel:originPoint:
	Show the dynamic notice for the AI Companion panel view.

(MobileRTCSDKError)	- hideDynamicNoticeForAICompanionPanel
	Hide dynamic notice for AI Companion panel view.

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

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

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

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

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

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

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

(MobileRTCSDKError)	- allowParticipantsToStartVideo:

(BOOL)	- isParticipantsStartVideoAllowed

(MobileRTCSDKError)	- allowParticipantsToShareWhiteBoard:

(BOOL)	- isParticipantsShareWhiteBoardAllowed

(BOOL)	- isLiveTranscriptLegalNoticeAvailable
	Is live transcript legal notice available.

(NSString *_Nullable)	- getLiveTranscriptLegalNoticesPrompt
	Get live transcript legal noticesPrompt.

(NSString *_Nullable)	- getLiveTranscriptLegalNoticesExplained
	Get live transcript legal notices explained.

(BOOL)	- isParticipantRequestLocalRecordingAllowed
	Check whether the current meeting allows participants to send local recording privilege requests. It can only be used in regular meetings, not in webinar or breakout room.

(MobileRTCSDKError)	- allowParticipantsToRequestLocalRecording:
	Allow participant to request local recording.

(BOOL)	- canEnableParticipantRequestCloudRecording
	Determine if the current user can enable participant request clould recording.

(BOOL)	- isParticipantRequestCloudRecordingEnabled
	Toggle whether attendees can send requests for the host to start a cloud recording. This can only be used in regular meeetings.

(MobileRTCSDKError)	- allowParticipantsToRequestCloudRecording:
	Allowing the regular attendees to send cloud recording privilege request, This can only be used in regular meeetings and webinar (no breakout rooms).

(BOOL)	- isAutoAllowLocalRecordingRequest
	Check whether the current meeting auto-grants participants’ local recording privilege requests. It can only be used in regular meetings (not webinar or breakout room).

(MobileRTCSDKError)	- autoAllowLocalRecordingRequest:
	Allow participants to request local recording.

(BOOL)	- canSuspendParticipantsActivities
	Whether the current user is able to suspend all participant activities.

(MobileRTCSDKError)	- suspendParticipantsActivites
	Suspend all participant activities.

(MobileRTCSDKError)	- canHideParticipantProfilePictures
	Query if the current user can hide participant profile pictures. @Note: This feature is influenced by focus mode change.

(MobileRTCSDKError)	- hideParticipantProfilePictures:
	Hide/Show participant profile pictures.

(BOOL)	- isParticipantProfilePicturesHidden

(BOOL)	- isFocusModeEnabled
	Get the focus mode enabled or not by web portal.

(MobileRTCSDKError)	- turnFocusModeOn:
	Turn focus mode on or off. Focus mode on means Participants will only be able to see hosts' videos and shared content, and videos of spotlighted participants.

(BOOL)	- isFocusModeOn
	Get the focus mode on or off.

(MobileRTCFocusModeShareType)	- getFocusModeShareType
	Get share focus mode type indicating who can see the shared content which is controlled by host or co-host.

(MobileRTCSDKError)	- setFocusModeShareType:
	Set focus mode type indicating who can see the shared content which is controlled by host or co-host.

Detailed Description

Set to provide interfaces for meeting events.

Definition at line 76 of file MobileRTCMeetingService+InMeeting.h.

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.

◆ allowParticipantsToRequestCloudRecording:

- (MobileRTCSDKError) allowParticipantsToRequestCloudRecording: (BOOL) allow

Allowing the regular attendees to send cloud recording privilege request, This can only be used in regular meeetings and webinar (no breakout rooms).

Parameters

allow TRUE indicates that participantsthe are allowed the regular attendees to send cloud recording privilege request.

Returns: If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise the function fails. To get extended error information, see MobileRTCSDKError

Extends class MobileRTCMeetingService.

◆ allowParticipantsToRequestLocalRecording:

- (MobileRTCSDKError) allowParticipantsToRequestLocalRecording: (BOOL) allow

Allow participant to request local recording.

Parameters

allow YES: allow, NO: disallow

Returns: error MobileRTCSDKError

Extends class MobileRTCMeetingService.

◆ allowParticipantsToShareWhiteBoard:

- (MobileRTCSDKError) allowParticipantsToShareWhiteBoard: (BOOL) allow

Allow participant to share white board

Parameters

allow YES: allow, NO: disallow

Returns: error MobileRTCSDKError

Extends class MobileRTCMeetingService.

◆ allowParticipantsToStartVideo:

- (MobileRTCSDKError) allowParticipantsToStartVideo: (BOOL) allow

Allow participant to start video

Parameters

allow YES: allow, NO: disallow

Returns: error MobileRTCSDKError

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.

◆ autoAllowLocalRecordingRequest:

- (MobileRTCSDKError) autoAllowLocalRecordingRequest: (BOOL) allow

Allow participants to request local recording.

Parameters

allow YES: allow, NO: disallow

Returns: error MobileRTCSDKError

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.

◆ canEnableParticipantRequestCloudRecording

- (BOOL) canEnableParticipantRequestCloudRecording

Determine if the current user can enable participant request clould recording.

Returns: If allows participants to send request, the return value is true.

Extends class MobileRTCMeetingService.

◆ canHideParticipantProfilePictures

- (MobileRTCSDKError) canHideParticipantProfilePictures

Query if the current user can hide participant profile pictures. @Note: This feature is influenced by focus mode change.

Returns: If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed, for more details, see MobileRTCSDKError.

Extends class MobileRTCMeetingService.

◆ canStartRawLiveStream

- (MobileRTCSDKError) canStartRawLiveStream

Extends class MobileRTCMeetingService.

◆ canSuspendParticipantsActivities

- (BOOL) canSuspendParticipantsActivities

Whether the current user is able to suspend all participant activities.

Returns: YES means user can suspend participant activities,

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.

◆ getCloudRecordingStatus

- (MobileRTCRecordingStatus) getCloudRecordingStatus

Get current cloud recording.

Returns: return If the function succeeds, the return value is recording status.

Extends class MobileRTCMeetingService.

◆ getFocusModeShareType

- (MobileRTCFocusModeShareType) getFocusModeShareType

Get share focus mode type indicating who can see the shared content which is controlled by host or co-host.

Returns: return the current share focus mode type.

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, "facebook" as the key in Dictionary. For Workplace by Facebook Live Stream Service, "fb_workplace" as the key in Dictionary. For YouTube Live Stream Service, "youtube" as the key in Dictionary. For Custom Live Stream Service, "custom" as the key in Dictionary.

Extends class MobileRTCMeetingService.

◆ getLiveTranscriptLegalNoticesExplained

- (NSString *_Nullable) getLiveTranscriptLegalNoticesExplained

Get live transcript legal notices explained.

Returns: live transcript legal notices explained.

Extends class MobileRTCMeetingService.

◆ getLiveTranscriptLegalNoticesPrompt

- (NSString *_Nullable) getLiveTranscriptLegalNoticesPrompt

Get live transcript legal noticesPrompt.

Returns: live transcript legal noticesPrompt.

Extends class MobileRTCMeetingService.

◆ getMeetingPassword

- (NSString *_Nullable) getMeetingPassword

Get current meeting's password.

Returns: The current meeting's password

Extends class MobileRTCMeetingService.

◆ getMeetingType

- (MobileRTCMeetingType) getMeetingType

Get the type of current meeting.

Returns: If the function succeeds, it will return the type of meeting, otherwise failed.

Extends class MobileRTCMeetingService.

◆ getRawLiveStreamingInfoList

- (NSArray< MobileRTCRawLiveStreamInfo * > *_Nullable) getRawLiveStreamingInfoList

Extends class MobileRTCMeetingService.

◆ getRawLiveStreamPrivilegeUserList

- (NSArray< NSNumber * > *_Nullable) getRawLiveStreamPrivilegeUserList

Extends class MobileRTCMeetingService.

◆ hideAANPanel

- (MobileRTCANNError) hideAANPanel

hide app signaling pannel.

Returns: MobileRTCANNError_Success means the operation succeed, otherwise not

Warning: suggest to hide ANNPannel when device orietation changed or trait collection changed to avoid layout issues

Extends class MobileRTCMeetingService.

◆ hideDynamicNoticeForAICompanionPanel

- (MobileRTCSDKError) hideDynamicNoticeForAICompanionPanel

Hide dynamic notice for AI Companion panel view.

Returns: If invoke succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed, for more details, see MobileRTCSDKError.

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.

◆ hideParticipantProfilePictures:

- (MobileRTCSDKError) hideParticipantProfilePictures: (BOOL) hide

Hide/Show participant profile pictures.

Parameters

hide	true means hide participant profile pictures, false means show participant pictures.

Returns: If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed, for more details, see MobileRTCSDKError.

Extends class MobileRTCMeetingService.

◆ isAutoAllowLocalRecordingRequest

- (BOOL) isAutoAllowLocalRecordingRequest

Check whether the current meeting auto-grants participants’ local recording privilege requests. It can only be used in regular meetings (not webinar or breakout room).

Returns: YES: allow, NO: disallow

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.

◆ isFailoverMeeting

- (BOOL) isFailoverMeeting

Query if the meeting is failover.

Returns: YES means failover, otherwise not.

Warning: The method is optional.

Extends class MobileRTCMeetingService.

◆ isFocusModeEnabled

- (BOOL) isFocusModeEnabled

Get the focus mode enabled or not by web portal.

Returns: YES Means focus mode enabled. Otherwise NO.

Extends class MobileRTCMeetingService.

◆ isFocusModeOn

- (BOOL) isFocusModeOn

Get the focus mode on or off.

Returns: YES Means focus mode on. Otherwise NO.

Extends class MobileRTCMeetingService.

◆ isLiveTranscriptLegalNoticeAvailable

- (BOOL) isLiveTranscriptLegalNoticeAvailable

Is live transcript legal notice available.

Returns: available or not.

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.

◆ isParticipantProfilePicturesHidden

- (BOOL) isParticipantProfilePicturesHidden

Query if the current meeting hides participant pictures.

Returns: true means hide participant pictures, false means show participant pictures

Extends class MobileRTCMeetingService.

◆ isParticipantRequestCloudRecordingEnabled

- (BOOL) isParticipantRequestCloudRecordingEnabled

Toggle whether attendees can send requests for the host to start a cloud recording. This can only be used in regular meeetings.

Returns: If allows participants to send request, the return value is true.

Extends class MobileRTCMeetingService.

◆ isParticipantRequestLocalRecordingAllowed

- (BOOL) isParticipantRequestLocalRecordingAllowed

Check whether the current meeting allows participants to send local recording privilege requests. It can only be used in regular meetings, not in webinar or breakout room.

Returns: YES: allow, NO: disallow

Extends class MobileRTCMeetingService.

◆ isParticipantsRenameAllowed

- (BOOL) isParticipantsRenameAllowed

Query if the meeting is allow participants to rename themselves.

Warning: Only in-meeting can call the function.

Extends class MobileRTCMeetingService.

◆ isParticipantsShareWhiteBoardAllowed

- (BOOL) isParticipantsShareWhiteBoardAllowed

Query is allow participant to share white board

Returns: YES: allow, NO: disallow

Extends class MobileRTCMeetingService.

◆ isParticipantsStartVideoAllowed

- (BOOL) isParticipantsStartVideoAllowed

Query is allow participant to start video

Returns: YES : allow, NO: disallow

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.

◆ isRawLiveStreamSupported

- (BOOL) isRawLiveStreamSupported

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.

◆ isSmartRecordingEnabled

- (BOOL) isSmartRecordingEnabled

Determine if the smart recording feature is enabled in the meeting.

Returns: true means that the feature enabled, false means that the feature isn't enabled.

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.

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

◆ removeRawLiveStreamPrivilege:

- (MobileRTCSDKError) removeRawLiveStreamPrivilege: (NSUInteger) userId

Remove the raw live stream privilege.

Parameters

userId Specify the ID of the user whose privilege will be removed.

Returns: If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise it fails. To get extended error information, see [MobileRTCSDKError] enum.

Extends class MobileRTCMeetingService.

◆ requestRawLiveStreaming:broadcastName:

- (MobileRTCSDKError) requestRawLiveStreaming:	(nonnull NSString *)	broadcastURL
broadcastName:	(NSString *_Nullable)	broadcastName

Extends class MobileRTCMeetingService.

◆ requestStartCloudRecording

- (MobileRTCSDKError) requestStartCloudRecording

Send a request to ask the host to start cloud recording.

Returns: If the function succeeds, the return value is SDKErr_Success and the SDK send the request. Otherwise it fails and the request is not sent. To get extended error information, see SDKError enum.

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.

◆ setFocusModeShareType:

- (MobileRTCSDKError) setFocusModeShareType: (MobileRTCFocusModeShareType) shareType

Set focus mode type indicating who can see the shared content which is controlled by host or co-host.

Parameters

shareType The type of focus mode share type.

Returns: Success means interface all success.

Extends class MobileRTCMeetingService.

◆ showAANPanelInView:originPoint:

- (MobileRTCANNError) showAANPanelInView:	(UIView *_Nullable)	containerView
originPoint:	(CGPoint)	originXY

show app signaling pannel in designated position of container view.

Parameters

containerView	the view container to show app signaling pannel.
originXY	the origin position of app signaling pannel in container view.

Returns: MobileRTCANNError_Success means the operation succeed, otherwise not

Warning: originXY only take effect on iPad device, behavior of iphone always pop up from the bottom with the device width.

Extends class MobileRTCMeetingService.

◆ showDynamicNoticeForAICompanionPanel:originPoint:

- (MobileRTCSDKError) showDynamicNoticeForAICompanionPanel:	(UIView *_Nullable)	containerView
originPoint:	(CGPoint)	originXY

Show the dynamic notice for the AI Companion panel view.

Parameters

containerView	Show the AI Companion panel's dynamic notice in this view.
originXY	the origin point which the panel placed in the containerView.

Returns: If invoke succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed, for more details, see MobileRTCSDKError.

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.

◆ startRawLiveStreaming:broadcastName:

- (MobileRTCSDKError) startRawLiveStreaming:	(nonnull NSString *)	broadcastURL
broadcastName:	(NSString *_Nullable)	broadcastName

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.

◆ stopRawLiveStream

- (MobileRTCSDKError) stopRawLiveStream

Stop a rawData live stream.

Returns: If the function succeeds, it will return the MobileRTCSDKError_Success, otherwise failed.

Extends class MobileRTCMeetingService.

◆ suspendParticipantsActivites

- (MobileRTCSDKError) suspendParticipantsActivites

Suspend all participant activities.

Returns: MobileRTCANNError_Success means the operation succeed, otherwise no

Warning: Audio,Video,Share,Chat,Wihteboard funcation will be suspended,that need to call allowParticipantsToUnmuteSelf.allowParticipantsToStartVideo.lockShare.changeAttendeeChatPriviledge and allowParticipantsToShareWhiteBoard interfaces to resume

Extends class MobileRTCMeetingService.

◆ switchToActiveSpeaker

- (void) switchToActiveSpeaker

Switch to active scene.The sequence of video frames is { drive scene(only iPhone), active scene, gallery scene(if has)}.

Warning: The zoom meeting UI is only valid, the customized UI is invalid.; Both the iPad and the iPhone can use this method

Extends class MobileRTCMeetingService.

◆ switchToDriveScene

- (void) switchToDriveScene

Switch to drive scene.The sequence of video frames is { drive scene(only iPhone), active scene, gallery scene(if has)}.

Warning: The zoom meeting UI is only valid, the customized UI is invalid.; Only iPhone can use this method

Extends class MobileRTCMeetingService.

◆ switchToVideoWall

- (void) switchToVideoWall

Switch to gallery scene.The sequence of video frames is { drive scene(only iPhone), active scene, gallery scene(if has)}.

Warning: The zoom meeting UI is only valid, the customized UI is invalid.; Both the iPad and the iPhone can use this method

Extends class MobileRTCMeetingService.

◆ turnFocusModeOn:

- (MobileRTCSDKError) turnFocusModeOn: (BOOL) on

Turn focus mode on or off. Focus mode on means Participants will only be able to see hosts' videos and shared content, and videos of spotlighted participants.

Parameters

on	Yes means to turen on, No means to turn off.

Returns: Success means enable/disable success. Otherwise false.

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.

Instance Methods

Detailed Description

Method Documentation

◆ allowParticipantsToRename:

◆ allowParticipantsToRequestCloudRecording:

◆ allowParticipantsToRequestLocalRecording:

◆ allowParticipantsToShareWhiteBoard:

◆ allowParticipantsToStartVideo:

◆ allowParticipantsToUnmuteSelf:

◆ autoAllowLocalRecordingRequest:

◆ backZoomUIMeetingFromMinimizeMeeting

◆ canEnableParticipantRequestCloudRecording

◆ canHideParticipantProfilePictures

◆ canStartRawLiveStream

◆ canSuspendParticipantsActivities

◆ configDSCPWithAudioValue:VideoValue:

◆ getCloudRecordingStatus

◆ getFocusModeShareType

◆ getLiveStreamURL

◆ getLiveTranscriptLegalNoticesExplained

◆ getLiveTranscriptLegalNoticesPrompt

◆ getMeetingPassword

◆ getMeetingType

◆ getRawLiveStreamingInfoList

◆ getRawLiveStreamPrivilegeUserList

◆ hideAANPanel

◆ hideDynamicNoticeForAICompanionPanel

◆ hideMobileRTCMeeting:

◆ hideParticipantProfilePictures:

◆ isAutoAllowLocalRecordingRequest

◆ isCMREnabled

◆ isCMRInProgress

◆ isCMRPaused

◆ isFailoverMeeting

◆ isFocusModeEnabled

◆ isFocusModeOn

◆ isLiveTranscriptLegalNoticeAvailable

◆ isMeetingCoHost

◆ isMeetingHost

◆ isMeetingLocked

◆ isParticipantProfilePicturesHidden

◆ isParticipantRequestCloudRecordingEnabled

◆ isParticipantRequestLocalRecordingAllowed

◆ isParticipantsRenameAllowed

◆ isParticipantsShareWhiteBoardAllowed

◆ isParticipantsStartVideoAllowed

◆ isParticipantsUnmuteSelfAllowed

◆ isRawLiveStreamSupported

◆ isShareLocked

◆ isSmartRecordingEnabled

◆ isWebinarAttendee

◆ isWebinarMeeting

◆ isWebinarPanelist

◆ lockMeeting:

◆ lockShare:

◆ presentMeetingChatViewController:userId:

◆ presentParticipantsViewController:

◆ queryNetworkQuality:withDataFlow:

◆ removeRawLiveStreamPrivilege:

◆ requestRawLiveStreaming:broadcastName:

◆ requestStartCloudRecording

◆ resumePauseCMR

◆ setFocusModeShareType:

◆ showAANPanelInView:originPoint:

◆ showDynamicNoticeForAICompanionPanel:originPoint:

◆ showMeetingControlBar

◆ showMinimizeMeetingFromZoomUIMeeting

◆ showMobileRTCMeeting:

◆ startLiveStreamWithStreamingURL:StreamingKey:BroadcastURL:

◆ startRawLiveStreaming:broadcastName:

◆ stopLiveStream

◆ stopRawLiveStream

◆ suspendParticipantsActivites

◆ switchToActiveSpeaker

◆ switchToDriveScene

◆ switchToVideoWall

◆ turnFocusModeOn:

◆ turnOnCMR: