Zoom Video SDK user information. More...

#include <ZoomVideoSDKUser.h>

Inherits NSObject.

Instance Methods
(NSInteger)	- getUserID
	Gets the user's ID.

(NSString *_Nullable)	- getUserName
	Gets the name of the user in the session.

(NSString *_Nullable)	- getCustomUserId
	Gets the user's custom identity. Which is passed in JWT token or in SDKSessionContext.customUserId.

(NSString *_Nullable)	- getUserKey
	Gets the user's key.

(NSString *_Nullable)	- getUserReference
	Gets the user's reference.

(BOOL)	- isHost
	Determines whether the user is the host.

(BOOL)	- isManager
	Determines whether the user is the manager.

(BOOL)	- isIndividualRecordAgreed
	Determines whether the user agreed with the individual record.

(BOOL)	- isVideoSpotLighted
	Determines whether the user is spotlighted.

(ZoomVideoSDKAudioStatus *_Nullable)	- audioStatus
	Gets the user's audio status.

(ZoomVideoSDKVideoStatisticInfo *_Nullable)	- getVideoStatisticInfo
	Gets the user's video statistic information.

(ZoomVideoSDKShareStatisticInfo *_Nullable)	- getShareStatisticInfo
	Gets the user's share statistic information.

(ZoomVideoSDKRawDataPipe *_Nullable)	- getVideoPipe
	Gets the user's video pipe.

(NSArray< ZoomVideoSDKRawDataPipe * > *_Nullable)	- getMultiCameraStreamList
	Gets the user's multi-camera stream list.

(ZoomVideoSDKVideoCanvas *_Nullable)	- getVideoCanvas
	Gets the user's video canvas.

(NSArray< ZoomVideoSDKVideoCanvas * > *_Nullable)	- getMultiCameraCanvasList
	Gets the user's multi-camera canvas list.

(ZoomVideoSDKRemoteCameraControlHelper *_Nullable)	- getRemoteCameraControlHelper
	Gets the helper class instance to access the remote camera control.

(NSArray< ZoomVideoSDKShareAction * > *_Nullable)	- getShareActionList
	Gets the user's share-action list.

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

(BOOL)	- getUserVolume:isShareAudio:
	Gets user volume.

(BOOL)	- canSetUserVolume:
	Determines 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:
	Sends file to current user.

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

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

(BOOL)	- isInSubSession
	Determines 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

Gets the user's audio status.

Returns: If the function succeeds, it returns a ZoomVideoSDKAudioStatus object. Otherwise, this function fails and returns nil.

◆ 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, NO to check if you can set the volume of the microphone.

Returns: YES if you can set the volume. Otherwise, NO.

◆ canSetUserVolume:

- (BOOL) canSetUserVolume: (BOOL) isSharingAudio

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

Parameters

isSharingAudio YES to check whether you can set the volume of shared audio, NO to check whether you can set the volume of the microphone.

Returns: YES if you can set the volume. Otherwise, NO.

Deprecated: Use canSetUserPlaybackVolume: instead.

◆ getAudioLevel

- (unsigned int) getAudioLevel

Gets the current audio level of a remote user.

Returns: If the function succeeds, it returns the current audio level. Otherwise, this function fails and returns 0.

◆ getCustomUserId

- (NSString *_Nullable) getCustomUserId

Gets the user's custom identity. Which is passed in JWT token or in SDKSessionContext.customUserId.

Returns: If the function succeeds, it returns the user's custom identity. Otherwise, this function fails and returns nil.

Deprecated: Use getUserKey instead.

◆ getMultiCameraCanvasList

- (NSArray< ZoomVideoSDKVideoCanvas * > *_Nullable) getMultiCameraCanvasList

Gets the user's multi-camera canvas list.

Returns: If the function succeeds, it returns an NSArray of ZoomVideoSDKVideoCanvas objects. Otherwise, this function fails and returns nil.

◆ getMultiCameraStreamList

- (NSArray< ZoomVideoSDKRawDataPipe * > *_Nullable) getMultiCameraStreamList

Gets the user's multi-camera stream list.

Returns: If the function succeeds, it returns an NSArray of ZoomVideoSDKRawDataPipe objects. Otherwise, this function fails and returns nil.

◆ 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

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

Returns: If the function succeeds, it returns a ZoomVideoSDKRemoteCameraControlHelper object. Otherwise, this function fails and returns nil.

◆ getShareActionList

- (NSArray< ZoomVideoSDKShareAction * > *_Nullable) getShareActionList

Gets the user's share-action list.

Returns: If the function succeeds, it returns an NSArray of ZoomVideoSDKShareAction objects. Otherwise, this function fails and returns nil.

◆ getShareStatisticInfo

- (ZoomVideoSDKShareStatisticInfo *_Nullable) getShareStatisticInfo

Gets the user's share statistic information.

