Zoom SDK global manager. More...

Public Member Functions
boolean	hasRawDataLicense ()
	Determines whether the SDK has a raw data license. Must call from the main thread.
ZoomSDKVideoSourceHelper	getVideoSourceHelper ()
	Gets the video source helper.
ZoomSDKShareSourceHelper	getShareSourceHelper ()
	Gets the share source helper.
void	addAuthenticationListener (ZoomSDKAuthenticationListener listener)
	Registers a listener for the callback events of user authentication.
void	removeAuthenticationListener (ZoomSDKAuthenticationListener listener)
	Unregisters the listener for the callback events of user authentication.
void	addNetworkConnectionListener (NetworkConnectionListener listener)
	Registers a listener to receive the NetworkConnectionHandler.
void	removeNetworkConnectionListener (NetworkConnectionListener listener)
	Unregisters the listener for network connection events.
void	initialize (Context context, ZoomSDKInitializeListener listener, ZoomSDKInitParams params)
	Initializes Zoom SDK.
void	uninitialize ()
	Uninitializes Zoom SDK.
boolean	switchDomain (String newDomain, boolean force)
	Switches the SDK domain.
String	getVersion (Context context)
	Gets the Zoom SDK version on Android.
boolean	isDeviceSupported (Context context)
	Determines whether the current device is able to run the SDK.
boolean	isInitialized ()
	Determines whether Zoom SDK has been initialized. Must call from the main thread.
String	generateSSOLoginURL (String ssoDomainPrefix)
	Gets the SSO login URL by the domain prefix.
boolean	handleSSOLoginURIProtocol (String uriProtocol)
	Logs in with the SSO login URI, link zoommtg://*.
boolean	logoutZoom ()
	Logs out Zoom SDK.
boolean	isLoggedIn ()
	Determines whether the Zoom user has logged in.
int	tryAutoLoginZoom ()
	Logs in Zoom SDK automatically with local Zoom or SSO token once you have logged in successfully.
boolean	setDomain (String domain)
	Sets a new web domain name. Must call from the main thread.
String	getDomain ()
	Gets the current domain.
void	setSdkLocale (Context context, Locale locale)
	Configures Zoom SDK locale.
Locale	getSdkLocale (Context context)
	Gets the current Zoom SDK locale configuration.
void	setShowProxyServerDialogImmediatelyIfNeeded (boolean show)
	Sets whether to display the setting dialog of proxy server immediately when needed.
MeetingService	getMeetingService ()
	Gets the instance of meeting service.
SmsService	getSmsService ()
	Gets SMS service for real name authentication for Chinese users.
AccountService	getAccountService ()
	Gets the account service instance.
PreMeetingService	getPreMeetingService ()
	Gets the pre-meeting service instance.
InMeetingService	getInMeetingService ()
	Gets the in-meeting service instance.
ZoomUIService	getZoomUIService ()
	Gets the Zoom UI service instance.
MeetingSettingsHelper	getMeetingSettingsHelper ()
	Gets the meeting settings helper instance.
I3DAvatarSettingContext	get3DAvatarSettings ()
	Gets the 3D avatar settings interface.
IReminderHelper	getReminderHelper ()
	Gets the reminder helper interface.
INotificationServiceHelper	getNotificationServiceHelper ()
	Gets the notification service helper interface.
void	enableAutoRegisterNotificationServiceForLogin (boolean enable)
	Enables or disables auto-register notification service. This is enabled by default.
MobileRTCSDKError	registerNotificationService (String accessToken)
	Registers notification service.
MobileRTCSDKError	unregisterNotificationService ()
	Unregisters notification service.

Static Public Member Functions
static ZoomSDK	getInstance ()
	Gets a shared instance of Zoom SDK. Must call from the main thread.

Private Member Functions
	ZoomSDK ()

Private Attributes
final ZoomSDKImpl	mZoomSDKImpl

Static Private Attributes
static volatile ZoomSDK	instance

Detailed Description

Zoom SDK global manager.

Definition at line 12 of file ZoomSDK.java.

Constructor & Destructor Documentation

◆ ZoomSDK()

us.zoom.sdk.ZoomSDK.ZoomSDK ( )

inlineprivate

Definition at line 16 of file ZoomSDK.java.

                      {
        mZoomSDKImpl = ZoomSDKImpl.getInstance();
    }

References mZoomSDKImpl.

Referenced by getInstance().

Member Function Documentation

◆ addAuthenticationListener()

void us.zoom.sdk.ZoomSDK.addAuthenticationListener ( ZoomSDKAuthenticationListener listener )

inline

Registers a listener for the callback events of user authentication.

Parameters

listener The listener instance.

Definition at line 68 of file ZoomSDK.java.

                                                                                  {
        mZoomSDKImpl.addAuthenticationListener(listener);
    }

References mZoomSDKImpl.

◆ addNetworkConnectionListener()

void us.zoom.sdk.ZoomSDK.addNetworkConnectionListener ( NetworkConnectionListener listener )

inline

Registers a listener to receive the NetworkConnectionHandler.

Parameters

listener The listener instance.

Definition at line 86 of file ZoomSDK.java.

                                                                                 {
        mZoomSDKImpl.addNetworkConnectionListener(listener);
    }

References mZoomSDKImpl.

◆ enableAutoRegisterNotificationServiceForLogin()

void us.zoom.sdk.ZoomSDK.enableAutoRegisterNotificationServiceForLogin ( boolean enable )

inline

Enables or disables auto-register notification service. This is enabled by default.

Parameters

enable true to enable, false otherwise.

Definition at line 359 of file ZoomSDK.java.

                                                                             {
        mZoomSDKImpl.enableAutoRegisterNotificationServiceForLogin(enable);
    }

References mZoomSDKImpl.

◆ generateSSOLoginURL()

String us.zoom.sdk.ZoomSDK.generateSSOLoginURL ( String ssoDomainPrefix )

inline

Gets the SSO login URL by the domain prefix.

Parameters

ssoDomainPrefix The domain prefix.

Returns: If the function succeeds, it returns the SSO login URL. Otherwise, this function fails and returns null.

Definition at line 163 of file ZoomSDK.java.

                                                              {
        return mZoomSDKImpl.generateSSOLoginURL(ssoDomainPrefix);
    }

References mZoomSDKImpl.

◆ get3DAvatarSettings()

I3DAvatarSettingContext us.zoom.sdk.ZoomSDK.get3DAvatarSettings ( )

inline

Gets the 3D avatar settings interface.

Returns: If the function succeeds, it returns the shared instance of I3DAvatarSettingContext. Otherwise, this function fails and returns null if the SDK has not been initialized successfully.

Definition at line 332 of file ZoomSDK.java.

                                                         {
        return mZoomSDKImpl.get3DAvatarSettings();
    }

References mZoomSDKImpl.

◆ getAccountService()

AccountService us.zoom.sdk.ZoomSDK.getAccountService ( )

inline

Gets the account service instance.

Returns: If the function succeeds, it returns the shared instance of account service. Otherwise, this function fails and returns null if the SDK has not been initialized successfully or the user did not log in.

Deprecated: This method is no longer used.

Definition at line 287 of file ZoomSDK.java.

                                              {
        return mZoomSDKImpl.getAccountService();
    }

References mZoomSDKImpl.

◆ getDomain()

String us.zoom.sdk.ZoomSDK.getDomain ( )

inline

Gets the current domain.

Returns: If the function succeeds, it returns the current domain. Otherwise, this function fails and returns null.

Definition at line 227 of file ZoomSDK.java.

                              {
        return mZoomSDKImpl.getDomain();
    }

References mZoomSDKImpl.

◆ getInMeetingService()

InMeetingService us.zoom.sdk.ZoomSDK.getInMeetingService ( )

inline

Gets the in-meeting service instance.

Returns: If the function succeeds, it returns the shared instance of InMeetingService. Otherwise, this function fails and returns null if the SDK has not been initialized successfully.

Definition at line 305 of file ZoomSDK.java.

                                                  {
        return mZoomSDKImpl.getInMeetingService();
    }

References mZoomSDKImpl.

Referenced by us.zoom.sdk.MobileRTCVideoView.init(), and us.zoom.sdk.MobileRTCVideoView.initActivity().

◆ getInstance()

ZoomSDK us.zoom.sdk.ZoomSDK.getInstance ( )

inlinestatic

Gets a shared instance of Zoom SDK. Must call from the main thread.

Returns: If the function succeeds, it returns the Zoom SDK instance. Otherwise, this function fails and returns null.

Definition at line 25 of file ZoomSDK.java.

                                        {
        if (instance == null) {
            synchronized (ZoomSDK.class) {
                if (instance == null) {
                    instance = new ZoomSDK();
                }
            }
        }
        return instance;
    }

References instance, and ZoomSDK().

Referenced by us.zoom.sdk.MobileRTCVideoView.init(), us.zoom.sdk.MobileRTCVideoView.initActivity(), and us.zoom.sdk.ZoomSDKRenderer.subscribe().

◆ getMeetingService()

MeetingService us.zoom.sdk.ZoomSDK.getMeetingService ( )

inline

Gets the instance of meeting service.

Returns: If the function succeeds, it returns the shared instance of MeetingService. Otherwise, this function fails and returns null if the SDK has not been initialized successfully.

Definition at line 266 of file ZoomSDK.java.

                                              {
        return mZoomSDKImpl.getMeetingService();
    }

References mZoomSDKImpl.

Referenced by us.zoom.sdk.ZoomSDKRenderer.subscribe().

◆ getMeetingSettingsHelper()

MeetingSettingsHelper us.zoom.sdk.ZoomSDK.getMeetingSettingsHelper ( )

inline

Gets the meeting settings helper instance.

Returns: If the function succeeds, it returns the shared instance of MeetingSettingsHelper. Otherwise, this function fails and returns null if the SDK has not been initialized successfully.

Definition at line 323 of file ZoomSDK.java.

                                                            {
        return mZoomSDKImpl.getMeetingSettingsHelper();
    }

References mZoomSDKImpl.

◆ getNotificationServiceHelper()

INotificationServiceHelper us.zoom.sdk.ZoomSDK.getNotificationServiceHelper ( )

inline

Gets the notification service helper interface.

Returns: If the function succeeds, it returns the shared instance of INotificationServiceHelper. Otherwise, this function fails and returns null.

Definition at line 350 of file ZoomSDK.java.

                                                                     {
        return mZoomSDKImpl.getNotificationServiceHelper();
    }

References mZoomSDKImpl.

◆ getPreMeetingService()

PreMeetingService us.zoom.sdk.ZoomSDK.getPreMeetingService ( )

inline

Gets the pre-meeting service instance.

Returns: If the function succeeds, it returns the shared instance of PreMeetingService. Otherwise, this function fails and returns null if the SDK has not been initialized successfully or the user did not log in.

Definition at line 296 of file ZoomSDK.java.

                                                    {
        return mZoomSDKImpl.getPreMeetingService();
    }

References mZoomSDKImpl.

◆ getReminderHelper()

IReminderHelper us.zoom.sdk.ZoomSDK.getReminderHelper ( )

inline

Gets the reminder helper interface.

Returns: If the function succeeds, it returns the shared instance of IReminderHelper. Otherwise, this function fails and returns null if the SDK has not been successfully initialized.

Definition at line 341 of file ZoomSDK.java.

                                               {
        return mZoomSDKImpl.getReminderHelper();
    }

References mZoomSDKImpl.

◆ getSdkLocale()

Locale us.zoom.sdk.ZoomSDK.getSdkLocale ( Context context )

inline

Gets the current Zoom SDK locale configuration.

Parameters

context Android context.

Returns: If the function succeeds, it returns the current Zoom SDK locale configuration. Otherwise, this function fails and returns null.

Definition at line 248 of file ZoomSDK.java.

                                                {
        return mZoomSDKImpl.getSdkLocale(context);
    }

References mZoomSDKImpl.

◆ getShareSourceHelper()

ZoomSDKShareSourceHelper us.zoom.sdk.ZoomSDK.getShareSourceHelper ( )

inline

Gets the share source helper.

Returns: If the function succeeds, it returns the share source helper. Otherwise, this function fails and returns null.

Definition at line 59 of file ZoomSDK.java.

                                                           {
        return mZoomSDKImpl.getShareSourceHelper();
    }

References mZoomSDKImpl.

◆ getSmsService()

SmsService us.zoom.sdk.ZoomSDK.getSmsService ( )

inline

Gets SMS service for real name authentication for Chinese users.

Returns: If the function succeeds, it returns the SMS service. Otherwise, this function fails and returns null.

Definition at line 275 of file ZoomSDK.java.

                                      {
        return mZoomSDKImpl.getSmsService();
    }

References mZoomSDKImpl.

◆ getVersion()

String us.zoom.sdk.ZoomSDK.getVersion ( Context context )

inline

Gets the Zoom SDK version on Android.

Parameters

context Android context.

Returns: If the function succeeds, it returns the Zoom SDK version. Otherwise, this function fails and returns null.

Definition at line 134 of file ZoomSDK.java.

                                              {
        return mZoomSDKImpl.getVersion(context);
    }

References mZoomSDKImpl.

◆ getVideoSourceHelper()

ZoomSDKVideoSourceHelper us.zoom.sdk.ZoomSDK.getVideoSourceHelper ( )

inline

Gets the video source helper.

Returns: If the function succeeds, it returns the video source helper. Otherwise, this function fails and returns null.

Definition at line 50 of file ZoomSDK.java.

                                                           {
        return mZoomSDKImpl.getVideoSourceHelper();
    }

References mZoomSDKImpl.

◆ getZoomUIService()

ZoomUIService us.zoom.sdk.ZoomSDK.getZoomUIService ( )

inline

Gets the Zoom UI service instance.

Returns: If the function succeeds, it returns the shared instance of ZoomUIService. Otherwise, this function fails and returns null if the SDK has not been initialized successfully.

Definition at line 314 of file ZoomSDK.java.

                                            {
        return mZoomSDKImpl.getZoomUIService();
    }

References mZoomSDKImpl.

◆ handleSSOLoginURIProtocol()

boolean us.zoom.sdk.ZoomSDK.handleSSOLoginURIProtocol ( String uriProtocol )

inline

Logs in with the SSO login URI, link zoommtg://*.

Parameters

uriProtocol The SSO login URL, link zoommtg://*.

Returns: true if the function succeeds. Otherwise, false.

Definition at line 173 of file ZoomSDK.java.

                                                                 {
        return mZoomSDKImpl.handleSSOLoginURIProtocol(uriProtocol);
    }

References mZoomSDKImpl.

◆ hasRawDataLicense()

boolean us.zoom.sdk.ZoomSDK.hasRawDataLicense ( )

inline

Determines whether the SDK has a raw data license. Must call from the main thread.

Returns: true if the SDK has a raw data license. Otherwise, false.

Definition at line 41 of file ZoomSDK.java.

                                       {
        return mZoomSDKImpl.hasRawDataLicense();
    }

References mZoomSDKImpl.

◆ initialize()

void us.zoom.sdk.ZoomSDK.initialize	(	Context	context,
		ZoomSDKInitializeListener	listener,
		ZoomSDKInitParams	params )

inline

Initializes Zoom SDK.

Parameters

context	Android context.
listener	Listener for initialization result.
params	Initialization params. You can use JWT token to initialize.

Definition at line 106 of file ZoomSDK.java.

                                                                                                          {
        mZoomSDKImpl.initialize(context, listener, params);
    }

References mZoomSDKImpl.

◆ isDeviceSupported()

boolean us.zoom.sdk.ZoomSDK.isDeviceSupported ( Context context )

inline

Determines whether the current device is able to run the SDK.

Parameters

context Android context.

Returns: true if the device is able to run the SDK. Otherwise, false.

Definition at line 144 of file ZoomSDK.java.

                                                      {
        return mZoomSDKImpl.isDeviceSupported(context);
    }

References mZoomSDKImpl.

◆ isInitialized()

boolean us.zoom.sdk.ZoomSDK.isInitialized ( )

inline

Determines whether Zoom SDK has been initialized. Must call from the main thread.

Returns: true if the SDK has been initialized. Otherwise, false.

Definition at line 153 of file ZoomSDK.java.

                                   {
        return mZoomSDKImpl.isInitialized();
    }

References mZoomSDKImpl.

◆ isLoggedIn()

boolean us.zoom.sdk.ZoomSDK.isLoggedIn ( )

inline

Determines whether the Zoom user has logged in.

Note: This function is optional. Ignore it if you do not have the account of working email in Zoom.

Returns: true if the user has logged in. Otherwise, false.

Definition at line 196 of file ZoomSDK.java.

                                {
        return mZoomSDKImpl.isLoggedIn();
    }

References mZoomSDKImpl.

◆ logoutZoom()

boolean us.zoom.sdk.ZoomSDK.logoutZoom ( )

inline

Logs out Zoom SDK.

Note: This function is optional. Ignore it if you do not have the account of working email or SSO in Zoom.

Returns: true if the user can log out. Otherwise, false.

Definition at line 185 of file ZoomSDK.java.

                                {
        return mZoomSDKImpl.logoutZoom();
    }

References mZoomSDKImpl.

◆ registerNotificationService()

MobileRTCSDKError us.zoom.sdk.ZoomSDK.registerNotificationService ( String accessToken )

inline

Registers notification service.

Parameters

accessToken Initialization parameter of notification service.

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

Definition at line 369 of file ZoomSDK.java.

                                                                             {
        return mZoomSDKImpl.registerNotificationService(accessToken);
    }

References mZoomSDKImpl.

◆ removeAuthenticationListener()

void us.zoom.sdk.ZoomSDK.removeAuthenticationListener ( ZoomSDKAuthenticationListener listener )

inline

Unregisters the listener for the callback events of user authentication.

Parameters

listener The listener instance.

Definition at line 77 of file ZoomSDK.java.

                                                                                     {
        mZoomSDKImpl.removeAuthenticationListener(listener);
    }

References mZoomSDKImpl.

◆ removeNetworkConnectionListener()

void us.zoom.sdk.ZoomSDK.removeNetworkConnectionListener ( NetworkConnectionListener listener )

inline

Unregisters the listener for network connection events.

Parameters

listener The listener instance.

Definition at line 95 of file ZoomSDK.java.

                                                                                    {
        mZoomSDKImpl.removeNetworkConnectionListener(listener);
    }

References mZoomSDKImpl.

◆ setDomain()

boolean us.zoom.sdk.ZoomSDK.setDomain ( String domain )

inline

Sets a new web domain name. Must call from the main thread.

Parameters

domain Domain name to be set. Default value: zoom.us.

Returns: true if the function succeeds. Otherwise, false if the domain is not supported.

Definition at line 218 of file ZoomSDK.java.

                                            {
        return mZoomSDKImpl.setDomain(domain);
    }

References mZoomSDKImpl.

◆ setSdkLocale()

void us.zoom.sdk.ZoomSDK.setSdkLocale	(	Context	context,
		Locale	locale )

inline

Configures Zoom SDK locale.

Parameters

context	Android context.
locale	The locale object. The language item of the locale object cannot be null.

Definition at line 238 of file ZoomSDK.java.

                                                             {
        mZoomSDKImpl.setSdkLocale(context, locale);
    }

References mZoomSDKImpl.

◆ setShowProxyServerDialogImmediatelyIfNeeded()

void us.zoom.sdk.ZoomSDK.setShowProxyServerDialogImmediatelyIfNeeded ( boolean show )

inline

Sets whether to display the setting dialog of proxy server immediately when needed.

Parameters

show	true to show the proxy server dialog when needed, false otherwise.

Definition at line 257 of file ZoomSDK.java.

                                                                          {
        mZoomSDKImpl.setShowProxyServerDialogImmediatelyIfNeeded(show);
    }

References mZoomSDKImpl.

◆ switchDomain()

boolean us.zoom.sdk.ZoomSDK.switchDomain	(	String	newDomain,
		boolean	force )

inline

Switches the SDK domain.

Parameters

newDomain	The new domain.
force	true to force switch, false otherwise.

Returns: true if the function succeeds. Otherwise, false.

Definition at line 124 of file ZoomSDK.java.

                                                                 {
        return mZoomSDKImpl.switchDomain(newDomain, force);
    }

References mZoomSDKImpl.

◆ tryAutoLoginZoom()

int us.zoom.sdk.ZoomSDK.tryAutoLoginZoom ( )

inline

Logs in Zoom SDK automatically with local Zoom or SSO token once you have logged in successfully.

Note: This function is optional. Ignore it if you do not have the account of working email or SSO account in Zoom.

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

Definition at line 207 of file ZoomSDK.java.

                                  {
        return mZoomSDKImpl.tryAutoLoginZoom();
    }

References mZoomSDKImpl.

◆ uninitialize()

void us.zoom.sdk.ZoomSDK.uninitialize ( )

inline

Uninitializes Zoom SDK.

Definition at line 113 of file ZoomSDK.java.

                               {
        mZoomSDKImpl.uninitialize();
    }

References mZoomSDKImpl.

◆ unregisterNotificationService()

MobileRTCSDKError us.zoom.sdk.ZoomSDK.unregisterNotificationService ( )

inline

Unregisters notification service.

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

Definition at line 378 of file ZoomSDK.java.

                                                             {
        return mZoomSDKImpl.unRegisterNotificationService();
    }

References mZoomSDKImpl.

Field Documentation

◆ instance

volatile ZoomSDK us.zoom.sdk.ZoomSDK.instance

staticprivate

Definition at line 13 of file ZoomSDK.java.

Referenced by getInstance().

◆ mZoomSDKImpl

final ZoomSDKImpl us.zoom.sdk.ZoomSDK.mZoomSDKImpl

private

Definition at line 14 of file ZoomSDK.java.

Referenced by addAuthenticationListener(), addNetworkConnectionListener(), enableAutoRegisterNotificationServiceForLogin(), generateSSOLoginURL(), get3DAvatarSettings(), getAccountService(), getDomain(), getInMeetingService(), getMeetingService(), getMeetingSettingsHelper(), getNotificationServiceHelper(), getPreMeetingService(), getReminderHelper(), getSdkLocale(), getShareSourceHelper(), getSmsService(), getVersion(), getVideoSourceHelper(), getZoomUIService(), handleSSOLoginURIProtocol(), hasRawDataLicense(), initialize(), isDeviceSupported(), isInitialized(), isLoggedIn(), logoutZoom(), registerNotificationService(), removeAuthenticationListener(), removeNetworkConnectionListener(), setDomain(), setSdkLocale(), setShowProxyServerDialogImmediatelyIfNeeded(), switchDomain(), tryAutoLoginZoom(), uninitialize(), unregisterNotificationService(), and ZoomSDK().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZoomSDK()

Member Function Documentation

◆ addAuthenticationListener()

◆ addNetworkConnectionListener()

◆ enableAutoRegisterNotificationServiceForLogin()

◆ generateSSOLoginURL()

◆ get3DAvatarSettings()

◆ getAccountService()

◆ getDomain()

◆ getInMeetingService()

◆ getInstance()

◆ getMeetingService()

◆ getMeetingSettingsHelper()

◆ getNotificationServiceHelper()

◆ getPreMeetingService()

◆ getReminderHelper()

◆ getSdkLocale()

◆ getShareSourceHelper()

◆ getSmsService()

◆ getVersion()

◆ getVideoSourceHelper()

◆ getZoomUIService()

◆ handleSSOLoginURIProtocol()

◆ hasRawDataLicense()

◆ initialize()

◆ isDeviceSupported()

◆ isInitialized()

◆ isLoggedIn()

◆ logoutZoom()

◆ registerNotificationService()

◆ removeAuthenticationListener()

◆ removeNetworkConnectionListener()

◆ setDomain()

◆ setSdkLocale()

◆ setShowProxyServerDialogImmediatelyIfNeeded()

◆ switchDomain()

◆ tryAutoLoginZoom()

◆ uninitialize()

◆ unregisterNotificationService()

Field Documentation

◆ instance

◆ mZoomSDKImpl