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

#include <MobileRTC.h>

Inherits NSObject.

Instance Methods
(BOOL)	- initialize:
	Initializes MobileRTC.
(BOOL)	- switchDomain:force:
	Switches the MobileRTC domain.
(void)	- setMobileRTCCustomLocalizableName:
	Sets the name of Localizable file for MobileRTC.
(UINavigationController *_Nullable)	- mobileRTCRootController
	Gets the root navigation controller of MobileRTC client.
(void)	- setMobileRTCRootController:
	Sets the MobileRTC client root navigation controller.
(UIScene *_Nullable)	- mobileRTCPresentationScene
	Get the presentation scene of MobileRTC client.
(void)	- setMobileRTCPresentationScene:
	Sets the UIScene context used by the SDK. In multi-scene environments, an application may create multiple UIScene instances. This method allows you to provide the SDK with the specific scene it should use for presenting UI, handling lifecycle events, or associating with the application's environment.
(NSString *_Nullable)	- mobileRTCVersion
	Gets the MobileRTC version.
(BOOL)	- isRTCAuthorized
	Queries if the MobileRTC is authorized successfully or not.
(BOOL)	- isSupportedCustomizeMeetingUI
	Queries if custom meeting UI is supported by MobileRTC.
(BOOL)	- isEnabledCustomizeMeetingUI
	Queries if custom meeting UI is enabled by MobileRTC.
(MobileRTCAuthService *_Nullable)	- getAuthService
	Gets the default authentication service.
(MobileRTCMeetingService *_Nullable)	- getMeetingService
	Gets the default meeting service.
(MobileRTCMeetingSettings *_Nullable)	- getMeetingSettings
	Gets the MobileRTC default meeting settings.
(MobileRTCAnnotationService *_Nullable)	- getAnnotationService
	Gets the MobileRTC default annotation service.
(MobileRTCRemoteControlService *_Nullable)	- getRemoteControlService
	Gets the default MobileRTC remote control service.
(MobileRTCCameraControlService *_Nullable)	- getCameraControlService:
	Gets the default MobileRTC camera control service.
(MobileRTCSDKError)	- revokeCameraControlPrivilege
	Revoke camera control privilege.
(MobileRTCWaitingRoomService *_Nullable)	- getWaitingRoomService
	Gets the default MobileRTC waiting room service.
(MobileRTCSMSService *_Nullable)	- getSMSService
	Gets the default MobileRTC sms service.
(MobileRTCDirectShareService *_Nullable)	- getDirectShareService
	Gets the default MobileRTC direct share service.
(MobileRTCReminderHelper *_Nullable)	- getReminderHelper
	Gets the default MobileRTC reminder helper.
(MobileRTCVideoSourceHelper *_Nullable)	- getVideoSourceHelper
	Gets the video source helper.
(MobileRTCShareSourceHelper *_Nullable)	- getShareSourceHelper
	Gets the share source helper.
(NSArray< NSString * > *_Nonnull)	- supportedLanguages
	Gets the languages supported by MobileRTC.
(void)	- setLanguage:
	Sets the MobileRTC language.
(void)	- appWillResignActive
	Notifies common layer that application will resign active. Call the systematical method and then call the appWillResignActive via applicationWillResignActive.
(void)	- appDidBecomeActive
	Notifies common layer that application did become active. Call the appDidBecomeActive via applicationDidBecomeActive.
(void)	- appDidEnterBackground
	Notifies common layer that application did enter background. Call the appDidEnterBackground via applicationDidEnterBackground.
(void)	- appWillTerminate
	Notifies common layer that application will terminate. Call the appWillTerminate via applicationWillTerminate.
(void)	- cleanup
	Cleanup the SDK.
(void)	- willTransitionToTraitCollection:withTransitionCoordinator:
	Notifies MobileRTC when the root UIViewController's traitCollection will change.
(void)	- viewWillTransitionToSize:withTransitionCoordinator:
	Notifies 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
	Gets 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 118 of file MobileRTC.h.

Method Documentation

◆ appDidBecomeActive

- (void) appDidBecomeActive

Notifies 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".

References appDidBecomeActive.

Referenced by appDidBecomeActive.

◆ appDidEnterBackground

- (void) appDidEnterBackground

Notifies common layer that application did enter background. Call the appDidEnterBackground via applicationDidEnterBackground.

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

References appDidEnterBackground.

Referenced by appDidEnterBackground.

◆ appWillResignActive

- (void) appWillResignActive

Notifies 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".

References appWillResignActive.

Referenced by appWillResignActive.

◆ appWillTerminate

- (void) appWillTerminate

Notifies 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".

References appWillTerminate.

Referenced by appWillTerminate.

◆ cleanup

- (void) cleanup

Cleanup the SDK.

Warning: User will clean up the SDK when no longer need the SDK instance, only can call this method after initialized.

References cleanup.

Referenced by cleanup.

◆ getAnnotationService

- (MobileRTCAnnotationService *_Nullable) getAnnotationService

Gets the MobileRTC default annotation service.

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

References getAnnotationService.

Referenced by getAnnotationService.

◆ getAuthService

- (MobileRTCAuthService *_Nullable) getAuthService

Gets the default authentication service.

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

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

References getAuthService.

Referenced by getAuthService.

◆ getCameraControlService:

- (MobileRTCCameraControlService *_Nullable) getCameraControlService: (NSInteger) userId

Gets the default MobileRTC camera control service.

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

◆ getDirectShareService

- (MobileRTCDirectShareService *_Nullable) getDirectShareService

Gets the default MobileRTC direct share service.

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

References getDirectShareService.

Referenced by getDirectShareService.

◆ getMeetingService

- (MobileRTCMeetingService *_Nullable) getMeetingService

Gets the default meeting service.

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

References getMeetingService.

Referenced by getMeetingService.

◆ getMeetingSettings

- (MobileRTCMeetingSettings *_Nullable) getMeetingSettings

Gets the MobileRTC default meeting settings.

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

References getMeetingSettings.

Referenced by getMeetingSettings.

◆ getReminderHelper

- (MobileRTCReminderHelper *_Nullable) getReminderHelper

Gets the default MobileRTC reminder helper.

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

References getReminderHelper.

Referenced by getReminderHelper.

◆ getRemoteControlService

- (MobileRTCRemoteControlService *_Nullable) getRemoteControlService

Gets the default MobileRTC remote control service.

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

References getRemoteControlService.

Referenced by getRemoteControlService.

◆ getShareSourceHelper

- (MobileRTCShareSourceHelper *_Nullable) getShareSourceHelper

Gets the share source helper.

See also: MobileRTCShareSourceHelper.

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

References getShareSourceHelper.

Referenced by getShareSourceHelper.

◆ getSMSService

- (MobileRTCSMSService *_Nullable) getSMSService

Gets the default MobileRTC sms service.

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

References getSMSService.

Referenced by getSMSService.

◆ getVideoSourceHelper

- (MobileRTCVideoSourceHelper *_Nullable) getVideoSourceHelper

Gets the video source helper.

See also: MobileRTCVideoSourceHelper.

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

References getVideoSourceHelper.

Referenced by getVideoSourceHelper.

◆ getWaitingRoomService

- (MobileRTCWaitingRoomService *_Nullable) getWaitingRoomService

Gets the default MobileRTC waiting room service.

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

References getWaitingRoomService.

Referenced by getWaitingRoomService.

◆ hasRawDataLicense

- (BOOL) hasRawDataLicense

Gets whether you have permission to use raw data.

Returns: YES means you have permission to use raw data.

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

References hasRawDataLicense.

Referenced by hasRawDataLicense.

◆ initialize:

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

Initializes 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].

◆ isEnabledCustomizeMeetingUI

- (BOOL) isEnabledCustomizeMeetingUI

Queries if custom meeting UI is enabled by MobileRTC.

Returns: YES indicates enabled. Otherwise not.

References isEnabledCustomizeMeetingUI.

Referenced by isEnabledCustomizeMeetingUI.

◆ isRTCAuthorized

- (BOOL) isRTCAuthorized

Queries if the MobileRTC is authorized successfully or not.

Returns: YES indicates authorized successfully. Otherwise not.

References isRTCAuthorized.

Referenced by isRTCAuthorized.

◆ isSupportedCustomizeMeetingUI

- (BOOL) isSupportedCustomizeMeetingUI

Queries if custom meeting UI is supported by MobileRTC.

Returns: YES indicates support. Otherwise not.

References isSupportedCustomizeMeetingUI.

Referenced by isSupportedCustomizeMeetingUI.

◆ mobileRTCPresentationScene

- (UIScene *_Nullable) mobileRTCPresentationScene

Get the presentation scene of MobileRTC client.

Returns: If the function succeeds, it returns the presentation scene of MobileRTC client. Otherwise, this function fails and returns nil.

References mobileRTCPresentationScene.

Referenced by mobileRTCPresentationScene, and mobileRTCRootController.

◆ mobileRTCRootController

- (UINavigationController *_Nullable) mobileRTCRootController

Gets the root navigation controller of MobileRTC client.

Returns: The root navigation controller.

Deprecated: This method is deprecated. Use mobileRTCPresentationScene instead.

References mobileRTCPresentationScene, and mobileRTCRootController.

Referenced by mobileRTCRootController.

◆ mobileRTCVersion

- (NSString *_Nullable) mobileRTCVersion

Gets the MobileRTC version.

Returns: The version of MobileRTC.

References mobileRTCVersion.

Referenced by mobileRTCVersion.

◆ revokeCameraControlPrivilege

- (MobileRTCSDKError) revokeCameraControlPrivilege

Revoke camera control privilege.

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

References revokeCameraControlPrivilege.

Referenced by revokeCameraControlPrivilege.

◆ setLanguage:

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

Sets the MobileRTC language.

Warning: Choose one of the languages supported by MobileRTC.

Parameters

lang	The specified language.

◆ setMobileRTCCustomLocalizableName:

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

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

◆ setMobileRTCPresentationScene:

- (void) setMobileRTCPresentationScene: (UIScene *_Nonnull) scene

Sets the UIScene context used by the SDK. In multi-scene environments, an application may create multiple UIScene instances. This method allows you to provide the SDK with the specific scene it should use for presenting UI, handling lifecycle events, or associating with the application's environment.

Parameters

scene The UIScene instance to be used by the SDK.

Warning: Passing an invalid or inactive scene may cause the SDK's UI to fail to present or behave unexpectedly.

◆ setMobileRTCRootController:

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

Sets the MobileRTC client root navigation controller.

Parameters

navController The root navigation controller for pushing MobileRTC meeting UI.

Deprecated: This method is deprecated. Use setMobileRTCPresentationScene instead.

◆ sharedRTC

+ (MobileRTC *_Nonnull) sharedRTC

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

References sharedRTC.

Referenced by sharedRTC.

◆ supportedLanguages

- (NSArray< NSString * > *_Nonnull) supportedLanguages

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

References supportedLanguages.

Referenced by supportedLanguages.

◆ switchDomain:force:

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

Switches the MobileRTC domain.

Parameters

newDomain The new domain.

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

Warning: After switch domain, need to auth again.

◆ viewWillTransitionToSize:withTransitionCoordinator:

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

Notifies 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

Notifies 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

readnonatomiccopy

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

Definition at line 132 of file MobileRTC.h.

◆ mobileRTCDomain

- (NSString* _Nullable) mobileRTCDomain

readnonatomiccopy

MobileRTC domain, read-only.

Definition at line 122 of file MobileRTC.h.

◆ mobileRTCResPath

- (NSString* _Nullable) mobileRTCResPath

readnonatomiccopy

The path of MobileRTC Resources Bundle, read-only.

Definition at line 127 of file MobileRTC.h.

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ appDidBecomeActive

◆ appDidEnterBackground

◆ appWillResignActive

◆ appWillTerminate

◆ cleanup

◆ getAnnotationService

◆ getAuthService

◆ getCameraControlService:

◆ getDirectShareService

◆ getMeetingService

◆ getMeetingSettings

◆ getReminderHelper

◆ getRemoteControlService

◆ getShareSourceHelper

◆ getSMSService

◆ getVideoSourceHelper

◆ getWaitingRoomService

◆ hasRawDataLicense

◆ initialize:

◆ isEnabledCustomizeMeetingUI

◆ isRTCAuthorized

◆ isSupportedCustomizeMeetingUI

◆ mobileRTCPresentationScene

◆ mobileRTCRootController

◆ mobileRTCVersion

◆ revokeCameraControlPrivilege

◆ setLanguage:

◆ setMobileRTCCustomLocalizableName:

◆ setMobileRTCPresentationScene:

◆ setMobileRTCRootController:

◆ sharedRTC

◆ supportedLanguages

◆ switchDomain:force:

◆ viewWillTransitionToSize:withTransitionCoordinator:

◆ willTransitionToTraitCollection:withTransitionCoordinator:

Property Documentation

◆ mobileRTCCustomLocalizableName

◆ mobileRTCDomain

◆ mobileRTCResPath