Initialize the class to acquire all the services. More...

#import <MobileRTC.h>

Inherits NSObject.

Instance Methods
(BOOL)	- initialize:
	Call the function to initialize MobileRTC.

(BOOL)	- switchDomain:force:
	Call the function to switch MobileRTC domain.

(void)	- setMobileRTCCustomLocalizableName:
	Set the name of Localizable file for MobileRTC.

(UINavigationController *_Nullable)	- mobileRTCRootController
	Get the root navigation controller of MobileRTC client.

(void)	- setMobileRTCRootController:
	Set the MobileRTC client root navigation controller.

(NSString *_Nullable)	- mobileRTCVersion
	Check the MobileRTC version.

(BOOL)	- isRTCAuthorized
	Query if the MobileRTC is authorized successfully or not.

(BOOL)	- isSupportedCustomizeMeetingUI
	Query if custom meeting UI is supported by MobileRTC.

(MobileRTCAuthService *_Nullable)	- getAuthService
	Get the default authentication service.

(MobileRTCMeetingService *_Nullable)	- getMeetingService
	Get the default meeting service.

(MobileRTCMeetingSettings *_Nullable)	- getMeetingSettings
	Get the MobileRTC default meeting settings.

(MobileRTCAnnotationService *_Nullable)	- getAnnotationService
	Get the MobileRTC default annotation service.

(MobileRTCRemoteControlService *_Nullable)	- getRemoteControlService
	Get the default MobileRTC remote control service.

(MobileRTCWaitingRoomService *_Nullable)	- getWaitingRoomService
	Get the default MobileRTC waiting room service.

(MobileRTCSMSService *_Nullable)	- getSMSService
	Get the default MobileRTC sms service.

(MobileRTCDirectShareService *_Nullable)	- getDirectShareService
	Get the default MobileRTC direct share service.

(MobileRTCVideoSourceHelper *_Nullable)	- getVideoSourceHelper
	Get the video source helper.

(MobileRTCShareSourceHelper *_Nullable)	- getShareSourceHelper
	Get the video source helper.

(NSArray< NSString * > *_Nonnull)	- supportedLanguages
	Get the languages supported by MobileRTC.

(void)	- setLanguage:
	Set the MobileRTC language.

(void)	- appWillResignActive
	Notify common layer that application will resign active. Call the systematical method and then call the appWillResignActive via applicationWillResignActive.

(void)	- appDidBecomeActive
	Notify common layer that application did become active. Call the appDidBecomeActive via applicationDidBecomeActive.

(void)	- appDidEnterBackgroud
	Notify common layer that application did enter background. Call the appDidEnterBackgroud via applicationDidEnterBackground.

(void)	- appWillTerminate
	Notify common layer that application will terminate. Call the appWillTerminate via applicationWillTerminate.

(void)	- willTransitionToTraitCollection:withTransitionCoordinator:
	Notify MobileRTC when the root UIViewController's traitCollection will change.

(void)	- viewWillTransitionToSize:withTransitionCoordinator:
	Notify MobileRTC when the root UIViewController's view size will change.

(BOOL)	- hasRawDataLicense
	Gets whether you have permission to use raw data.

Class Methods
(MobileRTC *_Nonnull)	+ sharedRTC
	Call the function to get the MobileRTC client.

Properties
NSString *_Nullable	mobileRTCDomain
	MobileRTC domain, read-only.

NSString *_Nullable	mobileRTCResPath
	The path of MobileRTC Resources Bundle, read-only.

NSString *_Nullable	mobileRTCCustomLocalizableName
	The name of APP Localizable file for MobileRTC, read-only.

Detailed Description

Initialize the class to acquire all the services.

Warning: Access to the class and all the other components of the MobileRTC by merging <MobileRTC/MobileRTC.h> into source code.; The user can only obtain SDK configuration by initializing the class.

Definition at line 95 of file MobileRTC.h.

Method Documentation

◆ appDidBecomeActive

- (void) appDidBecomeActive

Notify common layer that application did become active. Call the appDidBecomeActive via applicationDidBecomeActive.

Warning: It is necessary to call the method in AppDelegate "- (void)applicationDidBecomeActive:(UIApplication *)application".

◆ appDidEnterBackgroud

- (void) appDidEnterBackgroud

Notify common layer that application did enter background. Call the appDidEnterBackgroud via applicationDidEnterBackground.

Warning: It is necessary to call the method in AppDelegate "- (void)applicationDidEnterBackground:(UIApplication *)application".

◆ appWillResignActive

- (void) appWillResignActive

Notify common layer that application will resign active. Call the systematical method and then call the appWillResignActive via applicationWillResignActive.

Warning: It is necessary to call the method in AppDelegate "- (void)applicationWillResignActive:(UIApplication *)application".

◆ appWillTerminate

- (void) appWillTerminate

Notify common layer that application will terminate. Call the appWillTerminate via applicationWillTerminate.

Warning: It is necessary to call the method in AppDelegate "- (void)applicationWillTerminate:(UIApplication *)application".

◆ getAnnotationService

- (MobileRTCAnnotationService *_Nullable) getAnnotationService

Get the MobileRTC default annotation service.

Returns: The preconfigured annotation service.

◆ getAuthService

- (MobileRTCAuthService *_Nullable) getAuthService

Get the default authentication service.

Warning: The MobileRTC can not be called unless the authentication service is called successfully.

Returns: The preconfigured authentication service.

◆ getDirectShareService

- (MobileRTCDirectShareService *_Nullable) getDirectShareService

Get the default MobileRTC direct share service.

Returns: The MobileRTC direct share service.

◆ getMeetingService

- (MobileRTCMeetingService *_Nullable) getMeetingService

Get the default meeting service.

Returns: The default meeting service.

◆ getMeetingSettings

- (MobileRTCMeetingSettings *_Nullable) getMeetingSettings

Get the MobileRTC default meeting settings.

Returns: The MobileRTC default meeting settings.

◆ getRemoteControlService

- (MobileRTCRemoteControlService *_Nullable) getRemoteControlService

Get the default MobileRTC remote control service.

Returns: The preconfigured remote control service.

◆ getShareSourceHelper

- (MobileRTCShareSourceHelper *_Nullable) getShareSourceHelper

Get the video source helper.

See also: MobileRTCShareSourceHelper

Returns: The object of MobileRTCShareSourceHelper.

◆ getSMSService

- (MobileRTCSMSService *_Nullable) getSMSService

Get the default MobileRTC sms service.

Returns: The MobileRTC sms service.

◆ getVideoSourceHelper

- (MobileRTCVideoSourceHelper *_Nullable) getVideoSourceHelper

Get the video source helper.

See also: MobileRTCVideoSourceHelper

Returns: The object of MobileRTCVideoSourceHelper.

◆ getWaitingRoomService

- (MobileRTCWaitingRoomService *_Nullable) getWaitingRoomService

Get the default MobileRTC waiting room service.

Returns: The MobileRTC waiting room service.

◆ hasRawDataLicense

- (BOOL) hasRawDataLicense

Gets whether you have permission to use raw data.

Warning: It is necessary to call the method after auth success.

◆ initialize:

- (BOOL) initialize: (MobileRTCSDKInitContext *_Nonnull) context

Call the function to initialize MobileRTC.

Warning: The instance will be instantiated only once over the lifespan of the application.

Parameters

context Initialize the parameter configuration of the SDK, please See [MobileRTCSDKInitContext]

◆ isRTCAuthorized

- (BOOL) isRTCAuthorized

Query if the MobileRTC is authorized successfully or not.

Returns: YES indicates authorized successfully. Otherwise not.

◆ isSupportedCustomizeMeetingUI

- (BOOL) isSupportedCustomizeMeetingUI

Query if custom meeting UI is supported by MobileRTC.

Returns: YES indicates support. Otherwise not.

◆ mobileRTCRootController

- (UINavigationController *_Nullable) mobileRTCRootController

Get the root navigation controller of MobileRTC client.

Returns: The root navigation controller.

◆ mobileRTCVersion

- (NSString *_Nullable) mobileRTCVersion

Check the MobileRTC version.

Returns: The version of MobileRTC.

◆ setLanguage:

- (void) setLanguage: (NSString *_Nullable) lang

Set the MobileRTC language.

Warning: Choose one of the languages supported by MobileRTC.

Parameters

lang	The specified language.

◆ setMobileRTCCustomLocalizableName:

- (void) setMobileRTCCustomLocalizableName: (NSString *_Nullable) localizableName

Set the name of Localizable file for MobileRTC.

Warning: This method is optional, MobileRTC will read Custom Localizable file from App’s main bundle first.

Parameters

localizableName The name of APP Localizable file for MobileRTC.

◆ setMobileRTCRootController:

- (void) setMobileRTCRootController: (UINavigationController *_Nullable) navController

Set the MobileRTC client root navigation controller.

Parameters

navController The root navigation controller for pushing MobileRTC meeting UI.

