ZMVideoSDKUser Class Reference

Zoom Video SDK user information. More...

Public Member Functions
string	GetUserID ()
	Get the user's id.
string	GetCustomIdentity ()
	Get the user's custom id.
string	GetUserName ()
	Get the user's name.
ZMVideoSDKAudioStatus	GetAudioStatus ()
	Get the user's audio status.
bool	IsHost ()
	Determine whether the user is the host.
bool	IsManager ()
	Determine whether the user is the manager(coHost)
ZMVideoSDKVideoStatisticInfo	GetVideoStatisticInfo ()
	Get the user's video statistic information.
ZMVideoSDKRawDataPipe	GetVideoPipe ()
	Get the user's video raw data pipe.
bool	SetUserVolume (float volume, bool isSharingAudio)
	Set the user's local volume. This does not affect how other participants hear the user.
float	GetUserVolume (bool isSharingAudio)
	Get user volume.
bool	CanSetUserVolume (bool isShareAudio)
	Determine which audio you can set, shared audio or microphone.
bool	HasIndividualRecordingConsent ()
	Used to determine whether I agree to individual video recording.
ZMVideoSDKRawDataPipe	GetSharePipe ()

Detailed Description

Zoom Video SDK user information.

Definition at line 8 of file ZMVideoSDKUser.cs.

Member Function Documentation

CanSetUserVolume()

bool ZMVideoSDKUser.CanSetUserVolume ( bool  isShareAudio )

inline

Determine which audio you can set, shared audio or microphone.

Parameters

isShareAudio

If true, checks whether you can set the volume of shared audio, otherwise you can set the volume of the microphone.

Returns

return true if the volume of the user can be set, otherwise false.

Definition at line 154 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.CanSetUserVolume(isShareAudio);
    }

GetAudioStatus()

ZMVideoSDKAudioStatus ZMVideoSDKUser.GetAudioStatus ( )

inline

Get the user's audio status.

Returns

Audio status of the user object.

Definition at line 83 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.GetAudioStatus();
    }

GetCustomIdentity()

string ZMVideoSDKUser.GetCustomIdentity ( )

inline

Get the user's custom id.

Returns

The Custom id of the user object.

Definition at line 65 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.GetCustomIdentity();
    }

GetSharePipe()

ZMVideoSDKRawDataPipe ZMVideoSDKUser.GetSharePipe ( )

inline

Get the user's share pipe.

Returns

share pipe. For more information, see ZoomVideoSDKRawDataPipe.

Definition at line 173 of file ZMVideoSDKUser.cs.

    {
        ZMVideoSDKRawDataPipe pipe = _videoSDKUser.GetSharePipe();
        if (pipe == null)
        {
            throw new NullReferenceException("GetSharePipe returns null");
        }
        return pipe;
    }

GetUserID()

string ZMVideoSDKUser.GetUserID ( )

inline

Get the user's id.

Returns

The user id of the user object.

Definition at line 56 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.GetUserID();
    }

GetUserName()

string ZMVideoSDKUser.GetUserName ( )

inline

Get the user's name.

Returns

The name of the user object.

Definition at line 74 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.GetUserName();
    }

GetUserVolume()

float ZMVideoSDKUser.GetUserVolume ( bool  isSharingAudio )

inline

Get user volume.

Parameters

isSharingAudio

If true, gets the volume of shared audio(such as shared computer audio), otherwise gets the volume of the microphone.

Returns

return the volume of the user.

Definition at line 144 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.GetUserVolume(isSharingAudio);
    }

GetVideoPipe()

ZMVideoSDKRawDataPipe ZMVideoSDKUser.GetVideoPipe ( )

inline

Get the user's video raw data pipe.

Returns

The video pipe. For more information, see ZMVideoSDKRawDataPipe

Definition at line 119 of file ZMVideoSDKUser.cs.

    {
        ZMVideoSDKRawDataPipe pipe = _videoSDKUser.GetVideoPipe();
        if (pipe == null)
        {
            throw new NullReferenceException("GetVideoPipe returns null");
        }
        return pipe;
    }

GetVideoStatisticInfo()

ZMVideoSDKVideoStatisticInfo ZMVideoSDKUser.GetVideoStatisticInfo ( )

inline

Get the user's video statistic information.

Returns

The video statistic information. For more information, see ZMVideoSDKVideoStatisticInfo

Definition at line 110 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.GetVideoStatisticInfo();
    }

HasIndividualRecordingConsent()

bool ZMVideoSDKUser.HasIndividualRecordingConsent ( )

inline

Used to determine whether I agree to individual video recording.

Returns

If agreed return true, otherwise false.

Definition at line 163 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.HasIndividualRecordingConsent();
    }

IsHost()

bool ZMVideoSDKUser.IsHost ( )

inline

Determine whether the user is the host.

Returns

True indicates that the user is the host, otherwise false.

Definition at line 92 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.IsHost();
    }

IsManager()

bool ZMVideoSDKUser.IsManager ( )

inline

Determine whether the user is the manager(coHost)

Returns

True indicates that the user is the manager(coHost), otherwise false.

Definition at line 101 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.IsManager();
    }

SetUserVolume()

bool ZMVideoSDKUser.SetUserVolume ( float  volume, bool  isSharingAudio  )

inline

Set the user's local volume. This does not affect how other participants hear the user.

Parameters

volume	The value can be >= 0 and <=10. If volume is 0, you won't be able to hear the related audio.
isSharingAudio	If true, sets the volume of shared audio(such as shared computer audio), otherwise sets the volume of microphone.

Returns

If success return true, otherwise false.

Definition at line 134 of file ZMVideoSDKUser.cs.

    {
        return _videoSDKUser.SetUserVolume(volume, isSharingAudio);
    }