ZMVideoSDKSession Class Reference

Session instance object See ZMVideoSDK#JoinSession(ZMVideoSDKSessionContext). More...

Public Member Functions
ulong	GetSessionNumber ()
	Get the current session number.
string	GetSessionName ()
	Get the session name.
string	GetSessionPassword ()
	Get the session's password.
string	GetSessionPhonePasscode ()
	Get the session phone passcode.
string	GetSessionID ()
	Get the session ID.
string	GetSessionHostName ()
	Get the host's name.
ZMVideoSDKUser	GetSessionHost ()
	Get the session's host user object.
List< ZMVideoSDKUser >	GetRemoteUsers ()
	Get a list of the session's remote users.
ZMVideoSDKUser	GetMySelf ()
	Get the session's user object for myself.
ZMVideoSDKSessionAudioStatisticInfo	GetSessionAudioStatisticInfo ()
	Get session's audio statistic information.
ZMVideoSDKSessionASVStatisticInfo	GetSessionVideoStatisticInfo ()
	Get session's Video statistic information.
ZMVideoSDKSessionASVStatisticInfo	GetSessionShareStatisticInfo ()
	Get session's Video statistic information.

Detailed Description

Session instance object See ZMVideoSDK#JoinSession(ZMVideoSDKSessionContext).

Definition at line 7 of file ZMVideoSDKSession.cs.

Member Function Documentation

GetMySelf()

ZMVideoSDKUser ZMVideoSDKSession.GetMySelf ( )

inline

Get the session's user object for myself.

Returns

If the function succeeds, the return value is myself object. Otherwise returns NULL.

Definition at line 112 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetMySelf();
    }

GetRemoteUsers()

List< ZMVideoSDKUser > ZMVideoSDKSession.GetRemoteUsers ( )

inline

Get a list of the session's remote users.

Returns

If the function succeeds, the return value is remote users list. Otherwise returns NULL.

Definition at line 103 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetRemoteUsers();
    }

GetSessionAudioStatisticInfo()

ZMVideoSDKSessionAudioStatisticInfo ZMVideoSDKSession.GetSessionAudioStatisticInfo ( )

inline

Get session's audio statistic information.

Returns

If the function succeeds, the return value is audio statistic info object. Otherwise returns NULL.

Definition at line 121 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionAudioStatisticInfo();
    }

GetSessionHost()

ZMVideoSDKUser ZMVideoSDKSession.GetSessionHost ( )

inline

Get the session's host user object.

Returns

If the function succeeds, the return value is session host user object. Otherwise returns NULL.

Definition at line 94 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionHost();
    }

GetSessionHostName()

string ZMVideoSDKSession.GetSessionHostName ( )

inline

Get the host's name.

Returns

If the function succeeds, the return value is session host name. Otherwise returns NULL.

Definition at line 85 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionHostName();
    }

GetSessionID()

string ZMVideoSDKSession.GetSessionID ( )

inline

Get the session ID.

Returns

If the function succeeds, the return value is session ID. Otherwise returns NULL.

Remarks

This interface is only valid for the host.

Definition at line 76 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionID();
    }

GetSessionName()

string ZMVideoSDKSession.GetSessionName ( )

inline

Get the session name.

Returns

If the function succeeds, the return value is session name. Otherwise returns NULL.

Definition at line 48 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionName();
    }

GetSessionNumber()

ulong ZMVideoSDKSession.GetSessionNumber ( )

inline

Get the current session number.

Returns

If the function succeeds, the return value is the current session number. Otherwise returns ZERO(0).

Definition at line 39 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionNumber();
    }

GetSessionPassword()

string ZMVideoSDKSession.GetSessionPassword ( )

inline

Get the session's password.

Returns

If the function succeeds, the return value is session password. Otherwise returns NULL.

Definition at line 57 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionPassword();
    }

GetSessionPhonePasscode()

string ZMVideoSDKSession.GetSessionPhonePasscode ( )

inline

Get the session phone passcode.

Returns

If the function succeeds, the return value is session phone passcode. Otherwise returns NULL.

Definition at line 66 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionPhonePasscode();
    }

GetSessionShareStatisticInfo()

ZMVideoSDKSessionASVStatisticInfo ZMVideoSDKSession.GetSessionShareStatisticInfo ( )

inline

Get session's Video statistic information.

Returns

If the function succeeds, the return value is session share statistic info object. Otherwise returns NULL.

Definition at line 139 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionShareStatisticInfo();
    }

GetSessionVideoStatisticInfo()

ZMVideoSDKSessionASVStatisticInfo ZMVideoSDKSession.GetSessionVideoStatisticInfo ( )

inline

Get session's Video statistic information.

Returns

If the function succeeds, the return value is session video statistic info object. Otherwise returns NULL.

Definition at line 130 of file ZMVideoSDKSession.cs.

    {
        return _videoSDKSession.GetSessionVideoStatisticInfo();
    }