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

#import <MobileRTCMeetingService.h>

Inherits NSObject.

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

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

(MobileRTCMeetError)	- handZoomWebUrl:
	Start or join a Zoom meeting with zoom web URL.

(MobileRTCMeetingState)	- getMeetingState
	Get the current meeting state.

(void)	- leaveMeetingWithCmd:
	End or leave the current meeting.

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

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

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

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

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

(void)	- appShareWithView:
	Share content with current view.

(BOOL)	- startAppShare
	Set to start App Share.

(void)	- stopAppShare
	Set to stop App Share.

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

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

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

(BOOL)	- suspendSharing:
	Suspend App Sharing.

(BOOL)	- isWhiteboardLegalNoticeAvailable
	Is whiteboard legal notice available.

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

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

(void)	- setShareAudio:
	Enable the sending of device audio.

(BOOL)	- isSharedAudio
	Get state of device audio sharing.

(BOOL)	- isDeviceSharing
	Get state of device screen sharing.

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

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

(MobileRTCAudioOutput)	- myAudioOutputDescription
	Set to retrieve the audio output type of the current user.

(BOOL)	- isMyAudioMuted
	Query if the audio of the current user is muted.

(BOOL)	- canUnmuteMyAudio
	Query if the user can unmute his audio.

(BOOL)	- isMuteOnEntryOn
	Query if is enabled to mute attendees when they join the meeting.

(BOOL)	- muteOnEntry:
	Set if attendees join the meeting with audio muted.

(BOOL)	- isUserAudioMuted:
	Query if the user's audio is muted.

(BOOL)	- muteUserAudio:withUID:
	Set whether to mute user's audio.

(BOOL)	- muteAllUserAudio:
	Set to mute audio of all attendees.

(BOOL)	- askAllToUnmute
	Ask to unmute audio of all attendees.

(BOOL)	- isSupportedVOIP
	Query if the meeting supports VoIP.

(BOOL)	- isPlayChimeOn
	Query if chime is enabled when user joins/leaves meeting.

(BOOL)	- playChime:
	Set whether chime are enabled when the user joins/leaves meeting.

(MobileRTCAudioError)	- muteMyAudio:
	Set to mute the audio of the current user.

(MobileRTCAudioError)	- switchMyAudioSource
	switch my audio output(receiver/speaker).

(void)	- resetMeetingAudioSession
	Reset Meeting Audio Session including Category and Mode.

(void)	- resetMeetingAudioForCallKitHeld
	Reset Meeting Audio Session including Category and Mode. When the call comes in or goes out, click hold or swap in the dial-up UI to restore the zoom sound.

(BOOL)	- isIncomingAudioStopped
	Determine if the incoming audio is stopped.

(MobileRTCSDKError)	- stopIncomingAudio:
	Stop the incoming audio.

(int)	- getSupportedMeetingAudioType
	Get the audio type supported by the current meeting. See [MobileRTCInMeetingSupportAudioType].

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

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

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

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

(MobileRTCSDKError)	- showAvatar:
	Determine if show the last used avatar in the meeting.

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

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

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

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

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

(MobileRTCBOData *_Nullable)	- getDataHelper
	Object for Breakout Room meeting id information defined in [MobileRTCBOData].

(BOOL)	- isBOMeetingStarted
	Has Breakout Room meeting began.

(BOOL)	- isBOMeetingEnabled
	Is Breakout Room feature enabled in meeting.

(BOOL)	- isInBOMeeting
	Is currently in Breakout Room during meeting.

(MobileRTCBOStatus)	- getBOStatus
	Get current Breakout status.

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

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

(BOOL)	- changeAttendeeChatPriviledge:
	Set Attendee Chat Priviledge when in-meeting.

(MobileRTCMeetingChatPriviledgeType)	- getAttendeeChatPriviledge
	get Attendee Chat Priviledge when in-meeting

(BOOL)	- isMeetingChatLegalNoticeAvailable
	Is meeting chat legal notice available.

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

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

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

(MobileRTCSendChatError)	- sendChatToUser:WithContent:
	Send chat message to the specified user in the meeting.

(MobileRTCSendChatError)	- sendChatToGroup:WithContent:
	Send message to group in the meeting.

(BOOL)	- deleteChatMessage:
	Delete chat message by message id.

(nullable NSArray< NSString * > *)	- getAllChatMessageID
	Get all chat message id.

(BOOL)	- isChatMessageCanBeDeleted:
	Determine whether the message can be delete.

(BOOL)	- isShareMeetingChatLegalNoticeAvailable
	Is share meeting chat legal notice available.

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

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

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

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

(BOOL)	- isDialOutSupported
	Query if user can dial out in the meeting.

(BOOL)	- isDialOutInProgress
	Query if there is any outgoing call in process.

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

(BOOL)	- cancelDialOut:
	Cancel to dial out.

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

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

(BOOL)	- cancelCallRoomDevice
	Cancel to call room device.

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

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

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

(BOOL)	- sendPairingCode:WithMeetingNumber:
	Get the pairing code when the room device call in.

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

(NSUInteger)	- getParticipantID
	Get Participant ID.

(nullable MobileRTCCallCountryCode *)	- getDialInCurrentCountryCode
	Get countrycode for the current user's locale.

(nullable NSArray< NSArray< MobileRTCCallCountryCode * > * > *)	- getDialInAllCountryCodes
	Get all countrycodes.

(nullable NSArray< MobileRTCCallCountryCode * > *)	- getDialInCallCodesWithCountryId:
	Get to the countrycode specified by countryId.

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

(BOOL)	- setCustomizedPollingUrl:bCreate:
	Allowing the developer to customize the URL of create/edit the polling.

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

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

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

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

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

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

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

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

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

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

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

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

(MobileRTCRecordingStatus)	- getCloudRecordingStatus
	Get current cloud recording.

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

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

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

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

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

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

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

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

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

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

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

(BOOL)	- stopLiveStream
	Set to stop live streaming.

(BOOL)	- isRawLiveStreamSupported

(MobileRTCSDKError)	- canStartRawLiveStream

(MobileRTCSDKError)	- requestRawLiveStream:

(MobileRTCSDKError)	- startRawLiveStream:
	Start a rawData live stream.

(MobileRTCSDKError)	- stopRawLiveStream
	Stop a rawData live stream.

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

(NSArray< MobileRTCRawLiveStreamInfo * > *_Nullable)	- getRawLiveStreamingInfoList

(NSArray< NSNumber * > *_Nullable)	- getRawLiveStreamPrivilegeUserList

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

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

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

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

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

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

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

(MobileRTCANNError)	- hideAANPanel
	hide app signaling pannel.

(BOOL)	- isQAEnabled
	Query if Q&A is enabled.

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

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

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

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

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

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

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

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

(MobileRTCSDKError)	- allowParticipantsToStartVideo:

(BOOL)	- isParticipantsStartVideoAllowed

(MobileRTCSDKError)	- allowParticipantsToShareWhiteBoard:

(BOOL)	- isParticipantsShareWhiteBoardAllowed

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

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

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

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

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

(BOOL)	- isInterpreter
	Determine if myself is interpreter.

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

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

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

(BOOL)	- addInterpreter:lan1:andLan2:
	Add someone as a interpreter.

(BOOL)	- removeInterpreter:
	Remove some interpreter.

(BOOL)	- modifyInterpreter:lan1:andLan2:
	modify the language of some interpreter.

(BOOL)	- startInterpretation
	Start interpretation.

(BOOL)	- stopInterpretation
	Stop interpretation.

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

(BOOL)	- joinLanguageChannel:
	Join some language channel.

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

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

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

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

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

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

(NSInteger)	- getInterpreterActiveLan
	Get the active language ID, if myself is a interpreter.

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

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

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

(BOOL)	- isMeetingSupportCC
	Query if the current meeting is supported closed caption.

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

(MobileRTCSDKError)	- enableCaptions:

(BOOL)	- isCaptionsEnabled
	Query if the captions enabled.

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

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

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

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

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

(BOOL)	- isMeetingManualCaptionEnabled
	Determine whether it is enabled to manual input CC for meeting.

(BOOL)	- isLiveTranscriptionFeatureEnabled
	Query if this meeting support the live transcription feature.

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

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

(BOOL)	- startLiveTranscription
	Start live transcription. If the meeting enable multi language transcription,all user can start live transcription otherwise only host can start.

(BOOL)	- stopLiveTranscription
	Stop live transcription. If the meeting enable multi language transcription,all user can stop live transcription,otherwise only host can stop.

(BOOL)	- enableRequestLiveTranscription:
	The host enable/disable the request live transcription.

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

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

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

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

(MobileRTCSDKError)	- enableReceiveSpokenlLanguageContent:
	Enable or disable to receive original and translated content.If enable this feature,you need start live transcription.

(BOOL)	- isReceiveSpokenLanguageContentEnabled
	Determine whether receive original and translated is available.

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

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

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

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

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

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

(BOOL)	- startRawArchiving
	Start raw archiving and get raw data receive previlege.

(BOOL)	- stopRawArchiving
	Stop raw archiving and revoke rawdata receive previlege.

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

(MobileRTCMeetError)	- sendEmojiReaction:reactionSkinTone:
	Send emoji reaction.

(MobileRTCMeetError)	- sendEmojiReaction:
	Send emoji reaction.

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

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

(BOOL)	- isSignInterpreter
	Determine if self is sign interpreter.

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

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

(NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable)	- getAllSupportedSignLanguageInfoList
	Get the all supported sign interpretation language list.only for host.

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

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

(MobileRTCSDKError)	- removeSignInterpreter:
	Remove interpreter.

(MobileRTCSDKError)	- modifySignInterpreter:signLanId:
	Modify the language of some sign interpreter.

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

(MobileRTCSDKError)	- startSignInterpretation
	Start sign interpretation.

(MobileRTCSDKError)	- stopSignInterpretation
	Stop sign interppretation.

(MobileRTCSDKError)	- requestSignLanuageInterpreterToTalk:allowToTalk:
	Host allow sign language interpreter to talk.

(BOOL)	- isAllowSignLanuageInterpreterToTalk:
	Determine if the sign language interpreter be allowed to talk.

(NSString *_Nullable)	- getSignInterpreterAssignedLanID
	Get sign language id if myself is a sign interpreter.only for interpreter.

(MobileRTCSDKError)	- joinSignLanguageChannel:
	Join some sign language channel if myself is not a sign interpreter.only for non-interpreter.

(MobileRTCSDKError)	- leaveSignLanguageChannel
	Leave current sign language channel if myself is not a sign interpreter.only for non-interpreter.

(BOOL)	- changeName:withUserID:
	Set to change user's screen name in meeting.

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

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

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

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

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

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

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

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

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

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

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

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

(BOOL)	- isH323User:
	Query if the user join meeting from H323.

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

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

(BOOL)	- lowerAllHand:
	Set to put all users' hands down.

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

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

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

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

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

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

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

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

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

(BOOL)	- canUnmuteMyVideo
	Query if user can unmute his video himself.

(MobileRTCSDKError)	- muteMyVideo:
	Set to mute video of the current user.

(BOOL)	- rotateMyVideo:
	Rotate my video.

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

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

(BOOL)	- unSpotlightAllVideos
	Un-spotlight all the user.

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

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

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

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

(BOOL)	- stopUserVideo:
	Set to stop user's video.

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

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

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

(MobileRTCCameraError)	- switchMyCamera
	Set to Switch the camera of the current user in local device.

(BOOL)	- isSupportFollowHostVideoOrder
	Qurry if the account support follow host video order feature or not.

(BOOL)	- isFollowHostVideoOrderOn
	Qurry if follow host video order or not currently.

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

(MobileRTCSDKError)	- stopIncomingVideo:
	Stop the incoming video.

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

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

(BOOL)	- startPreviewWithFrame:
	Start preview for inspect the virtual background effect.

(BOOL)	- isSupportVirtualBG
	is support virtual background.

(BOOL)	- isSupportSmartVirtualBG
	is Support smart virtual background.

(NSArray< MobileRTCVirtualBGImageInfo * > *_Nonnull)	- getBGImageList
	get the virtual background list.

(MobileRTCMeetError)	- addBGImage:
	add and use the image for virtual background.

(MobileRTCMeetError)	- removeBGImage:
	Remove image item form image list.

(MobileRTCMeetError)	- useBGImage:
	use the specify image item for virtual background.

(MobileRTCMeetError)	- useNoneImage
	Disable the virtrual background, same as use a none image item.

(BOOL)	- isUsingGreenVB
	is using green virtual background.

(MobileRTCMeetError)	- enableGreenVB:
	Enable green virtual background mode.

(MobileRTCMeetError)	- selectGreenVBPoint:
	Select the point that regard as background.

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

(BOOL)	- promptAttendee2Panelist:
	Prompt Attendee to Panelist in Webinar.

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

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

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

(BOOL)	- allowAttendeeChat:
	Allow attendee to chat.

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

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

(BOOL)	- allowAttenddeTalk:allow:
	Allow attendee to talk in webinar.

(BOOL)	- isAllowPanelistStartVideo
	Query if Panelist can start video in Webinar Meeting.

(BOOL)	- allowPanelistStartVideo:
	Allow Panelist to start video in Webinar.

(BOOL)	- isAllowAskQuestionAnonymously
	Query if it is allowed to ask question anonymously in webinar.

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

(BOOL)	- isAllowAttendeeViewAllQuestion
	Query if attendee is allowed to view all question.

(BOOL)	- allowAttendeeViewAllQuestion:
	Allow attendee to view all question.

(BOOL)	- isAllowAttendeeUpVoteQuestion
	Query if attendee is allowed to submit questions.

(BOOL)	- allowAttendeeUpVoteQuestion:
	Allow attendee to submit questions.

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

(BOOL)	- allowCommentQuestion:
	Allow attendee to comment question.

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

(nullable NSArray< MobileRTCQAItem * > *)	- getMyQuestionList
	Get My questions.

(nullable NSArray< MobileRTCQAItem * > *)	- getOpenQuestionList
	Get Open questions.

(nullable NSArray< MobileRTCQAItem * > *)	- getDismissedQuestionList
	Get Dismissed questions.

(nullable NSArray< MobileRTCQAItem * > *)	- getAnsweredQuestionList
	Get Answered questions.

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

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

(int)	- getOpenQuestionCount
	Get the amount of Open questions.

(int)	- getDismissedQuestionCount
	Get the amount of dissmissed questions.

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

(nullable MobileRTCQAItem *)	- getQuestion:
	get question item by questionID.

(nullable MobileRTCQAAnswerItem *)	- getAnswer:
	get answer item by questionID.

(BOOL)	- addQuestion:anonymous:
	Add Quesion.

(BOOL)	- answerQuestionPrivate:answerContent:
	Answer quesion in private.

(BOOL)	- answerQuestionPublic:answerContent:
	Answer Quesion.

(BOOL)	- commentQuestion:commentContent:
	Attendee comment Quesion.

(BOOL)	- dismissQuestion:
	Dismiss Quesion.

(BOOL)	- reopenQuestion:
	Reopen Quesion.

(BOOL)	- voteupQuestion:voteup:
	Vote up Quesion.

(BOOL)	- startLiving:
	startLiving Quesion.

(BOOL)	- endLiving:
	endLiving Quesion.

(BOOL)	- deleteQuestion:
	delete Quesion.

(BOOL)	- deleteAnswer:
	delete answerID.

(BOOL)	- isQALegalNoticeAvailable
	Is QA legal notice available.

(BOOL)	- isWebinarEmojiReactionAllowed
	Query if emoji reactions status.

(MobileRTCSDKError)	- allowWebinarEmojiReaction
	permitted to use emoji reactions.

(MobileRTCSDKError)	- disallowWebinarEmojiReaction
	Forbid use of emoji reactions.

(BOOL)	- isAttendeeRaiseHandAllowed
	Query if attendee raise hand status.

(MobileRTCSDKError)	- allowAttendeeRaiseHand
	The attendee is allowed to use the raise hand.

(MobileRTCSDKError)	- disallowAttendeeRaiseHand
	Do not letthe attendee to raise their hand.

(BOOL)	- isAttendeeViewTheParticipantCountAllowed
	Query if attendee to view the participant count.

(MobileRTCSDKError)	- allowAttendeeViewTheParticipantCount
	The attendee is allow to view the participant count.

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

(NSUInteger)	- getParticipantCount
	Get the participant count.

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


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

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

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

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

(BOOL)	- isPollingLegalNoticeAvailable
	is polling legal notice available.

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

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

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

id< MobileRTCCustomizedUIMeetingDelegate >	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 216 of file MobileRTCMeetingService.h.

Method Documentation

◆ activeShareUserID

- (NSUInteger) activeShareUserID

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

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

Provided by category MobileRTCMeetingService(User).

◆ activeUserID

- (NSUInteger) activeUserID

Get the ID of the active user in the meeting.

Returns: Active user ID.

Provided by category MobileRTCMeetingService(User).

◆ addBGImage:

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

add and use the image for virtual background.

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

Add someone as a interpreter.

Parameters

userID	Specify the user.
lanID1	Specify the language1.
lanID2	Specify the language2.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ addQuestion:anonymous:

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

Add Quesion.

Parameters

content	question content.
anonymous	if true anonymously.

Returns: successs or not.

Warning: Only attendee can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ addSignInterpreter:signLanId:

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

Add 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 will return MobileRTCSDKError_Success, otherwise not.

Warning: the interface for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ allowAskQuestionAnonymously:

- (BOOL) allowAskQuestionAnonymously: (BOOL) enable

Set if it is enabled to ask questions anonymously.

Parameters

Enable Enable/Disable to ask questions anonymously.

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttenddeTalk:allow:

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

Allow attendee to talk in webinar.

Parameters

userId	The ID of user to be allowed
enable	Enable/Disable to talk

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeChat:

- (BOOL) allowAttendeeChat: (MobileRTCChatAllowAttendeeChat) privilegeType

Allow attendee to chat.

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeRaiseHand

- (MobileRTCSDKError) allowAttendeeRaiseHand

The attendee is allowed to use the raise hand.

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

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

Allow attendee to submit questions.

Parameters

Enable Allow/Disallow attendee to submit question.

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeViewAllQuestion:

- (BOOL) allowAttendeeViewAllQuestion: (BOOL) enable

Allow attendee to view all question.

Parameters

Enable Enable/Disable attendee to view all questions.

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ allowAttendeeViewTheParticipantCount

- (MobileRTCSDKError) allowAttendeeViewTheParticipantCount

The attendee is allow to view the participant count.

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

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

Allow attendee to comment question.

Parameters

Enable Allow/Disallow attendee to comment question.

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ allowPanelistStartVideo:

- (BOOL) allowPanelistStartVideo: (BOOL) enable

Allow Panelist to start video in Webinar.

Parameters

enable Enable/Disable Panelist to start video.

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

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

Provided by category MobileRTCMeetingService(Webinar).

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

◆ allowParticipantsToShareWhiteBoard:

- (MobileRTCSDKError) allowParticipantsToShareWhiteBoard: (BOOL) allow

Allow participant to share white board

Parameters

allow YES: allow, NO: disallow

Returns: error MobileRTCSDKError

Provided by category MobileRTCMeetingService(InMeeting).

◆ allowParticipantsToStartVideo:

- (MobileRTCSDKError) allowParticipantsToStartVideo: (BOOL) allow

Allow participant to start video

Parameters

allow YES: allow, NO: disallow

Returns: error MobileRTCSDKError

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

permitted to use emoji reactions.

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

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

Answer quesion in private.

Parameters

questionID	question id.
content	question content.
destUserID	destination userId.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ answerQuestionPublic:answerContent:

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

Answer Quesion.

Parameters

questionID	question id.
content	question content.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ appShareWithView:

- (void) appShareWithView: (nonnull id) view

Share content with current view.

Parameters

view	- The view shared.

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

Ask to unmute audio of all attendees.

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

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

Provided by category MobileRTCMeetingService(Audio).

◆ askUserStartVideo:

- (BOOL) askUserStartVideo: (NSUInteger) userID

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

Parameters

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

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

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

Provided by category MobileRTCMeetingService(Video).

◆ assignCCPrivilege:

- (BOOL) assignCCPrivilege: (NSUInteger) userId

Assign the user privilege to send closed caption.

Parameters

userid the user id.

Returns: If the function succeeds, the return value is YES. Otherwise failed.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ assignCohost:

- (BOOL) assignCohost: (NSUInteger) userID

Assign a user as co-host in meeting.

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

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

Provided by category MobileRTCMeetingService(User).

◆ attendeeInfoByID:

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

Get attendees' information in the webinar.

Parameters

userId attendee's ID in meeting.

Returns: attendee info, a MobileRTCMeetingWebinarAttendeeInfo object.

Warning: webinar meeting host/co-host/panelist can get other attendee info.; webinar attendee can only get their own attendee info.

Provided by category MobileRTCMeetingService(User).

◆ backZoomUIMeetingFromMinimizeMeeting

- (BOOL) backZoomUIMeetingFromMinimizeMeeting

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

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: YES means the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ canAssignOthersToSendCC

- (BOOL) canAssignOthersToSendCC

Query if the current user can assign the privilege of send closed caption to others.

Returns: YES means that the user can assign others privilege to send closed caption.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ canBeAssignedToSendCC:

- (BOOL) canBeAssignedToSendCC: (NSUInteger) userId

Query if the user is can be assigned to send closed caption.

Parameters

userid the user id.

Returns: TRUE means that the user can be assigned to send closed caption.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ canBeCoHost:

- (BOOL) canBeCoHost: (NSUInteger) userID

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

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

Provided by category MobileRTCMeetingService(User).

◆ cancelCallRoomDevice

- (BOOL) cancelCallRoomDevice

Cancel to call room device.

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

Provided by category MobileRTCMeetingService(Customize).

◆ cancelDialOut:

- (BOOL) cancelDialOut: (BOOL) isCallMe

Cancel to dial out.

Parameters

isCallMe YES means Call Me; NO means inviting others by Phone.

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

Provided by category MobileRTCMeetingService(Customize).

◆ canClaimhost

- (BOOL) canClaimhost

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

Returns: YES means that the current user can claim to be a host, otherwise not.

Provided by category MobileRTCMeetingService(User).

◆ canDisableCaptions

- (BOOL) canDisableCaptions

Query if the user can disable captions.

Returns: YES means that the host can disable captions.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ canStartLiveTranscription

- (BOOL) canStartLiveTranscription

Query if meeting participants can start live transcription.

Returns: YES means that the participant can start live transcription.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ canStartRawLiveStream

- (MobileRTCSDKError) canStartRawLiveStream

Provided by category MobileRTCMeetingService(InMeeting).

◆ canStartSignInterpretation

- (BOOL) canStartSignInterpretation

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

Warning: the interface for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ canUnmuteMyAudio

- (BOOL) canUnmuteMyAudio

Query if the user can unmute his audio.

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

Provided by category MobileRTCMeetingService(Audio).

◆ canUnmuteMyVideo

- (BOOL) canUnmuteMyVideo

Query if user can unmute his video himself.

Returns: YES means able, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ changeAttendeeChatPriviledge:

- (BOOL) changeAttendeeChatPriviledge: (MobileRTCMeetingChatPriviledgeType) privilege

Set Attendee Chat Priviledge when in-meeting.

Parameters

privilege The chat privilege of the attendee

Returns: YES means sucessfull, otherwise not.

Warning: Only meeting host/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

Set to change user's screen name in meeting.

Parameters

inputName	The screen name displayed in meeting.
userId	User ID.

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

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

Provided by category MobileRTCMeetingService(User).

◆ changePanelistChatPrivilege:

- (BOOL) changePanelistChatPrivilege: (MobileRTCPanelistChatPrivilegeType) privilege

Set the chat privilege of the panelist.

Parameters

privilege The chat privilege of the panelist

Returns: YES means sucessfull, otherwise not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ claimHostWithHostKey:

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

Set to claim to be a host by host key.

Parameters

hostKey Host key.

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

Provided by category MobileRTCMeetingService(User).

◆ commentQuestion:commentContent:

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

Attendee comment Quesion.

Parameters

questionID	question id.
commentContent	comment content.

Returns: successs or not.

Warning: Only meeting attendee can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ configDSCPWithAudioValue:VideoValue:

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

Configure DSCP values for audio and video.

Parameters

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

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

Warning: The function should be invoked before meeting starts.

Provided by category MobileRTCMeetingService(InMeeting).

◆ connectMyAudio:

- (BOOL) connectMyAudio: (BOOL) on

Set whether to connect the audio in the meeting.

Parameters

on	YES means to connect, otherwise not.

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

Provided by category MobileRTCMeetingService(Audio).

◆ customizeMeetingTitle:

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

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

Parameters

title The topic/title of the meeting.

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

Provided by category MobileRTCMeetingService(Customize).

◆ deleteAnswer:

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

delete answerID.

Parameters

answerID answerID id.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ deleteChatMessage:

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

Delete chat message by message id.

Parameters

msgId the message id.

Returns: The result of delete the message.

Provided by category MobileRTCMeetingService(Chat).

◆ deleteQuestion:

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

delete Quesion.

Parameters

questionID question id.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ dePromptPanelist2Attendee:

- (BOOL) dePromptPanelist2Attendee: (NSUInteger) userID

Demote the panelist to attendee.

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ dialInCall:

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

Make a phone call to access your voice.

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

Provided by category MobileRTCMeetingService(Customize).

◆ dialOut:isCallMe:withName:

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

Start to dial out.

Parameters

phone	The phone number of destination, you should add the country code in front of the phone number, such as +86123456789.
me	YES means Call Me; NO means inviting others by Phone.
username	The name of the user to be called.

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

Provided by category MobileRTCMeetingService(Customize).

◆ disallowAttendeeRaiseHand

- (MobileRTCSDKError) disallowAttendeeRaiseHand

Do not letthe attendee to raise their hand.

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

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

Forbid the attendee to view the participant count.

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

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

Forbid use of emoji reactions.

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ dismissQuestion:

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

Dismiss Quesion.

Parameters

questionID question id.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ enableCaptions:

- (MobileRTCSDKError) enableCaptions: (BOOL) bEnable

Returns: Enable or disable captions.

Parameters

bEnable YES means that captions are enabled. NO means that captions are disabled.

Returns: If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise the function returns a calling error. For more details, see MobileRTCSDKError enum.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ enableGreenVB:

- (MobileRTCMeetError) enableGreenVB: (BOOL) enable

Enable green virtual background mode.

Parameters

enable or disable.

Returns: result of enable green virtual background.

Warning: only iPad support Virtual background GreenScreen, iPhone does not support the feature.; need call "startPreviewWithFrame:" to get the preview View, and shown in your UI hierarchy. Then select the point in preview view. We will using the color of your selected(point of the preview) to calculate the background.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ enableMeetingManualCaption:

- (BOOL) enableMeetingManualCaption: (BOOL) bEnable

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

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ enableReceiveSpokenlLanguageContent:

- (MobileRTCSDKError) enableReceiveSpokenlLanguageContent: (BOOL) enabled

Enable or disable to receive original and translated content.If enable this feature,you need start live transcription.

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

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ enableRequestLiveTranscription:

- (BOOL) enableRequestLiveTranscription: (BOOL) enable

The host enable/disable the request live transcription.

Parameters

enable YES means that enable the request live transcription; FALSE means that disable the request live transcription.

Returns: If the function succeeds, the return value is YES. Otherwise failed.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ endLiving:

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

endLiving Quesion.

Parameters

questionID question id.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ get3DAvatarImageList

- (NSArray< MobileRTC3DAvatarImageInfo * > *) get3DAvatarImageList

Get the array of the video filter images.

Returns: the array of <MobileRTC3DAvatarImageInfo*> if the call success, otherwise return nil.

Provided by category MobileRTCMeetingService(Avatar).

◆ getAdminHelper

- (MobileRTCBOAdmin *_Nullable) getAdminHelper

Object for administrator management of Breakout Room meetings defined in [MobileRTCBOAdmin].

Provided by category MobileRTCMeetingService(BO).

◆ getAllChatMessageID

- (nullable NSArray< NSString * > *) getAllChatMessageID

Get all chat message id.

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

Provided by category MobileRTCMeetingService(Chat).

◆ getAllLanguageList

- (NSArray< MobileRTCInterpretationLanguage * > *_Nullable) getAllLanguageList

Get the all interpretation language list.

Returns: If the function succeeds, the return value is a pointer to the NSArray <MobileRTCInterpretationLanguage *>, Otherwise failed, the return value is nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getALLQuestionCount

- (int) getALLQuestionCount

Get the amount of all questions.

Returns: Amount of all questions.

Provided by category MobileRTCMeetingService(Webinar).

◆ getAllQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getAllQuestionList

Get all questions.

Returns: All questions list.

Provided by category MobileRTCMeetingService(Webinar).

◆ getAllSupportedSignLanguageInfoList

- (NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable) getAllSupportedSignLanguageInfoList

Get the all supported sign interpretation language list.only for host.

Returns: If the function succeeds, the return array contain support language object.

Warning: the interface for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getAnswer:

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

get answer item by questionID.

Parameters

answerID answer id.

Returns: the answer item.

Provided by category MobileRTCMeetingService(Webinar).

◆ getAnsweredQuestionCount

- (int) getAnsweredQuestionCount

Get the amount of answered questions.

Returns: Amount of open-ended questions.

Provided by category MobileRTCMeetingService(Webinar).

◆ getAnsweredQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getAnsweredQuestionList

Get Answered questions.

Returns: Answered questions list.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ getAssistantHelper

- (MobileRTCBOAssistant *_Nullable) getAssistantHelper

Object for help assistant of Breakout Room meetings defined in [MobileRTCBOAssistant].

Provided by category MobileRTCMeetingService(BO).

◆ getAttedeeHelper

- (MobileRTCBOAttendee *_Nullable) getAttedeeHelper

Object for attendee functionality of Breakout Room meetings defined in [MobileRTCBOAttendee].

Provided by category MobileRTCMeetingService(BO).

◆ getAttendeeChatPriviledge

- (MobileRTCMeetingChatPriviledgeType) getAttendeeChatPriviledge

get Attendee Chat Priviledge when in-meeting

Returns: the result of attendee chat priviledge.

Provided by category MobileRTCMeetingService(Chat).

◆ getAttendeeViewMode

- (MobileRTCAttendeeViewMode) getAttendeeViewMode

Get the view mode of the attendee.

Returns: If the function succeeds, it will return the attendee's view mode. For more details, see}. Only for host call this api, only for zoom ui mode.

Provided by category MobileRTCMeetingService(Webinar).

◆ getAvailableLanguageList

- (NSArray< MobileRTCInterpretationLanguage * > *_Nullable) getAvailableLanguageList

Get the available interpretation language list.

Returns: If the function succeeds, the return value is a pointer to the NSArray <MobileRTCInterpretationLanguage *>, Otherwise failed, the return value is nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getAvailableMeetingSpokenLanguages

- (NSArray< MobileRTCLiveTranscriptionLanguage * > *) getAvailableMeetingSpokenLanguages

Get the list of all available spoken languages in meeting.

Returns: If the function succeeds, the return value is the list of the available spoken languages in meeting. Otherwise failed, the return value is NULL.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getAvailableSignLanguageInfoList

- (NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable) getAvailableSignLanguageInfoList

Get the available sign interpretation language list.

Returns: If the function succeeds, the return array contain available language object.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getAvailableTranslationLanguages

- (NSArray< MobileRTCLiveTranscriptionLanguage * > *) getAvailableTranslationLanguages

Get the list of all available translation languages in meeting.

Returns: If the function succeeds, the return value is the list of all available translation languages in meeting. Otherwise failed, the return value is NULL.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getBGImageList

- (NSArray< MobileRTCVirtualBGImageInfo * > *_Nonnull) getBGImageList

get the virtual background list.

Returns: Return Narray of the items which include the None item.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ getBOStatus

- (MobileRTCBOStatus) getBOStatus

Get current Breakout status.

Returns: Enum for Breakout status. [MobileRTCBOStatus]

Provided by category MobileRTCMeetingService(BO).

◆ getChatLegalNoticesExplained

- (NSString *_Nullable) getChatLegalNoticesExplained

Get explained text for chat legal notice.

Returns: explained text for chat legal notice.

Provided by category MobileRTCMeetingService(Chat).

◆ getChatLegalNoticesPrompt

- (NSString *_Nullable) getChatLegalNoticesPrompt

Get chat legal notice prompt.

Returns: chat legal notice prompt.

Provided by category MobileRTCMeetingService(Chat).

◆ getCloudRecordingStatus

- (MobileRTCRecordingStatus) getCloudRecordingStatus

Get current cloud recording.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ getCreatorHelper

- (MobileRTCBOCreator *_Nullable) getCreatorHelper

Object for creating Breakout Room meetings defined in [MobileRTCBOCreator].

Provided by category MobileRTCMeetingService(BO).

