ZMVideoSDK Class Reference

Zoom Video SDK API manager. Main singleton object that controls the video session creation, event callbacks and other main features of video SDK. ZoomVideoSDK#initialize(Context, ZoomVideoSDKInitParams). More...

Public Member Functions
void	Initialize (ZMVideoSDKInitParams zmVideoSDKInitParams, Action< ZMVideoSDKErrors > callback)
	Initialize the Zoom Video SDK with the appropriate parameters in the ZMVideoSDKInitParams structure.
void	CleanUp (Action< ZMVideoSDKErrors > callback)
	Clean up ZOOM Video SDK.
void	AddListener (IZMVideoSDKDelegate videoSDKDelegate)
	Add a listener for session events.
void	RemoveListener (IZMVideoSDKDelegate videoSDKDelegate)
	Remove a listener for session events.
void	JoinSession (ZMVideoSDKSessionContext zmVideoSDKSessionContext, Action< ZMVideoSDKErrors > callback)
	Call this method to join a session with the appropriate ZMVideoSDKSessionContext parameters. When seccessful, the SDK will attempt to join a session. Use the callbacks in the listener to confirm whether the SDK actually joined.
void	LeaveSession (bool end, Action< ZMVideoSDKErrors > callback)
	Call this method to leave a session previously joined through joinSession method call. When successful, the SDK will attempt to leave a session. Use the callbacks in the listener to confirm whether the SDK actually left.
ZMVideoSDKSession	GetSessionInfo ()
	Returns the current session information.
bool	IsInSession ()
	Check if there is an active session between participants.
string	GetSDKVersion ()
	Returns the sdk version.
ZMVideoSDKAudioHelper	GetAudioHelper ()
	Returns an instance to manage audio controls related to the current video SDK session.
ZMVideoSDKVideoHelper	GetVideoHelper ()
	Returns an instance to manage cameras and video during a video SDK session.
ZMVideoSDKUserHelper	GetUserHelper ()
	Returns an instance to manage cameras and video during a video SDK session.
ZMVideoSDKChatHelper	GetChatHelper ()
	Returns an instance to send and receive chat messages within video SDK session participants.
ZMVideoSDKRecordingHelper	GetRecordingHelper ()
ZMVideoSDKShareHelper	GetShareHelper ()

Properties
static ZMVideoSDK	Instance [get]

Private Member Functions
	ZMVideoSDK ()

Static Private Member Functions
static	ZMVideoSDK ()

Static Private Attributes
static readonly ZMVideoSDK	instance = new ZMVideoSDK()

Detailed Description

Zoom Video SDK API manager. Main singleton object that controls the video session creation, event callbacks and other main features of video SDK. ZoomVideoSDK#initialize(Context, ZoomVideoSDKInitParams).

Definition at line 8 of file ZMVideoSDK.cs.

Constructor & Destructor Documentation

ZMVideoSDK() [1/2]

static ZMVideoSDK.ZMVideoSDK ( )

inlinestaticprivate

Definition at line 21 of file ZMVideoSDK.cs.

    {
    }

ZMVideoSDK() [2/2]

ZMVideoSDK.ZMVideoSDK ( )

inlineprivate

Definition at line 25 of file ZMVideoSDK.cs.

    {
#if UNITY_STANDALONE_OSX
        _videoSDK = MacZMVideoSDK.Instance;
#elif UNITY_ANDROID
        _videoSDK = AndroidZoomVideoSDK.Instance;
#elif UNITY_IOS
        _videoSDK = IOSZMVideoSDK.Instance;
#elif UNITY_STANDALONE_WIN
        _videoSDK = WindowsZoomVideoSDK.Instance;
#else
        Debug.Log("Platform not supported.");
#endif
    }

Member Function Documentation

AddListener()

void ZMVideoSDK.AddListener ( IZMVideoSDKDelegate  videoSDKDelegate )

inline

Add a listener for session events.

Parameters

videoSDKDelegate

A listener class that groups together all the callbacks related to a session.

Definition at line 69 of file ZMVideoSDK.cs.

    {
        _videoSDK.AddListener(videoSDKDelegate);
    }

CleanUp()

void ZMVideoSDK.CleanUp ( Action< ZMVideoSDKErrors >  callback )

inline

Clean up ZOOM Video SDK.

Parameters

[out]

callback

a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 60 of file ZMVideoSDK.cs.

    {
        _videoSDK.Cleanup(callback);
    }

GetAudioHelper()

ZMVideoSDKAudioHelper ZMVideoSDK.GetAudioHelper ( )

inline

Returns an instance to manage audio controls related to the current video SDK session.

Returns

If the function succeeds, the return value is the audio helper object. Otherwise returns NULL. For more details, see ZMVideoSDKAudioHelper.

Definition at line 142 of file ZMVideoSDK.cs.

    {
        ZMVideoSDKAudioHelper helper = _videoSDK.GetAudioHelper();
        if (helper == null)
        {
            throw new NullReferenceException("GetAudioHelper returns null");
        }
        return helper;
    }

GetChatHelper()

ZMVideoSDKChatHelper ZMVideoSDK.GetChatHelper ( )

inline

Returns an instance to send and receive chat messages within video SDK session participants.

Returns

If the function succeeds, the return value is the chat helper object. Otherwise returns NULL. For more details, see ZMVideoSDKChatHelper.

Definition at line 184 of file ZMVideoSDK.cs.

    {
        ZMVideoSDKChatHelper helper = _videoSDK.GetChatHelper();
        if (helper == null)
        {
            throw new NullReferenceException("GetChatHelper returns null");
        }
        return helper;
    }

GetRecordingHelper()

ZMVideoSDKRecordingHelper ZMVideoSDK.GetRecordingHelper ( )

inline

Returns an instance to manage cloud recordings during a video SDK session.

Returns

A ZMVideoSDKRecordingHelper instance.

Definition at line 199 of file ZMVideoSDK.cs.

    {
        ZMVideoSDKRecordingHelper helper = _videoSDK.GetRecordingHelper();
        if (helper == null)
        {
            throw new NullReferenceException("GetRecordingHelper returns null");
        }
        return helper;
    }

GetSDKVersion()

string ZMVideoSDK.GetSDKVersion ( )

inline

Returns the sdk version.

Returns

If the function succeeds, the return value is sdk version. Otherwise returns NULL.

Definition at line 133 of file ZMVideoSDK.cs.

    {
        return _videoSDK.GetSdkVersion();
    }

GetSessionInfo()

ZMVideoSDKSession ZMVideoSDK.GetSessionInfo ( )

inline

Returns the current session information.

Returns

If the function succeeds, the return value is the pointer to ZMVideoSDKSession object. Otherwise NULL.

Definition at line 110 of file ZMVideoSDK.cs.

    {
        ZMVideoSDKSession info = _videoSDK.GetSessionInfo();
        if (info == null)
        {
            throw new NullReferenceException("GetSessionInfo returns null");
        }
        return info;
    }

GetShareHelper()

ZMVideoSDKShareHelper ZMVideoSDK.GetShareHelper ( )

inline

Returns an instance to manage screen sharing during a video SDK session.

Returns

ZoomVideoSDKShareHelper

Definition at line 213 of file ZMVideoSDK.cs.

    {
        ZMVideoSDKShareHelper helper = _videoSDK.GetShareHelper();
        if (helper == null)
        {
            throw new NullReferenceException("GetShareHelper returns null");
        }
        return helper;
    }

GetUserHelper()

ZMVideoSDKUserHelper ZMVideoSDK.GetUserHelper ( )

inline

Returns an instance to manage cameras and video during a video SDK session.

Returns

If the function succeeds, the return value is the video helper object. Otherwise returns NULL. For more details, see ZMVideoSDKUserHelper.

Definition at line 170 of file ZMVideoSDK.cs.

    {
        ZMVideoSDKUserHelper helper = _videoSDK.GetUserHelper();
        if (helper == null)
        {
            throw new NullReferenceException("GetUserHelper returns null");
        }
        return helper;
    }

GetVideoHelper()

ZMVideoSDKVideoHelper ZMVideoSDK.GetVideoHelper ( )

inline

Returns an instance to manage cameras and video during a video SDK session.

Returns

If the function succeeds, the return value is the video helper object. Otherwise returns NULL. For more details, see ZMVideoSDKVideoHelper.

Definition at line 156 of file ZMVideoSDK.cs.

    {
        ZMVideoSDKVideoHelper helper = _videoSDK.GetVideoHelper();
        if (helper == null)
        {
            throw new NullReferenceException("GetVideoHelper returns null");
        }
        return helper;
    }

Initialize()

void ZMVideoSDK.Initialize ( ZMVideoSDKInitParams  zmVideoSDKInitParams, Action< ZMVideoSDKErrors >  callback  )

inline

Initialize the Zoom Video SDK with the appropriate parameters in the ZMVideoSDKInitParams structure.

Parameters

[out]	zmVideoSDKInitParams	Parameters for init zoom video sdk. For more details, see ZMVideoSDKInitParams structure.
[out]	callback	a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 52 of file ZMVideoSDK.cs.

    {
        _videoSDK.Initialize(zmVideoSDKInitParams, callback);
    }

IsInSession()

bool ZMVideoSDK.IsInSession ( )

inline

Check if there is an active session between participants.

Returns

True if there is; False if not

Definition at line 124 of file ZMVideoSDK.cs.

    {
        return _videoSDK.IsInSession();
    }

JoinSession()

void ZMVideoSDK.JoinSession ( ZMVideoSDKSessionContext  zmVideoSDKSessionContext, Action< ZMVideoSDKErrors >  callback  )

inline

Call this method to join a session with the appropriate ZMVideoSDKSessionContext parameters. When seccessful, the SDK will attempt to join a session. Use the callbacks in the listener to confirm whether the SDK actually joined.

Parameters

[out]	zmVideoSDKSessionContext	The parameter is used to join session. For more details, see ZMVideoSDKSessionContext structure.
[out]	callback	a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 89 of file ZMVideoSDK.cs.

    {
        _videoSDK.JoinSession(zmVideoSDKSessionContext, callback);
    }

LeaveSession()

void ZMVideoSDK.LeaveSession ( bool  end, Action< ZMVideoSDKErrors >  callback  )

inline

Call this method to leave a session previously joined through joinSession method call. When successful, the SDK will attempt to leave a session. Use the callbacks in the listener to confirm whether the SDK actually left.

Parameters

[out]	end	True if the host should end the entire session, or False if the host should just leave the session.
[out]	callback	a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 100 of file ZMVideoSDK.cs.

    {
        _videoSDK.LeaveSession(end, callback);
    }

RemoveListener()

void ZMVideoSDK.RemoveListener ( IZMVideoSDKDelegate  videoSDKDelegate )

inline

Remove a listener for session events.

Parameters

videoSDKDelegate

A listener class that groups together all the callbacks related to a session.

Definition at line 78 of file ZMVideoSDK.cs.

    {
        _videoSDK.RemoveListener(videoSDKDelegate);
    }

Field Documentation

instance

readonly ZMVideoSDK ZMVideoSDK.instance = new ZMVideoSDK()

staticprivate

Definition at line 10 of file ZMVideoSDK.cs.

Property Documentation

Instance

ZMVideoSDK ZMVideoSDK.Instance

staticget

Definition at line 39 of file ZMVideoSDK.cs.

    {
        get
        {
            return instance;
        }
    }