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.

(BOOL)	- setUserPlaybackVolume:isSharingAudio:
	Sets the user's local volume. This does not affect how other participants hear the user.

(BOOL)	- getUserPlaybackVolume:isSharingAudio:
	Gets the local user volume.

(BOOL)	- canSetUserPlaybackVolume:
	Checks whether you can set the volume for shared audio or microphone.

(unsigned int)	- getAudioLevel
	Gets the current audio level of a remote user.


(ZoomVideoSDKError)	- transferFile:
	Send file to current user.

(BOOL)	- isIncomingLiveStreamUser
	Determine whether the user is an incoming live stream user.

(ZoomVideoSDKWhiteboardStatus)	- getWhiteboardStatus
	Get the whiteboard share status of the user.

(BOOL)	- isInSubSession
	Determine whether the user is in SubSession.

(ZoomVideoSDKNetworkStatus)	- getNetworkLevel:
	Gets the network quality level of the specified data type for the user.

(ZoomVideoSDKNetworkStatus)	- getOverallNetworkLevel
	Gets the overall network quality level of the 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.

Returns: The user's audio status.

◆ canSetUserPlaybackVolume:

- (BOOL) canSetUserPlaybackVolume: (BOOL) isShareAudio

Checks whether you can set the volume for shared audio or microphone.

Parameters

isShareAudio YES to check if you can set the volume of shared audio; otherwise, you can set the volume of the microphone.

Returns: YES if you can set the volume of shared audio, otherwise, NO.

◆ 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.

Deprecated: Use canSetUserPlaybackVolume: instead.

◆ getAudioLevel

- (unsigned int) getAudioLevel

Gets the current audio level of a remote user.

Returns: The current audio level.

◆ getCustomUserId

- (NSString *_Nullable) getCustomUserId

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

Returns: The user's custom identity.

◆ 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].

◆ getNetworkLevel:

- (ZoomVideoSDKNetworkStatus) getNetworkLevel: (ZoomVideoSDKDataType) type

Gets the network quality level of the specified data type for the user.

Parameters

type	The data type, such as audio, video, or share.

Returns: The current network status level for the specified data type.

◆ getOverallNetworkLevel

- (ZoomVideoSDKNetworkStatus) getOverallNetworkLevel

Gets the overall network quality level of the user.

Returns: The overall network status level.

◆ 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.

◆ getShareActionList

- (NSArray< ZoomVideoSDKShareAction * > *_Nullable) getShareActionList

Get the user's share-action list.

Returns: A list of all share information.

◆ getShareStatisticInfo

- (ZoomVideoSDKShareStatisticInfo *_Nullable) getShareStatisticInfo

Get the user's share statistic information.

Returns: The user's share statistic information.

◆ getUserID

- (NSInteger) getUserID

Get the user's id.

Returns: The user's id.

◆ getUserName

- (NSString *_Nullable) getUserName

Get the name of the user in the session.

Returns: The user's name.

◆ getUserPlaybackVolume:isSharingAudio:

- (BOOL) getUserPlaybackVolume:		(float *_Nullable)	volume
isSharingAudio:		(BOOL)	isSharingAudio

Gets the local user volume.

Parameters

volume	The user volume.
isSharingAudio	YES to get the volume of shared audio (such as shared computer audio); otherwise gets the microphone volume.

Returns: YES if the operation succeeds; otherwise, NO.

◆ getUserReference

- (NSString *_Nullable) getUserReference

Get the user's reference.

Returns: 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.

Deprecated: Use getUserPlaybackVolume:isSharingAudio: instead.

◆ getVideoCanvas

- (ZoomVideoSDKVideoCanvas *_Nullable) getVideoCanvas

Get the user's video canvas.

Returns: The user's video canvas.

◆ getVideoPipe

- (ZoomVideoSDKRawDataPipe *_Nullable) getVideoPipe

Get the user's video pipe.

Returns: The user's video pipe.

◆ getVideoStatisticInfo

- (ZoomVideoSDKVideoStatisticInfo *_Nullable) getVideoStatisticInfo

Get the user's video statistic information.

Returns: The user's video statistic information.

◆ getWhiteboardStatus

- (ZoomVideoSDKWhiteboardStatus) getWhiteboardStatus

Get the whiteboard share status of the user.

Returns: The whiteboard share status.

◆ isHost

- (BOOL) isHost

Determine whether the user is the host.

Returns: YES if the user is the host, otherwise NO.

◆ 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.

Returns: YES if the user agreed with the individual record, otherwise NO.

◆ isInSubSession

- (BOOL) isInSubSession

Determine whether the user is in SubSession.

Returns: YES indicates that the user is an incoming live stream user, otherwise false.

◆ isManager

- (BOOL) isManager

Determine whether the user is the manager.

Returns: YES if the user is the manager, otherwise NO.

◆ isVideoSpotLighted

- (BOOL) isVideoSpotLighted

check if user be spotlighted.

Returns: YES if the user is spotlighted, otherwise NO.

◆ setUserPlaybackVolume:isSharingAudio:

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

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

Parameters

volume	Value can between 0 and 10. If 0, the user won't hear the related audio.
isSharingAudio	YES Sets the volume of shared audio (such as shared computer audio); otherwise sets the microphone volume.

Returns: YES if the operation succeeds; otherwise, NO.

◆ 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.

Deprecated: Use setUserPlaybackVolume:isSharingAudio: instead.

◆ 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}.

Instance Methods

Detailed Description

Method Documentation

◆ audioStatus

◆ canSetUserPlaybackVolume:

◆ canSetUserVolume:

◆ getAudioLevel

◆ getCustomUserId

◆ getMultiCameraCanvasList

◆ getMultiCameraStreamList

◆ getNetworkLevel:

◆ getOverallNetworkLevel

◆ getRemoteCameraControlHelper

◆ getShareActionList

◆ getShareStatisticInfo

◆ getUserID

◆ getUserName

◆ getUserPlaybackVolume:isSharingAudio:

◆ getUserReference

◆ getUserVolume:isShareAudio:

◆ getVideoCanvas

◆ getVideoPipe

◆ getVideoStatisticInfo

◆ getWhiteboardStatus

◆ isHost

◆ isIncomingLiveStreamUser

◆ isIndividualRecordAgreed

◆ isInSubSession

◆ isManager

◆ isVideoSpotLighted

◆ setUserPlaybackVolume:isSharingAudio:

◆ setUserVolume:isShareAudio:

◆ transferFile: