ZMVideoSDKUser Class Reference

Zoom Video SDK user information. More...

#include <ZMVideoSDKUserHelper.h>

Inherits NSObject.

Instance Methods
(NSString *_Nullable)	- getUserID
	Get the user's id.
(NSString *_Nullable)	- getCustomIdentity
	Get the user's custom identity.
(NSString *_Nullable)	- getUserName
	Get the name of the user in the session.
(NSString *_Nullable)	- getUserReference
	Get the user's reference.
(ZMVideoSDKAudioStatus *_Nullable)	- 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.
(ZMVideoSDKVideoStatisticInfo *_Nullable)	- getVideoStatisticInfo
	Get the user's video statistic information.
(ZMVideoSDKShareStatisticInfo *_Nullable)	- getShareStatisticInfo
	Get the user's share statistic information.
(ZMVideoSDKRawDataPipe *_Nullable)	- getVideoPipe
	Get the user's video pipe.
(ZMVideoSDKVideoCanvas *_Nullable)	- getVideoCanvas
	Gets the user's video canvas.
(NSArray< ZMVideoSDKShareAction * > *_Nullable)	- getShareActionList
	Get the user's share-action list.
(ZMVideoSDKRemoteCameraControlHelper *_Nullable)	- getRemoteCameraControlHelper
	Get the helper class instance to access the remote camera control.
(NSArray< ZMVideoSDKRawDataPipe * > *_Nullable)	- getMultiCameraStreamList
	Get the user's multi-camera stream list.
(BOOL)	- setUserVolume:isSharingAudio:
	Set the user's local volume. This does not affect how other participants hear the user.
(BOOL)	- getUserVolume:isSharingAudio:
	Get user volume.
(BOOL)	- canSetUserVolume:
	Determine which audio you can set, shared audio or microphone.
(BOOL)	- hasIndividualRecordingConsent
	Used to determine whether I agree to individual video recording.
(ZMVideoSDKErrors)	- transferFile:
	Send file to current user object.
(BOOL)	- isVideoSpotLighted
	check if user is spotlighted.
(BOOL)	- isIncomingLiveStreamUser
	Determine whether the user is incoming live stream user.
(BOOL)	- isInSubSession
	Determine whether the user is in a subsession.

Detailed Description

Zoom Video SDK user information.

Definition at line 380 of file ZMVideoSDKUserHelper.h.

Method Documentation

canSetUserVolume:

- (BOOL) canSetUserVolume:

(BOOL)

isShareAudio

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

Parameters

isShareAudio

YES means checks whether you can set the volume of shared audio, otherwise you can set the volume of the microphone.

Returns

If success return YES, otherwise NO.

getAudioStatus

- (ZMVideoSDKAudioStatus *_Nullable) getAudioStatus

Get the user's audio status.

Returns

Audio status.

getCustomIdentity

- (NSString *_Nullable) getCustomIdentity

Get the user's custom identity.

Returns

If the function succeeds, the return value is custom id, otherwise returns nil.

getMultiCameraStreamList

- (NSArray< ZMVideoSDKRawDataPipe * > *_Nullable) getMultiCameraStreamList

Get the user's multi-camera stream list.

Returns

A list of all streaming cameras pipe.

getRemoteCameraControlHelper

- (ZMVideoSDKRemoteCameraControlHelper *_Nullable) getRemoteCameraControlHelper

Get the helper class instance to access the remote camera control.

Returns

If the function succeeds, it will return a remote camera control object, otherwise returns nil.

getShareActionList

- (NSArray< ZMVideoSDKShareAction * > *_Nullable) getShareActionList

Get the user's share-action list.

Returns

A list of all share information.

getShareStatisticInfo

- (ZMVideoSDKShareStatisticInfo *_Nullable) getShareStatisticInfo

Get the user's share statistic information.

Returns

Share statistic information.

getUserID

- (NSString *_Nullable) getUserID

Get the user's id.

Returns

If the function succeeds, the return value is user id, otherwise returns nil.

getUserName

- (NSString *_Nullable) getUserName

Get the name of the user in the session.

Returns

If the function succeeds, the return value is user name, otherwise returns nil.

getUserReference

- (NSString *_Nullable) getUserReference

Get the user's reference.

getUserVolume:isSharingAudio:

- (BOOL) getUserVolume:		(float *)	volume
isSharingAudio:		(BOOL)	isSharingAudio

Get user volume.

Parameters

volume	The user volume.
isSharingAudio	YES means gets the volume of shared audio (such as shared computer audio), otherwise gets the volume of the microphone.

Returns

If success return YES, otherwise NO.

getVideoCanvas

- (ZMVideoSDKVideoCanvas *_Nullable) getVideoCanvas

Gets the user's video canvas.

Returns

If the function succeeds, it will return a ZMVideoSDKVideoCanvas object, otherwise returns nil.

getVideoPipe

- (ZMVideoSDKRawDataPipe *_Nullable) getVideoPipe

Get the user's video pipe.

Returns

Video pipe.

getVideoStatisticInfo

- (ZMVideoSDKVideoStatisticInfo *_Nullable) getVideoStatisticInfo

Get the user's video statistic information.

Returns

Video statistic information.

hasIndividualRecordingConsent

- (BOOL) hasIndividualRecordingConsent

Used to determine whether I agree to individual video recording.

isHost

- (BOOL) isHost

Determine whether the user is the host.

Returns

YES indicates that the user is the host, otherwise NO.

isIncomingLiveStreamUser

- (BOOL) isIncomingLiveStreamUser

Determine whether the user is incoming live stream user.

Returns

YES indicates that the user special for incoming live stream, otherwise NO.

isInSubSession

- (BOOL) isInSubSession

Determine whether the user is in a subsession.

Returns

YES indicates that the user is currently in a subsession, otherwise NO.

isManager

- (BOOL) isManager

Determine whether the user is the manager.

Returns

YES indicates that the user is the manager, otherwise NO.

isVideoSpotLighted

- (BOOL) isVideoSpotLighted

check if user is spotlighted.

Returns

If the function succeeds, the return value is YES. Otherwise, this function returns NO.

setUserVolume:isSharingAudio:

- (BOOL) setUserVolume:		(float)	volume
isSharingAudio:		(BOOL)	isSharingAudio

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

Parameters

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

Returns

If successful return YES, otherwise NO.

transferFile:

- (ZMVideoSDKErrors) transferFile:

(NSString *)

filePath

Send file to current user object.

Parameters

filePath

The local path of the file.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.