Returns: If the function succeeds, it returns a ZoomVideoSDKShareStatisticInfo object. Otherwise, this function fails and returns nil.

◆ getUserID

- (NSInteger) getUserID

Gets the user's ID.

Returns: The user's ID.

◆ getUserKey

- (NSString *_Nullable) getUserKey

Gets the user's key.

Returns: If the function succeeds, it returns the user's key. Otherwise, this function fails and returns nil.

◆ getUserName

- (NSString *_Nullable) getUserName

Gets the name of the user in the session.

Returns: If the function succeeds, it returns the user's name. Otherwise, this function fails and returns nil.

◆ 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), NO to get the microphone volume.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

◆ getUserReference

- (NSString *_Nullable) getUserReference

Gets the user's reference.

Returns: If the function succeeds, it returns the user's reference. Otherwise, this function fails and returns nil.

◆ getUserVolume:isShareAudio:

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

Gets user volume.

Parameters

volume	The obtained value.
isSharingAudio	YES to get the volume of shared audio, NO to get the volume of the microphone.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Deprecated: Use getUserPlaybackVolume:isSharingAudio: instead.

◆ getVideoCanvas

- (ZoomVideoSDKVideoCanvas *_Nullable) getVideoCanvas

Gets the user's video canvas.

Returns: If the function succeeds, it returns a ZoomVideoSDKVideoCanvas object. Otherwise, this function fails and returns nil.

◆ getVideoPipe

- (ZoomVideoSDKRawDataPipe *_Nullable) getVideoPipe

Gets the user's video pipe.

Returns: If the function succeeds, it returns a ZoomVideoSDKRawDataPipe object. Otherwise, this function fails and returns nil.

◆ getVideoStatisticInfo

- (ZoomVideoSDKVideoStatisticInfo *_Nullable) getVideoStatisticInfo

Gets the user's video statistic information.

Returns: If the function succeeds, it returns a ZoomVideoSDKVideoStatisticInfo object. Otherwise, this function fails and returns nil.

◆ getWhiteboardStatus

- (ZoomVideoSDKWhiteboardStatus) getWhiteboardStatus

Gets the whiteboard share status of the user.

Returns: The whiteboard share status.

◆ isHost

- (BOOL) isHost

Determines whether the user is the host.

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

◆ isIncomingLiveStreamUser

- (BOOL) isIncomingLiveStreamUser

Determines whether the user is an incoming live stream user.

Returns: YES if the user is an incoming live stream. Otherwise, NO.

◆ isIndividualRecordAgreed

- (BOOL) isIndividualRecordAgreed

Determines whether the user agreed with the individual record.

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

◆ isInSubSession

- (BOOL) isInSubSession

Determines whether the user is in SubSession.

Returns: YES if the user is in SubSession. Otherwise, NO.

◆ isManager

- (BOOL) isManager

Determines whether the user is the manager.

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

◆ isVideoSpotLighted

- (BOOL) isVideoSpotLighted

Determines whether the user is 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	The volume value can be between 0 and 10. If 0, the user won't hear the related audio.
isSharingAudio	YES to set the volume of shared audio (such as shared computer audio), NO to set the microphone volume.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

◆ setUserVolume:isShareAudio:

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

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

Parameters

volume	The volume value can be >= 0 and <= 10. If volume is 0, the user won't be able to hear related audio.
isSharingAudio	YES to set the volume of shared audio, NO to set the volume of the microphone.

Returns: If the function succeeds, it returns YES. Otherwise, NO.

Deprecated: Use setUserPlaybackVolume:isSharingAudio: instead.

◆ transferFile:

- (ZoomVideoSDKError) transferFile: (NSString *_Nullable) filePath

Sends file to current user.

Parameters

filePath The local path of the file.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

Warning: This interface will be related with chat privilege. SeeZoomVideoSDKChatPrivilegeType}.

Instance Methods

Detailed Description

Method Documentation

◆ audioStatus

◆ canSetUserPlaybackVolume:

◆ canSetUserVolume:

◆ getAudioLevel

◆ getCustomUserId

◆ getMultiCameraCanvasList

◆ getMultiCameraStreamList

◆ getNetworkLevel:

◆ getOverallNetworkLevel

◆ getRemoteCameraControlHelper

◆ getShareActionList

◆ getShareStatisticInfo

◆ getUserID

◆ getUserKey

◆ getUserName

◆ getUserPlaybackVolume:isSharingAudio:

◆ getUserReference

◆ getUserVolume:isShareAudio:

◆ getVideoCanvas

◆ getVideoPipe

◆ getVideoStatisticInfo

◆ getWhiteboardStatus

◆ isHost

◆ isIncomingLiveStreamUser

◆ isIndividualRecordAgreed

◆ isInSubSession

◆ isManager

◆ isVideoSpotLighted

◆ setUserPlaybackVolume:isSharingAudio:

◆ setUserVolume:isShareAudio:

◆ transferFile: