Package us.zoom.sdk
Interface ZoomVideoSDKUser
-
public interface ZoomVideoSDKUser
Zoom Video SDK user information.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
canSetUserVolume(boolean isShareAudio)
Determine which audio you can set, shared audio or microphoneZoomVideoSDKAudioStatus
getAudioStatus()
Get the user's audio status.java.lang.String
getCustomIdentity()
Get the user's custom identity.java.util.List<ZoomVideoSDKVideoCanvas>
getMultiCameraCanvasList()
Get the user's multi-camera canvas list.java.util.List<ZoomVideoSDKRawDataPipe>
getMultiCameraStreamList()
Get the user's multi-camera stream list.ZoomVideoSDKRemoteCameraControlHelper
getRemoteCameraControlHelper()
Get the helper class instance to access the remote camera control.ZoomVideoSDKVideoCanvas
getShareCanvas()
Get the user's share canvas.ZoomVideoSDKRawDataPipe
getSharePipe()
Get the user's share pipe.ZoomVideoSDKShareStatisticInfo
getShareStatisticInfo()
Get the user's share statistic information.ZoomVideoSDKShareStatus
getShareStatus()
Deprecated.java.lang.String
getUserGUID()
Gets the user's GUID.java.lang.String
getUserID()
Get the user's id.java.lang.String
getUserName()
Get the name of the user in the session.float
getUserVolume(boolean isShareAudio)
Get user volume.ZoomVideoSDKVideoCanvas
getVideoCanvas()
Get the user's video canvas.ZoomVideoSDKRawDataPipe
getVideoPipe()
Get the user's video pipe.ZoomVideoSDKVideoStatisticInfo
getVideoStatisticInfo()
Get the user's video statistic information.ZoomVideoSDKVideoStatus
getVideoStatus()
Deprecated.boolean
hasIndividualRecordingConsent()
Used to determine whether I agree to individual video recording.boolean
isHost()
Determine whether the user is the host.boolean
isManager()
Determine whether the user is the manager.boolean
setUserVolume(float volume, boolean isShareAudio)
Set the user's local volume.
-
-
-
Method Detail
-
getCustomIdentity
java.lang.String getCustomIdentity()
Get the user's custom identity.- Returns:
- custom identity
-
getUserID
java.lang.String getUserID()
Get the user's id.- Returns:
- user ID
-
getUserName
java.lang.String getUserName()
Get the name of the user in the session.- Returns:
- user name
-
getVideoStatus
@Deprecated ZoomVideoSDKVideoStatus getVideoStatus()
Deprecated.Get the user's video status.- Returns:
- video status. For more information, see
ZoomVideoSDKVideoStatus
.
-
getAudioStatus
ZoomVideoSDKAudioStatus getAudioStatus()
Get the user's audio status.- Returns:
- audio status. For more information, see
ZoomVideoSDKAudioStatus
.
-
getShareStatus
@Deprecated ZoomVideoSDKShareStatus getShareStatus()
Deprecated.Get the user's screen share status.- Returns:
- share status. For more information, see
ZoomVideoSDKShareStatus
.
-
getVideoPipe
ZoomVideoSDKRawDataPipe getVideoPipe()
Get the user's video pipe.- Returns:
- video pipe. For more information, see
ZoomVideoSDKRawDataPipe
.
-
getSharePipe
ZoomVideoSDKRawDataPipe getSharePipe()
Get the user's share pipe.- Returns:
- share pipe. For more information, see
ZoomVideoSDKRawDataPipe
.
-
getVideoCanvas
ZoomVideoSDKVideoCanvas getVideoCanvas()
Get the user's video canvas.- Returns:
- video canvas. For more information, see
ZoomVideoSDKVideoCanvas
.
-
getShareCanvas
ZoomVideoSDKVideoCanvas getShareCanvas()
Get the user's share canvas.- Returns:
- share canvas. For more information, see
ZoomVideoSDKVideoCanvas
.
-
isHost
boolean isHost()
Determine whether the user is the host.- Returns:
- true indicates that the user is the host, otherwise false.
-
isManager
boolean isManager()
Determine whether the user is the manager.- Returns:
- true indicates that the user is the manager, otherwise false.
-
getVideoStatisticInfo
ZoomVideoSDKVideoStatisticInfo getVideoStatisticInfo()
Get the user's video statistic information.- Returns:
- video statistic information. For more information, see
ZoomVideoSDKVideoStatisticInfo
.
-
getShareStatisticInfo
ZoomVideoSDKShareStatisticInfo getShareStatisticInfo()
Get the user's share statistic information.- Returns:
- share statistic information. For more information, see
ZoomVideoSDKShareStatisticInfo
.
-
getMultiCameraStreamList
java.util.List<ZoomVideoSDKRawDataPipe> getMultiCameraStreamList()
Get the user's multi-camera stream list.- Returns:
- a list of all streaming cameras pipe. For more information, see
ZoomVideoSDKRawDataPipe
.
-
getMultiCameraCanvasList
java.util.List<ZoomVideoSDKVideoCanvas> getMultiCameraCanvasList()
Get the user's multi-camera canvas list.- Returns:
- a list of all video canvas. For more information, see
ZoomVideoSDKVideoCanvas
.
-
getRemoteCameraControlHelper
ZoomVideoSDKRemoteCameraControlHelper 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
.
-
setUserVolume
boolean setUserVolume(float volume, boolean isShareAudio)
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 audioisShareAudio
- if true, sets the volume of shared audio, otherwise sets the volume of the microphone.- Returns:
- True if successful, return true, otherwise false.
-
getUserVolume
float getUserVolume(boolean isShareAudio)
Get user volume.- Parameters:
isShareAudio
- if true, gets the volume of shared audio, otherwise gets the volume of the microphone.- Returns:
- the user volume
-
canSetUserVolume
boolean canSetUserVolume(boolean isShareAudio)
Determine which audio you can set, shared audio or microphone- Parameters:
isShareAudio
- if true, checks whether you can set the volume of shared audio, otherwise you can set the volume of the microphone.- Returns:
- True if can set user volume, otherwise false
-
hasIndividualRecordingConsent
boolean hasIndividualRecordingConsent()
Used to determine whether I agree to individual video recording.- Returns:
- if agreed return true, otherwise false.
-
getUserGUID
java.lang.String getUserGUID()
Gets the user's GUID.- Returns:
- user's GUID.
-
-