Enables the client to start or join a meeting. More...

#include <MobileRTCMeetingService.h>

Inherits NSObject.

Instance Methods
(MobileRTCMeetError)	- startMeetingWithStartParam:
	Starts a meeting with MobileRTCMeetingStartParam parameter.

(MobileRTCMeetError)	- joinMeetingWithJoinParam:
	Joins a meeting with MobileRTCMeetingJoinParam parameter.

(MobileRTCMeetError)	- handZoomWebUrl:
	Starts or joins a Zoom meeting with zoom web URL.

(MobileRTCMeetingState)	- getMeetingState
	Gets the current meeting state.

(void)	- leaveMeetingWithCmd:
	Ends or leaves the current meeting.

(UIView *_Nullable)	- meetingView
	Returns the view of meeting UI, which enables customers to add their own view in the meeting UI.

(BOOL)	- setCustomizedInvitationDomain:
	Sets the customized invitation domain.

(BOOL)	- isSupportPSMode
	Determines if production studio mode is supported.

(BOOL)	- isPSModeStarted
	Determines if production studio mode is started.

(NSUInteger)	- getPSUserID
	Gets the production studio user's user ID.

(BOOL)	- isTurnoffAllAICompanionsSupported
	Determines whether the meeting supports turning off the AI Companion features.

(BOOL)	- canTurnOffAllAICompanions
	Determines whether the current user can turn off the AI Companion features.

(MobileRTCSDKError)	- turnOffAllAICompanion:
	Turns off the AI Companion features.

(BOOL)	- isTurnOnAllAICompanionSupported
	Determines whether the meeting supports turning on the AI Companion features.

(BOOL)	- canTurnOnAllAICompanion
	Determines whether the current user can turn on the AI Companion features.

(MobileRTCSDKError)	- turnOnAllAICompanion
	Turns on all the AI Companion features.

(BOOL)	- canRequestTurnoffAllAICompanion
	Determines whether the current user can ask the host to turn off all started AI Companion features.

(MobileRTCSDKError)	- requestTurnoffAllAICompanion
	Asks host to turn off all started AI Companion features.

(BOOL)	- canRequestTurnOnAllAICompanion
	Determines whether the current user can ask the host to turn on all AI Companion features if they are enabled for the current meeting.

(MobileRTCSDKError)	- requestTurnOnAllAICompanion
	Asks host to turn on all AI Companion features if they are enabled for the current meeting.

(MobileRTCAICompanionQueryHelper *)	- getQueryHelper
	Gets the AI Companion Query Helper.

(MobileRTCAICompanionSmartSummaryHelper *)	- getSmartSummaryHelper
	Gets the smart summary helper.

(BOOL)	- isDirectAppShareMeeting
	Queries if the current meeting was started with App Share.

(MobileRTCCannotShareReasonType)	- canStartShare
	Determines whether the current meeting can start sharing.

(void)	- appShareWithView:
	Shares content with the current view.

(BOOL)	- startAppShare
	Starts App Share.

(void)	- stopAppShare
	Stops App Share.

(BOOL)	- isStartingShare
	Notifies the current user if sharing has started.

(BOOL)	- isViewingShare
	Notifies the current user if they are currently viewing an App Share.

(BOOL)	- isAnnotationOff
	Notifies the current user if annotation is enabled.

(BOOL)	- suspendSharing:
	Suspends App Sharing.

(BOOL)	- isSupportShareAudio
	Determines if sharing device audio is supported.

(void)	- setShareAudio:
	Enables or disables the sending of device audio.

(BOOL)	- isSharedAudio
	Gets the state of device audio sharing.

(BOOL)	- isDeviceSharing
	Gets the state of device screen sharing.

(BOOL)	- isSupportOptimizeForSharedVideo
	Determines if optimizing share video is supported.

(BOOL)	- enableOptimizeForSharedVideo:
	Enables or disables optimizing share video.

(BOOL)	- isEnableOptimizeForSharedVideo
	Gets the state of optimizing share video.

(MobileRTCSDKError)	- allowParticipantsToShareWhiteBoard:
	Allows or disallows participants to share whiteboard.

(BOOL)	- isParticipantsShareWhiteBoardAllowed
	Queries if participants are allowed to share whiteboard.

(NSArray< MobileRTCSSharingSourceInfo * > *_Nullable)	- getSharingSourceInfoList:
	Gets the list of sharing source info.

(MobileRTCSDKError)	- setShareSettingType:
	Sets sharing types for the host or co-host in the meeting.

(MobileRTCShareSettingType)	- getShareSettingType
	Gets the sharing types for the host or co-host in the meeting.

(MobileRTCAudioType)	- myAudioType
	Gets the in-meeting audio type of the current user.

(BOOL)	- is3rdPartyTelephonyAudioOn
	Determines whether the meeting has third party telephony audio enabled.

(BOOL)	- connectMyAudio:
	Sets whether to connect the audio in the meeting.

(MobileRTCAudioOutput)	- myAudioOutputDescription
	Gets the audio output type of the current user.

(BOOL)	- isMyAudioMuted
	Determines whether the audio of the current user is muted.

(BOOL)	- canUnmuteMyAudio
	Determines whether the user can unmute audio.

(BOOL)	- canEnableMuteOnEntry
	Determines whether the host or cohost can enable mute on entry.

(MobileRTCSDKError)	- enableMuteOnEntry:allowUnmuteBySelf:
	Enables or disables mute on entry for users after joining the meeting.

(BOOL)	- isMuteOnEntryOn
	Determines whether mute on entry is enabled for attendees when they join the meeting.

(BOOL)	- isUserAudioMuted:
	Determines whether the user's audio is muted.

(BOOL)	- muteUserAudio:withUID:
	Mutes or unmutes the user's audio.

(BOOL)	- muteAllUserAudio:
	Mutes audio of all attendees.

(BOOL)	- askAllToUnmute
	Asks all attendees to unmute audio.

(BOOL)	- isSupportedVOIP
	Determines whether the meeting supports VoIP.

(BOOL)	- isPlayChimeOn
	Determines whether chime is enabled when user joins or leaves meeting.

(BOOL)	- playChime:
	Sets whether chime is enabled when the user joins or leaves meeting.

(MobileRTCAudioError)	- muteMyAudio:
	Mutes or unmutes the audio of the current user.

(MobileRTCAudioError)	- switchMyAudioSource
	Switches the audio output between receiver and speaker.

(void)	- resetMeetingAudioSession
	Resets the meeting audio session including category and mode.

(void)	- resetMeetingAudioForCallKitHeld
	Resets the 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)	- isIncomingAudioStopped
	Determines whether the incoming audio is stopped.

(MobileRTCSDKError)	- stopIncomingAudio:
	Stops or resumes the incoming audio.

(NSInteger)	- getSupportedMeetingAudioType
	Gets the audio type supported by the current meeting.

(MobileRTCRawDataError)	- enablePlayMeetingAudio:
	Enables or disables SDK to play meeting audio. When the value of enabled is NO, the SDK will not play meeting audio, but you can still subscribe audio rawdata.

(BOOL)	- isPlayMeetingAudioEnabled
	Determines whether play meeting audio is enabled.

(BOOL)	- is3DAvatarSupportedByDevice
	Determines if the 3D avatar feature is supported by the video device.

(BOOL)	- is3DAvatarEnabled
	Determines if the 3D avatar feature is enabled.

(NSArray< MobileRTC3DAvatarImageInfo * > *_Nullable)	- get3DAvatarImageList
	Gets the array of the video filter images.

(MobileRTCSDKError)	- set3DAvatarImage:
	Specifies an image to be the video filter image.

(MobileRTCSDKError)	- showAvatar:
	Sets to show or hide the last used avatar in the meeting.

(BOOL)	- isShowAvatar
	Determines if the meeting is showing the avatar.

(MobileRTCSDKError)	- enable3DAvatarEffectForAllMeeting:
	Enables or disables 3D avatar effect when joining meeting.

(BOOL)	- is3DAvatarEffectForAllMeetingEnabled
	Determines whether 3D avatar is enabled when joining the meeting.

(MobileRTCBOCreator *_Nullable)	- getCreatorHelper
	Gets the object for creating Breakout Room meetings defined in [MobileRTCBOCreator].

(MobileRTCBOAdmin *_Nullable)	- getAdminHelper
	Gets the object for administrator management of Breakout Room meetings defined in [MobileRTCBOAdmin].

(MobileRTCBOAssistant *_Nullable)	- getAssistantHelper
	Gets the object for help assistant of Breakout Room meetings defined in [MobileRTCBOAssistant].

(MobileRTCBOAttendee *_Nullable)	- getAttedeeHelper
	Gets the object for attendee functionality of Breakout Room meetings defined in [MobileRTCBOAttendee].

(MobileRTCBOData *_Nullable)	- getDataHelper
	Gets the object for Breakout Room meeting ID information defined in [MobileRTCBOData].

(BOOL)	- isBOMeetingStarted
	Determines if the Breakout Room meeting has begun.

(BOOL)	- isBOMeetingEnabled
	Determines if the Breakout Room feature is enabled in the meeting.

(BOOL)	- isInBOMeeting
	Determines if currently in Breakout Room during the meeting.

(BOOL)	- isBroadcastingVoiceToBO
	Queries if the host is broadcasting voice to BO.

(MobileRTCBOStatus)	- getBOStatus
	Gets the current Breakout status.

(NSString *_Nullable)	- getJoiningBOName
	Gets the name of the BO you are going to.

(BOOL)	- isChatDisabled
	Queries if the chat is disabled in the meeting.

(BOOL)	- isPrivateChatDisabled
	Queries if it is able to send private chat in the meeting.

(BOOL)	- changeAttendeeChatPriviledge:
	Sets attendee chat privilege when in-meeting.

(MobileRTCMeetingChatPriviledgeType)	- getAttendeeChatPriviledge
	Gets attendee chat privilege when in-meeting.

(BOOL)	- isMeetingChatLegalNoticeAvailable
	Determines if meeting chat legal notice is available.

(NSString *_Nullable)	- getChatLegalNoticesPrompt
	Gets chat legal notice prompt.

(NSString *_Nullable)	- getChatLegalNoticesExplained
	Gets explained text for chat legal notice.

(nullable MobileRTCMeetingChat *)	- meetingChatByID:
	Gets in-meeting chat message.

(MobileRTCSendChatError)	- sendChatMsg:
	Sends a chat message.

(BOOL)	- deleteChatMessage:
	Deletes chat message by message ID.

(nullable NSArray< NSString * > *)	- getAllChatMessageID
	Gets all chat message IDs.

(BOOL)	- isChatMessageCanBeDeleted:
	Determines whether the message can be deleted.

(BOOL)	- isShareMeetingChatLegalNoticeAvailable
	Determines if share meeting chat legal notice is available.

(NSString *_Nullable)	- getShareMeetingChatStartedLegalNoticeContent
	Gets start share meeting chat legal notice content.

(NSString *_Nullable)	- getShareMeetingChatStoppedLegalNoticeContent
	Gets stop share meeting chat legal notice content.

(BOOL)	- isFileTransferEnabled
	Determines whether file transfer is enabled.

(void)	- customizeMeetingTitle:
	Sets to customize the meeting title which will be displayed in the meeting bar.

(BOOL)	- canSetMeetingTopic
	Determines if host or co-host can change the meeting topic.

(MobileRTCSDKError)	- setMeetingTopics:
	Sets to customize the meeting topic which will be displayed in the meeting info view.

(BOOL)	- setMeetingTopic:
	Sets to customize the meeting topic which will be displayed in the meeting info view.

(BOOL)	- isCallRoomDeviceSupported
	Queries if it is able to call Room device (H.323).

(BOOL)	- isCallingRoomDevice
	Queries if it is in process to call room device.

(BOOL)	- cancelCallRoomDevice
	Cancels calling room device.

(nullable NSArray< NSString * > *)	- getIPAddressList
	Gets an array of IP addresses of room device which is used for calling.

(nullable NSString *)	- getH323MeetingPassword
	Gets the password of the meeting running on H.323 device.

(nullable NSArray< MobileRTCRoomDevice * > *)	- getRoomDeviceList
	Gets room devices that can be called.

(BOOL)	- sendPairingCode:WithMeetingNumber:
	Gets the pairing code when the room device calls in.

(BOOL)	- callRoomDevice:
	The user calls out to invite the room device.

(NSUInteger)	- getParticipantID
	Gets the participant ID.

(BOOL)	- setCustomizedPollingUrl:bCreate:
	Allows the developer to customize the URL of creating or editing the polling.

(BOOL)	- isSupportDocs
	Determines whether the current meeting supports Docs.

(MobileRTCCannotShareReasonType)	- canStartShareDoc
	Determines whether the current user can start sharing Doc.

(MobileRTCSDKError)	- showDocByParentViewCtroller:
	Shows Doc or DocDashboardView. Need to set parent view controller. If Doc is active MobileRTCDocsStatus_Start, that can show active Doc.

(MobileRTCSDKError)	- showActiveDoc:byParentViewCtroller:
	Shows Doc or DocDashboardView. Need to set parent view controller. If Doc is active MobileRTCDocsStatus_Start, that can show active Doc.

(MobileRTCSDKError)	- showDocDashboardView
	Shows the dashboard web view window.

(void)	- dismissDocOrDashboardView
	Dismisses Doc or dashboard.

(BOOL)	- canSetDocsOption
	Determines whether the current user can set Docs option.

(MobileRTCSDKError)	- setDocsShareOption:
	Sets the setting option for Docs who can share.

(MobileRTCDocsShareOption)	- getDocsShareOption
	Gets the setting option for Docs who can share.

(MobileRTCSDKError)	- setDocsCreateOption:
	Sets the setting option for Docs who can initiate new Docs.

(MobileRTCDocsCreateOption)	- getDocsCreateOption
	Gets the setting option for who can initiate new Docs.

(BOOL)	- isOtherSharingDocs
	Queries if other user is sharing docs.

(BOOL)	- isSharingDocsOut
	Queries if the current user is sharing docs successfully.

(NSArray< MobileRTCDocSharingSourceInfo * > *_Nullable)	- getDocSharingSourceInfoList:
	Gets the list of sharing source info.

(MobileRTCMeetingEncryptionType)	- getEncryptionType
	Gets the meeting encryption type.

(NSString *_Nullable)	- getE2EEMeetingSecurityCode
	Gets E2EE meeting security code.

(unsigned int)	- getE2EEMeetingSecurityCodePassedSeconds
	Gets security code passed seconds.

(BOOL)	- isUnencryptedExceptionDataValid
	Determines whether unencrypted exception data is valid.

(unsigned int)	- getUnencryptedExceptionCount
	Gets unencrypted exception count.

(NSString *_Nonnull)	- getUnencryptedExceptionInfo
	Gets unencrypted exception info.

(NSString *_Nonnull)	- getInMeetingDataCenterInfo
	Gets data center info.

(BOOL)	- isMeetingHost
	Queries if the current user is the host of the meeting.

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

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

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

(BOOL)	- isMeetingLocked
	Notifies 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
	Notifies if the share is locked by host. Once the meeting is locked by the host or co-host, other users cannot share except the host or co-host.

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

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

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

(BOOL)	- resumePauseCMR
	Pauses or resumes cloud recording in the meeting.

(void)	- turnOnCMR:
	Turns on or off the cloud recording in the meeting.

(MobileRTCRecordingStatus)	- getCloudRecordingStatus
	Gets current cloud recording status.

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

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

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

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

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

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

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

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

(MobileRTCAudioStatisticInfo *_Nullable)	- getMeetingAudioStatisticInfo
	Gets meeting audio statistics information.

(MobileRTCASVStatisticInfo *_Nullable)	- getMeetingVideoStatisticInfo
	Gets meeting video statistics information.

(MobileRTCASVStatisticInfo *_Nullable)	- getMeetingShareStatisticInfo
	Gets meeting share statistics information.

(BOOL)	- presentMeetingChatViewController:userId:
	Presents 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)	- isLiveStreamReminderEnabled
	Check if the live stream reminder is enabled.

(BOOL)	- canEnableLiveStreamReminder
	Check if the current user can enable/disable the live stream reminder.

(MobileRTCSDKError)	- enableLiveStreamReminder:
	Enable or disable the live stream reminder.

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

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

(NSArray< MobileRTCLiveStreamItem * > *_Nullable)	- getSupportLiveStreamItems
	Get the list of live stream information items in the current meeting.

(MobileRTCLiveStreamItem *_Nullable)	- getCurrentLiveStreamItem
	Get the current live stream object.

(BOOL)	- stopLiveStream
	Set to stop live streaming.

(BOOL)	- isRawLiveStreamSupported
	Query Whether the meeting supports raw live streams.

(MobileRTCSDKError)	- canStartRawLiveStream
	Whether the current user is able to start raw live streaming.

(MobileRTCSDKError)	- requestRawLiveStreaming:broadcastName:
	Send a request to enable the SDK to start a raw live stream.

(MobileRTCSDKError)	- startRawLiveStreaming:broadcastName:
	Start a rawData live stream.

(MobileRTCSDKError)	- stopRawLiveStream
	Stop a rawData live stream.

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

(NSArray< MobileRTCRawLiveStreamInfo * > *_Nullable)	- getRawLiveStreamingInfoList
	Get a list of current active raw live streams.

(NSArray< NSNumber * > *_Nullable)	- getRawLiveStreamPrivilegeUserList
	Get the list of users' IDs who have raw live stream privileges.

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

(MobileRTCSDKError)	- showAANPanelInView:
	Show app signaling pannel in designated position of container view.

(MobileRTCSDKError)	- hideAANPanel
	Hide app signaling pannel.

(MobileRTCSDKError)	- showDynamicNoticeForAICompanionPanel:
	Show the dynamic notice for the AI Companion panel view in the bottom of the container 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:
	Allow participant to start video.

(BOOL)	- isParticipantsStartVideoAllowed
	Query is allow participant to start video.

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

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

(BOOL)	- isParticipantProfilePicturesHidden
	Query if the current meeting hides participant pictures.

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

(BOOL)	- isSupportVirtualNameTag
	Determines if there is support for the virtual name tag feature.

(MobileRTCSDKError)	- enableVirtualNameTag:
	Enable the virtual name tag feature for the account.

(MobileRTCSDKError)	- updateVirtualNameTagRosterInfo:
	Update the virtual name tag roster infomation for the account.

(BOOL)	- isInterpretationEnabled
	Determines if the interpretation feature is enabled in the meeting.

(BOOL)	- isInterpretationStarted
	Determines if interpretation has been started by the host.

(BOOL)	- isInterpreter
	Determines if myself is an interpreter.

(MobileRTCInterpretationLanguage *_Nullable)	- getInterpretationLanguageByID:
	Gets the interpretation language object of the specified language ID.

(NSArray< MobileRTCInterpretationLanguage * > *_Nullable)	- getAllLanguageList
	Gets all interpretation language list.

(NSArray< MobileRTCMeetingInterpreter * > *_Nullable)	- getInterpreterList
	Gets the interpreters list.

(BOOL)	- addInterpreter:lan1:andLan2:
	Adds someone as an interpreter.

(BOOL)	- removeInterpreter:
	Removes an interpreter.

(BOOL)	- modifyInterpreter:lan1:andLan2:
	Modifies the language of an interpreter.

(BOOL)	- startInterpretation
	Starts interpretation.

(BOOL)	- stopInterpretation
	Stops interpretation.

(NSArray< MobileRTCInterpretationLanguage * > *_Nullable)	- getAvailableLanguageList
	Gets the available interpretation language list.

(BOOL)	- joinLanguageChannel:
	Joins a language channel.

(NSInteger)	- getJoinedLanguageID
	Gets the language ID which myself is in.

(BOOL)	- turnOffMajorAudio
	Turns off the major audio if you are in some interpreter language channel.

(BOOL)	- turnOnMajorAudio
	Turns on the major audio if you are in some interpreter language channel.

(BOOL)	- isMajorAudioTurnOff
	Determines if the major audio is off.

(NSArray< MobileRTCInterpretationLanguage * > *_Nullable)	- getInterpreterLans
	Gets languages if myself is an interpreter.

(BOOL)	- setInterpreterActiveLan:
	Sets a language channel which myself will be in, if myself is an interpreter.

(NSInteger)	- getInterpreterActiveLan
	Gets the active language ID, if myself is an interpreter.

(NSArray< MobileRTCInterpretationLanguage * > *_Nullable)	- getInterpreterAvailableLanguages
	Gets the list of available languages that interpreters can hear.

(BOOL)	- setInterpreterListenLan:
	Sets a language that I can hear as an interpreter.

(NSInteger)	- getInterpreterListenLan
	Gets a language that I can hear as an interpreter.

(BOOL)	- isMeetingSupportCC
	Queries if the current meeting supports closed caption.

(BOOL)	- canDisableCaptions
	Queries if the user can disable captions.

(MobileRTCSDKError)	- enableCaptions:
	Enables or disables captions.

(BOOL)	- isCaptionsEnabled
	Queries if captions are enabled.

(BOOL)	- isSupportRequestCaptions
	Determines whether users can request to start captions.

(MobileRTCSDKError)	- requestToStartCaptions:
	Requests the host to start captions. If the host approves your request, you receive the callback MobileRTCMeetingServiceDelegate::onStartCaptionsRequestApproved, and you should start captions or translation there.

(BOOL)	- isSupportTranslationWhenRequestToStartCaptions
	Determines if translation is available when users request to start captions.

(BOOL)	- canBeAssignedToSendCC:
	Queries if the user can be assigned to send closed caption.

(BOOL)	- assignCCPrivilege:
	Assigns the user privilege to send closed caption.

(BOOL)	- withdrawCCPrivilege:
	Withdraws the user privilege to send closed caption.

(BOOL)	- canAssignOthersToSendCC
	Queries if the current user can assign the privilege of sending closed caption to others.

(BOOL)	- enableMeetingManualCaption:
	Hosts only API to set meeting language for the entire meeting.

(BOOL)	- isMeetingManualCaptionEnabled
	Determines whether it is enabled to manually input CC for the meeting.

(BOOL)	- isLiveTranscriptionFeatureEnabled
	Queries if this meeting supports the live transcription feature.

(MobileRTCLiveTranscriptionStatus)	- getLiveTranscriptionStatus
	Gets the current live transcription status.

(BOOL)	- canStartLiveTranscription
	Queries if meeting participants can start live transcription.

(BOOL)	- startLiveTranscription
	Starts live transcription. If the meeting enables multi-language transcription, all users can start live transcription. Otherwise, only the host can start.

(BOOL)	- stopLiveTranscription
	Stops live transcription. If the meeting enables multi-language transcription, all users can stop live transcription. Otherwise, only the host can stop.

(BOOL)	- enableRequestLiveTranscription:
	The host enables or disables the request live transcription.

(BOOL)	- isRequestToStartLiveTranscriptionEnabled
	Queries if it is enabled to request to start live transcription.

(BOOL)	- requestToStartLiveTranscription:
	Requests the host to start live transcription.

(BOOL)	- isMultiLanguageTranscriptionEnabled
	Determines whether the multi-language transcription feature is enabled.

(BOOL)	- isTextLiveTranslationEnabled
	Determines whether the translated captions feature is enabled.

(MobileRTCSDKError)	- enableReceiveSpokenlLanguageContent:
	Enables or disables receiving original and translated content. If you enable this feature, you need to start live transcription.

(BOOL)	- isReceiveSpokenLanguageContentEnabled
	Determines whether receiving original and translated content is available.

(NSArray< MobileRTCLiveTranscriptionLanguage * > *_Nullable)	- getAvailableMeetingSpokenLanguages
	Gets the list of all available spoken languages in the meeting.

(BOOL)	- setMeetingSpokenLanguage:
	Sets the spoken language of the current user.

(MobileRTCSDKError)	- setMeetingSpokenLanguage:isForAll:
	Sets the current user's spoken language.

(MobileRTCLiveTranscriptionLanguage *_Nullable)	- getMeetingSpokenLanguage
	Gets the spoken language of the current user.

(NSArray< MobileRTCLiveTranscriptionLanguage * > *_Nullable)	- getAvailableTranslationLanguages
	Gets the list of all available translation languages in the meeting.

(BOOL)	- setTranslationLanguage:
	Sets the translation language of the current user.

(MobileRTCLiveTranscriptionLanguage *_Nullable)	- getTranslationLanguage
	Gets the translation language of the current user.

(BOOL)	- isSupportPhone
	Determines whether the user account supports calling out.

(BOOL)	- isDialOutSupported
	Determines whether the user can dial out in the meeting.

(NSArray< MobileRTCCallCountryCode * > *_Nullable)	- getSupportCountryInfo
	Gets the list of countries that support call out.

(BOOL)	- isDialOutInProgress
	Determines whether there is any outgoing call in process.

(BOOL)	- dialOut:isCallMe:withName:
	Starts to dial out.

(BOOL)	- cancelDialOut:
	Cancels the dial out.

(nullable MobileRTCCallCountryCode *)	- getDialInCurrentCountryCode
	Gets the country code for the current user's locale.

(nullable NSArray< NSArray< MobileRTCCallCountryCode * > * > *)	- getDialInAllCountryCodes
	Gets all country codes.

(nullable NSArray< MobileRTCCallCountryCode * > *)	- getDialInCallCodesWithCountryId:
	Gets the country codes specified by country ID.

(BOOL)	- dialInCall:
	Makes a phone call to access voice.

(BOOL)	- canDoPolling
	Determines whether the current meeting can do polling.

(NSString *_Nullable)	- getActivePollingID
	Gets the active poll's ID.

(NSArray< MobileRTCPollingQuestionItem * > *_Nullable)	- getPollingQuestionItemList:
	Gets the list of polling question's subquestion.

(BOOL)	- canGetRightAnswerItemList:
	Determines if the right answer item list can be allowed to get.

(NSArray< MobileRTCPollingAnswerItem * > *_Nullable)	- getPollingRightAnswerItemList:
	Gets the list of polling question or subquestion's right answer.

(BOOL)	- canShowAnswerResultList:
	Determines if the answer result list can be shown.

(NSArray< MobileRTCPollingAnswerResultItem * > *_Nullable)	- getPollingAnswerResultItemList:
	Gets the list of polling answer result items.

(MobileRTCPollingItem *_Nullable)	- getPollingItemByID:
	Gets the polling item object of the specified polling ID.

(NSString *_Nullable)	- getPollingQuestionImagePath:questionID:
	Gets the polling question's image path.

(NSInteger)	- getQuestionCharactersMinLen:questionID:
	Gets the polling question's minimum length.

(NSInteger)	- getQuestionCharactersMaxLen:questionID:
	Gets the polling question's maximum length.

(BOOL)	- isQuestionCaseSensitive:questionID:
	Determines if the question is case sensitive.

(BOOL)	- canAddPolling
	Determines if the host can add polling.

(MobileRTCSDKError)	- addPolling
	Creates polling in a web browser.

(BOOL)	- canEditPolling:
	Determines if the host can edit polling.

(MobileRTCSDKError)	- editPolling:
	Opens edit polling in a web browser.

(BOOL)	- canDeletePolling:
	Determines if the host can delete polling.

(MobileRTCSDKError)	- deletePolling:
	Deletes the polling.

(BOOL)	- canDuplicatePolling:
	Determines if the host can duplicate polling.

(MobileRTCSDKError)	- duplicatePolling:
	Duplicates the polling.

(BOOL)	- canViewPollingResultFromBrowser:
	Determines if the user can view polling results in the browser.

(MobileRTCSDKError)	- viewPollingResultFromBrowser:
	Opens a polling result in the web browser.

(NSArray< MobileRTCPollingItem * > *_Nullable)	- getPollingItemList
	Gets the list of poll items.

(BOOL)	- canStartPolling:
	Determines if the host or co-host can start the polling.

(MobileRTCSDKError)	- startPolling:
	Starts the polling.

(MobileRTCSDKError)	- stopPolling:
	Stops the polling.

(BOOL)	- canRestartPolling:
	Determines if the host or co-host can restart the polling.

(MobileRTCSDKError)	- restartPolling:
	Restarts the polling.

(BOOL)	- canSharePollingResult:
	Determines if the host or co-host can share the poll's result.

(MobileRTCSDKError)	- startSharePollingResult:
	Shares the poll's result.

(MobileRTCSDKError)	- stopSharePollingResult:
	Stops sharing the poll's result.

(MobileRTCSDKError)	- enableGetRightAnswerList:
	Sets to enable showing right answer to participants when sharing quiz's result.

(BOOL)	- canDownloadResult
	Determines if the host can download poll's result from browser.

(MobileRTCSDKError)	- downLoadResult
	Downloads all stopped poll's result from browser.

(MobileRTCSDKError)	- setAnswerCheck:check:
	Attendee sets answer's check.

(MobileRTCSDKError)	- setAnswerContent:answerText:
	Attendee sets answer's content.

(BOOL)	- canSubmitPolling:
	Determines if the attendee can submit the polling.

(MobileRTCSDKError)	- submitPolling:
	Attendee submits the polling.

(BOOL)	- isQAEnabled
	Queries if Q&A is supported in this meeting.

(MobileRTCSDKError)	- enableMeetingQAFeature:
	Enables or disables meeting QA.

(BOOL)	- isMeetingQAFeatureOn
	Queries if meeting QA is enabled in the current meeting.

(BOOL)	- isAskQuestionEnabled
	Determines if asking questions is allowed by the host or co-host.

(MobileRTCSDKError)	- enableAskQuestion:
	Sets whether attendee can ask questions.

(BOOL)	- presentQAViewController:
	Presents Zoom original Q&A ViewController.

(BOOL)	- isAllowAskQuestionAnonymously
	Queries if it is allowed to ask questions anonymously in webinar.

(BOOL)	- allowAskQuestionAnonymously:
	Sets if it is enabled to ask questions anonymously.

(BOOL)	- isAllowAttendeeViewAllQuestion
	Queries if attendee is allowed to view all questions.

(BOOL)	- allowAttendeeViewAllQuestion:
	Allows or disallows attendee to view all questions.

(BOOL)	- isAllowAttendeeUpVoteQuestion
	Queries if attendee is allowed to upvote questions.

(BOOL)	- allowAttendeeUpVoteQuestion:
	Allows or disallows attendee to upvote questions.

(BOOL)	- isAllowCommentQuestion
	Queries if attendee is allowed to comment on questions.

(BOOL)	- allowCommentQuestion:
	Allows or disallows attendee to comment on questions.

(nullable NSArray< MobileRTCQAItem * > *)	- getAllQuestionList
	Gets all questions.

(nullable NSArray< MobileRTCQAItem * > *)	- getMyQuestionList
	Gets my questions.

(nullable NSArray< MobileRTCQAItem * > *)	- getOpenQuestionList
	Gets open questions.

(nullable NSArray< MobileRTCQAItem * > *)	- getDismissedQuestionList
	Gets dismissed questions.

(nullable NSArray< MobileRTCQAItem * > *)	- getAnsweredQuestionList
	Gets answered questions.

(int)	- getALLQuestionCount
	Gets the amount of all questions.

(int)	- getMyQuestionCount
	Gets the amount of my questions.

(int)	- getOpenQuestionCount
	Gets the amount of open questions.

(int)	- getDismissedQuestionCount
	Gets the amount of dismissed questions.

(int)	- getAnsweredQuestionCount
	Gets the amount of answered questions.

(nullable MobileRTCQAItem *)	- getQuestion:
	Gets question item by question ID.

(nullable MobileRTCQAAnswerItem *)	- getAnswer:
	Gets answer item by answer ID.

(BOOL)	- addQuestion:anonymous:
	Adds a question.

(BOOL)	- answerQuestionPrivate:answerContent:
	Answers a question in private.

(BOOL)	- answerQuestionPublic:answerContent:
	Answers a question publicly.

(BOOL)	- commentQuestion:commentContent:
	Attendee comments on a question.

(BOOL)	- dismissQuestion:
	Dismisses a question.

(BOOL)	- reopenQuestion:
	Reopens a question.

(BOOL)	- voteupQuestion:voteup:
	Votes up a question.

(BOOL)	- startLiving:
	Starts living a question.

(BOOL)	- endLiving:
	Ends living a question.

(BOOL)	- deleteQuestion:
	Deletes a question.

(BOOL)	- deleteAnswer:
	Deletes an answer.

(BOOL)	- isQALegalNoticeAvailable
	Determines if QA legal notice is available.

(NSString *_Nullable)	- getQALegalNoticesPrompt
	Gets QA legal notices prompt.

(NSString *_Nullable)	- getQALegalNoticesExplained
	Gets QA legal notices explained.

(BOOL)	- startRawArchiving
	Starts raw archiving and gets raw data receive privilege.

(BOOL)	- stopRawArchiving
	Stops raw archiving and revokes raw data receive privilege.

(BOOL)	- isEmojiReactionEnabled
	Determines if the Reaction feature is enabled.

(MobileRTCSDKError)	- sendEmojiReaction:
	Sends emoji reaction.

(MobileRTCSDKError)	- sendEmojiFeedback:
	Sends the emoji feedback.

(MobileRTCSDKError)	- cancelEmojiFeedback
	Cancels the emoji feedback.

(BOOL)	- isSignInterpretationEnabled
	Determines if the sign interpretation function is enabled.

(MobileRTCSignInterpretationStatus)	- getSignInterpretationStatus
	Gets the sign interpretation status of the current meeting.

(BOOL)	- isSignInterpreter
	Determines if self is a sign interpreter.

(MobileRTCSignInterpreterLanguage *_Nullable)	- getSignInterpretationLanguageInfoByID:
	Gets the sign interpretation language object of the specified sign language ID.

(NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable)	- getAvailableSignLanguageInfoList
	Gets the available sign interpretation language list.

(NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable)	- getAllSupportedSignLanguageInfoList
	Gets all supported sign interpretation language list. Only for host.

(NSArray< MobileRTCSignInterpreter * > *_Nullable)	- getSignInterpreterList
	Gets the sign interpreters list.

(MobileRTCSDKError)	- addSignInterpreter:signLanId:
	Adds someone as a sign interpreter.

(MobileRTCSDKError)	- removeSignInterpreter:
	Removes an interpreter.

(MobileRTCSDKError)	- modifySignInterpreter:signLanId:
	Modifies the language of a sign interpreter.

(BOOL)	- canStartSignInterpretation
	Determines if I can start the sign interpretation in the meeting.

(MobileRTCSDKError)	- startSignInterpretation
	Starts sign interpretation.

(MobileRTCSDKError)	- stopSignInterpretation
	Stops sign interpretation.

(MobileRTCSDKError)	- requestSignLanuageInterpreterToTalk:allowToTalk:
	The host allows or disallows sign language interpreter to talk.

(BOOL)	- isAllowSignLanuageInterpreterToTalk:
	Determines if the sign language interpreter is allowed to talk.

(NSString *_Nullable)	- getSignInterpreterAssignedLanID
	Gets sign language ID if myself is a sign interpreter. Only for interpreter.

(MobileRTCSDKError)	- joinSignLanguageChannel:
	Joins a sign language channel if myself is not a sign interpreter. Only for non-interpreter.

(MobileRTCSDKError)	- leaveSignLanguageChannel
	Leaves the current sign language channel if myself is not a sign interpreter. Only for non-interpreter.

(BOOL)	- isSmartSummarySupported
	Determines if the current meeting supports smart summary feature.

(BOOL)	- isSmartSummaryEnabled
	Determines if the smart summary feature is enabled in the meeting.

(MobileRTCSDKError)	- canRequestStartSmartSummary
	Determines whether the current user can request the host to start the smart summary for the current meeting.

(MobileRTCSDKError)	- requestStartSmartSummary
	Requests the host to start the smart summary for the current meeting.

(MobileRTCSDKError)	- canStartSmartSummary
	Determines whether the current user is able to start smart summary.

(MobileRTCSDKError)	- startSmartSummary
	Starts smart summary.

(MobileRTCSDKError)	- stopSmartSummary
	Stops smart summary.

(BOOL)	- isSmartSummaryStarted
	Queries whether smart summary is started.

(BOOL)	- changeName:withUserID:
	Changes the user's screen name in the meeting.

(nullable NSArray< NSNumber * > *)	- getInMeetingUserList
	Gets all the users in the meeting.

(nullable NSArray< NSNumber * > *)	- getWebinarAttendeeList
	Gets all the attendees in the webinar.

(nullable MobileRTCMeetingUserInfo *)	- userInfoByID:
	Gets user information in the meeting.

(nullable MobileRTCMeetingWebinarAttendeeInfo *)	- attendeeInfoByID:
	Gets attendees' information in the webinar.

(BOOL)	- makeHost:
	Assigns a user as the host in the meeting.

(BOOL)	- removeUser:
	Removes a user from the meeting.

(NSUInteger)	- myselfUserID
	Gets the ID of the current user in the meeting.

(NSUInteger)	- activeUserID
	Gets the ID of the active user in the meeting.

(NSUInteger)	- activeShareUserID
	Gets the ID of the user who is sharing in the meeting.

(NSArray< NSNumber * > *_Nullable)	- getViewableSharingUserList
	Gets the IDs of users who are sharing.

(NSArray< NSNumber * > *_Nullable)	- getViewableDocSharingUserList
	Gets the IDs of users who are sharing docs.

(NSArray *_Nullable)	- getCompanionChildList:
	Gets the user's child list.

(MobileRTCMeetingUserInfo *_Nullable)	- getCompanionParentUser:
	Gets the information about the user's parent user.

(BOOL)	- isSameUser:compareTo:
	Judges if the two IDs from different sessions are of the same user.

(BOOL)	- isHostUser:
	Queries if the user is host.

(BOOL)	- isMyself:
	Queries if the ID is the current user's.

(BOOL)	- isH323User:
	Queries if the user joined the meeting from H.323.

(BOOL)	- raiseMyHand
	Raises hand of the current user.

(BOOL)	- lowerHand:
	Puts hands down of the current user.

(BOOL)	- lowerAllHand:
	Puts all users' hands down.

(BOOL)	- isSelfOriginalHost
	Queries whether the current user is the original host.

(BOOL)	- canClaimhost
	Queries if the current user can claim to be a host.

(BOOL)	- reclaimHost
	Reclaims the role of the host.

(BOOL)	- claimHostWithHostKey:
	Claims to be a host by host key.

(BOOL)	- assignCohost:
	Assigns a user as co-host in the meeting.

(BOOL)	- revokeCoHost:
	Revokes co-host role of another user in the meeting.

(BOOL)	- canBeCoHost:
	Queries if the user can be assigned as co-host in the meeting.

(BOOL)	- isRawLiveStreaming:
	Determines whether the user has started a live stream.

(BOOL)	- hasRawLiveStreamPrivilege:
	Determines whether the user has raw live stream privilege.

(nullable MobileRTCMeetingUserInfo *)	- getBotAuthorizedUserInfoByUserID:
	Gets the information about the bot's authorized user.

(nullable NSArray< NSNumber * > *)	- getAuthorizedBotListByUserID:
	Gets the authorizer's bot list.

(MobileRTCSDKError)	- assignCohost:withAssetsPrivilege:
	Assigns a user as co-host in the meeting and grants this user with privilege to manage related assets after the meeting.

(MobileRTCSDKError)	- makeHost:withAssetsPrivilege:
	Assigns a user as the host in the meeting and grants this user with privilege to manage related assets after the meeting.

(BOOL)	- canBeCoOwner:
	Queries if the user can be assigned as co-owner in the meeting. Co-owner can be granted with privilege to manage some assets after the meeting.

(BOOL)	- isSendingMyVideo
	Queries if the user is sending video.

(BOOL)	- canUnmuteMyVideo
	Queries if the user can unmute their video themselves.

(MobileRTCSDKError)	- muteMyVideo:
	Mutes or unmutes video of the current user.

(BOOL)	- rotateMyVideo:
	Rotates my video.

(BOOL)	- isUserSpotlighted:
	Queries if the user's video is spotlighted. Once the user's video is spotlighted, it shows only the specified video in the meeting instead of the active user's.

(BOOL)	- spotlightVideo:withUser:
	Sets whether to spotlight the user's video.

(BOOL)	- unSpotlightAllVideos
	Un-spotlights all users.

(NSArray< NSNumber * > *_Nullable)	- getSpotLightedVideoUserList
	Gets the spotlight user list.

(BOOL)	- isUserPinned:
	Queries if the user's video is pinned.

(MobileRTCPinResult)	- canPinVideo:
	Determines whether the user's video can be pinned.

(BOOL)	- pinVideo:withUser:
	Sets whether to pin the user's video or not.

(BOOL)	- isUserVideoSending:
	Queries if the user's video is being sent.

(BOOL)	- stopUserVideo:
	Stops the user's video.

(BOOL)	- askUserStartVideo:
	The host can use this function to demand the user to start video.

(CGSize)	- getUserVideoSize:
	Gets the size of the user's video.

(BOOL)	- isBackCamera
	Queries if the user is using back camera.

(MobileRTCCameraError)	- switchMyCamera
	Switches the camera of the current user in the local device.

(NSArray< MobileRTCCameraDevice * > *_Nullable)	- getCameraDeviceList
	Gets the camera device list.

(BOOL)	- switchCamera:
	Switches camera by camera ID.

(MobileRTCCameraDevice *_Nullable)	- getSelectedCamera
	Gets the current camera device in use.

(BOOL)	- zoomCamera:
	Zooms the camera in or out.

(MobileRTCSDKError)	- setVideoQualityPreference:
	Sets the video quality preference that automatically adjusts the user's video to prioritize frame rate vs. resolution based on the current bandwidth available.

(BOOL)	- isSupportFollowHostVideoOrder
	Queries if the account supports follow host video order feature.

(BOOL)	- isFollowHostVideoOrderOn
	Queries if follow host video order is currently on.

(NSArray< NSNumber * > *_Nullable)	- getVideoOrderList
	Gets the follow host video order array currently.

(MobileRTCSDKError)	- stopIncomingVideo:
	Stops the incoming video.

(BOOL)	- isIncomingVideoStoped
	Determines if the incoming video is stopped.

(BOOL)	- isStopIncomingVideoSupported
	Determines if the incoming video is supported.

(MobileRTCSDKError)	- enableVideoAutoFraming:forMode:
	Enables my video auto-framing.

(MobileRTCSDKError)	- disableVideoAutoFraming
	Stops video auto-framing.

(BOOL)	- isVideoAutoFramingEnabled
	Determines whether auto-framing is enabled.

(MobileRTCAutoFramingMode)	- getVideoAutoFramingMode
	Gets the current mode of auto-framing.

(MobileRTCSDKError)	- setVideoAutoFramingMode:
	Sets the mode of auto-framing when auto-framing is enabled.

(MobileRTCSDKError)	- setVideoAutoFramingRatio:
	Sets the zoom in ratio of auto-framing when auto-framing is enabled.

(MobileRTCSDKError)	- setFaceRecognitionFailStrategy:
	Sets the fail strategy of face recognition when auto-framing is enabled (mode is MobileRTCAutoFramingMode_FaceRecognition).

(MobileRTCAutoFramingParameter *_Nullable)	- getVideoAutoFramingSetting:
	Gets the setting of auto-framing.

(BOOL)	- canEnableAlphaChannelMode
	Determines if alpha channel mode can be enabled.

(MobileRTCSDKError)	- enableAlphaChannelMode:
	Enables or disables alpha channel mode.

(BOOL)	- isAlphaChannelModeEnabled
	Determines if alpha channel mode is enabled.

(BOOL)	- startPreviewWithFrame:
	Starts preview to inspect the virtual background effect.

(void)	- stopPreview
	Stops previewing the virtual background.

(BOOL)	- isSupportVirtualBG
	Determines if the virtual background feature is supported by the meeting.

(BOOL)	- isDeviceSupportSmartVirtualBG
	Determines if the smart virtual background feature can be supported by the machine.

(BOOL)	- isSupportSmartVirtualBG
	Determines if smart virtual background is supported.

(NSArray< MobileRTCVirtualBGImageInfo * > *_Nullable)	- getBGImageList
	Gets the virtual background list.

(BOOL)	- isAllowToAddNewVBItem
	Determines if the adding new virtual background item feature is supported by the meeting.

(MobileRTCMeetError)	- addBGImage:
	Adds and uses the image for virtual background.

(MobileRTCMeetError)	- removeBGImage:
	Removes image item from image list. Will use the previous one for virtual background.

(MobileRTCMeetError)	- useBGImage:
	Uses the specified image item for virtual background.

(MobileRTCMeetError)	- useNoneImage
	Disables the virtual background, same as using a none image item.

(BOOL)	- isUsingGreenVB
	Determines if using green virtual background.

(MobileRTCMeetError)	- enableGreenVB:
	Enables or disables green virtual background mode.

(MobileRTCMeetError)	- selectGreenVBPoint:
	Selects the point that is regarded as background.

(BOOL)	- hasPromptAndDePromptPrivilege
	Queries if the user has the privilege to prompt or demote users in the webinar.

(BOOL)	- promptAttendee2Panelist:
	Prompts attendee to panelist in Webinar.

(BOOL)	- dePromptPanelist2Attendee:
	Demotes the panelist to attendee.

(BOOL)	- changePanelistChatPrivilege:
	Sets the chat privilege of the panelist.

(MobileRTCPanelistChatPrivilegeType)	- getPanelistChatPrivilege
	Gets the chat privilege of the panelist.

(BOOL)	- allowAttendeeChat:
	Allows or disallows attendee to chat.

(MobileRTCChatAllowAttendeeChat)	- getWebinarAttendeeChatPrivilege
	Gets webinar attendee chat privilege type.

(BOOL)	- isAllowAttendeeTalk:
	Queries if the attendee is allowed to talk in Webinar Meeting.

(BOOL)	- allowAttenddeTalk:allow:
	Allows or disallows attendee to talk in webinar.

(BOOL)	- isAllowPanelistStartVideo
	Queries if panelist can start video in Webinar Meeting.

(BOOL)	- allowPanelistStartVideo:
	Allows or disallows panelist to start video in Webinar.

(BOOL)	- isWebinarEmojiReactionSupported
	Determines if current webinar supports emoji reactions.

(BOOL)	- isWebinarEmojiReactionAllowed
	Queries if emoji reactions status is allowed.

(MobileRTCSDKError)	- allowWebinarEmojiReaction
	Permits the use of emoji reactions.

(MobileRTCSDKError)	- disallowWebinarEmojiReaction
	Forbids the use of emoji reactions.

(BOOL)	- isAttendeeRaiseHandAllowed
	Queries if attendee raise hand status is allowed.

(MobileRTCSDKError)	- allowAttendeeRaiseHand
	Allows the attendee to use the raise hand.

(MobileRTCSDKError)	- disallowAttendeeRaiseHand
	Does not let the attendee raise their hand.

(BOOL)	- isAttendeeViewTheParticipantCountAllowed
	Queries if attendee is allowed to view the participant count.

(MobileRTCSDKError)	- allowAttendeeViewTheParticipantCount
	Allows the attendee to view the participant count.

(MobileRTCSDKError)	- disallowAttendeeViewTheParticipantCount
	Forbids the attendee to view the participant count.

(NSUInteger)	- getParticipantCount
	Gets the participant count.

(MobileRTCSDKError)	- setAttendeeViewMode:
	Sets the view mode of the attendee.

(MobileRTCAttendeeViewMode)	- getAttendeeViewMode
	Gets the view mode of the attendee.

(NSString *_Nullable)	- getPollLegalNoticesPrompt
	Gets poll legal notices prompt.

(BOOL)	- isPollingLegalNoticeAvailable
	Determines if polling legal notice is available.

(NSString *_Nullable)	- getPollLegalNoticesExplained
	Gets poll legal notices explained.

(NSString *_Nullable)	- getPollAnonymousLegalNoticesExplained
	Gets poll anonymous legal notices explained.

(NSString *_Nullable)	- getWebinarRegistrationLegalNoticesPrompt
	Gets annotation over share legal notices prompt.

(MobileRTCWebinarRegistLegalNoticeContent *_Nullable)	- getWebinarRegistrationLegalNoticesExplained
	Gets annotation over share legal notices explained.

(BOOL)	- isSupportWhiteBoard
	Determines whether the current meeting supports the whiteboard.

(MobileRTCCannotShareReasonType)	- canStartShareWhiteboard
	Determines whether the current meeting can start sharing the whiteboard.

(MobileRTCSDKError)	- setParentViewCtroller:
	Sets parent view controller for whiteboard board view and whiteboard canvas.

(MobileRTCSDKError)	- showWhiteboardByParentViewCtroller:
	Shows whiteboard or DashboardView. Need to set parent view controller. If whiteboard is active MobileRTCWhiteboardStatus_Started, that can show active whiteboard.

(MobileRTCSDKError)	- showDashboardView
	Shows the dashboard web view window.

(void)	- dismissWhiteboardOrDashboard
	Dismisses whiteboard or dashboard.

(MobileRTCSDKError)	- setWhiteboardShareOption:
	Sets the option for who can share a whiteboard.

(MobileRTCWhiteboardShareOption)	- getWhiteboardShareOption
	Gets the option for who can share a whiteboard.

(MobileRTCSDKError)	- setWhiteboardCreateOption:
	Sets the option for who can initiate a new whiteboard.

(MobileRTCWhiteboardCreateOption)	- getWhiteboardCreateOption
	Gets the option for who can initiate a new whiteboard.

(MobileRTCSDKError)	- enableParticipantsCreateWithoutHost:
	Enables or disables the participants to create a new whiteboard without the host in the meeting.

(BOOL)	- isParticipantsCreateWithoutHostEnabled
	Determines whether enabling the participants to create a new whiteboard without the host in the meeting is enabled.

(void)	- disableCloudWhiteboard:
	Enables or disables the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature is enabled by default.

(BOOL)	- setCloudWhiteboardFeedbackUrl:
	Allows the developer to customize the URL of cloud whiteboard feedback.

(void)	- hideCloudWhiteboardHelperCenterButton:
	Sets the Helper center button's visibility on cloud whiteboard. Default is displaying.

(void)	- hideCloudWhiteboardOpenInBrowserButton:
	Sets the Open in browser button's visibility on cloud whiteboard. Default is displaying.

(void)	- hideFeedbackButtonOnCloudWhiteboard:
	Hides feedback button on cloud whiteboard.

(void)	- hideShareButtonOnCloudWhiteboard:
	Hides share button on cloud whiteboard.

(void)	- hideAboutButtonOnCloudWhiteboard:
	Sets About button's visibility on the cloud whiteboard. Default is displaying.

(BOOL)	- isWhiteboardLegalNoticeAvailable
	Determines if whiteboard legal notice is available.

(NSString *_Nullable)	- getWhiteboardLegalNoticesPrompt
	Gets whiteboard legal notices message.

(NSString *_Nullable)	- getWhiteboardLegalNoticesExplained
	Gets whiteboard legal notices detailed description.

(BOOL)	- isOtherSharingWhiteboard
	Determines if other user is sharing whiteboard.

(BOOL)	- isSharingWhiteboardOut
	Determines if the current user is sharing whiteboard.


(MobileRTCSDKError)	- transferFile:toUser:
	Sends file to the specified user in the current meeting.

(MobileRTCSDKError)	- transferFileToAll:
	Sends file to all users in the current meeting.

(NSString *_Nullable)	- getTransferFileTypeAllowList
	Gets the list of allowed file types in transfer.

(unsigned long long)	- getMaxTransferFileSize
	Gets the maximum size for file transfer.

Properties
id< MobileRTCMeetingServiceDelegate > _Nullable	delegate
	Callback to receive meeting events.

id< MobileRTCCustomizedUIMeetingDelegate > _Nullable	customizedUImeetingDelegate
	Callback for custom UI meeting events. Custom UI features enable you to customize the user interface instead of using the default client view.

UIView *_Nullable	previewView
	The preview for inspect the virtual background effect.

Detailed Description

Enables the client to start or join a meeting.

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

Definition at line 304 of file MobileRTCMeetingService.h.

Method Documentation

◆ activeShareUserID

- (NSUInteger) activeShareUserID

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

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

Deprecated: Use getViewableSharingUserList instead.

Provided by category MobileRTCMeetingService(User).

◆ activeUserID

- (NSUInteger) activeUserID

Gets the ID of the active user in the meeting.

Returns: The active user ID.

Provided by category MobileRTCMeetingService(User).

◆ addBGImage:

- (MobileRTCMeetError) addBGImage: (UIImage *_Nullable) image

Adds and uses the image for virtual background.

Parameters

image The image to add.

Returns: Add and use virtual background result.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ addInterpreter:lan1:andLan2:

- (BOOL) addInterpreter:	(NSUInteger)	userID
lan1:	(NSInteger)	lanID1
andLan2:	(NSInteger)	lanID2

Adds someone as an interpreter.

Parameters

userID	The user ID.
lanID1	The first language ID.
lanID2	The second language ID.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ addPolling

- (MobileRTCSDKError) addPolling

Creates polling in a web browser.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ addQuestion:anonymous:

- (BOOL) addQuestion:		(nonnull NSString *)	content
anonymous:		(BOOL)	anonymous

Adds a question.

Parameters

content	The question content.
anonymous	YES if anonymously. Otherwise, NO.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only attendee can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ addSignInterpreter:signLanId:

- (MobileRTCSDKError) addSignInterpreter:		(NSUInteger)	userID
signLanId:		(NSString *_Nullable)	signLanID

Adds someone as a sign interpreter.

Parameters

userID	The unique identity of the user.
signLanID	The ID of sign language.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: The interface is for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ allowAskQuestionAnonymously:

- (BOOL) allowAskQuestionAnonymously: (BOOL) enable

Sets if it is enabled to ask questions anonymously.

Parameters

enable YES to enable. Otherwise, NO to disable.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run this function.

Provided by category MobileRTCMeetingService(QA).

◆ allowAttenddeTalk:allow:

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

Allows or disallows attendee to talk in webinar.

Parameters

userID	The user ID to be allowed.
enable	YES to enable. Otherwise, NO to disable.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeChat:

- (BOOL) allowAttendeeChat: (MobileRTCChatAllowAttendeeChat) privilegeType

Allows or disallows attendee to chat.

Parameters

privilegeType The chat privilege type.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.; Only webinar meeting can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeRaiseHand

- (MobileRTCSDKError) allowAttendeeRaiseHand

Allows the attendee to use the raise hand.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: If the function succeeds, the user will receive the callback onAllowAttendeeRiseHandStatusChanged:. Available only for the host.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeUpVoteQuestion:

- (BOOL) allowAttendeeUpVoteQuestion: (BOOL) enable

Allows or disallows attendee to upvote questions.

Parameters

enable YES to allow. Otherwise, NO to disallow.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ allowAttendeeViewAllQuestion:

- (BOOL) allowAttendeeViewAllQuestion: (BOOL) enable

Allows or disallows attendee to view all questions.

Parameters

enable YES to enable. Otherwise, NO to disable.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run this function.

Provided by category MobileRTCMeetingService(QA).

◆ allowAttendeeViewTheParticipantCount

- (MobileRTCSDKError) allowAttendeeViewTheParticipantCount

Allows the attendee to view the participant count.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged: callback event. Available only for the host.

Provided by category MobileRTCMeetingService(Webinar).

◆ allowCommentQuestion:

- (BOOL) allowCommentQuestion: (BOOL) enable

Allows or disallows attendee to comment on questions.

Parameters

enable YES to allow. Otherwise, NO to disallow.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ allowPanelistStartVideo:

- (BOOL) allowPanelistStartVideo: (BOOL) enable

Allows or disallows panelist to start video in Webinar.

Parameters

enable YES to enable. Otherwise, NO to disable.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ 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, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ allowParticipantsToRequestLocalRecording:

- (MobileRTCSDKError) allowParticipantsToRequestLocalRecording: (BOOL) allow

Allow participant to request local recording.

Parameters

allow YES: allow, NO: disallow.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ allowParticipantsToShareWhiteBoard:

- (MobileRTCSDKError) allowParticipantsToShareWhiteBoard: (BOOL) allow

Allows or disallows participants to share whiteboard.

Parameters

allow YES to allow. Otherwise, NO to disallow.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(AppShare).

◆ allowParticipantsToStartVideo:

- (MobileRTCSDKError) allowParticipantsToStartVideo: (BOOL) allow

Allow participant to start video.

Parameters

allow YES: allow, NO: disallow.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ allowWebinarEmojiReaction

- (MobileRTCSDKError) allowWebinarEmojiReaction

Permits the use of emoji reactions.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: If the function succeeds, the user will receive the callback onAllowWebinarReactionStatusChanged:. Available only for the host.

Provided by category MobileRTCMeetingService(Webinar).

◆ answerQuestionPrivate:answerContent:

- (BOOL) answerQuestionPrivate:		(nonnull NSString *)	questionID
answerContent:		(nonnull NSString *)	answerContent

Answers a question in private.

Parameters

questionID	The question ID.
answerContent	The answer content.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ answerQuestionPublic:answerContent:

- (BOOL) answerQuestionPublic:		(nonnull NSString *)	questionID
answerContent:		(nonnull NSString *)	answerContent

Answers a question publicly.

Parameters

questionID	The question ID.
answerContent	The answer content.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ appShareWithView:

- (void) appShareWithView: (nonnull id) view

Shares content with the current view.

Parameters

view	The view to share.

Warning: View, recommend to pass a single UIView object, e.g., UIView, UIImageView, or WKWebView.; The UIView passed should not have any child subviews.

Provided by category MobileRTCMeetingService(AppShare).

◆ askAllToUnmute

- (BOOL) askAllToUnmute

Asks all attendees to unmute audio.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(Audio).

◆ askUserStartVideo:

- (BOOL) askUserStartVideo: (NSUInteger) userID

The host can use this function to demand the user to start video.

Parameters

userID The user ID who needs to turn on video in the meeting.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only host can run the function in the meeting.

Provided by category MobileRTCMeetingService(Video).

◆ assignCCPrivilege:

- (BOOL) assignCCPrivilege: (NSUInteger) userId

Assigns the user privilege to send closed caption.

Parameters

userId The user ID.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ assignCohost:

- (BOOL) assignCohost: (NSUInteger) userID

Assigns a user as co-host in the meeting.

Parameters

userID The user ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: The co-host cannot be assigned as co-host by themselves. And the user should have the power to assign the role.

Provided by category MobileRTCMeetingService(User).

◆ assignCohost:withAssetsPrivilege:

- (MobileRTCSDKError) assignCohost:		(NSUInteger)	userId
withAssetsPrivilege:		(NSArray< MobileRTCGrantCoOwnerAssetsInfo * > *_Nonnull)	infoList

Assigns a user as co-host in the meeting and grants this user with privilege to manage related assets after the meeting.

Parameters

userId	The user ID who is specified as co-host in the meeting.
infoList	The assets privilege information list.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: The co-host cannot be assigned as co-host by themselves. And the user should have the power to assign the role.

Provided by category MobileRTCMeetingService(User).

◆ attendeeInfoByID:

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

Gets attendees' information in the webinar.

Parameters

userId The attendee's ID in the meeting.

Returns: Attendee info, a MobileRTCMeetingWebinarAttendeeInfo object.

Warning: Webinar meeting host, co-host, or panelist can get other attendee info.; Webinar attendee can only get their own attendee info.

Provided by category MobileRTCMeetingService(User).

◆ autoAllowLocalRecordingRequest:

- (MobileRTCSDKError) autoAllowLocalRecordingRequest: (BOOL) allow

Allow participants to request local recording.

Parameters

allow YES: allow, NO: disallow.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ backZoomUIMeetingFromMinimizeMeeting

- (BOOL) backZoomUIMeetingFromMinimizeMeeting

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

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: The method only for Zoom UI.

Provided by category MobileRTCMeetingService(InMeeting).

◆ callRoomDevice:

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

The user calls out to invite the room device.

Parameters

device The room device.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Customize).

◆ canAddPolling

- (BOOL) canAddPolling

Determines if the host can add polling.

Returns: YES if the host can add polling. Otherwise, NO.

Warning: Only the origin host can add polling.

Provided by category MobileRTCMeetingService(Polling).

◆ canAssignOthersToSendCC

- (BOOL) canAssignOthersToSendCC

Queries if the current user can assign the privilege of sending closed caption to others.

Returns: YES if the user can assign others privilege to send closed caption. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ canBeAssignedToSendCC:

- (BOOL) canBeAssignedToSendCC: (NSUInteger) userId

Queries if the user can be assigned to send closed caption.

Parameters

userId The user ID.

Returns: YES if the user can be assigned to send closed caption. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ canBeCoHost:

- (BOOL) canBeCoHost: (NSUInteger) userID

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

Parameters

userID The user ID.

Returns: YES if the user can be assigned as co-host. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ canBeCoOwner:

- (BOOL) canBeCoOwner: (NSUInteger) userId

Queries if the user can be assigned as co-owner in the meeting. Co-owner can be granted with privilege to manage some assets after the meeting.

Parameters

userId The user ID who will be assigned as co-owner in the meeting.

Returns: YES if the user can be assigned as co-owner. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ cancelCallRoomDevice

- (BOOL) cancelCallRoomDevice

Cancels calling room device.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Customize).

◆ cancelDialOut:

- (BOOL) cancelDialOut: (BOOL) isCallMe

Cancels the dial out.

Parameters

isCallMe YES to call me, NO to invite others by phone.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Phone).

◆ cancelEmojiFeedback

- (MobileRTCSDKError) cancelEmojiFeedback

Cancels the emoji feedback.

Returns: If the function succeeds, it will return MobileRTCMeetError_Success, otherwise not.

Provided by category MobileRTCMeetingService(Reaction).

◆ canClaimhost

- (BOOL) canClaimhost

Queries if the current user can claim to be a host.

Returns: YES if the current user can claim to be a host. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ canDeletePolling:

- (BOOL) canDeletePolling: (NSString *_Nullable) pollingID

Determines if the host can delete polling.

Parameters

pollingID The edit poll's polling ID.

Returns: YES if can delete the polling. Otherwise, NO.

Warning: Only the origin host can delete polling.

Provided by category MobileRTCMeetingService(Polling).

◆ canDisableCaptions

- (BOOL) canDisableCaptions

Queries if the user can disable captions.

Returns: YES if the host can disable captions. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ canDoPolling

- (BOOL) canDoPolling

Determines whether the current meeting can do polling.

Returns: YES if you can do polling. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ canDownloadResult

- (BOOL) canDownloadResult

Determines if the host can download poll's result from browser.

Returns: YES if can download the poll result. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ canDuplicatePolling:

- (BOOL) canDuplicatePolling: (NSString *_Nullable) pollingID

Determines if the host can duplicate polling.

Parameters

pollingID The duplicate poll's polling ID.

Returns: YES if can duplicate the polling. Otherwise, NO.

Warning: Only the origin host can duplicate polling.

Provided by category MobileRTCMeetingService(Polling).

◆ canEditPolling:

- (BOOL) canEditPolling: (NSString *_Nullable) pollingID

Determines if the host can edit polling.

Parameters

pollingID The edit poll's polling ID.

Returns: YES if can edit. Otherwise, NO.

Warning: Only the origin host can edit polling.

Provided by category MobileRTCMeetingService(Polling).

◆ canEnableAlphaChannelMode

- (BOOL) canEnableAlphaChannelMode

Determines if alpha channel mode can be enabled.

Returns: YES if it can be enabled. Otherwise, NO. Only for host call.

Warning: Only host can enable alpha channel.

Provided by category MobileRTCMeetingService(Video).

◆ canEnableLiveStreamReminder

- (BOOL) canEnableLiveStreamReminder

Check if the current user can enable/disable the live stream reminder.

Returns: YES means the current user can enable or disable the live stream reminder.

Provided by category MobileRTCMeetingService(InMeeting).

◆ canEnableMuteOnEntry

- (BOOL) canEnableMuteOnEntry

Determines whether the host or cohost can enable mute on entry.

Returns: YES if the host or cohost can enable mute on entry. Otherwise, NO.

Note: Valid for both ZOOM style and user custom interface mode.

Provided by category MobileRTCMeetingService(Audio).

◆ canEnableParticipantRequestCloudRecording

- (BOOL) canEnableParticipantRequestCloudRecording

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

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ canGetRightAnswerItemList:

- (BOOL) canGetRightAnswerItemList: (NSString *_Nullable) pollingID

Determines if the right answer item list can be allowed to get.

Parameters

pollingID The right answer's polling ID.

Returns: YES if can get the right. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ canHideParticipantProfilePictures

- (MobileRTCSDKError) canHideParticipantProfilePictures

Query if the current user can hide participant profile pictures.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: This feature is influenced by focus mode change.

Provided by category MobileRTCMeetingService(InMeeting).

◆ canPinVideo:

- (MobileRTCPinResult) canPinVideo: (NSUInteger) userId

Determines whether the user's video can be pinned.

Parameters

userId The user ID whose video is being checked.

Returns: The result indicating if it is able to pin.

Provided by category MobileRTCMeetingService(Video).

◆ canRequestStartSmartSummary

- (MobileRTCSDKError) canRequestStartSmartSummary

Determines whether the current user can request the host to start the smart summary for the current meeting.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Deprecated: Use MobileRTCAICompanionSmartSummaryHelper instead.

Provided by category MobileRTCMeetingService(SmartSummary).

◆ canRequestTurnoffAllAICompanion

- (BOOL) canRequestTurnoffAllAICompanion

Determines whether the current user can ask the host to turn off all started AI Companion features.

Returns: YES if the user can request host to turn off the AI Companion features. Otherwise, NO.

Note: If the current user joins the meeting before the host, they can check MobileRTCMeetingService::canTurnOffAllAICompanions to turn off the AI Companion features by himself or herself.; All AI features including MobileRTCAICompanionType_QUERY, MobileRTCAICompanionType_SMART_SUMMARY, and MobileRTCAICompanionType_SMART_RECORDING can be turned off at once.

Provided by category MobileRTCMeetingService(AICompanion).

◆ canRequestTurnOnAllAICompanion

- (BOOL) canRequestTurnOnAllAICompanion

Determines whether the current user can ask the host to turn on all AI Companion features if they are enabled for the current meeting.

Returns: YES if the user can ask the host to turn on the AI Companion features. Otherwise, NO.

Note: Only MobileRTCAICompanionType_QUERY and MobileRTCAICompanionType_SMART_SUMMARY can be turned on at once.

Provided by category MobileRTCMeetingService(AICompanion).

◆ canRestartPolling:

- (BOOL) canRestartPolling: (NSString *_Nullable) pollingID

Determines if the host or co-host can restart the polling.

Parameters

pollingID The poll's polling ID.

Returns: YES if can restart the poll. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ canSetDocsOption

- (BOOL) canSetDocsOption

Determines whether the current user can set Docs option.

Returns: YES if the current user can set Docs option. Otherwise, NO.

Provided by category MobileRTCMeetingService(Docs).

◆ canSetMeetingTopic

- (BOOL) canSetMeetingTopic

Determines if host or co-host can change the meeting topic.

Returns: YES if it can change the meeting topic. Otherwise, NO.

Provided by category MobileRTCMeetingService(Customize).

◆ canSharePollingResult:

- (BOOL) canSharePollingResult: (NSString *_Nullable) pollingID

Determines if the host or co-host can share the poll's result.

Parameters

pollingID The poll's polling ID.

Returns: YES if can share the poll result. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ canShowAnswerResultList:

- (BOOL) canShowAnswerResultList: (NSString *_Nullable) pollingID

Determines if the answer result list can be shown.

Parameters

pollingID The right answer's polling ID.

Returns: YES if can show the answer list. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ canStartLiveTranscription

- (BOOL) canStartLiveTranscription

Queries if meeting participants can start live transcription.

Returns: YES if the participant can start live transcription. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ canStartPolling:

- (BOOL) canStartPolling: (NSString *_Nullable) pollingID

Determines if the host or co-host can start the polling.

Parameters

pollingID The poll's polling ID.

Returns: YES if can start the poll. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ canStartRawLiveStream

- (MobileRTCSDKError) canStartRawLiveStream

Whether the current user is able to start raw live streaming.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ canStartShare

- (MobileRTCCannotShareReasonType) canStartShare

Determines whether the current meeting can start sharing.

Returns: If the function succeeds, it returns MobileRTCCannotShareReasonType_None. Otherwise, this function returns the reason that no one can start sharing. See [MobileRTCCannotShareReasonType].

Provided by category MobileRTCMeetingService(AppShare).

◆ canStartShareDoc

- (MobileRTCCannotShareReasonType) canStartShareDoc

Determines whether the current user can start sharing Doc.

Returns: If the function succeeds, it returns MobileRTCCannotShareReasonType_None. Otherwise, this function returns the reason that no one can start sharing the Doc.

Provided by category MobileRTCMeetingService(Docs).

◆ canStartShareWhiteboard

- (MobileRTCCannotShareReasonType) canStartShareWhiteboard

Determines whether the current meeting can start sharing the whiteboard.

Returns: If the function succeeds, it returns MobileRTCCannotShareReasonType_None. Otherwise, this function returns the reason that no one can start sharing the whiteboard.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ canStartSignInterpretation

- (BOOL) canStartSignInterpretation

Determines if I can start the sign interpretation in the meeting.

Returns: YES if I can start the sign interpretation in the meeting. Otherwise, NO.

Warning: The interface is for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ canStartSmartSummary

- (MobileRTCSDKError) canStartSmartSummary

Determines whether the current user is able to start smart summary.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Deprecated: Use MobileRTCAICompanionSmartSummaryHelper instead.

Provided by category MobileRTCMeetingService(SmartSummary).

◆ canSubmitPolling:

- (BOOL) canSubmitPolling: (NSString *_Nullable) pollingID

Determines if the attendee can submit the polling.

Parameters

pollingID The submit poll's polling ID.

Returns: YES if can submit the polling. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ canSuspendParticipantsActivities

- (BOOL) canSuspendParticipantsActivities

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

Returns: YES means user can suspend participant activities,.

Provided by category MobileRTCMeetingService(InMeeting).

◆ canTurnOffAllAICompanions

- (BOOL) canTurnOffAllAICompanions

Determines whether the current user can turn off the AI Companion features.

Returns: YES if the user can turn off the AI Companion features. Otherwise, NO.

Provided by category MobileRTCMeetingService(AICompanion).

◆ canTurnOnAllAICompanion

- (BOOL) canTurnOnAllAICompanion

Determines whether the current user can turn on the AI Companion features.

Returns: YES if the user can turn on the AI Companion features. Otherwise, NO.

Provided by category MobileRTCMeetingService(AICompanion).

◆ canUnmuteMyAudio

- (BOOL) canUnmuteMyAudio

Determines whether the user can unmute audio.

Returns: YES if the user can unmute audio. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ canUnmuteMyVideo

- (BOOL) canUnmuteMyVideo

Queries if the user can unmute their video themselves.

Returns: YES if able. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ canViewPollingResultFromBrowser:

- (BOOL) canViewPollingResultFromBrowser: (NSString *_Nullable) pollingID

Determines if the user can view polling results in the browser.

Parameters

pollingID The duplicate poll's polling ID.

Returns: YES if can view the polling result. Otherwise, NO.

Provided by category MobileRTCMeetingService(Polling).

◆ changeAttendeeChatPriviledge:

- (BOOL) changeAttendeeChatPriviledge: (MobileRTCMeetingChatPriviledgeType) privilege

Sets attendee chat privilege when in-meeting.

Parameters

privilege The chat privilege of the attendee.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.; Only normal meeting (non-webinar meeting) can run the function.

Provided by category MobileRTCMeetingService(Chat).

◆ changeName:withUserID:

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

Changes the user's screen name in the meeting.

Parameters

inputName	The screen name displayed in the meeting.
userId	The user ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Normal user can change their own screen name, while the host or co-host can change all attendees' names.

Provided by category MobileRTCMeetingService(User).

◆ changePanelistChatPrivilege:

- (BOOL) changePanelistChatPrivilege: (MobileRTCPanelistChatPrivilegeType) privilege

Sets the chat privilege of the panelist.

Parameters

privilege The chat privilege of the panelist.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.; Only webinar meeting can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ claimHostWithHostKey:

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

Claims to be a host by host key.

Parameters

hostKey The host key.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ commentQuestion:commentContent:

- (BOOL) commentQuestion:		(nonnull NSString *)	questionID
commentContent:		(nonnull NSString *)	commentContent

Attendee comments on a question.

Parameters

questionID	The question ID.
commentContent	The comment content.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting attendee can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ 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: If the function succeeds, it returns YES. Otherwise, NO.

Warning: The function should be invoked before meeting starts.

Provided by category MobileRTCMeetingService(InMeeting).

◆ connectMyAudio:

- (BOOL) connectMyAudio: (BOOL) on

Sets whether to connect the audio in the meeting.

Parameters

on	YES to connect, NO to disconnect.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ customizeMeetingTitle:

- (void) customizeMeetingTitle: (NSString *_Nullable) title

Sets to customize the meeting title which will be displayed in the meeting bar.

Parameters

title The topic or title of the meeting.

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

Provided by category MobileRTCMeetingService(Customize).

◆ deleteAnswer:

- (BOOL) deleteAnswer: (nonnull NSString *) answerID

Deletes an answer.

Parameters

answerID The answer ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ deleteChatMessage:

- (BOOL) deleteChatMessage: (nonnull NSString *) msgId

Deletes chat message by message ID.

Parameters

msgId The message ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Chat).

◆ deletePolling:

- (MobileRTCSDKError) deletePolling: (NSString *_Nullable) pollingID

Deletes the polling.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ deleteQuestion:

- (BOOL) deleteQuestion: (nonnull NSString *) questionID

Deletes a question.

Parameters

questionID The question ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ dePromptPanelist2Attendee:

- (BOOL) dePromptPanelist2Attendee: (NSUInteger) userID

Demotes the panelist to attendee.

Parameters

userID The user ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ dialInCall:

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

Makes a phone call to access voice.

Parameters

countryNumber The country number.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Phone).

◆ dialOut:isCallMe:withName:

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

Starts to dial out.

Parameters

phone	The destination phone number. Add the country code in front of the phone number, such as +86123456789.
me	YES to call me, NO to invite others by phone.
username	The name of the user to be called.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Phone).

◆ disableCloudWhiteboard:

- (void) disableCloudWhiteboard: (BOOL) disabled

Enables or disables the new Zoom Whiteboard feature (different from Classic Whiteboard). This feature is enabled by default.

Parameters

disabled YES to disable. Otherwise, NO.

Warning: The function is only for Zoom UI.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ disableVideoAutoFraming

- (MobileRTCSDKError) disableVideoAutoFraming

Stops video auto-framing.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Video).

◆ disallowAttendeeRaiseHand

- (MobileRTCSDKError) disallowAttendeeRaiseHand

Does not let the attendee raise their hand.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: If the function succeeds, the user will receive the callback onAllowAttendeeRiseHandStatusChanged:. Available only for the host.

Provided by category MobileRTCMeetingService(Webinar).

◆ disallowAttendeeViewTheParticipantCount

- (MobileRTCSDKError) disallowAttendeeViewTheParticipantCount

Forbids the attendee to view the participant count.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged: callback event. Available only for the host.

Provided by category MobileRTCMeetingService(Webinar).

◆ disallowWebinarEmojiReaction

- (MobileRTCSDKError) disallowWebinarEmojiReaction

Forbids the use of emoji reactions.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: If the function succeeds, the user will receive the callback onAllowWebinarReactionStatusChanged:. Available only for the host.

Provided by category MobileRTCMeetingService(Webinar).

◆ dismissDocOrDashboardView

- (void) dismissDocOrDashboardView

Dismisses Doc or dashboard.

Warning: The function is only for Custom UI.

Provided by category MobileRTCMeetingService(Docs).

◆ dismissQuestion:

- (BOOL) dismissQuestion: (nonnull NSString *) questionID

Dismisses a question.

Parameters

questionID The question ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ dismissWhiteboardOrDashboard

- (void) dismissWhiteboardOrDashboard

Dismisses whiteboard or dashboard.

Warning: The function is only for Custom UI.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ downLoadResult

- (MobileRTCSDKError) downLoadResult

Downloads all stopped poll's result from browser.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ duplicatePolling:

- (MobileRTCSDKError) duplicatePolling: (NSString *_Nullable) pollingID

Duplicates the polling.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ editPolling:

- (MobileRTCSDKError) editPolling: (NSString *_Nullable) pollingID

Opens edit polling in a web browser.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ enable3DAvatarEffectForAllMeeting:

- (MobileRTCSDKError) enable3DAvatarEffectForAllMeeting: (BOOL) enable

Enables or disables 3D avatar effect when joining meeting.

Parameters

enable YES to enable 3D avatar effect. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Avatar).

◆ enableAlphaChannelMode:

- (MobileRTCSDKError) enableAlphaChannelMode: (BOOL) enable

Enables or disables alpha channel mode.

Parameters

enable YES to enable alpha channel mode. Otherwise, NO to disable it.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: Only host can enable alpha channel.; This function enables the meeting alpha channel, even if the current iOS device does not support alpha channel.; For iOS device should be iPhone 8/8 Plus/X or above or be iPad Pro 9.7 above. OS should be iOS 11 or above.

Provided by category MobileRTCMeetingService(Video).

◆ enableAskQuestion:

- (MobileRTCSDKError) enableAskQuestion: (BOOL) enable

Sets whether attendee can ask questions.

Parameters

enable YES if attendee can ask questions. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(QA).

◆ enableCaptions:

- (MobileRTCSDKError) enableCaptions: (BOOL) bEnable

Enables or disables captions.

Parameters

bEnable YES to enable captions. Otherwise, NO to disable.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ enableGetRightAnswerList:

- (MobileRTCSDKError) enableGetRightAnswerList: (BOOL) enable

Sets to enable showing right answer to participants when sharing quiz's result.

Parameters

enable YES to enable. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ enableGreenVB:

- (MobileRTCMeetError) enableGreenVB: (BOOL) enable

Enables or disables green virtual background mode.

Parameters

enable YES to enable. Otherwise, NO to disable.

Returns: Result of enable green virtual background.

Warning: Only iPad supports Virtual background GreenScreen. iPhone does not support the feature.; Need to call "startPreviewWithFrame:" to get the preview View, and show it in your UI hierarchy. Then select the point in the preview view. We will use the color of your selected point (point of the preview) to calculate the background.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ enableLiveStreamReminder:

- (MobileRTCSDKError) enableLiveStreamReminder: (BOOL) enable

Enable or disable the live stream reminder.

Parameters

enable true means enable the live stream reminder. False means disable the live stream reminder.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ enableMeetingManualCaption:

- (BOOL) enableMeetingManualCaption: (BOOL) bEnable

Hosts only API to set meeting language for the entire meeting.

Parameters

bEnable YES to enable. Otherwise, NO.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ enableMeetingQAFeature:

- (MobileRTCSDKError) enableMeetingQAFeature: (BOOL) enable

Enables or disables meeting QA.

Parameters

enable YES to enable. Otherwise, NO to disable.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(QA).

◆ enableMuteOnEntry:allowUnmuteBySelf:

- (MobileRTCSDKError) enableMuteOnEntry:		(BOOL)	bEnable
allowUnmuteBySelf:		(BOOL)	allowUnmuteBySelf

Enables or disables mute on entry for users after joining the meeting.

Parameters

bEnable	YES to mute the user after joining the meeting, NO otherwise.
allowUnmuteBySelf	YES to allow users to unmute themselves, NO otherwise.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: Valid for both ZOOM style and user custom interface mode.

Provided by category MobileRTCMeetingService(Audio).

◆ enableOptimizeForSharedVideo:

- (BOOL) enableOptimizeForSharedVideo: (BOOL) enableVideo

Enables or disables optimizing share video.

Parameters

enableVideo YES to enable. Otherwise, NO.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ enableParticipantsCreateWithoutHost:

- (MobileRTCSDKError) enableParticipantsCreateWithoutHost: (BOOL) enable

Enables or disables the participants to create a new whiteboard without the host in the meeting.

Parameters

enable YES to enable. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ enablePlayMeetingAudio:

- (MobileRTCRawDataError) enablePlayMeetingAudio: (BOOL) enabled

Enables or disables SDK to play meeting audio. When the value of enabled is NO, the SDK will not play meeting audio, but you can still subscribe audio rawdata.

Parameters

enabled YES to enable SDK to play meeting audio, NO to disable.

Returns: If the function succeeds, it will return MobileRTCRawDataError_Success. Otherwise return an error.

Provided by category MobileRTCMeetingService(Audio).

◆ enableReceiveSpokenlLanguageContent:

- (MobileRTCSDKError) enableReceiveSpokenlLanguageContent: (BOOL) enabled

Enables or disables receiving original and translated content. If you enable this feature, you need to start live transcription.

Parameters

enabled YES to enable. Otherwise, NO to disable.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ enableRequestLiveTranscription:

- (BOOL) enableRequestLiveTranscription: (BOOL) enable

The host enables or disables the request live transcription.

Parameters

enable YES to enable the request live transcription. Otherwise, NO to disable.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ enableVideoAutoFraming:forMode:

- (MobileRTCSDKError) enableVideoAutoFraming:		(MobileRTCAutoFramingParameter *_Nullable)	setting
forMode:		(MobileRTCAutoFramingMode)	mode

Enables my video auto-framing.

Parameters

setting	The auto-framing parameter.
mode	The auto-framing mode.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Video).

◆ enableVirtualNameTag:

- (MobileRTCSDKError) enableVirtualNameTag: (BOOL) bEnabled

Enable the virtual name tag feature for the account.

Parameters

bEnabled YES means enabled. Otherwise not.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ endLiving:

- (BOOL) endLiving: (nonnull NSString *) questionID

Ends living a question.

Parameters

questionID The question ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ get3DAvatarImageList

- (NSArray< MobileRTC3DAvatarImageInfo * > *_Nullable) get3DAvatarImageList

Gets the array of the video filter images.

Returns: If the function succeeds, it returns an NSArray of MobileRTC3DAvatarImageInfo objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Avatar).

◆ getActivePollingID

- (NSString *_Nullable) getActivePollingID

Gets the active poll's ID.

Returns: The shared result or started poll's ID.

Provided by category MobileRTCMeetingService(Polling).

◆ getAdminHelper

- (MobileRTCBOAdmin *_Nullable) getAdminHelper

Gets the object for administrator management of Breakout Room meetings defined in [MobileRTCBOAdmin].

Returns: If the function succeeds, it returns a MobileRTCBOAdmin object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(BO).

◆ getAllChatMessageID

- (nullable NSArray< NSString * > *) getAllChatMessageID

Gets all chat message IDs.

Returns: The all chat message id list. nil means failed.

Provided by category MobileRTCMeetingService(Chat).

◆ getAllLanguageList

- (NSArray< MobileRTCInterpretationLanguage * > *_Nullable) getAllLanguageList

Gets all interpretation language list.

Returns: If the function succeeds, it returns an NSArray of MobileRTCInterpretationLanguage objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getALLQuestionCount

- (int) getALLQuestionCount

Gets the amount of all questions.

Returns: The amount of all questions.

Provided by category MobileRTCMeetingService(QA).

◆ getAllQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getAllQuestionList

Gets all questions.

Returns: If the function succeeds, it returns an NSArray of MobileRTCQAItem objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(QA).

◆ getAllSupportedSignLanguageInfoList

- (NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable) getAllSupportedSignLanguageInfoList

Gets all supported sign interpretation language list. Only for host.

Returns: If the function succeeds, it returns an NSArray of MobileRTCSignInterpreterLanguage objects. Otherwise, this function fails and returns nil.

Warning: The interface is for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getAnswer:

- (nullable MobileRTCQAAnswerItem *) getAnswer: (nonnull NSString *) answerID

Gets answer item by answer ID.

Parameters

answerID The answer ID.

Returns: If the function succeeds, it returns a MobileRTCQAAnswerItem object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(QA).

◆ getAnsweredQuestionCount

- (int) getAnsweredQuestionCount

Gets the amount of answered questions.

Returns: The amount of answered questions.

Provided by category MobileRTCMeetingService(QA).

◆ getAnsweredQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getAnsweredQuestionList

Gets answered questions.

Returns: If the function succeeds, it returns an NSArray of MobileRTCQAItem objects. Otherwise, this function fails and returns nil.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ getAssistantHelper

- (MobileRTCBOAssistant *_Nullable) getAssistantHelper

Gets the object for help assistant of Breakout Room meetings defined in [MobileRTCBOAssistant].

Returns: If the function succeeds, it returns a MobileRTCBOAssistant object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(BO).

◆ getAttedeeHelper

- (MobileRTCBOAttendee *_Nullable) getAttedeeHelper

Gets the object for attendee functionality of Breakout Room meetings defined in [MobileRTCBOAttendee].

Returns: If the function succeeds, it returns a MobileRTCBOAttendee object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(BO).

◆ getAttendeeChatPriviledge

- (MobileRTCMeetingChatPriviledgeType) getAttendeeChatPriviledge

Gets attendee chat privilege when in-meeting.

Returns: The result of attendee chat privilege.

Provided by category MobileRTCMeetingService(Chat).

◆ getAttendeeViewMode

- (MobileRTCAttendeeViewMode) getAttendeeViewMode

Gets the view mode of the attendee.

Returns: The attendee's view mode.

Warning: Only for host to call this API. Only for Zoom UI mode.

Provided by category MobileRTCMeetingService(Webinar).

◆ getAuthorizedBotListByUserID:

- (nullable NSArray< NSNumber * > *) getAuthorizedBotListByUserID: (NSUInteger) userId

Gets the authorizer's bot list.

Parameters

userId The user ID for which to get the information.

Returns: The authorizer's robot list in the meeting.

Provided by category MobileRTCMeetingService(User).

◆ getAvailableLanguageList

- (NSArray< MobileRTCInterpretationLanguage * > *_Nullable) getAvailableLanguageList

Gets the available interpretation language list.

Returns: If the function succeeds, it returns an NSArray of MobileRTCInterpretationLanguage objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getAvailableMeetingSpokenLanguages

- (NSArray< MobileRTCLiveTranscriptionLanguage * > *_Nullable) getAvailableMeetingSpokenLanguages

Gets the list of all available spoken languages in the meeting.

Returns: If the function succeeds, it returns an NSArray of MobileRTCLiveTranscriptionLanguage objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getAvailableSignLanguageInfoList

- (NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable) getAvailableSignLanguageInfoList

Gets the available sign interpretation language list.

Returns: If the function succeeds, it returns an NSArray of MobileRTCSignInterpreterLanguage objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getAvailableTranslationLanguages

- (NSArray< MobileRTCLiveTranscriptionLanguage * > *_Nullable) getAvailableTranslationLanguages

Gets the list of all available translation languages in the meeting.

Returns: If the function succeeds, it returns an NSArray of MobileRTCLiveTranscriptionLanguage objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getBGImageList

- (NSArray< MobileRTCVirtualBGImageInfo * > *_Nullable) getBGImageList

Gets the virtual background list.

Returns: If the function succeeds, it returns an NSArray of virtual background image info objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ getBOStatus

- (MobileRTCBOStatus) getBOStatus

Gets the current Breakout status.

Returns: The enum for Breakout status. See [MobileRTCBOStatus].

Provided by category MobileRTCMeetingService(BO).

◆ getBotAuthorizedUserInfoByUserID:

- (nullable MobileRTCMeetingUserInfo *) getBotAuthorizedUserInfoByUserID: (NSUInteger) botUserId

Gets the information about the bot's authorized user.

Parameters

botUserId The user ID for which to get the information.

Returns: If the function succeeds, it returns a MobileRTCMeetingUserInfo object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(User).

◆ getCameraDeviceList

- (NSArray< MobileRTCCameraDevice * > *_Nullable) getCameraDeviceList

Gets the camera device list.

Returns: If the function succeeds, it returns an NSArray of MobileRTCCameraDevice objects. Otherwise, this function fails and returns nil.

Warning: Only iOS 17.0 or above and iPad device can get the external camera devices.

Provided by category MobileRTCMeetingService(Video).

◆ getChatLegalNoticesExplained

- (NSString *_Nullable) getChatLegalNoticesExplained

Gets explained text for chat legal notice.

Returns: The explained text for chat legal notice.

Provided by category MobileRTCMeetingService(Chat).

◆ getChatLegalNoticesPrompt

- (NSString *_Nullable) getChatLegalNoticesPrompt

Gets chat legal notice prompt.

Returns: The chat legal notice prompt.

Provided by category MobileRTCMeetingService(Chat).

◆ getCloudRecordingStatus

- (MobileRTCRecordingStatus) getCloudRecordingStatus

Gets current cloud recording status.

Returns: The recording status.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getCompanionChildList:

- (NSArray *_Nullable) getCompanionChildList: (NSUInteger) userId

Gets the user's child list.

Parameters

userId The user ID for which to get the information.

Returns: The sub-user list of user companion mode.

Provided by category MobileRTCMeetingService(User).

◆ getCompanionParentUser:

- (MobileRTCMeetingUserInfo *_Nullable) getCompanionParentUser: (NSUInteger) userId

Gets the information about the user's parent user.

Parameters

userId The user ID for which to get the information.

Returns: If the function succeeds, it returns a MobileRTCMeetingUserInfo object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(User).

◆ getCreatorHelper

- (MobileRTCBOCreator *_Nullable) getCreatorHelper

Gets the object for creating Breakout Room meetings defined in [MobileRTCBOCreator].

Returns: If the function succeeds, it returns a MobileRTCBOCreator object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(BO).

◆ getCurrentLiveStreamItem

- (MobileRTCLiveStreamItem *_Nullable) getCurrentLiveStreamItem

Get the current live stream object.

Returns: If the function succeeds, it returns a MobileRTCLiveStreamItem object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getDataHelper

- (MobileRTCBOData *_Nullable) getDataHelper

Gets the object for Breakout Room meeting ID information defined in [MobileRTCBOData].

Returns: If the function succeeds, it returns a MobileRTCBOData object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(BO).

◆ getDialInAllCountryCodes

- (nullable NSArray< NSArray< MobileRTCCallCountryCode * > * > *) getDialInAllCountryCodes

Gets all country codes.

Returns: If the function succeeds, it returns an NSArray of NSArray of MobileRTCCallCountryCode objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Phone).

◆ getDialInCallCodesWithCountryId:

- (nullable NSArray< MobileRTCCallCountryCode * > *) getDialInCallCodesWithCountryId: (nullable NSString *) countryId

Gets the country codes specified by country ID.

Parameters

countryId The country ID.

Returns: If the function succeeds, it returns an NSArray of MobileRTCCallCountryCode objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Phone).

◆ getDialInCurrentCountryCode

- (nullable MobileRTCCallCountryCode *) getDialInCurrentCountryCode

Gets the country code for the current user's locale.

Returns: If the function succeeds, it returns a MobileRTCCallCountryCode object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Phone).

◆ getDismissedQuestionCount

- (int) getDismissedQuestionCount

Gets the amount of dismissed questions.

Returns: The amount of dismissed questions.

Provided by category MobileRTCMeetingService(QA).

◆ getDismissedQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getDismissedQuestionList

Gets dismissed questions.

Returns: If the function succeeds, it returns an NSArray of MobileRTCQAItem objects. Otherwise, this function fails and returns nil.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ getDocsCreateOption

- (MobileRTCDocsCreateOption) getDocsCreateOption

Gets the setting option for who can initiate new Docs.

Returns: The option.

Provided by category MobileRTCMeetingService(Docs).

◆ getDocSharingSourceInfoList:

- (NSArray< MobileRTCDocSharingSourceInfo * > *_Nullable) getDocSharingSourceInfoList: (NSUInteger) userID

Gets the list of sharing source info.

Parameters

userID The user ID who is sharing.

Returns: If the function succeeds, it returns an NSArray of MobileRTCDocSharingSourceInfo objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Docs).

◆ getDocsShareOption

- (MobileRTCDocsShareOption) getDocsShareOption

Gets the setting option for Docs who can share.

Returns: The option.

Provided by category MobileRTCMeetingService(Docs).

◆ getE2EEMeetingSecurityCode

- (NSString *_Nullable) getE2EEMeetingSecurityCode

Gets E2EE meeting security code.

Returns: The 40-digit security code.

Provided by category MobileRTCMeetingService(Encryption).

◆ getE2EEMeetingSecurityCodePassedSeconds

- (unsigned int) getE2EEMeetingSecurityCodePassedSeconds

Gets security code passed seconds.

Returns: The time the security code exists, in seconds.

Provided by category MobileRTCMeetingService(Encryption).

◆ getEncryptionType

- (MobileRTCMeetingEncryptionType) getEncryptionType

Gets the meeting encryption type.

Returns: The meeting encryption type.

Provided by category MobileRTCMeetingService(Encryption).

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ getH323MeetingPassword

- (nullable NSString *) getH323MeetingPassword

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

Returns: The meeting password.

Provided by category MobileRTCMeetingService(Customize).

◆ getInMeetingDataCenterInfo

- (NSString *_Nonnull) getInMeetingDataCenterInfo

Gets data center info.

Returns: Data center details.

Provided by category MobileRTCMeetingService(Encryption).

◆ getInMeetingUserList

- (nullable NSArray< NSNumber * > *) getInMeetingUserList

Gets 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).

◆ getInterpretationLanguageByID:

- (MobileRTCInterpretationLanguage *_Nullable) getInterpretationLanguageByID: (NSInteger) lanID

Gets the interpretation language object of the specified language ID.

Parameters

lanID The language ID for which you want to get the information.

Returns: If the function succeeds, it returns a MobileRTCInterpretationLanguage object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterActiveLan

- (NSInteger) getInterpreterActiveLan

Gets the active language ID, if myself is an interpreter.

Returns: The active language ID.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterAvailableLanguages

- (NSArray< MobileRTCInterpretationLanguage * > *_Nullable) getInterpreterAvailableLanguages

Gets the list of available languages that interpreters can hear.

Returns: If the function succeeds, it returns an NSArray of MobileRTCInterpretationLanguage objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterLans

- (NSArray< MobileRTCInterpretationLanguage * > *_Nullable) getInterpreterLans

Gets languages if myself is an interpreter.

Returns: If the function succeeds, it returns an NSArray of MobileRTCInterpretationLanguage objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterList

- (NSArray< MobileRTCMeetingInterpreter * > *_Nullable) getInterpreterList

Gets the interpreters list.

Returns: If the function succeeds, it returns an NSArray of MobileRTCMeetingInterpreter objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterListenLan

- (NSInteger) getInterpreterListenLan

Gets a language that I can hear as an interpreter.

Returns: Specify the selected language that I can hear as an interpreter.Otherwise failed, the return value is -1.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getIPAddressList

- (nullable NSArray< NSString * > *) getIPAddressList

Gets 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).

◆ getJoinedLanguageID

- (NSInteger) getJoinedLanguageID

Gets the language ID which myself is in.

Returns: The language ID.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getJoiningBOName

- (NSString *_Nullable) getJoiningBOName

Gets the name of the BO you are going to.

Returns: The join BO name which you are going to.

Note: When you enter a BO or are switched to another BO by the host, you may need the BO name to display on the transfer UI.

Provided by category MobileRTCMeetingService(BO).

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

Note: 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.

Deprecated: Use getSupportLiveStreamItems instead.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getLiveTranscriptionStatus

- (MobileRTCLiveTranscriptionStatus) getLiveTranscriptionStatus

Gets the current live transcription status.

Returns: The live transcription status. For more details, see MobileRTCLiveTranscriptionStatus.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getLiveTranscriptLegalNoticesExplained

- (NSString *_Nullable) getLiveTranscriptLegalNoticesExplained

Get live transcript legal notices explained.

Returns: Live transcript legal notices explained.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getLiveTranscriptLegalNoticesPrompt

- (NSString *_Nullable) getLiveTranscriptLegalNoticesPrompt

Get live transcript legal noticesPrompt.

Returns: Live transcript legal noticesPrompt.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMaxTransferFileSize

- (unsigned long long) getMaxTransferFileSize

Gets the maximum size for file transfer.

Returns: The maximum number of bytes for file transfer.

Provided by category MobileRTCMeetingService(Chat).

◆ getMeetingAudioStatisticInfo

- (MobileRTCAudioStatisticInfo *_Nullable) getMeetingAudioStatisticInfo

Gets meeting audio statistics information.

Returns: If the function succeeds, it returns a MobileRTCAudioStatisticInfo object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMeetingPassword

- (NSString *_Nullable) getMeetingPassword

Get current meeting's password.

Returns: The current meeting's password.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMeetingShareStatisticInfo

- (MobileRTCASVStatisticInfo *_Nullable) getMeetingShareStatisticInfo

Gets meeting share statistics information.

Returns: If the function succeeds, it returns a MobileRTCASVStatisticInfo object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMeetingSpokenLanguage

- (MobileRTCLiveTranscriptionLanguage *_Nullable) getMeetingSpokenLanguage

Gets the spoken language of the current user.

Returns: If the function succeeds, it returns a MobileRTCLiveTranscriptionLanguage object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getMeetingState

- (MobileRTCMeetingState) getMeetingState

Gets the current meeting state.

Returns: The current meeting state.

◆ getMeetingType

- (MobileRTCMeetingType) getMeetingType

Gets the type of current meeting.

Returns: The type of meeting.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMeetingVideoStatisticInfo

- (MobileRTCASVStatisticInfo *_Nullable) getMeetingVideoStatisticInfo

Gets meeting video statistics information.

Returns: If the function succeeds, it returns a MobileRTCASVStatisticInfo object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMyQuestionCount

- (int) getMyQuestionCount

Gets the amount of my questions.

Returns: The amount of my questions.

Provided by category MobileRTCMeetingService(QA).

◆ getMyQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getMyQuestionList

Gets my questions.

Returns: If the function succeeds, it returns an NSArray of MobileRTCQAItem objects. Otherwise, this function fails and returns nil.

Warning: Only attendee can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ getOpenQuestionCount

- (int) getOpenQuestionCount

Gets the amount of open questions.

Returns: The amount of open questions.

Provided by category MobileRTCMeetingService(QA).

◆ getOpenQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getOpenQuestionList

Gets open questions.

Returns: If the function succeeds, it returns an NSArray of MobileRTCQAItem objects. Otherwise, this function fails and returns nil.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ getPanelistChatPrivilege

- (MobileRTCPanelistChatPrivilegeType) getPanelistChatPrivilege

Gets the chat privilege of the panelist.

Returns: The chat privilege of the panelist.

Provided by category MobileRTCMeetingService(Webinar).

◆ getParticipantCount

- (NSUInteger) getParticipantCount

Gets the participant count.

Returns: The count of participants.

Provided by category MobileRTCMeetingService(Webinar).

◆ getParticipantID

- (NSUInteger) getParticipantID

Gets the participant ID.

Returns: The participant ID.

Provided by category MobileRTCMeetingService(Customize).

◆ getPollAnonymousLegalNoticesExplained

- (NSString *_Nullable) getPollAnonymousLegalNoticesExplained

Gets poll anonymous legal notices explained.

Returns: The poll anonymous legal notices explained.

Provided by category MobileRTCMeetingService(Webinar).

◆ getPollingAnswerResultItemList:

- (NSArray< MobileRTCPollingAnswerResultItem * > *_Nullable) getPollingAnswerResultItemList: (NSString *_Nullable) pollingID

Gets the list of polling answer result items.

Parameters

pollingID The right answer's polling ID.

Returns: If the function succeeds, it returns an NSArray of MobileRTCPollingAnswerResultItem objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Polling).

◆ getPollingItemByID:

- (MobileRTCPollingItem *_Nullable) getPollingItemByID: (NSString *_Nullable) pollingID

Gets the polling item object of the specified polling ID.

Parameters

pollingID The polling ID for which you want to get the information.

Returns: If the function succeeds, it returns a MobileRTCPollingItem object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Polling).

◆ getPollingItemList

- (NSArray< MobileRTCPollingItem * > *_Nullable) getPollingItemList

Gets the list of poll items.

Returns: If the function succeeds, it returns an NSArray of MobileRTCPollingItem objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Polling).

◆ getPollingQuestionImagePath:questionID:

- (NSString *_Nullable) getPollingQuestionImagePath:		(NSString *_Nullable)	pollingID
questionID:		(NSString *_Nullable)	questionID

Gets the polling question's image path.

Parameters

pollingID	The answer's polling ID.
questionID	The answer's question ID.

Returns: The question's image path.

Provided by category MobileRTCMeetingService(Polling).

◆ getPollingQuestionItemList:

- (NSArray< MobileRTCPollingQuestionItem * > *_Nullable) getPollingQuestionItemList: (NSString *_Nullable) pollingID

Gets the list of polling question's subquestion.

Parameters

pollingID The question's polling ID.

Returns: If the function succeeds, it returns an NSArray of MobileRTCPollingQuestionItem objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Polling).

◆ getPollingRightAnswerItemList:

- (NSArray< MobileRTCPollingAnswerItem * > *_Nullable) getPollingRightAnswerItemList: (NSString *_Nullable) pollingID

Gets the list of polling question or subquestion's right answer.

Parameters

pollingID The right answer's polling ID.

Returns: If the function succeeds, it returns an NSArray of MobileRTCPollingAnswerItem objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Polling).

◆ getPollLegalNoticesExplained

- (NSString *_Nullable) getPollLegalNoticesExplained

Gets poll legal notices explained.

Returns: The poll legal notices explained.

Provided by category MobileRTCMeetingService(Webinar).

◆ getPollLegalNoticesPrompt

- (NSString *_Nullable) getPollLegalNoticesPrompt

Gets poll legal notices prompt.

Returns: The poll legal notices prompt.

Provided by category MobileRTCMeetingService(Webinar).

◆ getPSUserID

- (NSUInteger) getPSUserID

Gets the production studio user's user ID.

Returns: The production studio user's user ID.

◆ getQALegalNoticesExplained

- (NSString *_Nullable) getQALegalNoticesExplained

Gets QA legal notices explained.

Returns: The QA legal notices explained.

Provided by category MobileRTCMeetingService(QA).

◆ getQALegalNoticesPrompt

- (NSString *_Nullable) getQALegalNoticesPrompt

Gets QA legal notices prompt.

Returns: The QA legal notices prompt.

Provided by category MobileRTCMeetingService(QA).

◆ getQueryHelper

- (MobileRTCAICompanionQueryHelper *) getQueryHelper

Gets the AI Companion Query Helper.

Returns: If the function succeeds, it returns a MobileRTCAICompanionQueryHelper object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(AICompanion).

◆ getQuestion:

- (nullable MobileRTCQAItem *) getQuestion: (nonnull NSString *) questionID

Gets question item by question ID.

Parameters

questionID The question ID.

Returns: If the function succeeds, it returns a MobileRTCQAItem object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(QA).

◆ getQuestionCharactersMaxLen:questionID:

- (NSInteger) getQuestionCharactersMaxLen:		(NSString *_Nullable)	pollingID
questionID:		(NSString *_Nullable)	questionID

Gets the polling question's maximum length.

Parameters

pollingID	The poll's polling ID.
questionID	The question's question ID.

Returns: The integer value of the question's maximum length.

Provided by category MobileRTCMeetingService(Polling).

◆ getQuestionCharactersMinLen:questionID:

- (NSInteger) getQuestionCharactersMinLen:		(NSString *_Nullable)	pollingID
questionID:		(NSString *_Nullable)	questionID

Gets the polling question's minimum length.

Parameters

pollingID	The poll's polling ID.
questionID	The question's question ID.

Returns: The integer value of the question's minimum length.

Provided by category MobileRTCMeetingService(Polling).

◆ getRawLiveStreamingInfoList

- (NSArray< MobileRTCRawLiveStreamInfo * > *_Nullable) getRawLiveStreamingInfoList

Get a list of current active raw live streams.

Returns: If the function succeeds, it returns an NSArray of MobileRTCRawLiveStreamInfo objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getRawLiveStreamPrivilegeUserList

- (NSArray< NSNumber * > *_Nullable) getRawLiveStreamPrivilegeUserList

Get the list of users' IDs who have raw live stream privileges.

Returns: If the function succeeds, the return value is a pointer to the NSArray object.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getRoomDeviceList

- (nullable NSArray< MobileRTCRoomDevice * > *) getRoomDeviceList

Gets room devices that can be called.

Returns: If the function succeeds, it returns an NSArray of MobileRTCRoomDevice objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Customize).

◆ getSelectedCamera

- (MobileRTCCameraDevice *_Nullable) getSelectedCamera

Gets the current camera device in use.

Returns: If the function succeeds, it returns a MobileRTCCameraDevice object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Video).

◆ getShareMeetingChatStartedLegalNoticeContent

- (NSString *_Nullable) getShareMeetingChatStartedLegalNoticeContent

Gets start share meeting chat legal notice content.

Returns: The start share chat legal notice content.

Provided by category MobileRTCMeetingService(Chat).

◆ getShareMeetingChatStoppedLegalNoticeContent

- (NSString *_Nullable) getShareMeetingChatStoppedLegalNoticeContent

Gets stop share meeting chat legal notice content.

Returns: The stop share chat legal notice content.

Provided by category MobileRTCMeetingService(Chat).

◆ getShareSettingType

- (MobileRTCShareSettingType) getShareSettingType

Gets the sharing types for the host or co-host in the meeting.

Returns: MobileRTCShareSettingType.

Provided by category MobileRTCMeetingService(AppShare).

◆ getSharingSourceInfoList:

- (NSArray< MobileRTCSSharingSourceInfo * > *_Nullable) getSharingSourceInfoList: (NSInteger) userID

Gets the list of sharing source info.

Parameters

userID The user ID who is sharing.

Returns: If the function succeeds, it returns an NSArray of MobileRTCSSharingSourceInfo objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(AppShare).

◆ getSignInterpretationLanguageInfoByID:

- (MobileRTCSignInterpreterLanguage *_Nullable) getSignInterpretationLanguageInfoByID: (NSString *_Nullable) signLanguageID

Gets the sign interpretation language object of the specified sign language ID.

Parameters

signLanguageID The sign language ID for which you want to get the information.

Returns: If the function succeeds, it returns a MobileRTCSignInterpreterLanguage object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getSignInterpretationStatus

- (MobileRTCSignInterpretationStatus) getSignInterpretationStatus

Gets the sign interpretation status of the current meeting.

Returns: The sign interpretation status of the current meeting.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getSignInterpreterAssignedLanID

- (NSString *_Nullable) getSignInterpreterAssignedLanID

Gets sign language ID if myself is a sign interpreter. Only for interpreter.

Returns: The current assigned sign language ID.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getSignInterpreterList

- (NSArray< MobileRTCSignInterpreter * > *_Nullable) getSignInterpreterList

Gets the sign interpreters list.

Returns: If the function succeeds, it returns an NSArray of MobileRTCSignInterpreter objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getSmartSummaryHelper

- (MobileRTCAICompanionSmartSummaryHelper *) getSmartSummaryHelper

Gets the smart summary helper.

Returns: If the function succeeds, it returns a MobileRTCAICompanionSmartSummaryHelper object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(AICompanion).

◆ getSpotLightedVideoUserList

- (NSArray< NSNumber * > *_Nullable) getSpotLightedVideoUserList

Gets the spotlight user list.

Returns: UserId array.

Provided by category MobileRTCMeetingService(Video).

◆ getSupportCountryInfo

- (NSArray< MobileRTCCallCountryCode * > *_Nullable) getSupportCountryInfo

Gets the list of countries that support call out.

Returns: If the function succeeds, it returns an NSArray of MobileRTCCallCountryCode objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Phone).

◆ getSupportedMeetingAudioType

- (NSInteger) getSupportedMeetingAudioType

Gets the audio type supported by the current meeting.

Returns: If the function succeeds, it will return the type. The value is the 'bitwise OR' of each supported audio type.

Provided by category MobileRTCMeetingService(Audio).

◆ getSupportLiveStreamItems

- (NSArray< MobileRTCLiveStreamItem * > *_Nullable) getSupportLiveStreamItems

Get the list of live stream information items in the current meeting.

Returns: If the function succeeds, it returns an NSArray of MobileRTCLiveStreamItem objects. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getTransferFileTypeAllowList

- (NSString *_Nullable) getTransferFileTypeAllowList

Gets the list of allowed file types in transfer.

Returns: The value of allowed file types in transfer, comma-separated if there are multiple values. Exe files are by default forbidden from being transferred.

Provided by category MobileRTCMeetingService(Chat).

◆ getTranslationLanguage

- (MobileRTCLiveTranscriptionLanguage *_Nullable) getTranslationLanguage

Gets the translation language of the current user.

Returns: If the function succeeds, it returns a MobileRTCLiveTranscriptionLanguage object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getUnencryptedExceptionCount

- (unsigned int) getUnencryptedExceptionCount

Gets unencrypted exception count.

Returns: The unencrypted exception count.

Provided by category MobileRTCMeetingService(Encryption).

◆ getUnencryptedExceptionInfo

- (NSString *_Nonnull) getUnencryptedExceptionInfo

Gets unencrypted exception info.

Returns: Unencrypted exception details.

Provided by category MobileRTCMeetingService(Encryption).

◆ getUserVideoSize:

- (CGSize) getUserVideoSize: (NSUInteger) userID

Gets the size of the user's video.

Parameters

userID The user ID in the meeting. userID should be 0 when not in meeting.

Returns: The size of the user's video.

Provided by category MobileRTCMeetingService(Video).

◆ getVideoAutoFramingMode

- (MobileRTCAutoFramingMode) getVideoAutoFramingMode

Gets the current mode of auto-framing.

Returns: The current auto-framing mode.

Provided by category MobileRTCMeetingService(Video).

◆ getVideoAutoFramingSetting:

- (MobileRTCAutoFramingParameter *_Nullable) getVideoAutoFramingSetting: (MobileRTCAutoFramingMode) mode

Gets the setting of auto-framing.

Parameters

mode	The auto-framing mode.

Returns: If the function succeeds, it returns a MobileRTCAutoFramingParameter object. Otherwise, this function fails and returns nil.

Provided by category MobileRTCMeetingService(Video).

◆ getVideoOrderList

- (NSArray< NSNumber * > *_Nullable) getVideoOrderList

Gets the follow host video order array currently.

Returns: UserId array.

Provided by category MobileRTCMeetingService(Video).

◆ getViewableDocSharingUserList

- (NSArray< NSNumber * > *_Nullable) getViewableDocSharingUserList

Gets the IDs of users who are sharing docs.

Returns: An NSArray of user ID of all users who are sharing.

Provided by category MobileRTCMeetingService(User).

◆ getViewableSharingUserList

- (NSArray< NSNumber * > *_Nullable) getViewableSharingUserList

Gets the IDs of users who are sharing.

Returns: A NSArray of sourceID of all users who are sharing.

Provided by category MobileRTCMeetingService(User).

◆ getWebinarAttendeeChatPrivilege

- (MobileRTCChatAllowAttendeeChat) getWebinarAttendeeChatPrivilege

Gets webinar attendee chat privilege type.

Returns: The chat privilege type for the webinar attendee.

Provided by category MobileRTCMeetingService(Webinar).

◆ getWebinarAttendeeList

- (nullable NSArray< NSNumber * > *) getWebinarAttendeeList

Gets all the attendees in the webinar.

Returns: User id array, each Attendee id is a NSNumber object.

Warning: Only webinar meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(User).

◆ getWebinarRegistrationLegalNoticesExplained

- (MobileRTCWebinarRegistLegalNoticeContent *_Nullable) getWebinarRegistrationLegalNoticesExplained

Gets annotation over share legal notices explained.

Returns: The annotation over share legal notices explained.

Provided by category MobileRTCMeetingService(Webinar).

◆ getWebinarRegistrationLegalNoticesPrompt

- (NSString *_Nullable) getWebinarRegistrationLegalNoticesPrompt

Gets annotation over share legal notices prompt.

Returns: The annotation over share legal notices prompt.

Provided by category MobileRTCMeetingService(Webinar).

◆ getWhiteboardCreateOption

- (MobileRTCWhiteboardCreateOption) getWhiteboardCreateOption

Gets the option for who can initiate a new whiteboard.

Returns: The setting option for who can initiate a new whiteboard.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ getWhiteboardLegalNoticesExplained

- (NSString *_Nullable) getWhiteboardLegalNoticesExplained

Gets whiteboard legal notices detailed description.

Returns: The whiteboard legal notices detailed description.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ getWhiteboardLegalNoticesPrompt

- (NSString *_Nullable) getWhiteboardLegalNoticesPrompt

Gets whiteboard legal notices message.

Returns: The whiteboard legal notices message as a string.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ getWhiteboardShareOption

- (MobileRTCWhiteboardShareOption) getWhiteboardShareOption

Gets the option for who can share a whiteboard.

Returns: The setting option for who can share a whiteboard.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ handZoomWebUrl:

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

Starts or joins a Zoom meeting with zoom web URL.

Parameters

meetingUrl The Zoom web meeting URL.

Returns: The state of the meeting: started or failed.

◆ hasPromptAndDePromptPrivilege

- (BOOL) hasPromptAndDePromptPrivilege

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

Returns: YES if the user owns the privilege. Otherwise, NO.

Provided by category MobileRTCMeetingService(Webinar).

◆ hasRawLiveStreamPrivilege:

- (BOOL) hasRawLiveStreamPrivilege: (NSUInteger) userID

Determines whether the user has raw live stream privilege.

Parameters

userID The user ID.

Returns: YES if the specified user has raw live stream privilege. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ hideAANPanel

- (MobileRTCSDKError) hideAANPanel

Hide app signaling pannel.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ hideAboutButtonOnCloudWhiteboard:

- (void) hideAboutButtonOnCloudWhiteboard: (BOOL) hide

Sets About button's visibility on the cloud whiteboard. Default is displaying.

Parameters

hide	YES to hide. Otherwise, NO to display.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ hideCloudWhiteboardHelperCenterButton:

- (void) hideCloudWhiteboardHelperCenterButton: (BOOL) hide

Sets the Helper center button's visibility on cloud whiteboard. Default is displaying.

Parameters

hide	YES to hide. Otherwise, NO to display.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ hideCloudWhiteboardOpenInBrowserButton:

- (void) hideCloudWhiteboardOpenInBrowserButton: (BOOL) hide

Sets the Open in browser button's visibility on cloud whiteboard. Default is displaying.

Parameters

hide	YES to hide. Otherwise, NO to display.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ hideDynamicNoticeForAICompanionPanel

- (MobileRTCSDKError) hideDynamicNoticeForAICompanionPanel

Hide dynamic notice for AI Companion panel view.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ hideFeedbackButtonOnCloudWhiteboard:

- (void) hideFeedbackButtonOnCloudWhiteboard: (BOOL) hide

Hides feedback button on cloud whiteboard.

Parameters

hide	YES to hide. Otherwise, NO to display.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ 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: If the function succeeds, it returns YES. Otherwise, NO.

Warning: The method does not work if you have set mobileRTCRootController via [MobileRTC setMobileRTCRootController].

Provided by category MobileRTCMeetingService(InMeeting).

◆ 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, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ hideShareButtonOnCloudWhiteboard:

- (void) hideShareButtonOnCloudWhiteboard: (BOOL) hide

Hides share button on cloud whiteboard.

Parameters

hide	YES to hide. Otherwise, NO to display.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ is3DAvatarEffectForAllMeetingEnabled

- (BOOL) is3DAvatarEffectForAllMeetingEnabled

Determines whether 3D avatar is enabled when joining the meeting.

Returns: YES if enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Avatar).

◆ is3DAvatarEnabled

- (BOOL) is3DAvatarEnabled

Determines if the 3D avatar feature is enabled.

Returns: YES if the video filter feature is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Avatar).

◆ is3DAvatarSupportedByDevice

- (BOOL) is3DAvatarSupportedByDevice

Determines if the 3D avatar feature is supported by the video device.

Returns: YES if the video device supports the 3D avatar feature. Otherwise, NO.

Provided by category MobileRTCMeetingService(Avatar).

◆ is3rdPartyTelephonyAudioOn

- (BOOL) is3rdPartyTelephonyAudioOn

Determines whether the meeting has third party telephony audio enabled.

Returns: YES if third party telephony audio is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ isAllowAskQuestionAnonymously

- (BOOL) isAllowAskQuestionAnonymously

Queries if it is allowed to ask questions anonymously in webinar.

Returns: YES if allowed. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ isAllowAttendeeTalk:

- (BOOL) isAllowAttendeeTalk: (NSUInteger) userID

Queries if the attendee is allowed to talk in Webinar Meeting.

Parameters

userID The user ID to be checked.

Returns: YES if allowed. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowAttendeeUpVoteQuestion

- (BOOL) isAllowAttendeeUpVoteQuestion

Queries if attendee is allowed to upvote questions.

Returns: YES if allowed. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ isAllowAttendeeViewAllQuestion

- (BOOL) isAllowAttendeeViewAllQuestion

Queries if attendee is allowed to view all questions.

Returns: YES if allowed. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ isAllowCommentQuestion

- (BOOL) isAllowCommentQuestion

Queries if attendee is allowed to comment on questions.

Returns: YES if allowed. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ isAllowPanelistStartVideo

- (BOOL) isAllowPanelistStartVideo

Queries if panelist can start video in Webinar Meeting.

Returns: YES if able. Otherwise, NO.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowSignLanuageInterpreterToTalk:

- (BOOL) isAllowSignLanuageInterpreterToTalk: (NSUInteger) userID

Determines if the sign language interpreter is allowed to talk.

Parameters

userID The unique identity of the user.

Returns: YES if allowed to talk. Otherwise, NO.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ isAllowToAddNewVBItem

- (BOOL) isAllowToAddNewVBItem

Determines if the adding new virtual background item feature is supported by the meeting.

Returns: YES if the meeting supports adding new virtual background item feature. Otherwise, NO.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ isAlphaChannelModeEnabled

- (BOOL) isAlphaChannelModeEnabled

Determines if alpha channel mode is enabled.

Returns: YES if in alpha channel mode. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isAnnotationOff

- (BOOL) isAnnotationOff

Notifies the current user if annotation is enabled.

Returns: YES if enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isAskQuestionEnabled

- (BOOL) isAskQuestionEnabled

Determines if asking questions is allowed by the host or co-host.

Returns: YES if can ask question. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ isAttendeeRaiseHandAllowed

- (BOOL) isAttendeeRaiseHandAllowed

Queries if attendee raise hand status is allowed.

Returns: YES if webinar attendee is allowed to raise hand. Otherwise, NO.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAttendeeViewTheParticipantCountAllowed

- (BOOL) isAttendeeViewTheParticipantCountAllowed

Queries if attendee is allowed to view the participant count.

Returns: YES if allowed. Otherwise, NO.

Provided by category MobileRTCMeetingService(Webinar).

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isBackCamera

- (BOOL) isBackCamera

Queries if the user is using back camera.

Returns: YES if using back camera. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isBOMeetingEnabled

- (BOOL) isBOMeetingEnabled

Determines if the Breakout Room feature is enabled in the meeting.

Returns: YES if the Breakout Room feature is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(BO).

◆ isBOMeetingStarted

- (BOOL) isBOMeetingStarted

Determines if the Breakout Room meeting has begun.

Returns: YES if the Breakout Room meeting has begun. Otherwise, NO.

Provided by category MobileRTCMeetingService(BO).

◆ isBroadcastingVoiceToBO

- (BOOL) isBroadcastingVoiceToBO

Queries if the host is broadcasting voice to BO.

Returns: YES if the host is broadcasting. Otherwise, NO.

Provided by category MobileRTCMeetingService(BO).

◆ isCallingRoomDevice

- (BOOL) isCallingRoomDevice

Queries if it is in process to call room device.

Returns: YES if calling room device is in process. Otherwise, NO.

Provided by category MobileRTCMeetingService(Customize).

◆ isCallRoomDeviceSupported

- (BOOL) isCallRoomDeviceSupported

Queries if it is able to call Room device (H.323).

Returns: YES if able. Otherwise, NO.

Provided by category MobileRTCMeetingService(Customize).

◆ isCaptionsEnabled

- (BOOL) isCaptionsEnabled

Queries if captions are enabled.

Returns: YES if captions are enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isChatDisabled

- (BOOL) isChatDisabled

Queries if the chat is disabled in the meeting.

Returns: YES if disabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Chat).

◆ isChatMessageCanBeDeleted:

- (BOOL) isChatMessageCanBeDeleted: (nonnull NSString *) msgId

Determines whether the message can be deleted.

Parameters

msgId The message ID.

Returns: YES if the message can be deleted. Otherwise, NO.

Provided by category MobileRTCMeetingService(Chat).

◆ isCMREnabled

- (BOOL) isCMREnabled

Notifies if the cloud recording is enabled.

Returns: YES if enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isCMRInProgress

- (BOOL) isCMRInProgress

Notifies if the cloud recording is in progress.

Returns: YES if the cloud recording is in progress. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isCMRPaused

- (BOOL) isCMRPaused

Notifies if the cloud recording is paused.

Returns: YES if the cloud recording is paused. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isDeviceSharing

- (BOOL) isDeviceSharing

Gets the state of device screen sharing.

Returns: YES if the device is currently screen sharing. Otherwise, NO.

Warning: When the onSinkMeetingActiveShare callback returns, the developer needs to judge the share screen state.

Provided by category MobileRTCMeetingService(AppShare).

◆ isDeviceSupportSmartVirtualBG

- (BOOL) isDeviceSupportSmartVirtualBG

Determines if the smart virtual background feature can be supported by the machine.

Returns: YES if the machine can support using the smart virtual background feature. Otherwise, NO.

Warning: Device should be iPhone 8/8 Plus/X or above or be iPad Pro 9.7 above. OS should be iOS 11 or above.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ isDialOutInProgress

- (BOOL) isDialOutInProgress

Determines whether there is any outgoing call in process.

Returns: YES if there is an outgoing call in process. Otherwise, NO.

Provided by category MobileRTCMeetingService(Phone).

◆ isDialOutSupported

- (BOOL) isDialOutSupported

Determines whether the user can dial out in the meeting.

Returns: YES if the user can dial out. Otherwise, NO.

Provided by category MobileRTCMeetingService(Phone).

◆ isDirectAppShareMeeting

- (BOOL) isDirectAppShareMeeting

Queries if the current meeting was started with App Share.

Returns: YES if the meeting was started by App Share. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isEmojiReactionEnabled

- (BOOL) isEmojiReactionEnabled

Determines if the Reaction feature is enabled.

Returns: YES if the Reaction feature is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Reaction).

◆ isEnableOptimizeForSharedVideo

- (BOOL) isEnableOptimizeForSharedVideo

Gets the state of optimizing share video.

Returns: YES if optimizing share video is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isFailoverMeeting

- (BOOL) isFailoverMeeting

Queries if the meeting is failover.

Returns: YES if failover. Otherwise, NO.

Warning: The method is optional.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isFileTransferEnabled

- (BOOL) isFileTransferEnabled

Determines whether file transfer is enabled.

Returns: YES if file transfer is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Chat).

◆ isFocusModeEnabled

- (BOOL) isFocusModeEnabled

Get the focus mode enabled or not by web portal.

Returns: YES Means focus mode enabled. Otherwise NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isFocusModeOn

- (BOOL) isFocusModeOn

Get the focus mode on or off.

Returns: YES Means focus mode on. Otherwise NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isFollowHostVideoOrderOn

- (BOOL) isFollowHostVideoOrderOn

Queries if follow host video order is currently on.

Returns: YES if follow. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isH323User:

- (BOOL) isH323User: (NSUInteger) userID

Queries if the user joined the meeting from H.323.

Parameters

userID The user ID.

Returns: YES if the user joined the meeting from H.323. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ isHostUser:

- (BOOL) isHostUser: (NSUInteger) userID

Queries if the user is host.

Parameters

userID The user ID.

Returns: YES if the user is the host. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ isInBOMeeting

- (BOOL) isInBOMeeting

Determines if currently in Breakout Room during the meeting.

Returns: YES if currently in Breakout Room. Otherwise, NO.

Provided by category MobileRTCMeetingService(BO).

◆ isIncomingAudioStopped

- (BOOL) isIncomingAudioStopped

Determines whether the incoming audio is stopped.

Returns: YES if the incoming audio is stopped. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ isIncomingVideoStoped

- (BOOL) isIncomingVideoStoped

Determines if the incoming video is stopped.

Returns: YES if the incoming video is stopped. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isInterpretationEnabled

- (BOOL) isInterpretationEnabled

Determines if the interpretation feature is enabled in the meeting.

Returns: YES if the interpretation function is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ isInterpretationStarted

- (BOOL) isInterpretationStarted

Determines if interpretation has been started by the host.

Returns: YES if interpretation is started. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ isInterpreter

- (BOOL) isInterpreter

Determines if myself is an interpreter.

Returns: YES if self is an interpreter. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ isLiveStreamReminderEnabled

- (BOOL) isLiveStreamReminderEnabled

Check if the live stream reminder is enabled.

Returns: YES means the live stream reminder is enabled.

Note: When the live stream reminder is enabled, the new join user is notified that the meeting is at capacity but that they can.; Watch live stream with the callback MobileRTCMeetingServiceDelegate::onMeetingFullToWatchLiveStream:.; When the meeting user has reached the meeting capacity.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isLiveTranscriptionFeatureEnabled

- (BOOL) isLiveTranscriptionFeatureEnabled

Queries if this meeting supports the live transcription feature.

Returns: YES if the live transcription feature is supported. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isLiveTranscriptLegalNoticeAvailable

- (BOOL) isLiveTranscriptLegalNoticeAvailable

Is live transcript legal notice available.

Returns: Available or not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMajorAudioTurnOff

- (BOOL) isMajorAudioTurnOff

Determines if the major audio is off.

Returns: YES if the major audio is off. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ isMeetingChatLegalNoticeAvailable

- (BOOL) isMeetingChatLegalNoticeAvailable

Determines if meeting chat legal notice is available.

Returns: YES if available. Otherwise, NO.

Provided by category MobileRTCMeetingService(Chat).

◆ isMeetingCoHost

- (BOOL) isMeetingCoHost

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

Returns: YES if the current user is the co-host of the meeting. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingHost

- (BOOL) isMeetingHost

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

Returns: YES if the current user is the host of the meeting. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingLocked

- (BOOL) isMeetingLocked

Notifies 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 if the meeting is locked by host. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingManualCaptionEnabled

- (BOOL) isMeetingManualCaptionEnabled

Determines whether it is enabled to manually input CC for the meeting.

Returns: YES if enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isMeetingQAFeatureOn

- (BOOL) isMeetingQAFeatureOn

Queries if meeting QA is enabled in the current meeting.

Returns: YES if enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ isMeetingSupportCC

- (BOOL) isMeetingSupportCC

Queries if the current meeting supports closed caption.

Returns: YES if the current meeting supports closed caption. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isMultiLanguageTranscriptionEnabled

- (BOOL) isMultiLanguageTranscriptionEnabled

Determines whether the multi-language transcription feature is enabled.

Returns: YES if multi-language transcription is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isMuteOnEntryOn

- (BOOL) isMuteOnEntryOn

Determines whether mute on entry is enabled for attendees when they join the meeting.

Returns: YES if mute on entry is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ isMyAudioMuted

- (BOOL) isMyAudioMuted

Determines whether the audio of the current user is muted.

Returns: YES if the audio is muted. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ isMyself:

- (BOOL) isMyself: (NSUInteger) userID

Queries if the ID is the current user's.

Parameters

userID The user ID to be checked.

Returns: YES if the user themselves. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ isOtherSharingDocs

- (BOOL) isOtherSharingDocs

Queries if other user is sharing docs.

Returns: YES if sharing successfully. Otherwise, NO.

Provided by category MobileRTCMeetingService(Docs).

◆ isOtherSharingWhiteboard

- (BOOL) isOtherSharingWhiteboard

Determines if other user is sharing whiteboard.

Returns: YES if sharing. Otherwise, NO.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ isParticipantProfilePicturesHidden

- (BOOL) isParticipantProfilePicturesHidden

Query if the current meeting hides participant pictures.

Returns: YES means hide participant pictures, false means show participant pictures.

Provided by category MobileRTCMeetingService(InMeeting).

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

Provided by category MobileRTCMeetingService(InMeeting).

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isParticipantsCreateWithoutHostEnabled

- (BOOL) isParticipantsCreateWithoutHostEnabled

Determines whether enabling the participants to create a new whiteboard without the host in the meeting is enabled.

Returns: YES if they have this permission. Otherwise, NO.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ isParticipantsRenameAllowed

- (BOOL) isParticipantsRenameAllowed

Query if the meeting is allow participants to rename themselves.

Returns: YES means will allow participants to rename themselves, Otherwise not.

Warning: Only in-meeting can call the function.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isParticipantsShareWhiteBoardAllowed

- (BOOL) isParticipantsShareWhiteBoardAllowed

Queries if participants are allowed to share whiteboard.

Returns: YES if allowed. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isParticipantsStartVideoAllowed

- (BOOL) isParticipantsStartVideoAllowed

Query is allow participant to start video.

Returns: YES : allow, NO: disallow.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isParticipantsUnmuteSelfAllowed

- (BOOL) isParticipantsUnmuteSelfAllowed

Query if the meeting is allow participants to unmute themselves.

Returns: YES means will allow participants to unmute themselves, Otherwise not.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isPlayChimeOn

- (BOOL) isPlayChimeOn

Determines whether chime is enabled when user joins or leaves meeting.

Returns: YES if chime is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ isPlayMeetingAudioEnabled

- (BOOL) isPlayMeetingAudioEnabled

Determines whether play meeting audio is enabled.

Returns: YES if play meeting audio is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ isPollingLegalNoticeAvailable

- (BOOL) isPollingLegalNoticeAvailable

Determines if polling legal notice is available.

Returns: YES if available. Otherwise, NO.

Provided by category MobileRTCMeetingService(Webinar).

◆ isPrivateChatDisabled

- (BOOL) isPrivateChatDisabled

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

Returns: YES if disabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Chat).

◆ isPSModeStarted

- (BOOL) isPSModeStarted

Determines if production studio mode is started.

Returns: YES if production studio mode is started. Otherwise, NO.

◆ isQAEnabled

- (BOOL) isQAEnabled

Queries if Q&A is supported in this meeting.

Returns: YES if Q&A is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ isQALegalNoticeAvailable

- (BOOL) isQALegalNoticeAvailable

Determines if QA legal notice is available.

Returns: YES if available. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ isQuestionCaseSensitive:questionID:

- (BOOL) isQuestionCaseSensitive:		(NSString *_Nullable)	pollingID
questionID:		(NSString *_Nullable)	questionID

Determines if the question is case sensitive.

Parameters

pollingID	The question's polling ID.
questionID	The question's question ID.

Returns: YES if case sensitive. Otherwise, NO. This function can only be used by fill blank questions.

Provided by category MobileRTCMeetingService(Polling).

◆ isRawLiveStreaming:

- (BOOL) isRawLiveStreaming: (NSUInteger) userID

Determines whether the user has started a live stream.

Parameters

userID The user ID.

Returns: YES if the specified user has started a raw live stream. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ isRawLiveStreamSupported

- (BOOL) isRawLiveStreamSupported

Query Whether the meeting supports raw live streams.

Returns: YES if supported, NO if not supported.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isReceiveSpokenLanguageContentEnabled

- (BOOL) isReceiveSpokenLanguageContentEnabled

Determines whether receiving original and translated content is available.

Returns: YES if receiving original and translated content is available. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isRequestToStartLiveTranscriptionEnabled

- (BOOL) isRequestToStartLiveTranscriptionEnabled

Queries if it is enabled to request to start live transcription.

Returns: YES if it is enabled to request to start live transcription. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isSameUser:compareTo:

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

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

Parameters

user1	One user ID in the meeting.
user2	Another user ID in the meeting.

Returns: YES if the same user. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ isSelfOriginalHost

- (BOOL) isSelfOriginalHost

Queries whether the current user is the original host.

Returns: YES if the current user is the original host. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ isSendingMyVideo

- (BOOL) isSendingMyVideo

Queries if the user is sending video.

Returns: YES if sending. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isSharedAudio

- (BOOL) isSharedAudio

Gets the state of device audio sharing.

Returns: YES if the device is currently audio sharing. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isShareLocked

- (BOOL) isShareLocked

Notifies if the share is locked by host. Once the meeting is locked by the host or co-host, other users cannot share except the host or co-host.

Returns: YES if the screen share is locked by host. Otherwise, NO.

Deprecated: Use getShareSettingType] instead.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isShareMeetingChatLegalNoticeAvailable

- (BOOL) isShareMeetingChatLegalNoticeAvailable

Determines if share meeting chat legal notice is available.

Returns: YES if available. Otherwise, NO.

Warning: Need to call in meeting.

Provided by category MobileRTCMeetingService(Chat).

◆ isSharingDocsOut

- (BOOL) isSharingDocsOut

Queries if the current user is sharing docs successfully.

Returns: YES if sharing successfully. Otherwise, NO.

Provided by category MobileRTCMeetingService(Docs).

◆ isSharingWhiteboardOut

- (BOOL) isSharingWhiteboardOut

Determines if the current user is sharing whiteboard.

Returns: YES if sharing. Otherwise, NO.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ isShowAvatar

- (BOOL) isShowAvatar

Determines if the meeting is showing the avatar.

Returns: YES if the meeting is showing the avatar. Otherwise, NO.

Provided by category MobileRTCMeetingService(Avatar).

◆ isSignInterpretationEnabled

- (BOOL) isSignInterpretationEnabled

Determines if the sign interpretation function is enabled.

Returns: YES if the sign interpretation function is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ isSignInterpreter

- (BOOL) isSignInterpreter

Determines if self is a sign interpreter.

Returns: YES if self is a sign interpreter. Otherwise, NO.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ isSmartRecordingEnabled

- (BOOL) isSmartRecordingEnabled

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

Returns: YES if the feature is enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isSmartSummaryEnabled

- (BOOL) isSmartSummaryEnabled

Determines if the smart summary feature is enabled in the meeting.

Returns: YES if smart summary feature is enabled. Otherwise, NO.

Deprecated: Use MobileRTCAICompanionSmartSummaryHelper instead.

Provided by category MobileRTCMeetingService(SmartSummary).

◆ isSmartSummaryStarted

- (BOOL) isSmartSummaryStarted

Queries whether smart summary is started.

Returns: YES if smart summary is started. Otherwise, NO.

Deprecated: Use MobileRTCAICompanionSmartSummaryHelper instead.

Provided by category MobileRTCMeetingService(SmartSummary).

◆ isSmartSummarySupported

- (BOOL) isSmartSummarySupported

Determines if the current meeting supports smart summary feature.

Returns: YES if the current meeting supports the smart summary feature. Otherwise, NO.

Deprecated: Use MobileRTCAICompanionSmartSummaryHelper instead.

Provided by category MobileRTCMeetingService(SmartSummary).

◆ isStartingShare

- (BOOL) isStartingShare

Notifies the current user if sharing has started.

Returns: YES if the current user is sharing. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isStopIncomingVideoSupported

- (BOOL) isStopIncomingVideoSupported

Determines if the incoming video is supported.

Returns: YES if the incoming video is supported. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isSupportDocs

- (BOOL) isSupportDocs

Determines whether the current meeting supports Docs.

Returns: YES if the current meeting supports Docs. Otherwise, NO.

Provided by category MobileRTCMeetingService(Docs).

◆ isSupportedVOIP

- (BOOL) isSupportedVOIP

Determines whether the meeting supports VoIP.

Returns: YES if the meeting supports VoIP. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ isSupportFollowHostVideoOrder

- (BOOL) isSupportFollowHostVideoOrder

Queries if the account supports follow host video order feature.

Returns: YES if supported. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isSupportOptimizeForSharedVideo

- (BOOL) isSupportOptimizeForSharedVideo

Determines if optimizing share video is supported.

Returns: YES if supported. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isSupportPhone

- (BOOL) isSupportPhone

Determines whether the user account supports calling out.

Returns: YES if the client supports the phone call-out feature. Otherwise, NO.

Provided by category MobileRTCMeetingService(Phone).

◆ isSupportPSMode

- (BOOL) isSupportPSMode

Determines if production studio mode is supported.

Returns: YES if supported. Otherwise, NO.

◆ isSupportRequestCaptions

- (BOOL) isSupportRequestCaptions

Determines whether users can request to start captions.

Returns: YES if users can request to start captions. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isSupportShareAudio

- (BOOL) isSupportShareAudio

Determines if sharing device audio is supported.

Returns: YES if supported. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isSupportSmartVirtualBG

- (BOOL) isSupportSmartVirtualBG

Determines if smart virtual background is supported.

Returns: YES if supported. Otherwise, NO.

Deprecated: Use isDeviceSupportSmartVirtualBG instead.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ isSupportTranslationWhenRequestToStartCaptions

- (BOOL) isSupportTranslationWhenRequestToStartCaptions

Determines if translation is available when users request to start captions.

Returns: YES if translation is available when users request to start captions. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isSupportVirtualBG

- (BOOL) isSupportVirtualBG

Determines if the virtual background feature is supported by the meeting.

Returns: YES if the meeting supports the virtual background feature. Otherwise, NO.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ isSupportVirtualNameTag

- (BOOL) isSupportVirtualNameTag

Determines if there is support for the virtual name tag feature.

Returns: YES means supports the virtual name tag feature. NO means not supported.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isSupportWhiteBoard

- (BOOL) isSupportWhiteBoard

Determines whether the current meeting supports the whiteboard.

Returns: YES if supported. Otherwise, NO.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ isTextLiveTranslationEnabled

- (BOOL) isTextLiveTranslationEnabled

Determines whether the translated captions feature is enabled.

Returns: YES if enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isTurnoffAllAICompanionsSupported

- (BOOL) isTurnoffAllAICompanionsSupported

Determines whether the meeting supports turning off the AI Companion features.

Returns: YES if the meeting can support turning off the AI Companion features. Otherwise, NO.

Provided by category MobileRTCMeetingService(AICompanion).

◆ isTurnOnAllAICompanionSupported

- (BOOL) isTurnOnAllAICompanionSupported

Determines whether the meeting supports turning on the AI Companion features.

Returns: YES if the meeting can support turning on the AI Companion features. Otherwise, NO.

Provided by category MobileRTCMeetingService(AICompanion).

◆ isUnencryptedExceptionDataValid

- (BOOL) isUnencryptedExceptionDataValid

Determines whether unencrypted exception data is valid.

Note: This method can only be called when the encryption type is MobileRTCMeetingEncryptionType_Enhanced.

Returns: YES if unencrypted exception data is valid. Otherwise, NO.

Provided by category MobileRTCMeetingService(Encryption).

◆ isUserAudioMuted:

- (BOOL) isUserAudioMuted: (NSUInteger) userID

Determines whether the user's audio is muted.

Parameters

userID The user's ID to be checked.

Returns: YES if the user's audio is muted. Otherwise, NO.

Provided by category MobileRTCMeetingService(Audio).

◆ isUserPinned:

- (BOOL) isUserPinned: (NSUInteger) userId

Queries if the user's video is pinned.

Parameters

userId The user ID whose video will be pinned in the meeting.

Returns: YES if the user's video is pinned. Otherwise, NO.

Warning: This function is only for Zoom UI.

Provided by category MobileRTCMeetingService(Video).

◆ isUserSpotlighted:

- (BOOL) isUserSpotlighted: (NSUInteger) userId

Queries if the user's video is spotlighted. Once the user's video is spotlighted, it shows only the specified video in the meeting instead of the active user's.

Parameters

userId The user ID in the meeting.

Returns: YES if spotlighted. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isUserVideoSending:

- (BOOL) isUserVideoSending: (NSUInteger) userID

Queries if the user's video is being sent.

Parameters

userID The user ID whose video will be sent in the meeting.

Returns: YES if the video is being sent. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isUsingGreenVB

- (BOOL) isUsingGreenVB

Determines if using green virtual background.

Returns: YES if using green virtual background. Otherwise, NO.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ isVideoAutoFramingEnabled

- (BOOL) isVideoAutoFramingEnabled

Determines whether auto-framing is enabled.

Returns: YES if enabled. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ isViewingShare

- (BOOL) isViewingShare

Notifies the current user if they are currently viewing an App Share.

Returns: YES if the user is viewing the share. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ isWebinarAttendee

- (BOOL) isWebinarAttendee

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

Returns: YES if the current user is the webinar attendee of the meeting. Otherwise, NO.

Warning: Only for webinar meeting.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isWebinarEmojiReactionAllowed

- (BOOL) isWebinarEmojiReactionAllowed

Queries if emoji reactions status is allowed.

Returns: YES if webinar emoji reaction is allowed. Otherwise, NO.

Provided by category MobileRTCMeetingService(Webinar).

◆ isWebinarEmojiReactionSupported

- (BOOL) isWebinarEmojiReactionSupported

Determines if current webinar supports emoji reactions.

Returns: YES means the current webinar supports emoji reactions, NO means the feature is not supported.

Provided by category MobileRTCMeetingService(Webinar).

◆ isWebinarMeeting

- (BOOL) isWebinarMeeting

Queries if the meeting is Webinar.

Returns: YES if Webinar. Otherwise, NO.

Warning: It returns NO if MobileRTCMeetingState is not equal to MobileRTCMeetingState_InMeeting.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isWebinarPanelist

- (BOOL) isWebinarPanelist

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

Returns: YES if the current user is the webinar panelist of the meeting. Otherwise, NO.

Warning: Only for webinar meeting.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isWhiteboardLegalNoticeAvailable

- (BOOL) isWhiteboardLegalNoticeAvailable

Determines if whiteboard legal notice is available.

Returns: YES if notice is available. Otherwise, NO.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ joinLanguageChannel:

- (BOOL) joinLanguageChannel: (NSInteger) lanID

Joins a language channel.

Parameters

lanID The language channel ID.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ joinMeetingWithJoinParam:

- (MobileRTCMeetError) joinMeetingWithJoinParam: (nonnull MobileRTCMeetingJoinParam *) param

Joins a meeting with MobileRTCMeetingJoinParam parameter.

Parameters

param Create an instance with settings via MobileRTCMeetingJoinParam.

Returns: The state of the meeting: started or failed.

Note: If the app is in CallKit mode, set parameter:userName to empty. CallKit lets you integrate your calling services with other call-related apps on the system.

◆ joinSignLanguageChannel:

- (MobileRTCSDKError) joinSignLanguageChannel: (NSString *_Nullable) signLanID

Joins a sign language channel if myself is not a sign interpreter. Only for non-interpreter.

Parameters

signLanID The sign language ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: The interface is only for Zoom UI.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ leaveMeetingWithCmd:

- (void) leaveMeetingWithCmd: (LeaveMeetingCmd) cmd

Ends or leaves the current meeting.

Parameters

cmd	The command for leaving the current meeting. Only a host can end the meeting.

◆ leaveSignLanguageChannel

- (MobileRTCSDKError) leaveSignLanguageChannel

Leaves the current sign language channel if myself is not a sign interpreter. Only for non-interpreter.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: The interface is only for Zoom UI.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ lockMeeting:

- (BOOL) lockMeeting: (BOOL) lock

Sets to lock the meeting.

Parameters

lock	YES to lock the meeting. Otherwise, NO.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can call the function.

Provided by category MobileRTCMeetingService(InMeeting).

◆ lockShare:

- (BOOL) lockShare: (BOOL) lock

Sets to lock the share.

Parameters

lock	YES to lock the share. Otherwise, NO.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can call the function.

Deprecated: Use setShareSettingType:] instead.

Provided by category MobileRTCMeetingService(InMeeting).

◆ lowerAllHand:

- (BOOL) lowerAllHand: (BOOL) isWebinarAttendee

Puts all users' hands down.

Parameters

isWebinarAttendee YES to lower all hands for webinar attendee. Otherwise, NO.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function when in meeting.

Provided by category MobileRTCMeetingService(User).

◆ lowerHand:

- (BOOL) lowerHand: (NSUInteger) userId

Puts hands down of the current user.

Parameters

userId The user ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function when in meeting.

Provided by category MobileRTCMeetingService(User).

◆ makeHost:

- (BOOL) makeHost: (NSUInteger) userId

Assigns a user as the host in the meeting.

Parameters

userId The user ID who is specified as host in the meeting.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host can run this function, and userId should not be myself.

Provided by category MobileRTCMeetingService(User).

◆ makeHost:withAssetsPrivilege:

- (MobileRTCSDKError) makeHost:		(NSUInteger)	userId
withAssetsPrivilege:		(NSArray< MobileRTCGrantCoOwnerAssetsInfo * > *_Nonnull)	infoList

Assigns a user as the host in the meeting and grants this user with privilege to manage related assets after the meeting.

Parameters

userId	The user ID who is specified as host in the meeting.
infoList	The assets privilege information list.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: The host cannot be assigned as host by themselves. And the user should have the power to assign the role.

Provided by category MobileRTCMeetingService(User).

◆ meetingChatByID:

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

Gets in-meeting chat message.

Parameters

messageID The message ID sent in the meeting.

Returns: The instance of in-meeting chat.

Warning: The method is optional.

Provided by category MobileRTCMeetingService(Chat).

◆ meetingView

- (UIView *_Nullable) meetingView

Returns the view of meeting UI, which enables customers to add their own view in the meeting UI.

Returns: The view of the current meeting.

Warning: Only valid in non-custom UI (only valid in Zoom meeting UI).

◆ modifyInterpreter:lan1:andLan2:

- (BOOL) modifyInterpreter:	(NSUInteger)	userID
lan1:	(NSInteger)	lanID1
andLan2:	(NSInteger)	lanID2

Modifies the language of an interpreter.

Parameters

userID	The interpreter user ID.
lanID1	The new first language ID.
lanID2	The new second language ID.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ modifySignInterpreter:signLanId:

- (MobileRTCSDKError) modifySignInterpreter:		(NSUInteger)	userID
signLanId:		(NSString *_Nullable)	signLanID

Modifies the language of a sign interpreter.

Parameters

userID	The unique identity of the user.
signLanID	The ID of sign language.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: The interface is for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ muteAllUserAudio:

- (BOOL) muteAllUserAudio: (BOOL) allowSelfUnmute

Mutes audio of all attendees.

Parameters

allowSelfUnmute YES to allow attendees to unmute audio themselves, NO otherwise.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(Audio).

◆ muteMyAudio:

- (MobileRTCAudioError) muteMyAudio: (BOOL) mute

Mutes or unmutes the audio of the current user.

Parameters

mute	YES to mute, NO to unmute.

Returns: If the function succeeds, it returns MobileRTCAudioError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Audio).

◆ muteMyVideo:

- (MobileRTCSDKError) muteMyVideo: (BOOL) mute

Mutes or unmutes video of the current user.

Parameters

mute	YES to mute video of the current user. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Video).

◆ muteUserAudio:withUID:

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

Mutes or unmutes the user's audio.

Parameters

mute	YES to mute, NO to unmute.
userID	The user's ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host can run the function.

Provided by category MobileRTCMeetingService(Audio).

◆ myAudioOutputDescription

- (MobileRTCAudioOutput) myAudioOutputDescription

Gets the audio output type of the current user.

Returns: The descriptions of audio output types.

Provided by category MobileRTCMeetingService(Audio).

◆ myAudioType

- (MobileRTCAudioType) myAudioType

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

Returns: The audio type.

Provided by category MobileRTCMeetingService(Audio).

◆ myselfUserID

- (NSUInteger) myselfUserID

Gets 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

Sets whether to pin the user's video or not.

Parameters

on	YES to pin the user's video. Otherwise, NO.
userId	The user ID whose video will be pinned.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: This function is only for Zoom UI.

Provided by category MobileRTCMeetingService(Video).

◆ playChime:

- (BOOL) playChime: (BOOL) on

Sets whether chime is enabled when the user joins or leaves meeting.

Parameters

on	YES to enable chime, NO to disable.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or cohost can run the function when in meeting.

Provided by category MobileRTCMeetingService(Audio).

◆ presentMeetingChatViewController:userId:

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

Presents Zoom original Meeting Chat ViewController.

Parameters

parentVC	The view controller used to present ViewController.
userId	The user ID of the user you would like to chat.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

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

parentVC which use to present ViewController.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ presentQAViewController:

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

Presents Zoom original Q&A ViewController.

Parameters

parentVC The view controller used to present ViewController.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(QA).

◆ promptAttendee2Panelist:

- (BOOL) promptAttendee2Panelist: (NSUInteger) userID

Prompts attendee to panelist in Webinar.

Parameters

userID The user ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ queryNetworkQuality:withDataFlow:

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

Checks in-meeting network status.

Parameters

type	Meeting component types. Now we can only query three components network status: MobileRTCComponentType_AUDIO, MobileRTCComponentType_VIDEO, and MobileRTCComponentType_SHARE.
sending	YES to query sending data. Otherwise, NO to 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

Raises hand of the current user.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ reclaimHost

- (BOOL) reclaimHost

Reclaims the role of the host.

Returns: YES if the current user can claim to be a host. Otherwise, NO.

Provided by category MobileRTCMeetingService(User).

◆ removeBGImage:

- (MobileRTCMeetError) removeBGImage: (MobileRTCVirtualBGImageInfo *_Nullable) bgImageInfo

Removes image item from image list. Will use the previous one for virtual background.

Parameters

bgImageInfo The background image info to remove.

Returns: Remove result.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ removeInterpreter:

- (BOOL) removeInterpreter: (NSUInteger) userID

Removes an interpreter.

Parameters

userID The interpreter user ID.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ 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, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ removeSignInterpreter:

- (MobileRTCSDKError) removeSignInterpreter: (NSUInteger) userID

Removes an interpreter.

Parameters

userID The unique identity of the user.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: The interface is for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ removeUser:

- (BOOL) removeUser: (NSUInteger) userId

Removes a user from the meeting.

Parameters

userId The user ID to be removed from the meeting.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: The method is available only for the host or co-host, and the host or co-host cannot remove themselves.

Provided by category MobileRTCMeetingService(User).

◆ reopenQuestion:

- (BOOL) reopenQuestion: (nonnull NSString *) questionID

Reopens a question.

Parameters

questionID The question ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ requestRawLiveStreaming:broadcastName:

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

Send a request to enable the SDK to start a raw live stream.

Parameters

broadcastURL	The broadcast URL of the live-stream.
broadcastName	The broadcast name of the live-stream.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success and the SDK will send the request. Otherwise, this function returns an error and the request will not be sent.

Provided by category MobileRTCMeetingService(InMeeting).

◆ requestSignLanuageInterpreterToTalk:allowToTalk:

- (MobileRTCSDKError) requestSignLanuageInterpreterToTalk:		(NSUInteger)	userID
allowToTalk:		(BOOL)	allowToTalk

The host allows or disallows sign language interpreter to talk.

Parameters

userID	The unique identity of the user.
allowToTalk	YES to allow to talk. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ requestStartCloudRecording

- (MobileRTCSDKError) requestStartCloudRecording

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

Returns: If the function succeeds, it returns MobileRTCSDKError_Success and the SDK sends the request. Otherwise, this function returns an error and the request is not sent.

Provided by category MobileRTCMeetingService(InMeeting).

◆ requestStartSmartSummary

- (MobileRTCSDKError) requestStartSmartSummary

Requests the host to start the smart summary for the current meeting.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Deprecated: Use MobileRTCAICompanionSmartSummaryHelper instead.

Provided by category MobileRTCMeetingService(SmartSummary).

◆ requestToStartCaptions:

- (MobileRTCSDKError) requestToStartCaptions: (BOOL) enableTranslation

Requests the host to start captions. If the host approves your request, you receive the callback MobileRTCMeetingServiceDelegate::onStartCaptionsRequestApproved, and you should start captions or translation there.

Parameters

enableTranslation YES to enable translation at the same time. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ requestToStartLiveTranscription:

- (BOOL) requestToStartLiveTranscription: (BOOL) requestAnonymous

Requests the host to start live transcription.

Parameters

requestAnonymous YES if it is anonymous to request the host to start live transcription. Otherwise, NO.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ requestTurnoffAllAICompanion

- (MobileRTCSDKError) requestTurnoffAllAICompanion

Asks host to turn off all started AI Companion features.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: All AI features including MobileRTCAICompanionType_QUERY, MobileRTCAICompanionType_SMART_SUMMARY, and MobileRTCAICompanionType_SMART_RECORDING can be turned off at once.

Provided by category MobileRTCMeetingService(AICompanion).

◆ requestTurnOnAllAICompanion

- (MobileRTCSDKError) requestTurnOnAllAICompanion

Asks host to turn on all AI Companion features if they are enabled for the current meeting.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: Only MobileRTCAICompanionType_QUERY and MobileRTCAICompanionType_SMART_SUMMARY can be turned on at once.

Provided by category MobileRTCMeetingService(AICompanion).

◆ resetMeetingAudioForCallKitHeld

- (void) resetMeetingAudioForCallKitHeld

Resets the 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.

Provided by category MobileRTCMeetingService(Audio).

◆ resetMeetingAudioSession

- (void) resetMeetingAudioSession

Resets the meeting audio session including category and mode.

Provided by category MobileRTCMeetingService(Audio).

◆ restartPolling:

- (MobileRTCSDKError) restartPolling: (NSString *_Nullable) pollingID

Restarts the polling.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ resumePauseCMR

- (BOOL) resumePauseCMR

Pauses or resumes cloud recording in the meeting.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ revokeCoHost:

- (BOOL) revokeCoHost: (NSUInteger) userID

Revokes co-host role of another user in the meeting.

Parameters

userID The user ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host can run the function.

Provided by category MobileRTCMeetingService(User).

◆ rotateMyVideo:

- (BOOL) rotateMyVideo: (UIDeviceOrientation) rotation

Rotates my video.

Parameters

rotation The device orientation.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ selectGreenVBPoint:

- (MobileRTCMeetError) selectGreenVBPoint: (CGPoint) point

Selects the point that is regarded as background.

Parameters

point The point in the preview view.

Returns: Result of set background point action.

Warning: Only iPad supports Virtual background GreenScreen. iPhone does not support the feature.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ sendChatMsg:

- (MobileRTCSendChatError) sendChatMsg: (nullable MobileRTCMeetingChat *) msg

Sends a chat message.

Parameters

msg	The chat message.

Returns: MobileRTCSendChatError_Success.

Provided by category MobileRTCMeetingService(Chat).

◆ sendEmojiFeedback:

- (MobileRTCSDKError) sendEmojiFeedback: (MobileRTCEmojiFeedbackType) type

Sends the emoji feedback.

Parameters

type	The emoji feedback type to be sent.

Returns: If the function succeeds, it will return MobileRTCMeetError_Success, otherwise not.

Provided by category MobileRTCMeetingService(Reaction).

◆ sendEmojiReaction:

- (MobileRTCSDKError) sendEmojiReaction: (MobileRTCEmojiReactionType) type

Sends emoji reaction.

Parameters

type	The type of the emoji reaction.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: MobileRTCEmojiReactionSkinTone doesn't work for MobileRTCEmojiReactionType_Heart type. To set MobileRTCEmojiReactionSkinTone, use -[MobileRTCMeetingSettings setReactionSkinTone] in MobileRTCMeetingSettings.h file.

Provided by category MobileRTCMeetingService(Reaction).

◆ sendPairingCode:WithMeetingNumber:

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

Gets the pairing code when the room device calls in.

Parameters

code	The pairing code which enables the device to connect to the meeting.
meetingNumber	The meeting number.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: App can invite Room System while App is in Meeting or in pre-Meeting.

Provided by category MobileRTCMeetingService(Customize).

◆ set3DAvatarImage:

- (MobileRTCSDKError) set3DAvatarImage: (MobileRTC3DAvatarImageInfo *_Nullable) imageInfo

Specifies an image to be the video filter image.

Parameters

imageInfo The image to use.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: Will close the 3D avatar when the imageInfo.index is -1.

Provided by category MobileRTCMeetingService(Avatar).

◆ setAnswerCheck:check:

- (MobileRTCSDKError) setAnswerCheck:		(MobileRTCPollingAnswerItem *_Nullable)	answerItem
check:		(BOOL)	check

Attendee sets answer's check.

Parameters

answerItem	The answer item where you want to set check.
check	YES to select the answer. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: This function should only be used by single, matching, rank order, multi, rating scale, or drop down questions.

Provided by category MobileRTCMeetingService(Polling).

◆ setAnswerContent:answerText:

- (MobileRTCSDKError) setAnswerContent:		(MobileRTCPollingAnswerItem *_Nullable)	answerItem
answerText:		(NSString *_Nullable)	answerText

Attendee sets answer's content.

Parameters

answerItem	The answer item where you want to answer.
answerText	The answer's content you want to reply.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: This function should only be used by fill blank, short answer, and long answer questions.

Provided by category MobileRTCMeetingService(Polling).

◆ setAttendeeViewMode:

- (MobileRTCSDKError) setAttendeeViewMode: (MobileRTCAttendeeViewMode) mode

Sets the view mode of the attendee.

Parameters

mode	The view mode of the attendee.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: Only for host to call this API. Only for Zoom UI mode.

Provided by category MobileRTCMeetingService(Webinar).

◆ setCloudWhiteboardFeedbackUrl:

- (BOOL) setCloudWhiteboardFeedbackUrl: (nullable NSString *) feedbackUrl

Allows the developer to customize the URL of cloud whiteboard feedback.

Parameters

feedbackUrl The customized URL.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ setCustomizedInvitationDomain:

- (BOOL) setCustomizedInvitationDomain: (NSString *_Nonnull) invitationDomain

Sets the customized invitation domain.

Parameters

invitationDomain The customized invitation domain. For example, https://example.com.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: This method can only be called after auth ready and before join or start meeting.

◆ setCustomizedPollingUrl:bCreate:

- (BOOL) setCustomizedPollingUrl:		(nullable NSString *)	pollingURL
bCreate:		(BOOL)	bCreate

Allows the developer to customize the URL of creating or editing the polling.

Parameters

pollingURL	The customized URL.
bCreate	YES to change the URL of creating a polling. Otherwise, NO to change the URL of editing a polling.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Customize).

◆ setDocsCreateOption:

- (MobileRTCSDKError) setDocsCreateOption: (MobileRTCDocsCreateOption) option

Sets the setting option for Docs who can initiate new Docs.

Parameters

option The setting option for who can initiate new Docs.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Docs).

◆ setDocsShareOption:

- (MobileRTCSDKError) setDocsShareOption: (MobileRTCDocsShareOption) option

Sets the setting option for Docs who can share.

Parameters

option The setting for who can share.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Docs).

◆ setFaceRecognitionFailStrategy:

- (MobileRTCSDKError) setFaceRecognitionFailStrategy: (MobileRTCFaceRecognitionFailStrategy) strategy

Sets the fail strategy of face recognition when auto-framing is enabled (mode is MobileRTCAutoFramingMode_FaceRecognition).

Parameters

strategy The fail strategy of face recognition.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Video).

◆ 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: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ setInterpreterActiveLan:

- (BOOL) setInterpreterActiveLan: (NSInteger) activeLanID

Sets a language channel which myself will be in, if myself is an interpreter.

Parameters