Warning: This method is optional, call the method if the window's rootViewController of the application is the UINavigationController, prefer to set the root view controller.<UINavigationController>.; If not set the root view controller. Zoom meeting will displayed on the WINDOW which level same as app window, create by SDK.; In that case, if you want to disaplay customized UI of you app above Zoom meeting view, should get meeting view(call "- (UIView * _Nullable)meetingView;) and then add your customized view to the meeting view.

◆ sharedRTC

+ (MobileRTC *_Nonnull) sharedRTC

Call the function to get the MobileRTC client.

Warning: The sharedSDK will be instantiated only once over the lifespan of the application. Configure the client with the specified key and secret.

Returns: A preconfigured MobileRTC client.

◆ supportedLanguages

- (NSArray< NSString * > *_Nonnull) supportedLanguages

Get the languages supported by MobileRTC.

Warning: The languages supported by MobileRTC are English, German, Spanish, Japanese, French, Simplified Chinese, Traditional Chinese.

Returns: An array of languages supported by MobileRTC.

◆ switchDomain:force:

- (BOOL) switchDomain:	(NSString *_Nonnull)	newDomain
force:	(BOOL)	force

Call the function to switch MobileRTC domain.

Parameters

newDomain The new domain.

Returns: YES indicates successfully. Otherwise not.

Warning: After switch domain, need to auth again.

◆ viewWillTransitionToSize:withTransitionCoordinator:

- (void) viewWillTransitionToSize:	(CGSize)	size
withTransitionCoordinator:	(id< UIViewControllerTransitionCoordinator >_Nullable)	coordinator

Notify MobileRTC when the root UIViewController's view size will change.

Parameters

size	The first parameter of viewWillTransitionToSize:withTransitionCoordinator.
coordinator	the second parameter of viewWillTransitionToSize:withTransitionCoordinator.

Warning: Not work in Custom In-Meeting UI.; Call this method when the window.rootViewController recevived viewWillTransitionToSize:withTransitionCoordinator.

◆ willTransitionToTraitCollection:withTransitionCoordinator:

- (void) willTransitionToTraitCollection:	(UITraitCollection *_Nullable)	newCollection
withTransitionCoordinator:	(id< UIViewControllerTransitionCoordinator >_Nullable)	coordinator

Notify MobileRTC when the root UIViewController's traitCollection will change.

Parameters

newCollection	The first parameter of willTransitionToTraitCollection:withTransitionCoordinator which is UIContentContainer method.
coordinator	The second parameter of willTransitionToTraitCollection:withTransitionCoordinator which is UIContentContainer method.

Warning: Not work in Custom In-Meeting UI.; Call this method when the window.rootViewController recevived willTransitionToTraitCollection:withTransitionCoordinator.

Property Documentation

◆ mobileRTCCustomLocalizableName

- (NSString* _Nullable) mobileRTCCustomLocalizableName

readnonatomicretain

The name of APP Localizable file for MobileRTC, read-only.

Definition at line 109 of file MobileRTC.h.

◆ mobileRTCDomain

- (NSString* _Nullable) mobileRTCDomain

readnonatomicretain

MobileRTC domain, read-only.

Definition at line 99 of file MobileRTC.h.

◆ mobileRTCResPath

- (NSString* _Nullable) mobileRTCResPath

readnonatomicretain

The path of MobileRTC Resources Bundle, read-only.

Definition at line 104 of file MobileRTC.h.

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ appDidBecomeActive

◆ appDidEnterBackgroud

◆ appWillResignActive

◆ appWillTerminate

◆ getAnnotationService

◆ getAuthService

◆ getDirectShareService

◆ getMeetingService

◆ getMeetingSettings

◆ getRemoteControlService

◆ getShareSourceHelper

◆ getSMSService

◆ getVideoSourceHelper

◆ getWaitingRoomService

◆ hasRawDataLicense

◆ initialize:

◆ isRTCAuthorized

◆ isSupportedCustomizeMeetingUI

◆ mobileRTCRootController

◆ mobileRTCVersion

◆ setLanguage:

◆ setMobileRTCCustomLocalizableName:

◆ setMobileRTCRootController:

◆ sharedRTC

◆ supportedLanguages

◆ switchDomain:force:

◆ viewWillTransitionToSize:withTransitionCoordinator:

◆ willTransitionToTraitCollection:withTransitionCoordinator:

Property Documentation

◆ mobileRTCCustomLocalizableName

◆ mobileRTCDomain

◆ mobileRTCResPath