Zoom Video SDK user information. More...

#include <ZMVideoSDKUserHelper.h>

Inherits NSObject.

Instance Methods
(NSString *_Nullable)	- getUserID
	Gets the user's ID.
(NSString *_Nullable)	- getCustomIdentity
	Gets the user's custom identity.
(NSString *_Nullable)	- getUserKey
	Gets the user's key.
(NSString *_Nullable)	- getUserName
	Gets the user's name in the session.
(NSString *_Nullable)	- getUserReference
	Gets the user's reference.
(ZMVideoSDKAudioStatus *_Nullable)	- getAudioStatus
	Gets the user's audio status.
(BOOL)	- isHost
	Determines whether the user is the host.
(BOOL)	- isManager
	Determines whether the user is the manager.
(ZMVideoSDKVideoStatisticInfo *_Nullable)	- getVideoStatisticInfo
	Gets the user's video statistic information.
(ZMVideoSDKShareStatisticInfo *_Nullable)	- getShareStatisticInfo
	Gets the user's share statistic information.
(ZMVideoSDKRawDataPipe *_Nullable)	- getVideoPipe
	Gets the user's video pipe.
(ZMVideoSDKVideoCanvas *_Nullable)	- getVideoCanvas
	Gets the user's video canvas.
(NSArray< ZMVideoSDKShareAction * > *_Nullable)	- getShareActionList
	Gets the user's share-action list.
(ZMVideoSDKRemoteCameraControlHelper *_Nullable)	- getRemoteCameraControlHelper
	Gets the helper class instance to access the remote camera control.
(NSArray< ZMVideoSDKRawDataPipe * > *_Nullable)	- getMultiCameraStreamList
	Gets the user's multi-camera stream list.
(BOOL)	- setUserVolume:isSharingAudio:
	Sets the user's local volume. This does not affect how other participants hear the user.
(BOOL)	- getUserVolume:isSharingAudio:
	Gets user volume.
(BOOL)	- canSetUserVolume:
	Determines which audio to 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 volume.
(BOOL)	- canSetUserPlaybackVolume:
	Checks whether to set the volume for shared audio or microphone.
(unsigned int)	- getAudioLevel
	Gets the current audio level of a remote user.
(BOOL)	- hasIndividualRecordingConsent
	Determines whether I agree to individual video recording.
(ZMVideoSDKErrors)	- transferFile:
	Sends file to current user object.
(BOOL)	- isVideoSpotLighted
	Check if user is spotlighted.
(BOOL)	- isIncomingLiveStreamUser
	Determines whether the user is incoming live stream user.
(BOOL)	- isInSubSession
	Determines whether the user is in a subsession.
(ZMVideoSDKWhiteboardStatus)	- getWhiteboardStatus
	Gets the user's whiteboard sharing status.
(ZMVideoSDKNetworkStatus)	- getNetworkLevel:
	Gets the network quality level of the specified data type for the user.
(ZMVideoSDKNetworkStatus)	- getOverallNetworkLevel
	Gets the user's overall network quality level.

Detailed Description

Zoom Video SDK user information.

Definition at line 405 of file ZMVideoSDKUserHelper.h.

Method Documentation

◆ canSetUserPlaybackVolume:

- (BOOL) canSetUserPlaybackVolume: (BOOL) isShareAudio

Checks whether to set the volume for shared audio or microphone.

Parameters

isShareAudio YES to check if to set the shared audio's volume, NO to set the microphone's volume.

Returns: YES if setting the volume of shared audio is supported. Otherwise, NO.

◆ canSetUserVolume:

- (BOOL) canSetUserVolume: (BOOL) isShareAudio

Determines which audio to set, shared audio or microphone.

Parameters

isShareAudio YES to check whether to set the shared audio's volume, NO to set the microphone's volume.

Returns: If the function succeeds 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.

References getAudioLevel.

Referenced by getAudioLevel.

◆ getAudioStatus

- (ZMVideoSDKAudioStatus *_Nullable) getAudioStatus

Gets the user's audio status.

Returns: Audio status object. Otherwise, this function fails and returns nil.

References getAudioStatus.

Referenced by getAudioStatus.

◆ getCustomIdentity

- (NSString *_Nullable) getCustomIdentity

Gets the user's custom identity.

Returns: If the function succeeds, it returns custom ID. Otherwise, this function fails and returns nil.

Deprecated: Use getUserKey instead.

References getCustomIdentity, and getUserKey.

Referenced by getCustomIdentity.

◆ getMultiCameraStreamList

- (NSArray< ZMVideoSDKRawDataPipe * > *_Nullable) getMultiCameraStreamList

Gets the user's multi-camera stream list.

Returns: A list of all streaming cameras pipe objects. Otherwise, this function fails and returns nil.

References getMultiCameraStreamList.

Referenced by getMultiCameraStreamList.

◆ getNetworkLevel:

- (ZMVideoSDKNetworkStatus) getNetworkLevel: (ZMVideoSDKDataType) 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

- (ZMVideoSDKNetworkStatus) getOverallNetworkLevel

Gets the user's overall network quality level.

Returns: The overall network status level.

References getOverallNetworkLevel.

Referenced by getOverallNetworkLevel.

◆ getRemoteCameraControlHelper

- (ZMVideoSDKRemoteCameraControlHelper *_Nullable) getRemoteCameraControlHelper

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

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

References getRemoteCameraControlHelper.

Referenced by getRemoteCameraControlHelper.

◆ getShareActionList

- (NSArray< ZMVideoSDKShareAction * > *_Nullable) getShareActionList

Gets the user's share-action list.

Returns: A list of all share action objects. Otherwise, this function fails and returns nil.

References getShareActionList.

Referenced by getShareActionList.

◆ getShareStatisticInfo

- (ZMVideoSDKShareStatisticInfo *_Nullable) getShareStatisticInfo

Gets the user's share statistic information.

Returns: Share statistic information object. Otherwise, this function fails and returns nil.

References getShareStatisticInfo.

Referenced by getShareStatisticInfo.

◆ getUserID

- (NSString *_Nullable) getUserID

Gets the user's ID.

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

References getUserID.

Referenced by getUserID.

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

References getUserKey.

Referenced by getCustomIdentity, and getUserKey.

◆ getUserName

- (NSString *_Nullable) getUserName

Gets the user's name in the session.

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

References getUserName.

Referenced by getUserName.

◆ getUserPlaybackVolume:isSharingAudio:

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

Gets the local volume.

Parameters

volume	The user volume.
isShareAudio	YES to get the volume of shared audio (such as shared computer audio), NO to get the microphone volume.

Returns: YES if the operation succeeds. Otherwise, NO.

◆ getUserReference

- (NSString *_Nullable) getUserReference

Gets the user's reference.

References getUserReference.

Referenced by getUserReference.

◆ getUserVolume:isSharingAudio:

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

Gets user volume.

Parameters

volume	The user volume.
isSharingAudio	YES to get the shared audio's volume (such as shared computer audio), NO to get the microphone's volume.

Returns: If the function succeeds return YES. Otherwise, NO.

Deprecated: Use getUserPlaybackVolume:isSharingAudio: instead.

◆ getVideoCanvas

- (ZMVideoSDKVideoCanvas *_Nullable) getVideoCanvas

Gets the user's video canvas.

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

References getVideoCanvas.

Referenced by getVideoCanvas.

◆ getVideoPipe

- (ZMVideoSDKRawDataPipe *_Nullable) getVideoPipe

Gets the user's video pipe.

Returns: Video pipe object. Otherwise, this function fails and returns nil.

References getVideoPipe.

Referenced by getVideoPipe.

◆ getVideoStatisticInfo

- (ZMVideoSDKVideoStatisticInfo *_Nullable) getVideoStatisticInfo

Gets the user's video statistic information.

Returns: Video statistic information object. Otherwise, this function fails and returns nil.

References getVideoStatisticInfo.

Referenced by getVideoStatisticInfo.

◆ getWhiteboardStatus

- (ZMVideoSDKWhiteboardStatus) getWhiteboardStatus

Gets the user's whiteboard sharing status.

Returns: The whiteboard sharing status.

References getWhiteboardStatus.

Referenced by getWhiteboardStatus.

◆ hasIndividualRecordingConsent

- (BOOL) hasIndividualRecordingConsent

Determines whether I agree to individual video recording.

Returns: YES if the user has individual video recording consent. Otherwise, NO.

References hasIndividualRecordingConsent.

Referenced by hasIndividualRecordingConsent.

◆ isHost

- (BOOL) isHost

Determines whether the user is the host.

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

References isHost.

Referenced by isHost.

◆ isIncomingLiveStreamUser

- (BOOL) isIncomingLiveStreamUser

Determines whether the user is incoming live stream user.

Returns: YES if that the user special for incoming live stream. Otherwise, NO.

References isIncomingLiveStreamUser.

Referenced by isIncomingLiveStreamUser.

◆ isInSubSession

- (BOOL) isInSubSession

Determines whether the user is in a subsession.

Returns: YES if that the user is currently in a subsession. Otherwise, NO.

References isInSubSession.

Referenced by isInSubSession.

◆ isManager

- (BOOL) isManager

Determines whether the user is the manager.

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

References isManager.

Referenced by isManager.

◆ isVideoSpotLighted

- (BOOL) isVideoSpotLighted

Check if user is spotlighted.

Returns: YES if that the user is spotlighted. Otherwise, this function returns NO.

References isVideoSpotLighted.

Referenced by isVideoSpotLighted.

◆ 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 to set the volume of shared audio (such as shared computer audio), NO to set the microphone volume.

Returns: YES if the operation succeeds. Otherwise, NO.

◆ setUserVolume:isSharingAudio:

- (BOOL) setUserVolume:		(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 be >= 0 and <=10. If volume is 0, the user won't be able to hear the related audio.
isSharingAudio	YES to set the shared audio's volume (such as shared computer audio), NO to set the microphone's volume.

Returns: If the function succeedsful return YES. Otherwise, NO.

Deprecated: Use setUserPlaybackVolume:isSharingAudio: instead.

◆ transferFile:

- (ZMVideoSDKErrors) transferFile: (NSString *) filePath

Sends file to current user object.

Parameters

filePath The file's local path.

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

Instance Methods

Detailed Description

Method Documentation

◆ canSetUserPlaybackVolume:

◆ canSetUserVolume:

◆ getAudioLevel

◆ getAudioStatus

◆ getCustomIdentity

◆ getMultiCameraStreamList

◆ getNetworkLevel:

◆ getOverallNetworkLevel

◆ getRemoteCameraControlHelper

◆ getShareActionList

◆ getShareStatisticInfo

◆ getUserID

◆ getUserKey

◆ getUserName

◆ getUserPlaybackVolume:isSharingAudio:

◆ getUserReference

◆ getUserVolume:isSharingAudio:

◆ getVideoCanvas

◆ getVideoPipe

◆ getVideoStatisticInfo

◆ getWhiteboardStatus

◆ hasIndividualRecordingConsent

◆ isHost

◆ isIncomingLiveStreamUser

◆ isInSubSession

◆ isManager

◆ isVideoSpotLighted

◆ setUserPlaybackVolume:isSharingAudio:

◆ setUserVolume:isSharingAudio:

◆ transferFile: