us.zoom.sdk.ZoomSDK Class Reference

ZOOM SDK global manager. More...

Public Member Functions
boolean	hasRawDataLicense ()
	Query is has raw data license, must call from the main thread.
ZoomSDKVideoSourceHelper	getVideoSourceHelper ()
	Get video source helper.
ZoomSDKShareSourceHelper	getShareSourceHelper ()
	Get share source helper.
void	addAuthenticationListener (ZoomSDKAuthenticationListener listener)
	Register a listener for the callback events of user authentication.
void	removeAuthenticationListener (ZoomSDKAuthenticationListener listener)
	Unregister the listener for the callback events of user authentication.
void	addNetworkConnectionListener (NetworkConnectionListener listener)
	Register a listener to receive the NetworkConnectionHandler.
void	removeNetworkConnectionListener (NetworkConnectionListener listener)
	Unregister a listener for the callback event of user authentication.
void	initialize (Context context, ZoomSDKInitializeListener listener, ZoomSDKInitParams params)
void	uninitialize ()
	uninitialize Zoom SDK
boolean	switchDomain (String newDomain, boolean force)
	Call the method to switch sdk domain.
String	getVersion (Context context)
	Get ZOOM SDK version on Android.
boolean	isDeviceSupported (Context context)
	Query if the current device is able to run SDK.
boolean	isInitialized ()
	Query if ZOOM SDK has been initialized, must call from main thread.
String	generateSSOLoginURL (String ssoDomainPrefix)
	Get SSO login url By the domain prefix.
boolean	handleSSOLoginURIProtocol (String uriProtocol)
	Login with the SSO login uri, link zoommtg://*.
boolean	logoutZoom ()
	Logout ZOOM SDK. Note This function is optional, ignore it if you do not have the account of working email/SSO in ZOOM.
boolean	isLoggedIn ()
	Query if ZOOM user has logged in. Note This function is optional, ignore it if you do not have the account of working email in ZOOM.
int	tryAutoLoginZoom ()
	Login ZOOM SDK automatically with local ZOOM/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/SSO account in ZOOM.
boolean	setDomain (String domain)
	Set a new web domain name, must call from main thread.
String	getDomain ()
	Get current domain.
void	setSdkLocale (Context context, Locale locale)
	Configure ZOOM SDK locale.
Locale	getSdkLocale (Context context)
	Get current ZOOM SDK locale configuration.
void	setShowProxyServerDialogImmediatelyIfNeeded (boolean show)
	Set if display immediately the setting dialog of proxy server.
MeetingService	getMeetingService ()
	Get the instance of meeting service.
SmsService	getSmsService ()
	Get Sms Service for real name auth for chinese user.
AccountService	getAccountService ()
	Get account service instance.
PreMeetingService	getPreMeetingService ()
	Get preMeetingService instance.
InMeetingService	getInMeetingService ()
	Get InMeetingService instance.
ZoomUIService	getZoomUIService ()
	Get ZoomUIService instance.
MeetingSettingsHelper	getMeetingSettingsHelper ()
	Get MeetingSettingsHelper instance.
I3DAvatarSettingContext	get3DAvatarSettings ()
	Get 3D avatar settings interface.
IReminderHelper	getReminderHelper ()
	Get Reminder Helper interface;.
INotificationServiceHelper	getNotificationServiceHelper ()
	Get notification service helper interface.
void	enableAutoRegisterNotificationServiceForLogin (boolean enable)
	Enable or disable auto register notification service. This is enabled by default.
MobileRTCSDKError	registerNotificationService (String accessToken)
	Register notification service.
MobileRTCSDKError	unregisterNotificationService ()
	Unregister notification service.

Static Public Member Functions
static ZoomSDK	getInstance ()
	Get 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 us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

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

Member Function Documentation

addAuthenticationListener()

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

inline

Register 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 us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

addNetworkConnectionListener()

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

inline

Register a listener to receive the NetworkConnectionHandler.

Parameters

listener

The listener instance

Definition at line 86 of file ZoomSDK.java.

                                                                                 {
        mZoomSDKImpl.addNetworkConnectionListener(listener);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

enableAutoRegisterNotificationServiceForLogin()

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

inline

Enable or disable auto register notification service. This is enabled by default.

Parameters

enable

true means enabled, otherwise not.

Definition at line 348 of file ZoomSDK.java.

                                                                             {
        mZoomSDKImpl.enableAutoRegisterNotificationServiceForLogin(enable);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

generateSSOLoginURL()

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

inline

Get SSO login url By the domain prefix.

Parameters

ssoDomainPrefix

The domain prefix

Returns

result the SSO login url, null for error

Definition at line 159 of file ZoomSDK.java.

                                                              {
        return mZoomSDKImpl.generateSSOLoginURL(ssoDomainPrefix);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

get3DAvatarSettings()

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

inline

Get 3D avatar settings interface.

Returns

The shared instance of I3DAvatarSettingContext. It will return null if the SDK has not been initialized successfully.

Definition at line 323 of file ZoomSDK.java.

                                                         {
        return mZoomSDKImpl.get3DAvatarSettings();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getAccountService()

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

inline

Get account service instance.

Returns

The shared instance of account service. It will return null if the SDK has not been initialized successfully or the user didn't login.

Definition at line 278 of file ZoomSDK.java.

                                              {
        return mZoomSDKImpl.getAccountService();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getDomain()

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

inline

Get current domain.

Returns

current The current domain.

Definition at line 220 of file ZoomSDK.java.

                              {
        return mZoomSDKImpl.getDomain();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getInMeetingService()

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

inline

Get InMeetingService instance.

Returns

The shared instance of InMeetingService. It will return null if the SDK has not been initialized successfully.

Definition at line 296 of file ZoomSDK.java.

                                                  {
        return mZoomSDKImpl.getInMeetingService();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

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

getInstance()

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

inlinestatic

Get a shared instance of ZOOM SDK, must call from the main thread.

Returns

The ZOOM SDK instance.

Definition at line 25 of file ZoomSDK.java.

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

References us.zoom.sdk.ZoomSDK.instance, and us.zoom.sdk.ZoomSDK.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

Get the instance of meeting service.

Returns

The shared instance of MeetingService. Return null if the SDK has not been initialized successfully.

Definition at line 259 of file ZoomSDK.java.

                                              {
        return mZoomSDKImpl.getMeetingService();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

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

getMeetingSettingsHelper()

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

inline

Get MeetingSettingsHelper instance.

Returns

The shared instance of MeetingSettingsHelper. It will return null if the SDK has not been initialized successfully.

Definition at line 314 of file ZoomSDK.java.

                                                            {
        return mZoomSDKImpl.getMeetingSettingsHelper();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getNotificationServiceHelper()

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

inline

Get notification service helper interface.

Returns

The shared instance of INotificationServiceHelper

Definition at line 340 of file ZoomSDK.java.

                                                                     {
        return mZoomSDKImpl.getNotificationServiceHelper();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getPreMeetingService()

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

inline

Get preMeetingService instance.

Returns

The shared instance of PreMeetingService. It will return null if the SDK has not been initialized successfully or the user didn't login.

Definition at line 287 of file ZoomSDK.java.

                                                    {
        return mZoomSDKImpl.getPreMeetingService();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getReminderHelper()

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

inline

Get Reminder Helper interface;.

Returns

The shared instance of IReminderHelper. If the SDK has’t been successfully initialized, it returns null.

Definition at line 331 of file ZoomSDK.java.

                                               {
        return mZoomSDKImpl.getReminderHelper();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getSdkLocale()

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

inline

Get current ZOOM SDK locale configuration.

Parameters

context

Android context.

Returns

Current ZOOM SDK locale configuration.

Definition at line 241 of file ZoomSDK.java.

                                                {
        return mZoomSDKImpl.getSdkLocale(context);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getShareSourceHelper()

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

inline

Get share source helper.

Returns

share source helper

Definition at line 59 of file ZoomSDK.java.

                                                           {
        return mZoomSDKImpl.getShareSourceHelper();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getSmsService()

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

inline

Get Sms Service for real name auth for chinese user.

Returns

SmsService SmsService

Definition at line 268 of file ZoomSDK.java.

                                      {
        return mZoomSDKImpl.getSmsService();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getVersion()

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

inline

Get ZOOM SDK version on Android.

Returns

ZOOM SDK version

Definition at line 131 of file ZoomSDK.java.

                                              {
        return mZoomSDKImpl.getVersion(context);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getVideoSourceHelper()

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

inline

Get video source helper.

Returns

video source helper

Definition at line 50 of file ZoomSDK.java.

                                                           {
        return mZoomSDKImpl.getVideoSourceHelper();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

getZoomUIService()

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

inline

Get ZoomUIService instance.

Returns

The shared instance of ZoomUIService. It will return null if the SDK has not been initialized successfully.

Definition at line 305 of file ZoomSDK.java.

                                            {
        return mZoomSDKImpl.getZoomUIService();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

handleSSOLoginURIProtocol()

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

inline

Login with the SSO login uri, link zoommtg://*.

Parameters

uriProtocol

the sso login url, link zoommtg://*

Returns

true for success, false for fail

Definition at line 169 of file ZoomSDK.java.

                                                                 {
        return mZoomSDKImpl.handleSSOLoginURIProtocol(uriProtocol);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

hasRawDataLicense()

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

inline

Query is has raw data license, must call from the main thread.

Returns

raw data license

Definition at line 41 of file ZoomSDK.java.

                                       {
        return mZoomSDKImpl.hasRawDataLicense();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

initialize()

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

inline

Parameters

context	Android context
listener	Listener for initialization result.
params	Init params. you can use jwtToken to initialize

Definition at line 104 of file ZoomSDK.java.

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

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

isDeviceSupported()

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

inline

Query if the current device is able to run SDK.

Returns

TRUE means able, otherwise not.

Definition at line 140 of file ZoomSDK.java.

                                                      {
        return mZoomSDKImpl.isDeviceSupported(context);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

isInitialized()

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

inline

Query if ZOOM SDK has been initialized, must call from main thread.

Returns

TRUE means initialized. Otherwise not.

Definition at line 149 of file ZoomSDK.java.

                                   {
        return mZoomSDKImpl.isInitialized();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

isLoggedIn()

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

inline

Query if 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 means that the user has logged in. Otherwise not.

Definition at line 190 of file ZoomSDK.java.

                                {
        return mZoomSDKImpl.isLoggedIn();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

logoutZoom()

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

inline

Logout ZOOM SDK. Note This function is optional, ignore it if you do not have the account of working email/SSO in ZOOM.

Returns

TRUE means that the user can logout. Otherwise not.

Definition at line 180 of file ZoomSDK.java.

                                {
        return mZoomSDKImpl.logoutZoom();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

registerNotificationService()

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

inline

Register notification service.

Parameters

accessToken

Initialize parameter of notification service.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

Definition at line 358 of file ZoomSDK.java.

                                                                             {
        return mZoomSDKImpl.registerNotificationService(accessToken);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

removeAuthenticationListener()

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

inline

Unregister 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 us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

removeNetworkConnectionListener()

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

inline

Unregister a listener for the callback event of user authentication.

Parameters

listener

The listener instance.

Definition at line 95 of file ZoomSDK.java.

                                                                                    {
        mZoomSDKImpl.removeNetworkConnectionListener(listener);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

setDomain()

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

inline

Set a new web domain name, must call from main thread.

Parameters

domain

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

Returns

true means success, false means fail for not support domain.

Definition at line 211 of file ZoomSDK.java.

                                            {
        return mZoomSDKImpl.setDomain(domain);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

setSdkLocale()

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

inline

Configure ZOOM SDK locale.

Parameters

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

Definition at line 231 of file ZoomSDK.java.

                                                             {
        mZoomSDKImpl.setSdkLocale(context, locale);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

setShowProxyServerDialogImmediatelyIfNeeded()

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

inline

Set if display immediately the setting dialog of proxy server.

Parameters

show	TRUE means to show proxy server dialog when needed. FALSE not.

Definition at line 250 of file ZoomSDK.java.

                                                                          {
        mZoomSDKImpl.setShowProxyServerDialogImmediatelyIfNeeded(show);
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

switchDomain()

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

inline

Call the method to switch sdk domain.

Parameters

newDomain	The new domain.
force	true:force switch

Returns

true indicates successfully. Otherwise not.

Definition at line 122 of file ZoomSDK.java.

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

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

tryAutoLoginZoom()

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

inline

Login ZOOM SDK automatically with local ZOOM/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/SSO account in ZOOM.

Returns

Login ZOOM successfully or not. See ZoomApiError.

Definition at line 200 of file ZoomSDK.java.

                                  {
        return mZoomSDKImpl.tryAutoLoginZoom();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

uninitialize()

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

inline

uninitialize Zoom SDK

Definition at line 111 of file ZoomSDK.java.

                               {
        mZoomSDKImpl.uninitialize();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

unregisterNotificationService()

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

inline

Unregister notification service.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

Definition at line 367 of file ZoomSDK.java.

                                                             {
        return mZoomSDKImpl.unRegisterNotificationService();
    }

References us.zoom.sdk.ZoomSDK.mZoomSDKImpl.

Field Documentation

instance

volatile ZoomSDK us.zoom.sdk.ZoomSDK.instance

staticprivate

Definition at line 13 of file ZoomSDK.java.

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

mZoomSDKImpl

final ZoomSDKImpl us.zoom.sdk.ZoomSDK.mZoomSDKImpl

private

Definition at line 14 of file ZoomSDK.java.

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