◆ getDataHelper

- (MobileRTCBOData *_Nullable) getDataHelper

Object for Breakout Room meeting id information defined in [MobileRTCBOData].

Provided by category MobileRTCMeetingService(BO).

◆ getDialInAllCountryCodes

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

Get all countrycodes.

Returns: The array of all countrycode.

Provided by category MobileRTCMeetingService(Customize).

◆ getDialInCallCodesWithCountryId:

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

Get to the countrycode specified by countryId.

Returns: The array of countrycode.

Provided by category MobileRTCMeetingService(Customize).

◆ getDialInCurrentCountryCode

- (nullable MobileRTCCallCountryCode *) getDialInCurrentCountryCode

Get countrycode for the current user's locale.

Returns: The object of MobileRTCCallCountryCode for user's locale.

Provided by category MobileRTCMeetingService(Customize).

◆ getDismissedQuestionCount

- (int) getDismissedQuestionCount

Get the amount of dissmissed questions.

Returns: Amount of open-ended questions.

Provided by category MobileRTCMeetingService(Webinar).

◆ getDismissedQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getDismissedQuestionList

Get Dismissed questions.

Returns: Dismissed questions list.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ getH323MeetingPassword

- (nullable NSString *) getH323MeetingPassword

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

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

Provided by category MobileRTCMeetingService(Customize).

◆ getInMeetingUserList

- (nullable NSArray< NSNumber * > *) getInMeetingUserList

Get all the users in the meeting.

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

Warning: For Webinar Meeting, returned list does not include Attendee User

Provided by category MobileRTCMeetingService(User).

◆ getInterpretationLanguageByID:

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

Get the interpretation language object of specified language ID.

Parameters

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

Returns: If the function succeeds, the return value is a pointer to the MobileRTCInterpretationLanguage, Otherwise failed, the return value is nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterActiveLan

- (NSInteger) getInterpreterActiveLan

Get the active language ID, if myself is a interpreter.

Returns: The Active LanguageID..

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterAvailableLanguages

- (NSArray< MobileRTCInterpretationLanguage * > *_Nullable) getInterpreterAvailableLanguages

Get the list of available languages that interpreters can hear.

Returns: If the function succeeds, the return value is a pointer to the NSArray NSArray <MobileRTCInterpretationLanguage *>, Otherwise failed, the return value is nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterLans

- (NSArray< MobileRTCInterpretationLanguage * > *_Nullable) getInterpreterLans

Get languages if myself is a interpreter.

Returns: If the function succeeds, the return value is a pointer to the NSArray NSArray <MobileRTCInterpretationLanguage *>, Otherwise failed, the return value is nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterList

- (NSArray< MobileRTCMeetingInterpreter * > *_Nullable) getInterpreterList

Get the interpreters list.

Returns: If the function succeeds, the return value is a pointer to the NSArray <MobileRTCMeetingInterpreter *>, Otherwise failed, the return value is nil.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getInterpreterListenLan

- (NSInteger) getInterpreterListenLan

Get 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

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

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

Provided by category MobileRTCMeetingService(Customize).

◆ getJoinedLanguageID

- (NSInteger) getJoinedLanguageID

Get the language ID which myself is in.

Returns: The LanguageID.

Provided by category MobileRTCMeetingService(Interpretation).

◆ getLiveStreamURL

- (nullable NSDictionary *) getLiveStreamURL

Get live stream server URL.

Returns: The dictionary of live stream URL if the function succeeds.

Warning: The function is available only for host. For Facebook Live Stream Service, "facebook" as the key in Dictionary. For Workplace by Facebook Live Stream Service, "fb_workplace" as the key in Dictionary. For YouTube Live Stream Service, "youtube" as the key in Dictionary. For Custom Live Stream Service, "custom" as the key in Dictionary.

Provided by category MobileRTCMeetingService(InMeeting).

◆ getLiveTranscriptionStatus

- (MobileRTCLiveTranscriptionStatus) getLiveTranscriptionStatus

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

◆ getMeetingPassword

- (NSString *_Nullable) getMeetingPassword

Get current meeting's password.

Returns: The current meeting's password

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMeetingSpokenLanguage

- (MobileRTCLiveTranscriptionLanguage *) getMeetingSpokenLanguage

Get the spoken language of the current user.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getMeetingState

- (MobileRTCMeetingState) getMeetingState

Get the current meeting state.

Returns: Current meeting state. MobileRTCMeetingState

◆ getMeetingType

- (MobileRTCMeetingType) getMeetingType

Get the type of current meeting.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ getMyQuestionCount

- (int) getMyQuestionCount

Get the amount of my questions.

Returns: Amount of open-ended questions.

Provided by category MobileRTCMeetingService(Webinar).

◆ getMyQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getMyQuestionList

Get My questions.

Returns: My questions list.

Warning: Only attendee can run the function.

Provided by category MobileRTCMeetingService(Webinar).

◆ getOpenQuestionCount

- (int) getOpenQuestionCount

Get the amount of Open questions.

Returns: Amount of open-ended questions.

Provided by category MobileRTCMeetingService(Webinar).

◆ getOpenQuestionList

- (nullable NSArray< MobileRTCQAItem * > *) getOpenQuestionList

Get Open questions.

Returns: Open questions list.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ getPanelistChatPrivilege

- (MobileRTCPanelistChatPrivilegeType) getPanelistChatPrivilege

Get the chat privilege of the panelist.

Returns: The chat privilege of the panelist.

Provided by category MobileRTCMeetingService(Webinar).

◆ getParticipantCount

- (NSUInteger) getParticipantCount

Get the participant count.

Returns: The count of participant.

Provided by category MobileRTCMeetingService(Webinar).

◆ getParticipantID

- (NSUInteger) getParticipantID

Get Participant ID.

Returns: The Participant ID.

Provided by category MobileRTCMeetingService(Customize).

◆ getPollAnonymousLegalNoticesExplained

- (NSString *_Nullable) getPollAnonymousLegalNoticesExplained

Get poll anonymous legal notices explained.

Returns: poll anonymous legal notices explained.

Provided by category MobileRTCMeetingService(Webinar).

◆ getPollLegalNoticesExplained

- (NSString *_Nullable) getPollLegalNoticesExplained

Get poll legal notices explained.

Returns: poll legal notices explained.

Provided by category MobileRTCMeetingService(Webinar).

◆ getPollLegalNoticesPrompt

- (NSString *_Nullable) getPollLegalNoticesPrompt

Get poll legal notices prompt.

Returns: poll legal notices prompt.

Provided by category MobileRTCMeetingService(Webinar).

◆ getQALegalNoticesExplained

- (NSString *_Nullable) getQALegalNoticesExplained

Get QA legal notices explained.

Returns: QA legal notices explained.

Provided by category MobileRTCMeetingService(Webinar).

◆ getQALegalNoticesPrompt

- (NSString *_Nullable) getQALegalNoticesPrompt

Get QA legal notices prompt.

Returns: QA legal notices prompt.

Provided by category MobileRTCMeetingService(Webinar).

◆ getQuestion:

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

get question item by questionID.

Parameters

questionID question id.

Returns: the question item.

Provided by category MobileRTCMeetingService(Webinar).

◆ getRawLiveStreamingInfoList

- (NSArray< MobileRTCRawLiveStreamInfo * > *_Nullable) getRawLiveStreamingInfoList

Provided by category MobileRTCMeetingService(InMeeting).

◆ getRawLiveStreamPrivilegeUserList

- (NSArray< NSNumber * > *_Nullable) getRawLiveStreamPrivilegeUserList

Provided by category MobileRTCMeetingService(InMeeting).

◆ getRoomDeviceList

- (nullable NSArray< MobileRTCRoomDevice * > *) getRoomDeviceList

Get room devices that can be called.

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

Provided by category MobileRTCMeetingService(Customize).

◆ getShareMeetingChatStartedLegalNoticeContent

- (NSString *_Nullable) getShareMeetingChatStartedLegalNoticeContent

Get start share meeting chat legal notice content.

Returns: start share chat legal notice content.

Provided by category MobileRTCMeetingService(Chat).

◆ getShareMeetingChatStoppedLegalNoticeContent

- (NSString *_Nullable) getShareMeetingChatStoppedLegalNoticeContent

Get stop share meeting chat legal notice content.

Returns: stop share chat legal notice content.

Provided by category MobileRTCMeetingService(Chat).

◆ getSignInterpretationLanguageInfoByID:

- (MobileRTCSignInterpreterLanguage *_Nullable) getSignInterpretationLanguageInfoByID: (NSString *_Nullable) signLanguageID

Get the sign interpretation language object of specified sign language ID.

Parameters

signLanguageID Specify the sign language ID for which you want to get the information.

Returns: If the function succeeds, the return value is MobileRTCSignInterpreterLanguage object.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getSignInterpretationStatus

- (MobileRTCSignInterpretationStatus) getSignInterpretationStatus

Get sign interpretation status of current meeting.

Returns: If the function succeeds, the return value is the sign interpretation status of current meeting.For more details, see MobileRTCSignInterpretationStatus.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getSignInterpreterAssignedLanID

- (NSString *_Nullable) getSignInterpreterAssignedLanID

Get sign language id if myself is a sign interpreter.only for interpreter.

Returns: If the function succeeds, the return value is the current assigned sign language id, otherwise not.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getSignInterpreterList

- (NSArray< MobileRTCSignInterpreter * > *_Nullable) getSignInterpreterList

Get the sign interpreters list.

Returns: If the function succeeds, the return array contain sign interpreter object.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ getSpotLightedVideoUserList

- (NSArray< NSNumber * > *_Nullable) getSpotLightedVideoUserList

get spotlight user list.

Returns: userId array.

Provided by category MobileRTCMeetingService(Video).

◆ getSupportedMeetingAudioType

- (int) getSupportedMeetingAudioType

Get the audio type supported by the current meeting. See [MobileRTCInMeetingSupportAudioType].

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

◆ getTranslationLanguage

- (MobileRTCLiveTranscriptionLanguage *) getTranslationLanguage

Get the translation language of the current user.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ getUserVideoSize:

- (CGSize) getUserVideoSize: (NSUInteger) userID

Get the size of user's video.

Parameters

userID The ID of user in the meeting

Returns: The size of user's video.

Provided by category MobileRTCMeetingService(Video).

◆ getVideoOrderList

- (NSArray< NSNumber * > *_Nullable) getVideoOrderList

get follow host video order array currently.

Returns: userId array.

Provided by category MobileRTCMeetingService(Video).

◆ getWebinarAttendeeChatPrivilege

- (MobileRTCChatAllowAttendeeChat) getWebinarAttendeeChatPrivilege

get webinar attendee chat privilege type.

Returns: The chat privilege type for the webinar attendee.

Provided by category MobileRTCMeetingService(Webinar).

◆ getWebinarAttendeeList

- (nullable NSArray< NSNumber * > *) getWebinarAttendeeList

Get all the attendees in the webinar.

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

Warning: Only webinar meeting host/co-host/panelist can run the function.

Provided by category MobileRTCMeetingService(User).

◆ getWebinarRegistrationLegalNoticesExplained

- (MobileRTCWebinarRegistLegalNoticeContent *_Nullable) getWebinarRegistrationLegalNoticesExplained

Get annotation over share legal notices explained.

Returns: annotation over share legal notices explained.

◆ getWebinarRegistrationLegalNoticesPrompt

- (NSString *_Nullable) getWebinarRegistrationLegalNoticesPrompt

Get annotation over share legal notices prompt.

Returns: annotation over share legal notices prompt.

◆ getWhiteboardLegalNoticesExplained

- (NSString *_Nullable) getWhiteboardLegalNoticesExplained

Get whiteboard legal notices detailed description.

Returns: Whiteboard legal notices detailed description.

Provided by category MobileRTCMeetingService(AppShare).

◆ getWhiteboardLegalNoticesPrompt

- (NSString *_Nullable) getWhiteboardLegalNoticesPrompt

Get whiteboard legal notices message.

Returns: The whiteboard legal notices message as a string.

Provided by category MobileRTCMeetingService(AppShare).

◆ handZoomWebUrl:

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

Start or join a Zoom meeting with zoom web URL.

Parameters

meetingUrl Zoom web meeting URL.

Returns: The state of the meeting: started or failed.

◆ hasPromptAndDePromptPrivilige

- (BOOL) hasPromptAndDePromptPrivilige

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ hasRawLiveStreamPrivilege:

- (BOOL) hasRawLiveStreamPrivilege: (NSUInteger) userID

Determine whether the user has raw live stream privilege.

Returns: YES indicates that the specified user has raw live stream privilege, otherwise false NO.

Provided by category MobileRTCMeetingService(User).

◆ hideAANPanel

- (MobileRTCANNError) hideAANPanel

hide app signaling pannel.

Returns: MobileRTCANNError_Success means the operation succeed, otherwise not

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ hideMobileRTCMeeting:

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

Set to hide the UI of meeting.

Parameters

completion User can do other operations once the meeting UI hide.

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

Warning: The method does not work if you have set mobileRTCRootController via [MobileRTC setMobileRTCRootController]

Provided by category MobileRTCMeetingService(InMeeting).

◆ is3DAvatarEnabled

- (BOOL) is3DAvatarEnabled

Determine if the 3D avatar feature is enabled.

Returns: Yes indicates the video filter feature is enabled.

Provided by category MobileRTCMeetingService(Avatar).

◆ is3DAvatarSupportedByDevice

- (BOOL) is3DAvatarSupportedByDevice

Determine if the 3D avatar feature is supported by video device.

Returns: Yes indicates that the video device supports the 3D avatar feature.

Provided by category MobileRTCMeetingService(Avatar).

◆ isAllowAskQuestionAnonymously

- (BOOL) isAllowAskQuestionAnonymously

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

Returns: YES means allowed, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowAttendeeTalk:

- (BOOL) isAllowAttendeeTalk: (NSUInteger) userID

Query if attendee is allowed to talk in Webinar Meeting.

Parameters

userId The ID of user to be allowed.

Returns: YES means allowed, otherwise not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowAttendeeUpVoteQuestion

- (BOOL) isAllowAttendeeUpVoteQuestion

Query if attendee is allowed to submit questions.

Returns: YES means allowed, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowAttendeeViewAllQuestion

- (BOOL) isAllowAttendeeViewAllQuestion

Query if attendee is allowed to view all question.

Returns: YES means allowed, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowCommentQuestion

- (BOOL) isAllowCommentQuestion

Query if attendee is allowed to comment questions.

Returns: YES means allowed, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowPanelistStartVideo

- (BOOL) isAllowPanelistStartVideo

Query if Panelist can start video in Webinar Meeting.

Returns: YES means able, otherwise not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAllowSignLanuageInterpreterToTalk:

- (BOOL) isAllowSignLanuageInterpreterToTalk: (NSUInteger) userID

Determine if the sign language interpreter be allowed to talk.

Parameters

userID The unique identity of the user.

Returns: YES indicates to allow to talk, otherwise not.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ isAnnotationOff

- (BOOL) isAnnotationOff

Notify the current user if annotation is enabled.

Returns: YES if enabled, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ isAttendeeRaiseHandAllowed

- (BOOL) isAttendeeRaiseHandAllowed

Query if attendee raise hand status.

Returns: webinar attendee allow to reaise hand or not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isAttendeeViewTheParticipantCountAllowed

- (BOOL) isAttendeeViewTheParticipantCountAllowed

Query if attendee to view the participant count.

Returns: If it allow, the return value is YES, otherwise NO.

Provided by category MobileRTCMeetingService(Webinar).

◆ isBackCamera

- (BOOL) isBackCamera

Query if user is using back camera.

Returns: YES means using Back camera, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isBOMeetingEnabled

- (BOOL) isBOMeetingEnabled

Is Breakout Room feature enabled in meeting.

Provided by category MobileRTCMeetingService(BO).

◆ isBOMeetingStarted

- (BOOL) isBOMeetingStarted

Has Breakout Room meeting began.

Provided by category MobileRTCMeetingService(BO).

◆ isCallingRoomDevice

- (BOOL) isCallingRoomDevice

Query if it is in process to call room device.

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

Provided by category MobileRTCMeetingService(Customize).

◆ isCallRoomDeviceSupported

- (BOOL) isCallRoomDeviceSupported

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

Returns: YES means able, otherwise not.

Provided by category MobileRTCMeetingService(Customize).

◆ isCaptionsEnabled

- (BOOL) isCaptionsEnabled

Query if the captions enabled.

Returns: YES means that captions are enabled.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isChatDisabled

- (BOOL) isChatDisabled

Query if the chat is disabled in the meeting.

Returns: YES means disabled, otherwise not.

Provided by category MobileRTCMeetingService(Chat).

◆ isChatMessageCanBeDeleted:

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

Determine whether the message can be delete.

Parameters

msgId the message id.

Returns: The result of the message can be deleted.

Provided by category MobileRTCMeetingService(Chat).

◆ isCMREnabled

- (BOOL) isCMREnabled

Notify if the cloud recording is enabled.

Returns: YES means enabled, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isCMRInProgress

- (BOOL) isCMRInProgress

Notify if the cloud recording is in progress.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isCMRPaused

- (BOOL) isCMRPaused

Notify if the cloud recording is paused.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isDeviceSharing

- (BOOL) isDeviceSharing

Get state of device screen sharing.

Returns: YES if device is currently screen sharing.

Warning: When the onSinkMeetingActiveShare callback return. developer nned to judge that share screen state.

Provided by category MobileRTCMeetingService(AppShare).

◆ isDialOutInProgress

- (BOOL) isDialOutInProgress

Query if there is any outgoing call in process.

Returns: YES means that there is outgoing call in process.

Provided by category MobileRTCMeetingService(Customize).

◆ isDialOutSupported

- (BOOL) isDialOutSupported

Query if user can dial out in the meeting.

Returns: YES means able, No disable.

Provided by category MobileRTCMeetingService(Customize).

◆ isDirectAppShareMeeting

- (BOOL) isDirectAppShareMeeting

Query if the current meeting was started with App Share.

Returns: YES means that meeting was started by App Share, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ isEmojiReactionEnabled

- (BOOL) isEmojiReactionEnabled

Determine if the Reaction feature is enabled.

Returns: YES means Reaction feature is enabled, otherwise not.

Provided by category MobileRTCMeetingService(Reaction).

◆ isFailoverMeeting

- (BOOL) isFailoverMeeting

Query if the meeting is failover.

Returns: YES means failover, otherwise not.

Warning: The method is optional.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isFollowHostVideoOrderOn

- (BOOL) isFollowHostVideoOrderOn

Qurry if follow host video order or not currently.

Returns: Yes means follow, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isH323User:

- (BOOL) isH323User: (NSUInteger) userID

Query if the user join meeting from H323.

Parameters

userID The ID of user.

Returns: TRUE means user join meeting from H323. FALSE not.

Provided by category MobileRTCMeetingService(User).

◆ isHostUser:

- (BOOL) isHostUser: (NSUInteger) userID

Query if the user is host.

Parameters

userID The ID of user.

Returns: YES means that the user is the host, otherwise not.

Provided by category MobileRTCMeetingService(User).

◆ isInBOMeeting

- (BOOL) isInBOMeeting

Is currently in Breakout Room during meeting.

Provided by category MobileRTCMeetingService(BO).

◆ isIncomingAudioStopped

- (BOOL) isIncomingAudioStopped

Determine if the incoming audio is stopped.

Returns: YES indicates that the incoming audio is stopped.

Provided by category MobileRTCMeetingService(Audio).

◆ isIncomingVideoStoped

- (BOOL) isIncomingVideoStoped

Determine if the incoming video is stopped.

Returns: YES indicates to the incoming video is stopped.

Provided by category MobileRTCMeetingService(Video).

◆ isInterpretationEnabled

- (BOOL) isInterpretationEnabled

Determine if interpretation feature is enabled in the meeting.

Provided by category MobileRTCMeetingService(Interpretation).

◆ isInterpretationStarted

- (BOOL) isInterpretationStarted

Determine if interpretation has been started by host.

Provided by category MobileRTCMeetingService(Interpretation).

◆ isInterpreter

- (BOOL) isInterpreter

Determine if myself is interpreter.

Provided by category MobileRTCMeetingService(Interpretation).

◆ isLiveTranscriptionFeatureEnabled

- (BOOL) isLiveTranscriptionFeatureEnabled

Query if this meeting support the live transcription feature.

Returns: YES means that the live transcription feature is supported.

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

Determine if the major audio is off.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ isMeetingChatLegalNoticeAvailable

- (BOOL) isMeetingChatLegalNoticeAvailable

Is meeting chat legal notice available.

Returns: available or not.

Provided by category MobileRTCMeetingService(Chat).

◆ isMeetingCoHost

- (BOOL) isMeetingCoHost

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

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingHost

- (BOOL) isMeetingHost

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

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingLocked

- (BOOL) isMeetingLocked

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

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isMeetingManualCaptionEnabled

- (BOOL) isMeetingManualCaptionEnabled

Determine whether it is enabled to manual input CC for meeting.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isMeetingSupportCC

- (BOOL) isMeetingSupportCC

Query if the current meeting is supported closed caption.

Returns: YES means that the current meeting is supported close caption.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isMultiLanguageTranscriptionEnabled

- (BOOL) isMultiLanguageTranscriptionEnabled

Determine whether the multi language transcription feature is enabled.

Returns: returns YES if multi-language transcription enabled. Otherwise failed.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isMuteOnEntryOn

- (BOOL) isMuteOnEntryOn

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

Returns: YES means enabled, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isMyAudioMuted

- (BOOL) isMyAudioMuted

Query if the audio of the current user is muted.

Returns: YES means muted, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isMyself:

- (BOOL) isMyself: (NSUInteger) userID

Query if the ID is the current user's.

Parameters

userID The ID of user to be checked.

Returns: TRUE means user himself. FALSE not.

Provided by category MobileRTCMeetingService(User).

◆ isParticipantsRenameAllowed

- (BOOL) isParticipantsRenameAllowed

Query if the meeting is allow participants to rename themselves.

Warning: Only in-meeting can call the function.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isParticipantsShareWhiteBoardAllowed

- (BOOL) isParticipantsShareWhiteBoardAllowed

Query is allow participant to share white board

Returns: YES: allow, NO: disallow

Provided by category MobileRTCMeetingService(InMeeting).

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

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

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

Returns: YES means enabled, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isPollingLegalNoticeAvailable

- (BOOL) isPollingLegalNoticeAvailable

is polling legal notice available.

Returns: available or not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isPrivateChatDisabled

- (BOOL) isPrivateChatDisabled

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

Returns: YES means disabled, otherwise not.

Provided by category MobileRTCMeetingService(Chat).

◆ isQAEnabled

- (BOOL) isQAEnabled

Query if Q&A is enabled.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isQALegalNoticeAvailable

- (BOOL) isQALegalNoticeAvailable

Is QA legal notice available.

Returns: available or not.

Provided by category MobileRTCMeetingService(Webinar).

◆ isRawLiveStreaming:

- (BOOL) isRawLiveStreaming: (NSUInteger) userID

Determine whether the user has started a live stream.

Returns: YES indicates that the specified user has started a raw live stream, otherwise NO.

Provided by category MobileRTCMeetingService(User).

◆ isRawLiveStreamSupported

- (BOOL) isRawLiveStreamSupported

Provided by category MobileRTCMeetingService(InMeeting).

◆ isReceiveSpokenLanguageContentEnabled

- (BOOL) isReceiveSpokenLanguageContentEnabled

Determine whether receive original and translated is available.

Returns: True indicates receive original and translated is available. Otherwise False.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isRequestToStartLiveTranscriptionEnabled

- (BOOL) isRequestToStartLiveTranscriptionEnabled

Query if it is enabled to request to start live transcription.

Returns: YES means that it is enabled to request to start live transcription.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isSameUser:compareTo:

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

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

Parameters

user1	One user ID in meeting
user2	Another user ID in meeting

Returns: YES means the same user.

Provided by category MobileRTCMeetingService(User).

◆ isSendingMyVideo

- (BOOL) isSendingMyVideo

Query if the user is sending video.

Returns: YES means sending, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isSharedAudio

- (BOOL) isSharedAudio

Get state of device audio sharing.

Returns: YES if device is currently audio sharing.

Provided by category MobileRTCMeetingService(AppShare).

◆ isShareLocked

- (BOOL) isShareLocked

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

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ isShareMeetingChatLegalNoticeAvailable

- (BOOL) isShareMeetingChatLegalNoticeAvailable

Is share meeting chat legal notice available.

Returns: available or not.

Warning: need call in meeting.

Provided by category MobileRTCMeetingService(Chat).

◆ isShowAvatar

- (BOOL) isShowAvatar

Determine if the meeting is showing the avatar.

Returns: YES indicates the meeting is showing the avatar.

Provided by category MobileRTCMeetingService(Avatar).

◆ isSignInterpretationEnabled

- (BOOL) isSignInterpretationEnabled

Determine if the sign interpretation function is enabled.

Returns: YES means sign interpretation function is enable,otherwise not.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ isSignInterpreter

- (BOOL) isSignInterpreter

Determine if self is sign interpreter.

Returns: YES means self is sign interpreter,otherwise not.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ isStartingShare

- (BOOL) isStartingShare

Notify the current user if sharing has started.

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

Provided by category MobileRTCMeetingService(AppShare).

◆ isStopIncomingVideoSupported

- (BOOL) isStopIncomingVideoSupported

Determine if the incoming video is supported.

Returns: YES indicates to the incoming video is supported.

Provided by category MobileRTCMeetingService(Video).

◆ isSupportedVOIP

- (BOOL) isSupportedVOIP

Query if the meeting supports VoIP.

Returns: YES means supported, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isSupportFollowHostVideoOrder

- (BOOL) isSupportFollowHostVideoOrder

Qurry if the account support follow host video order feature or not.

Returns: Yes means support, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isSupportSmartVirtualBG

- (BOOL) isSupportSmartVirtualBG

is Support smart virtual background.

Returns: YES mean support, you can use it.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ isSupportVirtualBG

- (BOOL) isSupportVirtualBG

is support virtual background.

Returns: YES mean support, you can use it.

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

◆ isTextLiveTranslationEnabled

- (BOOL) isTextLiveTranslationEnabled

Determine whether the translated captions feature is enabled.

Returns: YES means enabled, otherwise not.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ isUserAudioMuted:

- (BOOL) isUserAudioMuted: (NSUInteger) userID

Query if the user's audio is muted.

Parameters

userID The ID of user to be checked.

Returns: YES means muted, otherwise not.

Provided by category MobileRTCMeetingService(Audio).

◆ isUserPinned:

- (BOOL) isUserPinned: (NSUInteger) userId

Query if the user's video is pinned.

Parameters

userId The ID of user whose video will be pinned in the meeting.

Returns: YES means that the user's video is pinned, otherwise not.

Warning: The function is only for Zoom UI.

Provided by category MobileRTCMeetingService(Video).

◆ isUserSpotlighted:

- (BOOL) isUserSpotlighted: (NSUInteger) userId

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

Parameters

userId The ID of user in meeting.

Returns: YES means spotlighted, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isUserVideoSending:

- (BOOL) isUserVideoSending: (NSUInteger) userID

Query if user's video is being sent.

Parameters

userID The ID of user whose video will be sent in meeting

Returns: YES means that the video is being sent, otherwise not.

Provided by category MobileRTCMeetingService(Video).

◆ isUsingGreenVB

- (BOOL) isUsingGreenVB

is using green virtual background.

Returns: Return yes if using green virtual background.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ isViewingShare

- (BOOL) isViewingShare

Notify the current user if they are currently viewing an App Share.

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

Provided by category MobileRTCMeetingService(AppShare).

◆ isWebinarAttendee

- (BOOL) isWebinarAttendee

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

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

Warning: only for webinar meeting.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isWebinarEmojiReactionAllowed

- (BOOL) isWebinarEmojiReactionAllowed

Query if emoji reactions status.

Returns: webinar emoji reaction be allowed or not

Provided by category MobileRTCMeetingService(Webinar).

◆ isWebinarMeeting

- (BOOL) isWebinarMeeting

Query if the meeting is Webinar.

Returns: YES means Webinar, otherwise not.

Warning: It will return NO as MobileRTCMeetingState is not equal to MobileRTCMeetingState_InMeeting.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isWebinarPanelist

- (BOOL) isWebinarPanelist

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

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

Warning: only for webinar meeting.

Provided by category MobileRTCMeetingService(InMeeting).

◆ isWhiteboardLegalNoticeAvailable

- (BOOL) isWhiteboardLegalNoticeAvailable

Is whiteboard legal notice available.

Returns: YES if notice is available, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ joinLanguageChannel:

- (BOOL) joinLanguageChannel: (NSInteger) lanID

Join some language channel.

Parameters

lanID Specify the language channel.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ joinMeetingWithJoinParam:

- (MobileRTCMeetError) joinMeetingWithJoinParam: (nonnull MobileRTCMeetingJoinParam *) param

Join 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

Join some sign language channel if myself is not a sign interpreter.only for non-interpreter.

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

Warning: the inferface only for ZOOM UI

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ leaveMeetingWithCmd:

- (void) leaveMeetingWithCmd: (LeaveMeetingCmd) cmd

End or leave the current meeting.

Parameters

cmd	The command for leaving the current meeting. Only a host can end the meeting. `LeaveMeetingCmd`

◆ leaveSignLanguageChannel

- (MobileRTCSDKError) leaveSignLanguageChannel

Leave current sign language channel if myself is not a sign interpreter.only for non-interpreter.

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

Warning: the inferface only for ZOOM UI

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ lockMeeting:

- (BOOL) lockMeeting: (BOOL) lock

Set to lock the meeting.

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

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ lockShare:

- (BOOL) lockShare: (BOOL) lock

Set to lock the share.

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

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ lowerAllHand:

- (BOOL) lowerAllHand: (BOOL) isWebinarAttendee

Set to put all users' hands down.

Parameters

isWebinarAttendee YES indicates to lower all hands for webinar attendee.

Returns: YES means that the method is called successfully, otherwise not. @warning Only meeting host/cohost can run the function when in meeting.

Provided by category MobileRTCMeetingService(User).

◆ lowerHand:

- (BOOL) lowerHand: (NSUInteger) userId

Put hands down of the current user.

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

Warning: Only meeting host/cohost can run the function when in meeting.

Provided by category MobileRTCMeetingService(User).

◆ makeHost:

- (BOOL) makeHost: (NSUInteger) userId

Assign a user as the host in meeting.

Parameters

userId The ID of user who is specified as host in meeting.

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

Warning: only meeting host can run this function, and userId should not be myself.

Provided by category MobileRTCMeetingService(User).

◆ meetingChatByID:

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

Get in-meeting chat message.

Parameters

messageID The ID of the message sent in the meeting.

Returns: The instance of in-meeting chat.

Warning: The method is optional.

Provided by category MobileRTCMeetingService(Chat).

◆ meetingView

- (UIView *_Nullable) meetingView

This method will return the view of meeting UI, which enables customers to add their own view in the meeting UI.

Returns: The view of the current meeting. If there is no ongoing meeting, it will return nil.

Warning: Only valid in non-custom UI (only valid in Zoom meeting UI).

◆ modifyInterpreter:lan1:andLan2:

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

modify the language of some interpreter.

Parameters

userID	Specify the interpreter.
lanID1	Specify the new language1.
lanID2	Specify the new language2.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ modifySignInterpreter:signLanId:

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

Modify the language of some sign interpreter.

Parameters

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

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

Warning: the interface for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ muteAllUserAudio:

- (BOOL) muteAllUserAudio: (BOOL) allowSelfUnmute

Set to mute audio of all attendees.

Parameters

allowSelfUnmute YES means that attendee can unmute the audio himself, otherwise not.

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

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

Provided by category MobileRTCMeetingService(Audio).

◆ muteMyAudio:

- (MobileRTCAudioError) muteMyAudio: (BOOL) mute

Set to mute the audio of the current user.

Parameters

mute	YES means the audio is muted, otherwise not.

Returns: The result of operation, muted or not.

Provided by category MobileRTCMeetingService(Audio).

◆ muteMyVideo:

- (MobileRTCSDKError) muteMyVideo: (BOOL) mute

Set to mute video of the current user.

Parameters

mute	YES means to mute video of the current user, otherwise not.

Returns: The result of operation.

Provided by category MobileRTCMeetingService(Video).

◆ muteOnEntry:

- (BOOL) muteOnEntry: (BOOL) on

Set if attendees join the meeting with audio muted.

Returns: YES means muted, otherwise not.

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

Provided by category MobileRTCMeetingService(Audio).

◆ muteUserAudio:withUID:

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

Set whether to mute user's audio.

Parameters

mute	YES means to mute, otherwise not.
userID	The ID of user.

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

Warning: Only meeting host can run the function.

Provided by category MobileRTCMeetingService(Audio).

◆ myAudioOutputDescription

- (MobileRTCAudioOutput) myAudioOutputDescription

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

Returns: The descriptions of audio output types.

Provided by category MobileRTCMeetingService(Audio).

◆ myAudioType

- (MobileRTCAudioType) myAudioType

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

Returns: The audio type.

Provided by category MobileRTCMeetingService(Audio).

◆ myselfUserID

- (NSUInteger) myselfUserID

Get the ID of the current user in the meeting.

Returns: The ID of the current user.

Provided by category MobileRTCMeetingService(User).

◆ pinVideo:withUser:

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

Set whether to pin user's video or not.

Parameters

on	YES means to pin user's video, otherwise not.
userId	The ID of user whose video will be pinned.

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

Warning: The function is only for Zoom UI.

Provided by category MobileRTCMeetingService(Video).

◆ playChime:

- (BOOL) playChime: (BOOL) on

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

Returns: YES means enabled, otherwise not.

Warning: Only meeting host/cohost can run the function when in meeting.

Provided by category MobileRTCMeetingService(Audio).

◆ presentMeetingChatViewController:userId:

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

Set to present Zoom original Meeting Chat ViewController.

Parameters

parentVC	which use to present ViewController.
userId	userId of the user you would like to chat.

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

Warning: If userId = 0 or nil, it will send to everyone.

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: YES means that the method is called successfully, otherwise not.

Provided by category MobileRTCMeetingService(InMeeting).

◆ presentQAViewController:

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

Set to present Zoom original Q&A ViewController.

Parameters

parentVC which use to present ViewController

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ promptAttendee2Panelist:

- (BOOL) promptAttendee2Panelist: (NSUInteger) userID

Prompt Attendee to Panelist in Webinar.

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

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

Provided by category MobileRTCMeetingService(Webinar).

◆ queryNetworkQuality:withDataFlow:

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

Check in-meeting network status.

Parameters

type	Meeting component types, now we can only query three components network status: MobileRTCComponentType_AUDIO, MobileRTCComponentType_VIDEO and MobileRTCComponentType_AS
sending,if	YES means that query sending data; if NO means that query receiving data

Returns: the level of network quality.

Warning: The method is optional, you can query the network quality of audio, video and sharing.

Provided by category MobileRTCMeetingService(InMeeting).

◆ raiseMyHand

- (BOOL) raiseMyHand

Raise hand of the current user.

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

Provided by category MobileRTCMeetingService(User).

◆ reclaimHost

- (BOOL) reclaimHost

Reclaim the role of the host.

Returns: YES means that the current user can claim to be a host, otherwise not.

Provided by category MobileRTCMeetingService(User).

◆ removeBGImage:

- (MobileRTCMeetError) removeBGImage: (MobileRTCVirtualBGImageInfo *_Nonnull) bgImageInfo

Remove image item form image list.

Will use the previous one for virtual background.

Returns: Remove result.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ removeInterpreter:

- (BOOL) removeInterpreter: (NSUInteger) userID

Remove some interpreter.

Parameters

userID Specify the interpreter.

Returns: The result of the function.

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, the return value is SDKErr_Success. Otherwise it fails. To get extended error information, see [MobileRTCSDKError] enum.

Provided by category MobileRTCMeetingService(InMeeting).

◆ removeSignInterpreter:

- (MobileRTCSDKError) removeSignInterpreter: (NSUInteger) userID

Remove interpreter.

Parameters

userID The unique identity of the user.

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

Warning: the interface for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ removeUser:

- (BOOL) removeUser: (NSUInteger) userId

Remove a user from the meeting.

Parameters

userId The ID of user to be removed from the meeting.

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

Warning: The method is available only for the host/co-host, and the host/co-host can not remove himself.

Provided by category MobileRTCMeetingService(User).

◆ reopenQuestion:

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

Reopen Quesion.

Parameters

questionID question id.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ requestRawLiveStream:

- (MobileRTCSDKError) requestRawLiveStream: (nonnull NSString *) broadcastURL

Provided by category MobileRTCMeetingService(InMeeting).

◆ requestSignLanuageInterpreterToTalk:allowToTalk:

- (MobileRTCSDKError) requestSignLanuageInterpreterToTalk:	(NSUInteger)	userID
allowToTalk:	(BOOL)	allowToTalk

Host allow sign language interpreter to talk.

Parameters

userID	The unique identity of the user.
allowToTalk	YES indicates to allow to talk, otherwise not.

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

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ requestToStartLiveTranscription:

- (BOOL) requestToStartLiveTranscription: (BOOL) requestAnonymous

Request the host to start live transcription.

Parameters

requestAnonymous TRUE means that it is anonymous to request the host to start live transcription.

Returns: If the function succeeds, the return value is YES. Otherwise failed.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ resetMeetingAudioForCallKitHeld

- (void) resetMeetingAudioForCallKitHeld

Reset Meeting Audio Session including Category and Mode. When the call comes in or goes out, click hold or swap in the dial-up UI to restore the zoom sound.

Provided by category MobileRTCMeetingService(Audio).

◆ resetMeetingAudioSession

- (void) resetMeetingAudioSession

Reset Meeting Audio Session including Category and Mode.

Provided by category MobileRTCMeetingService(Audio).

◆ resumePauseCMR

- (BOOL) resumePauseCMR

Set to pause/resume cloud recording in the meeting.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ revokeCoHost:

- (BOOL) revokeCoHost: (NSUInteger) userID

Revoke co-host role of another user in meeting.

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

Warning: Only meeting host can run the function.

Provided by category MobileRTCMeetingService(User).

◆ rotateMyVideo:

- (BOOL) rotateMyVideo: (UIDeviceOrientation) rotation

Rotate my video.

Returns: the result of it.

Provided by category MobileRTCMeetingService(Video).

◆ selectGreenVBPoint:

- (MobileRTCMeetError) selectGreenVBPoint: (CGPoint) point

Select the point that regard as background.

Parameters

point point in preview view.

Returns: result of set background point action.

Warning: only iPad support Virtual background GreenScreen, iPhone does not support the feature.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ sendChatToGroup:WithContent:

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

Send message to group in the meeting.

Parameters

group	Group type in the meeting, see MobileRTCChatGroup.
content	The message to be sent.

Returns: The result of sending the message.

Provided by category MobileRTCMeetingService(Chat).

◆ sendChatToUser:WithContent:

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

Send chat message to the specified user in the meeting.

Parameters

userID	The ID of user who receives message in the meeting.
content	The message to be sent.

Returns: The result of sending the message.

Provided by category MobileRTCMeetingService(Chat).

◆ sendEmojiReaction:

- (MobileRTCMeetError) sendEmojiReaction: (MobileRTCEmojiReactionType) type

Send emoji reaction.

Parameters

type	- The type of the emoji reaction.

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

Warning: MobileRTCEmojiReactionSkinTone doesn't work for MobileRTCEmojiReactionType_Heart type. To set MobileRTCEmojiReactionSkinTone, use -[MobileRTCMeetingSettings setReactionSkinTone] in MobileRTCMeetingSettings.h file

Provided by category MobileRTCMeetingService(Reaction).

◆ sendEmojiReaction:reactionSkinTone:

- (MobileRTCMeetError) sendEmojiReaction:	(MobileRTCEmojiReactionType)	type
reactionSkinTone:	(MobileRTCEmojiReactionSkinTone)	skinTone

Send emoji reaction.

Parameters

type	- The type of the emoji reaction.
skinTone	- The skintone of the emoji reaction

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

Deprecated:: replace with sendEmojiReaction:

Provided by category MobileRTCMeetingService(Reaction).

◆ sendPairingCode:WithMeetingNumber:

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

Get the pairing code when the room device call in.

Parameters

code	The pairing code which enable the device connect to the meeting.
meetingNumber	The number of meeting.

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

Warning: App can invite Room System while App is in Meeting or in pre-Meeting.

Provided by category MobileRTCMeetingService(Customize).

◆ set3DAvatarImage:

- (MobileRTCSDKError) set3DAvatarImage: (MobileRTC3DAvatarImageInfo *) imageInfo

Specify an image to be the video filter image.

Parameters

imageInfo Specify the image to use.

Returns: success of errors of this function call.

Warning: Will close the 3D avatar when the imageInfo.index is -1.

Provided by category MobileRTCMeetingService(Avatar).

◆ setAttendeeViewMode:

- (MobileRTCSDKError) setAttendeeViewMode: (MobileRTCAttendeeViewMode) mode

Set the view mode of the attendee.

Parameters

mode	The view mode of the attendee.

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

Warning: Only for host call this api, only for zoom ui mode.

Provided by category MobileRTCMeetingService(Webinar).

◆ setCloudWhiteboardFeedbackUrl:

- (BOOL) setCloudWhiteboardFeedbackUrl: (nullable NSString *) feedbackUrl

Allowing the developer to customize the URL of cloud whiteboard feedback.

Parameters

feedbackUrl customized URL.

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

Provided by category MobileRTCMeetingService(Customize).

◆ setCustomizedInvitationDomain:

- (BOOL) setCustomizedInvitationDomain: (NSString *_Nonnull) invitationDomain

Set the customized invitation domain.

Parameters

invitationDomain Specify the customized invitation domain. For example, https://example.com.

Returns: YES means success, otherwise it's not successful.

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

Allowing the developer to customize the URL of create/edit the polling.

Parameters

pollingURL	customized URL.
bCreate	When bCreate is true, it changes the URL of creating a polling. Otherwise, it changes the URL of editing a polling.

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

Provided by category MobileRTCMeetingService(Customize).

◆ setInterpreterActiveLan:

- (BOOL) setInterpreterActiveLan: (NSInteger) activeLanID

Set a language channel which myself will be in, if myself is a interpreter.

Parameters

activeLanID Specify the active language.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ setInterpreterListenLan:

- (BOOL) setInterpreterListenLan: (NSInteger) lanID

Set a language that I can hear as an interpreter.

Parameters

lanID Specify the selected language that I can hear as an interpreter.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ setMeetingSpokenLanguage:

- (BOOL) setMeetingSpokenLanguage: (NSInteger) languageID

set spoken language of the current user.

Parameters

languageID the speak language id.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ setMeetingTopic:

- (BOOL) setMeetingTopic: (NSString *_Nonnull) meetingTopic

Set to customize the meeting topic which will be displayed in the meeting info view.

Parameters

topic The topic of the meeting.

Warning: only meeting original host can call the function.; only in-meeting can call the function.

Provided by category MobileRTCMeetingService(Customize).

◆ setShareAudio:

- (void) setShareAudio: (BOOL) enableAudio

Enable the sending of device audio.

Parameters

enableAudio - YES if device audio sharing should be enabled, otherwise disable.

Provided by category MobileRTCMeetingService(AppShare).

◆ setTranslationLanguage:

- (BOOL) setTranslationLanguage: (NSInteger) languageID

set the translation language of the current user.

Parameters

languageID the translation language id. If the language ID is set to -1, live translation will be disabled,then you can reveive closed caption when host set meeting manual caption is true.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ showAANPanelInView:originPoint:

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

show app signaling pannel in designated position of container view.

Parameters

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

Returns: MobileRTCANNError_Success means the operation succeed, otherwise not

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ showAvatar:

- (MobileRTCSDKError) showAvatar: (BOOL) bShow

Determine if show the last used avatar in the meeting.

Parameters

bShow YES indicates to show the last used avatar.

Returns: If the function succeeds, the return value is SDKErr_Success.Otherwise failed.

Provided by category MobileRTCMeetingService(Avatar).

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

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: YES means that the method is called successfully, otherwise not.

Warning: The method does not work if you have set mobileRTCRootController via [MobileRTC setMobileRTCRootController]

Provided by category MobileRTCMeetingService(InMeeting).

◆ spotlightVideo:withUser:

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

Set whether to spotlight user's video.

Parameters

on	YES means to spotlight user's video; NO means that spotlight user's video will be canceled.
userId	The ID of user whose video will be spotlighted in the meeting.

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

Warning: Only meeting host/cohost can run the function, and user spotlighted should not be the host himself.

Provided by category MobileRTCMeetingService(Video).

◆ startAppShare

- (BOOL) startAppShare

Set to start App Share.

Returns: YES means starting App Share successfully, otherwise not.

Provided by category MobileRTCMeetingService(AppShare).

◆ startInterpretation

- (BOOL) startInterpretation

Start interpretation.

Returns: The result of the function.

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: YES means that the method is called successfully, otherwise not.

Warning: Only meeting host can start live Stream successfully.

Provided by category MobileRTCMeetingService(InMeeting).

◆ startLiveTranscription

- (BOOL) startLiveTranscription

Start live transcription. If the meeting enable multi language transcription,all user can start live transcription otherwise only host can start.

Returns: If the function succeeds, the return value is YES. Otherwise failed.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ startLiving:

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

startLiving Quesion.

Parameters

questionID question id.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ startMeetingWithStartParam:

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

Start a meeting with MobileRTCMeetingStartParam parameter.

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.

Parameters

param Create an instance with settings via MobileRTCMeetingStartParam.

Returns: The state of the meeting: started or failed.

Warning: A meeting started with wrong parameters will return MobileRTCMeetError_InvalidArguments.

◆ startPreviewWithFrame:

- (BOOL) startPreviewWithFrame: (CGRect) frame

Start preview for inspect the virtual background effect.

Returns: YES mean preview is ready.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ startRawArchiving

- (BOOL) startRawArchiving

Start raw archiving and get raw data receive previlege.

Returns: YES if start raw archiving succeeds. Otherwise failed.

Provided by category MobileRTCMeetingService(RawArchiving).

◆ startRawLiveStream:

- (MobileRTCSDKError) startRawLiveStream: (nonnull NSString *) broadcastURL

Start a rawData live stream.

Parameters

broadcastURL Everyone who uses this link can watch the live broadcast.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ startSignInterpretation

- (MobileRTCSDKError) startSignInterpretation

Start sign interpretation.

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

Warning: the interface for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ stopAppShare

- (void) stopAppShare

Set to stop App Share.

Provided by category MobileRTCMeetingService(AppShare).

◆ stopIncomingAudio:

- (MobileRTCSDKError) stopIncomingAudio: (BOOL) enabled

Stop the incoming audio.

Parameters

enabled YES means enabled. NO not.

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

Provided by category MobileRTCMeetingService(Audio).

◆ stopIncomingVideo:

- (MobileRTCSDKError) stopIncomingVideo: (BOOL) enable

Stop the incoming video.

Parameters

enable YES indicates to enable to stop incoming video.

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

Provided by category MobileRTCMeetingService(Video).

◆ stopInterpretation

- (BOOL) stopInterpretation

Stop interpretation.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ stopLiveStream

- (BOOL) stopLiveStream

Set to stop live streaming.

Returns: YES means stopping live streaming successfully, otherwise not.

Warning: The function is available only for host.

Provided by category MobileRTCMeetingService(InMeeting).

◆ stopLiveTranscription

- (BOOL) stopLiveTranscription

Stop live transcription. If the meeting enable multi language transcription,all user can stop live transcription,otherwise only host can stop.

Returns: If the function succeeds, the return value is YES. Otherwise failed.

Provided by category MobileRTCMeetingService(LiveTranscription).

◆ stopRawArchiving

- (BOOL) stopRawArchiving

Stop raw archiving and revoke rawdata receive previlege.

Returns: YES if stop raw archiving succeeds. Otherwise failed.

Provided by category MobileRTCMeetingService(RawArchiving).

◆ stopRawLiveStream

- (MobileRTCSDKError) stopRawLiveStream

Stop a rawData live stream.

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ stopSignInterpretation

- (MobileRTCSDKError) stopSignInterpretation

Stop sign interppretation.

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

Warning: the interface for host only.

Provided by category MobileRTCMeetingService(SignInterpreter).

◆ stopUserVideo:

- (BOOL) stopUserVideo: (NSUInteger) userID

Set to stop user's video.

Parameters

userID The ID of other users except the host in the meeting.

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

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

Provided by category MobileRTCMeetingService(Video).

◆ suspendSharing:

- (BOOL) suspendSharing: (BOOL) suspend

Suspend App Sharing.

Parameters

suspend - YES if sharing should be suspended, otherwise resume sharing.

Returns: YES means successful, otherwise not.

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 sample project.

Provided by category MobileRTCMeetingService(AppShare).

◆ switchMyAudioSource

- (MobileRTCAudioError) switchMyAudioSource

switch my audio output(receiver/speaker).

Provided by category MobileRTCMeetingService(Audio).

◆ switchMyCamera

- (MobileRTCCameraError) switchMyCamera

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

Returns: The result of operation.

Provided by category MobileRTCMeetingService(Video).

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

◆ turnOffMajorAudio

- (BOOL) turnOffMajorAudio

Turn off the major audio, if you are in some interpreter language channel.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ turnOnCMR:

- (void) turnOnCMR: (BOOL) on

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

Parameters

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

Provided by category MobileRTCMeetingService(InMeeting).

◆ turnOnMajorAudio

- (BOOL) turnOnMajorAudio

Turn on the major audio, if you are in some interpreter language channel.

Returns: The result of the function.

Provided by category MobileRTCMeetingService(Interpretation).

◆ unSpotlightAllVideos

- (BOOL) unSpotlightAllVideos

Un-spotlight all the user.

Returns: Yes means follow, otherwise not.

Warning: Only meeting host/cohost can run the function, and user spotlighted should not be the host himself.

Provided by category MobileRTCMeetingService(Video).

◆ useBGImage:

- (MobileRTCMeetError) useBGImage: (MobileRTCVirtualBGImageInfo *_Nonnull) bgImage

use the specify image item for virtual background.

Returns: The result of use image item.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ useNoneImage

- (MobileRTCMeetError) useNoneImage

Disable the virtrual background, same as use a none image item.

Returns: The result of disable virtual background.

Provided by category MobileRTCMeetingService(VirtualBackground).

◆ userInfoByID:

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

Get user information in the meeting.

Parameters

userId In-meeting user ID.

Returns: User information.

Warning: webinar attendee can not call the function, please use: [attendeeInfoByID:].

Provided by category MobileRTCMeetingService(User).

◆ voteupQuestion:voteup:

- (BOOL) voteupQuestion:	(nonnull NSString *)	questionID
voteup:	(BOOL)	voteup

Vote up Quesion.

Parameters

questionID question id.

Returns: successs or not.

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

Provided by category MobileRTCMeetingService(Webinar).

◆ withdrawCCPrivilege:

- (BOOL) withdrawCCPrivilege: (NSUInteger) userId

WithDraw the user privilege to send closed caption.

Parameters

userid the user id.

Returns: If the function succeeds, the return value is YES. Otherwise failed.

Provided by category MobileRTCMeetingService(LiveTranscription).

Property Documentation

◆ customizedUImeetingDelegate

- (id<MobileRTCCustomizedUIMeetingDelegate>) customizedUImeetingDelegate

readwritenonatomicassign

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 226 of file MobileRTCMeetingService.h.

◆ delegate

- (id<MobileRTCMeetingServiceDelegate>) delegate

readwritenonatomicassign

Callback to receive meeting events.

Definition at line 221 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 40 of file MobileRTCMeetingService+VirtualBackground.h.

Instance Methods

Properties

Detailed Description

Method Documentation

◆ activeShareUserID

◆ activeUserID

◆ addBGImage:

◆ addInterpreter:lan1:andLan2:

◆ addQuestion:anonymous:

◆ addSignInterpreter:signLanId:

◆ allowAskQuestionAnonymously:

◆ allowAttenddeTalk:allow:

◆ allowAttendeeChat:

◆ allowAttendeeRaiseHand

◆ allowAttendeeUpVoteQuestion:

◆ allowAttendeeViewAllQuestion:

◆ allowAttendeeViewTheParticipantCount

◆ allowCommentQuestion:

◆ allowPanelistStartVideo:

◆ allowParticipantsToRename:

◆ allowParticipantsToShareWhiteBoard:

◆ allowParticipantsToStartVideo:

◆ allowParticipantsToUnmuteSelf:

◆ allowWebinarEmojiReaction

◆ answerQuestionPrivate:answerContent:

◆ answerQuestionPublic:answerContent:

◆ appShareWithView:

◆ askAllToUnmute

◆ askUserStartVideo:

◆ assignCCPrivilege:

◆ assignCohost:

◆ attendeeInfoByID:

◆ backZoomUIMeetingFromMinimizeMeeting

◆ callRoomDevice:

◆ canAssignOthersToSendCC

◆ canBeAssignedToSendCC:

◆ canBeCoHost:

◆ cancelCallRoomDevice

◆ cancelDialOut:

◆ canClaimhost

◆ canDisableCaptions

◆ canStartLiveTranscription

◆ canStartRawLiveStream

◆ canStartSignInterpretation

◆ canUnmuteMyAudio

◆ canUnmuteMyVideo

◆ changeAttendeeChatPriviledge:

◆ changeName:withUserID:

◆ changePanelistChatPrivilege:

◆ claimHostWithHostKey:

◆ commentQuestion:commentContent:

◆ configDSCPWithAudioValue:VideoValue:

◆ connectMyAudio:

◆ customizeMeetingTitle:

◆ deleteAnswer:

◆ deleteChatMessage:

◆ deleteQuestion:

◆ dePromptPanelist2Attendee:

◆ dialInCall:

◆ dialOut:isCallMe:withName:

◆ disallowAttendeeRaiseHand

◆ disallowAttendeeViewTheParticipantCount

◆ disallowWebinarEmojiReaction

◆ dismissQuestion:

◆ enableCaptions:

◆ enableGreenVB:

◆ enableMeetingManualCaption:

◆ enableReceiveSpokenlLanguageContent:

◆ enableRequestLiveTranscription:

◆ endLiving:

◆ get3DAvatarImageList

◆ getAdminHelper

◆ getAllChatMessageID

◆ getAllLanguageList

◆ getALLQuestionCount

◆ getAllQuestionList

◆ getAllSupportedSignLanguageInfoList

◆ getAnswer:

◆ getAnsweredQuestionCount

◆ getAnsweredQuestionList