ZoomVideoSDKUser Class Reference

Zoom Video SDK user information. More...

#include <ZoomVideoSDKUser.h>

Inherits NSObject.

Instance Methods
(NSInteger)	- getUserID
	Get the user's id.
(NSString *_Nullable)	- getUserName
	Get the name of the user in the session.
(NSString *_Nullable)	- getCustomUserId
	Get the user's custom identity.. Which pass in jwt token or in SDKSessionContext.customUserId.
(NSString *_Nullable)	- getUserReference
	Get the user's reference.
(BOOL)	- isHost
	Determine whether the user is the host.
(BOOL)	- isManager
	Determine whether the user is the manager.
(BOOL)	- isIndividualRecordAgreed
	are user agreed with the individual record.
(BOOL)	- isVideoSpotLighted
	check if user be spotlighted.
(ZoomVideoSDKAudioStatus *_Nullable)	- audioStatus
	Get the user's audio status.
(ZoomVideoSDKVideoStatisticInfo *_Nullable)	- getVideoStatisticInfo
	Get the user's video statistic information.
(ZoomVideoSDKShareStatisticInfo *_Nullable)	- getShareStatisticInfo
	Get the user's share statistic information.
(ZoomVideoSDKRawDataPipe *_Nullable)	- getVideoPipe
	Get the user's video pipe.
(NSArray< ZoomVideoSDKRawDataPipe * > *_Nullable)	- getMultiCameraStreamList
	Get the user's multi-camera stream list.
(ZoomVideoSDKVideoCanvas *_Nullable)	- getVideoCanvas
	Get the user's video canvas.
(NSArray< ZoomVideoSDKVideoCanvas * > *_Nullable)	- getMultiCameraCanvasList
	Get the user's multi-camera canvas list.
(ZoomVideoSDKRemoteCameraControlHelper *_Nullable)	- getRemoteCameraControlHelper
	Get the helper class instance to access the remote camera control.
(NSArray< ZoomVideoSDKShareAction * > *_Nullable)	- getShareActionList
	Get the user's share-action list.
(BOOL)	- setUserVolume:isShareAudio:
	Set the user's local volume. This does not affect how other participants hear the user.
(BOOL)	- getUserVolume:isShareAudio:
	Get user volume.
(BOOL)	- canSetUserVolume:
	Determine which audio you can set, shared audio or microphone.
(ZoomVideoSDKError)	- transferFile:
	Send file to current user.
(BOOL)	- isIncomingLiveStreamUser
	Determine whether the user is an incoming live stream user.

Detailed Description

Zoom Video SDK user information.

Definition at line 90 of file ZoomVideoSDKUser.h.

Method Documentation

audioStatus

- (ZoomVideoSDKAudioStatus *_Nullable) audioStatus

Get the user's audio status.

canSetUserVolume:

- (BOOL) canSetUserVolume:

(BOOL)

isSharingAudio

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

Parameters

isSharingAudio

if true, 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.

getCustomUserId

- (NSString *_Nullable) getCustomUserId

Get the user's custom identity.. Which pass in jwt token or in SDKSessionContext.customUserId.

getMultiCameraCanvasList

- (NSArray< ZoomVideoSDKVideoCanvas * > *_Nullable) getMultiCameraCanvasList

Get the user's multi-camera canvas list.

Returns

a list of all video canvas. For more information, see [ZoomVideoSDKVideoCanvas].

getMultiCameraStreamList

- (NSArray< ZoomVideoSDKRawDataPipe * > *_Nullable) getMultiCameraStreamList

Get the user's multi-camera stream list.

Returns

a list of all streaming cameras pipe. For more information, see [ZoomVideoSDKRawDataPipe].

getRemoteCameraControlHelper

- (ZoomVideoSDKRemoteCameraControlHelper *_Nullable) getRemoteCameraControlHelper

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

Returns

If the function succeeds, the return value is the remote camera control helper object. Otherwise returns null. For more details, see ZoomVideoSDKRemoteCameraControlHelper.

getShareActionList

- (NSArray< ZoomVideoSDKShareAction * > *_Nullable) getShareActionList

Get the user's share-action list.

Returns

A list of all share information. For more information, see ZoomVideoSDKShareAction.

getShareStatisticInfo

- (ZoomVideoSDKShareStatisticInfo *_Nullable) getShareStatisticInfo

Get the user's share statistic information.

getUserID

- (NSInteger) getUserID

Get the user's id.

getUserName

- (NSString *_Nullable) getUserName

Get the name of the user in the session.

getUserReference

- (NSString *_Nullable) getUserReference

Get the user's reference.

getUserVolume:isShareAudio:

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

Get user volume.

Parameters

volume	Store the obtained value.
isSharingAudio	if true, gets the volume of shared audio, otherwise gets the volume of the microphone.

Returns

if success return YES, otherwise NO.

getVideoCanvas

- (ZoomVideoSDKVideoCanvas *_Nullable) getVideoCanvas

Get the user's video canvas.

getVideoPipe

- (ZoomVideoSDKRawDataPipe *_Nullable) getVideoPipe

Get the user's video pipe.

getVideoStatisticInfo

- (ZoomVideoSDKVideoStatisticInfo *_Nullable) getVideoStatisticInfo

Get the user's video statistic information.

isHost

- (BOOL) isHost

Determine whether the user is the host.

isIncomingLiveStreamUser

- (BOOL) isIncomingLiveStreamUser

Determine whether the user is an incoming live stream user.

Returns

YES indicates that the user is an incoming live stream, otherwise NO.

isIndividualRecordAgreed

- (BOOL) isIndividualRecordAgreed

are user agreed with the individual record.

isManager

- (BOOL) isManager

Determine whether the user is the manager.

isVideoSpotLighted

- (BOOL) isVideoSpotLighted

check if user be spotlighted.

setUserVolume:isShareAudio:

- (BOOL) setUserVolume:		(float)	volume
isShareAudio:		(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 related audio
isSharingAudio	if true, sets the volume of shared audio, otherwise sets the volume of the microphone.

Returns

if success return YES, otherwise NO.

transferFile:

- (ZoomVideoSDKError) transferFile:

(NSString *_Nullable)

filePath

Send file to current user.

Parameters

filePath

The local path of the file.

Returns

If the function succeeds, the return value is Errors_Success.

Warning

this interface will related with chat privilege seeZoomVideoSDKChatPrivilegeType}.