activeLanID The active language ID.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ setInterpreterListenLan:

- (BOOL) setInterpreterListenLan: (NSInteger) lanID

Sets a language that I can hear as an interpreter.

Parameters

lanID The selected language ID that I can hear as an interpreter.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ setMeetingSpokenLanguage:

- (BOOL) setMeetingSpokenLanguage: (NSInteger) languageID

Sets the spoken language of the current user.

Parameters

languageID The spoken language ID.

Returns: YES if the function succeeds. Otherwise, NO.

Deprecated: Use setMeetingSpokenLanguage:isForAll: instead.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ setMeetingSpokenLanguage:isForAll:

- (MobileRTCSDKError) setMeetingSpokenLanguage:		(NSInteger)	languageID
isForAll:		(BOOL)	isForAll

Sets the current user's spoken language.

Parameters

languageID	The spoken language ID.
isForAll	YES to set spoken language for all users. Otherwise, NO to set only for myself.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ setMeetingTopic:

- (BOOL) setMeetingTopic: (NSString *_Nonnull) meetingTopic

Sets to customize the meeting topic which will be displayed in the meeting info view.

Parameters

meetingTopic The topic of the meeting.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

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

Deprecated: Use setMeetingTopics: instead.

Provided by category MobileRTCMeetingService(Customize).

◆ setMeetingTopics:

- (MobileRTCSDKError) setMeetingTopics: (NSString *_Nonnull) meetingTopic

Sets to customize the meeting topic which will be displayed in the meeting info view.

Parameters

meetingTopic The topic of the meeting.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

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

Provided by category MobileRTCMeetingService(Customize).

◆ setParentViewCtroller:

- (MobileRTCSDKError) setParentViewCtroller: (UIViewController *_Nullable) parentVC

Sets parent view controller for whiteboard board view and whiteboard canvas.

Parameters

parentVC The view controller used to present ViewController. If parentVC is nil, whiteboard will dismiss.

Warning: The function is only for Custom UI. This method is a prerequisite for using whiteboard. Suggest to call this function in "onMeetingStateChange:" for inMeeting status.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Deprecated: Not maintained anymore. Use showWhiteboardByParentViewCtroller: instead.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ setShareAudio:

- (void) setShareAudio: (BOOL) enableAudio

Enables or disables the sending of device audio.

Parameters

enableAudio YES to enable device audio sharing. Otherwise, NO to disable.

Provided by category MobileRTCMeetingService(AppShare).

◆ setShareSettingType:

- (MobileRTCSDKError) setShareSettingType: (MobileRTCShareSettingType) shareType

Sets sharing types for the host or co-host in the meeting.

Parameters

shareType Custom setting types of ZOOM SDK sharing.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(AppShare).

◆ setTranslationLanguage:

- (BOOL) setTranslationLanguage: (NSInteger) languageID

Sets the translation language of the current user.

Parameters

languageID The translation language ID. If the language ID is set to -1, live translation is disabled. Then you can receive closed caption when the host sets meeting manual caption to YES.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ setVideoAutoFramingMode:

- (MobileRTCSDKError) setVideoAutoFramingMode: (MobileRTCAutoFramingMode) mode

Sets the mode of auto-framing when auto-framing is enabled.

Parameters

mode	The auto-framing mode.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Video).

◆ setVideoAutoFramingRatio:

- (MobileRTCSDKError) setVideoAutoFramingRatio: (CGFloat) ratio

Sets the zoom in ratio of auto-framing when auto-framing is enabled.

Parameters

ratio The zoom in ratio of auto-framing. Valid range of ratio: A. mode is "MobileRTCAutoFramingMode_CenterCoordinates", 1~10. B. mode is "MobileRTCAutoFramingMode_FaceRecognition", 0.1~10.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Video).

◆ setVideoQualityPreference:

- (MobileRTCSDKError) setVideoQualityPreference: (MobileRTCVideoPreferenceSetting *_Nullable) preferenceSetting

Sets the video quality preference that automatically adjusts the user's video to prioritize frame rate vs. resolution based on the current bandwidth available.

Parameters

preferenceSetting The video quality preference.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: This only supports the raw data render model.

Provided by category MobileRTCMeetingService(Video).

◆ setWhiteboardCreateOption:

- (MobileRTCSDKError) setWhiteboardCreateOption: (MobileRTCWhiteboardCreateOption) option

Sets the option for who can initiate a new whiteboard.

Parameters

option The setting option for who can initiate a new whiteboard.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ setWhiteboardShareOption:

- (MobileRTCSDKError) setWhiteboardShareOption: (MobileRTCWhiteboardShareOption) option

Sets the option for who can share a whiteboard.

Parameters

option The new setting for who can share a whiteboard.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ showAANPanelInView:

- (MobileRTCSDKError) showAANPanelInView: (UIView *_Nullable) containerView

Show app signaling pannel in designated position of container view.

Parameters

containerView the view container to show app signaling pannel.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: Only custom UI mode can use this method.

Provided by category MobileRTCMeetingService(InMeeting).

◆ showActiveDoc:byParentViewCtroller:

- (MobileRTCSDKError) showActiveDoc:		(NSUInteger)	shareSourceID
byParentViewCtroller:		(UIViewController *_Nonnull)	parentVC

Shows Doc or DocDashboardView. Need to set parent view controller. If Doc is active MobileRTCDocsStatus_Start, that can show active Doc.

Parameters

parentVC	The view controller used to present ViewController.
shareSourceID	The selected doc share source ID.

Warning: The function is only for Custom UI. This method is a prerequisite for using doc. Suggest to call this function in "onDocsStatusChanged:" for doc status.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Docs).

◆ showAvatar:

- (MobileRTCSDKError) showAvatar: (BOOL) bShow

Sets to show or hide the last used avatar in the meeting.

Parameters

bShow YES to show the last used avatar. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Avatar).

◆ showDashboardView

- (MobileRTCSDKError) showDashboardView

Shows the dashboard web view window.

Warning: The function is only for Custom UI.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ showDocByParentViewCtroller:

- (MobileRTCSDKError) showDocByParentViewCtroller: (UIViewController *_Nonnull) parentVC

Shows Doc or DocDashboardView. Need to set parent view controller. If Doc is active MobileRTCDocsStatus_Start, that can show active Doc.

Parameters

parentVC The view controller used to present ViewController.

Warning: The function is only for Custom UI. This method is a prerequisite for using doc. Suggest to call this function in "onDocsStatusChanged:" for doc status.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Docs).

◆ showDocDashboardView

- (MobileRTCSDKError) showDocDashboardView

Shows the dashboard web view window.

Warning: The function is only for Custom UI.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Docs).

◆ showDynamicNoticeForAICompanionPanel:

- (MobileRTCSDKError) showDynamicNoticeForAICompanionPanel: (UIView *_Nullable) containerView

Show the dynamic notice for the AI Companion panel view in the bottom of the container view.

Parameters

containerView Show the AI Companion panel's dynamic notice in this view.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: Only custom UI mode can use this method.

Provided by category MobileRTCMeetingService(InMeeting).

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

◆ showMinimizeMeetingFromZoomUIMeeting

- (BOOL) showMinimizeMeetingFromZoomUIMeeting

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

Warning: The method only for Zoom UI.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ 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: If the function succeeds, it returns YES. Otherwise, NO.

Warning: The method does not work if you have set mobileRTCRootController via [MobileRTC setMobileRTCRootController].

Provided by category MobileRTCMeetingService(InMeeting).

◆ showWhiteboardByParentViewCtroller:

- (MobileRTCSDKError) showWhiteboardByParentViewCtroller: (UIViewController *_Nullable) parentVC

Shows whiteboard or DashboardView. Need to set parent view controller. If whiteboard is active MobileRTCWhiteboardStatus_Started, that can show active whiteboard.

Parameters

parentVC The view controller used to present ViewController. If parentVC is nil, whiteboard will dismiss.

Warning: The function is only for Custom UI. This method is a prerequisite for using whiteboard. Suggest to call this function in "onWhiteboardStatusChanged:" for whiteboard status.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Whiteboard).

◆ spotlightVideo:withUser:

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

Sets whether to spotlight the user's video.

Parameters

on	YES to spotlight the user's video. NO to cancel spotlighting the user's video.
userId	The user ID whose video will be spotlighted in the meeting.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function, and the user spotlighted should not be the host themselves.

Provided by category MobileRTCMeetingService(Video).

◆ startAppShare

- (BOOL) startAppShare

Starts App Share.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(AppShare).

◆ startInterpretation

- (BOOL) startInterpretation

Starts interpretation.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ 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: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host can start live Stream successfully.

Provided by category MobileRTCMeetingService(InMeeting).

◆ startLiveTranscription

- (BOOL) startLiveTranscription

Starts live transcription. If the meeting enables multi-language transcription, all users can start live transcription. Otherwise, only the host can start.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ startLiving:

- (BOOL) startLiving: (nonnull NSString *) questionID

Starts living a question.

Parameters

questionID The question ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ startMeetingWithStartParam:

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

Starts a meeting with MobileRTCMeetingStartParam parameter.

Parameters

param Create an instance with settings via MobileRTCMeetingStartParam.

Returns: The state of the meeting: started or failed.

Note: For a non-logged-in user, create an instance via MobileRTCMeetingStartParam4WithoutLoginUser to pass the parameters. For a logged-in user, create an instance via MobileRTCMeetingStartParam4LoginlUser to pass the parameters.

Warning: A meeting started with wrong parameters will return MobileRTCMeetError_InvalidArguments.

◆ startPolling:

- (MobileRTCSDKError) startPolling: (NSString *_Nullable) pollingID

Starts the polling.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ startPreviewWithFrame:

- (BOOL) startPreviewWithFrame: (CGRect) frame

Starts preview to inspect the virtual background effect.

Parameters

frame The frame for the preview.

Returns: YES if preview is ready. Otherwise, NO.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ startRawArchiving

- (BOOL) startRawArchiving

Starts raw archiving and gets raw data receive privilege.

Returns: YES if starting raw archiving succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(RawArchiving).

◆ startRawLiveStreaming:broadcastName:

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

Start a rawData live stream.

Parameters

broadcastURL	The broadcast URL of the live-stream.
broadcastName	The broadcast name of the live-stream.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success and the SDK will send the request. Otherwise, this function returns an error and the request will not be sent.

Provided by category MobileRTCMeetingService(InMeeting).

◆ startSharePollingResult:

- (MobileRTCSDKError) startSharePollingResult: (NSString *_Nullable) pollingID

Shares the poll's result.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ startSignInterpretation

- (MobileRTCSDKError) startSignInterpretation

Starts sign interpretation.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: The interface is for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ startSmartSummary

- (MobileRTCSDKError) startSmartSummary

Starts smart summary.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Deprecated: Use MobileRTCAICompanionSmartSummaryHelper instead.

Provided by category MobileRTCMeetingService(SmartSummary).

◆ stopAppShare

- (void) stopAppShare

Stops App Share.

Provided by category MobileRTCMeetingService(AppShare).

◆ stopIncomingAudio:

- (MobileRTCSDKError) stopIncomingAudio: (BOOL) enabled

Stops or resumes the incoming audio.

Parameters

enabled YES to stop incoming audio, NO to resume.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Audio).

◆ stopIncomingVideo:

- (MobileRTCSDKError) stopIncomingVideo: (BOOL) enable

Stops the incoming video.

Parameters

enable YES to enable to stop incoming video. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Video).

◆ stopInterpretation

- (BOOL) stopInterpretation

Stops interpretation.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ stopLiveStream

- (BOOL) stopLiveStream

Set to stop live streaming.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: The function is available only for host.

Provided by category MobileRTCMeetingService(InMeeting).

◆ stopLiveTranscription

- (BOOL) stopLiveTranscription

Stops live transcription. If the meeting enables multi-language transcription, all users can stop live transcription. Otherwise, only the host can stop.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ stopPolling:

- (MobileRTCSDKError) stopPolling: (NSString *_Nullable) pollingID

Stops the polling.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ stopPreview

- (void) stopPreview

Stops previewing the virtual background.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ stopRawArchiving

- (BOOL) stopRawArchiving

Stops raw archiving and revokes raw data receive privilege.

Returns: YES if stopping raw archiving succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(RawArchiving).

◆ stopRawLiveStream

- (MobileRTCSDKError) stopRawLiveStream

Stop a rawData live stream.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ stopSharePollingResult:

- (MobileRTCSDKError) stopSharePollingResult: (NSString *_Nullable) pollingID

Stops sharing the poll's result.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ stopSignInterpretation

- (MobileRTCSDKError) stopSignInterpretation

Stops sign interpretation.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: The interface is for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ stopSmartSummary

- (MobileRTCSDKError) stopSmartSummary

Stops smart summary.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Deprecated: Use MobileRTCAICompanionSmartSummaryHelper instead.

Provided by category MobileRTCMeetingService(SmartSummary).

◆ stopUserVideo:

- (BOOL) stopUserVideo: (NSUInteger) userID

Stops the user's video.

Parameters

userID The user ID of other users except the host in the meeting.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only host can run the function in the meeting.

Provided by category MobileRTCMeetingService(Video).

◆ submitPolling:

- (MobileRTCSDKError) submitPolling: (NSString *_Nullable) pollingID

Attendee submits the polling.

Parameters

pollingID The submit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ suspendParticipantsActivites

- (MobileRTCSDKError) suspendParticipantsActivites

Suspend all participant activities.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ suspendSharing:

- (BOOL) suspendSharing: (BOOL) suspend

Suspends App Sharing.

Parameters

suspend YES if sharing should be suspended. Otherwise, NO to resume sharing.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: When the customer goes to share content, consider the effects on device performance, and use this method to pause sharing when UI changes, and resume sharing when UI changes stop. See WebViewController.m in the sample project.

Provided by category MobileRTCMeetingService(AppShare).

◆ switchCamera:

- (BOOL) switchCamera: (NSString *_Nullable) cameraId

Switches camera by camera ID.

Parameters

cameraId The target camera ID.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Provided by category MobileRTCMeetingService(Video).

◆ switchMyAudioSource

- (MobileRTCAudioError) switchMyAudioSource

Switches the audio output between receiver and speaker.

Returns: If the function succeeds, it returns MobileRTCAudioError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Audio).

◆ switchMyCamera

- (MobileRTCCameraError) switchMyCamera

Switches the camera of the current user in the local device.

Returns: The result of operation.

Provided by category MobileRTCMeetingService(Video).

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

Provided by category MobileRTCMeetingService(InMeeting).

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

Provided by category MobileRTCMeetingService(InMeeting).

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ transferFile:toUser:

- (MobileRTCSDKError) transferFile:		(NSString *_Nullable)	filePath
toUser:		(NSUInteger)	userId

Sends file to the specified user in the current meeting.

Parameters

filePath	The absolute path of the file.
userId	The user ID to send the file to.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: This interface is related to chat privilege. SeeMobileRTCMeetingChatPriviledgeType}.

Provided by category MobileRTCMeetingService(Chat).

◆ transferFileToAll:

- (MobileRTCSDKError) transferFileToAll: (NSString *_Nullable) filePath

Sends file to all users in the current meeting.

Parameters

filePath The local path of the file.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: This interface is related to chat privilege. SeeMobileRTCMeetingChatPriviledgeType}.

Provided by category MobileRTCMeetingService(Chat).

◆ 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: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(InMeeting).

◆ turnOffAllAICompanion:

- (MobileRTCSDKError) turnOffAllAICompanion: (BOOL) deleteMeetingAssets

Turns off the AI Companion features.

Parameters

deleteMeetingAssets YES to delete the meeting assets when turning off the AI Companion features. Otherwise, NO.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: All AI features including MobileRTCAICompanionType_QUERY, MobileRTCAICompanionType_SMART_SUMMARY, and MobileRTCAICompanionType_SMART_RECORDING can be turned off at once.

Provided by category MobileRTCMeetingService(AICompanion).

◆ turnOffMajorAudio

- (BOOL) turnOffMajorAudio

Turns off the major audio if you are in some interpreter language channel.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ turnOnAllAICompanion

- (MobileRTCSDKError) turnOnAllAICompanion

Turns on all the AI Companion features.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(AICompanion).

◆ turnOnCMR:

- (void) turnOnCMR: (BOOL) on

Turns on or off the cloud recording in the meeting.

Parameters

on	YES to turn on cloud recording. Otherwise, NO.

Provided by category MobileRTCMeetingService(InMeeting).

◆ turnOnMajorAudio

- (BOOL) turnOnMajorAudio

Turns on the major audio if you are in some interpreter language channel.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(Interpretation).

◆ unSpotlightAllVideos

- (BOOL) unSpotlightAllVideos

Un-spotlights all users.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host or co-host can run the function.

Provided by category MobileRTCMeetingService(Video).

◆ updateVirtualNameTagRosterInfo:

- (MobileRTCSDKError) updateVirtualNameTagRosterInfo: (NSArray< MobileRTCVirtualNameTag * > *_Nullable) userRoster

Update the virtual name tag roster infomation for the account.

Parameters

userRoster The virtual name tag roster info list for specify user.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Note: The maximum size of userRoster should less 20. User should sepcify the tagName and tagID of each MobileRTCVirtualNameTag object. The range of tagID is 0-1024.

Provided by category MobileRTCMeetingService(InMeeting).

◆ useBGImage:

- (MobileRTCMeetError) useBGImage: (MobileRTCVirtualBGImageInfo *_Nullable) bgImage

Uses the specified image item for virtual background.

Parameters

bgImage The background image info to use.

Returns: The result of use image item.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ useNoneImage

- (MobileRTCMeetError) useNoneImage

Disables the virtual background, same as using a none image item.

Returns: The result of disable virtual background.

Deprecated: Use useBGImage: instead.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ userInfoByID:

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

Gets user information in the meeting.

Parameters

userId The in-meeting user ID.

Returns: User information.

Warning: Webinar attendee cannot call the function. Please use attendeeInfoByID:.

Provided by category MobileRTCMeetingService(User).

◆ viewPollingResultFromBrowser:

- (MobileRTCSDKError) viewPollingResultFromBrowser: (NSString *_Nullable) pollingID

Opens a polling result in the web browser.

Parameters

pollingID The edit poll's polling ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Provided by category MobileRTCMeetingService(Polling).

◆ voteupQuestion:voteup:

- (BOOL) voteupQuestion:		(nonnull NSString *)	questionID
voteup:		(BOOL)	voteup

Votes up a question.

Parameters

questionID	The question ID.
voteup	YES to vote up. Otherwise, NO.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Only meeting host, co-host, or panelist can run the function.

Provided by category MobileRTCMeetingService(QA).

◆ withdrawCCPrivilege:

- (BOOL) withdrawCCPrivilege: (NSUInteger) userId

Withdraws the user privilege to send closed caption.

Parameters

userId The user ID.

Returns: YES if the function succeeds. Otherwise, NO.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ zoomCamera:

- (BOOL) zoomCamera: (CGFloat) velocity

Zooms the camera in or out.

Parameters

velocity The zoom velocity.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Warning: Please refer to the MobileRTCCameraDevice class. The value of maxZoomFactor means the camera's maximum zoom factor. The value of videoZoomFactorUpscaleThreshold means the maximum scale of optical zoom factor.

Provided by category MobileRTCMeetingService(Video).

Property Documentation

◆ customizedUImeetingDelegate

- (id<MobileRTCCustomizedUIMeetingDelegate> _Nullable) customizedUImeetingDelegate

readwritenonatomicweak

Callback for custom UI meeting events. Custom UI features enable you to customize the user interface instead of using the default client view.

Definition at line 313 of file MobileRTCMeetingService.h.

◆ delegate

- (id<MobileRTCMeetingServiceDelegate> _Nullable) delegate

readwritenonatomicweak

Callback to receive meeting events.

Definition at line 308 of file MobileRTCMeetingService.h.

◆ previewView

- (UIView* _Nullable) previewView

readwritenonatomicretain

The preview for inspect the virtual background effect.

Provided by category MobileRTCMeetingService(VirtualBackground).

Definition at line 42 of file MobileRTCMeetingService+VirtualBackground.h.

Instance Methods

Properties

Detailed Description

Method Documentation

◆ activeShareUserID

◆ activeUserID

◆ addBGImage:

◆ addInterpreter:lan1:andLan2:

◆ addPolling

◆ addQuestion:anonymous:

◆ addSignInterpreter:signLanId:

◆ allowAskQuestionAnonymously:

◆ allowAttenddeTalk:allow:

◆ allowAttendeeChat:

◆ allowAttendeeRaiseHand

◆ allowAttendeeUpVoteQuestion:

◆ allowAttendeeViewAllQuestion:

◆ allowAttendeeViewTheParticipantCount

◆ allowCommentQuestion:

◆ allowPanelistStartVideo:

◆ allowParticipantsToRename:

◆ allowParticipantsToRequestCloudRecording:

◆ allowParticipantsToRequestLocalRecording:

◆ allowParticipantsToShareWhiteBoard:

◆ allowParticipantsToStartVideo:

◆ allowParticipantsToUnmuteSelf:

◆ allowWebinarEmojiReaction

◆ answerQuestionPrivate:answerContent:

◆ answerQuestionPublic:answerContent:

◆ appShareWithView:

◆ askAllToUnmute

◆ askUserStartVideo:

◆ assignCCPrivilege:

◆ assignCohost:

◆ assignCohost:withAssetsPrivilege:

◆ attendeeInfoByID:

◆ autoAllowLocalRecordingRequest:

◆ backZoomUIMeetingFromMinimizeMeeting

◆ callRoomDevice:

◆ canAddPolling

◆ canAssignOthersToSendCC

◆ canBeAssignedToSendCC:

◆ canBeCoHost:

◆ canBeCoOwner:

◆ cancelCallRoomDevice

◆ cancelDialOut:

◆ cancelEmojiFeedback

◆ canClaimhost

◆ canDeletePolling:

◆ canDisableCaptions

◆ canDoPolling

◆ canDownloadResult

◆ canDuplicatePolling:

◆ canEditPolling:

◆ canEnableAlphaChannelMode

◆ canEnableLiveStreamReminder

◆ canEnableMuteOnEntry

◆ canEnableParticipantRequestCloudRecording

◆ canGetRightAnswerItemList:

◆ canHideParticipantProfilePictures

◆ canPinVideo:

◆ canRequestStartSmartSummary

◆ canRequestTurnoffAllAICompanion

◆ canRequestTurnOnAllAICompanion

◆ canRestartPolling:

◆ canSetDocsOption

◆ canSetMeetingTopic

◆ canSharePollingResult:

◆ canShowAnswerResultList:

◆ canStartLiveTranscription

◆ canStartPolling:

◆ canStartRawLiveStream

◆ canStartShare

◆ canStartShareDoc

◆ canStartShareWhiteboard

◆ canStartSignInterpretation

◆ canStartSmartSummary

◆ canSubmitPolling:

◆ canSuspendParticipantsActivities

◆ canTurnOffAllAICompanions