Video controller in meeting. More...

Public Member Functions
long	activeVideoUserID ()
	Gets the ID of the user whose video is active in the meeting.
boolean	isMyVideoMuted ()
	Determines whether the current user's video is muted.
boolean	canUnmuteMyVideo ()
	Determines whether the user is able to unmute their video.
MobileRTCSDKError	muteMyVideo (boolean mute)
	Mutes or unmutes the video.
void	setVideoCaptureSurfaceHolder (SurfaceHolder holder)
	Sets a surface holder to capture video with the camera.
boolean	rotateMyVideo (int rotation)
	Rotates the user's video.
boolean	canSwitchCamera ()
	Determines whether it is able to switch the camera.
boolean	switchToNextCamera ()
	Switches to the next camera.
boolean	switchCamera (String cameraId)
	Switches to the camera by ID.
List< CameraDevice >	getCameraDeviceList ()
	Gets the list of all camera devices.
String	getSelectedCameraId ()
	Gets the ID of the currently selected camera.
boolean	isFrontCamera (String cameraId)
	Determines whether the camera is the front one.
boolean	isBackCamera (String cameraId)
	Determines whether the camera is the back one.
MobileRTCSDKError	stopAttendeeVideo (long userId)
	Stops the attendee's video. The host can use this function.
MobileRTCSDKError	askAttendeeStartVideo (long userId)
	Asks the user to start video. The host can use this function.
boolean	isUserVideoSpotLighted (long userId)
	Determines whether the user's video is spotlighted.
MobileRTCSDKError	spotLightVideo (boolean on, long userId)
	Sets whether to spotlight the user's video.
MobileRTCSDKError	unSpotlightAllVideos ()
	Unspotlights all users' videos.
SDKPinResult	canPinVideo (long userId)
	Determines whether the user's video can be pinned.
long	getPinnedUser ()
	Gets the user's ID of the current pinned video.
boolean	isUserPinned (long userId)
	Determines whether the current user's video is pinned.
MobileRTCSDKError	pinVideo (boolean on, long userId)
	Sets whether to pin the user's video, which means that during a video conference, the monitor will always display the specified user's view instead of the active speaker's video.
ISetVideoOrderHelper	getSetVideoOrderHelper ()
	Gets the video order helper.
MobileRTCSDKError	stopIncomingVideo (boolean bStop)
	Stops the incoming video.
boolean	isIncomingVideoStopped ()
	Determines whether the incoming video is stopped.
MobileRTCSDKError	showAvatar (boolean show)
	Sets whether to show the last used avatar in the meeting.
boolean	isShowAvatar ()
	Determines whether the meeting is showing the avatar.
boolean	isStopIncomingVideoSupported ()
	Determines whether stopping incoming video is supported.
MobileRTCSDKError	enableVideoAutoFraming (AutoFramingMode mode, AutoFramingParameter setting)
	Enables video auto-framing.
boolean	isVideoAutoFramingEnabled ()
	Determines whether auto-framing is enabled.
AutoFramingMode	getVideoAutoFramingMode ()
	Gets the current mode of auto-framing.
MobileRTCSDKError	setVideoAutoFramingMode (AutoFramingMode mode)
	Sets the mode of auto-framing when auto-framing is started.
MobileRTCSDKError	setVideoAutoFramingRatio (float ratio)
	Sets the zoom-in ratio of auto-framing when auto-framing is enabled.
MobileRTCSDKError	setFaceRecognitionFailStrategy (FaceRecognitionFailStrategy strategy)
	Sets the fail strategy of face recognition when auto-framing is enabled (mode is "AutoFramingMode_face_recognition").
AutoFramingParameter	getVideoAutoFramingSetting (AutoFramingMode mode)
	Gets the setting of auto-framing.
MobileRTCSDKError	disableVideoAutoFraming ()
	Stops video auto-framing.
boolean	canEnableAlphaChannelMode ()
	Determines whether alpha channel mode can be enabled.
MobileRTCSDKError	enableAlphaChannelMode (boolean enable)
	Enables or disables alpha channel mode.
boolean	isAlphaChannelModeEnabled ()
	Determines whether alpha channel mode is enabled.
VideoSize	getUserVideoSize (long userID)
	Gets the size of the user's video.
ICameraController	getCameraController (long userId)
	Gets the camera controller object that can control any user's camera.
MobileRTCSDKError	revokeCameraControlPrivilege ()
	Revokes camera control privilege.
boolean	zoomCamera (float zoomStep)
	Zooms the camera.
MobileRTCSDKError	setVideoQualityPreference (SDKVideoPreferenceSetting preferenceSetting)
	Sets the video quality preference that automatically adjusts the user's video to prioritize frame rate versus resolution based on the current bandwidth available.
MobileRTCASVStatisticInfo	getMeetingVideoStatisticInfo ()
	Gets meeting video statistics information.

Detailed Description

Video controller in meeting.

Definition at line 10 of file InMeetingVideoController.java.

Member Function Documentation

◆ activeVideoUserID()

long us.zoom.sdk.InMeetingVideoController.activeVideoUserID ( )

Gets the ID of the user whose video is active in the meeting.

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

◆ askAttendeeStartVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.askAttendeeStartVideo ( long userId )

Asks the user to start video. The host can use this function.

Parameters

userId The user's ID who needs to turn on video in the meeting.

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

◆ canEnableAlphaChannelMode()

boolean us.zoom.sdk.InMeetingVideoController.canEnableAlphaChannelMode ( )

Determines whether alpha channel mode can be enabled.

Returns: true if it can be enabled. Otherwise, false.

◆ canPinVideo()

SDKPinResult us.zoom.sdk.InMeetingVideoController.canPinVideo ( long userId )

Determines whether the user's video can be pinned.

Parameters

userId The user's ID whose video is being checked.

Returns: If the function succeeds, it returns the pin result. Otherwise, this function fails and returns null.

◆ canSwitchCamera()

boolean us.zoom.sdk.InMeetingVideoController.canSwitchCamera ( )

Determines whether it is able to switch the camera.

Returns: true if it is able to switch. Otherwise, false.

◆ canUnmuteMyVideo()

boolean us.zoom.sdk.InMeetingVideoController.canUnmuteMyVideo ( )

Determines whether the user is able to unmute their video.

Returns: true if the user is able to unmute. Otherwise, false.

◆ disableVideoAutoFraming()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.disableVideoAutoFraming ( )

Stops video auto-framing.

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

◆ enableAlphaChannelMode()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.enableAlphaChannelMode ( boolean enable )

Enables or disables alpha channel mode.

Parameters

enable true to enable alpha channel mode, false to disable it.

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

◆ enableVideoAutoFraming()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.enableVideoAutoFraming	(	AutoFramingMode	mode,
		AutoFramingParameter	setting )

Enables video auto-framing.

Parameters

mode	The auto-framing mode.
setting	The setting of video auto-framing.

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

◆ getCameraController()

ICameraController us.zoom.sdk.InMeetingVideoController.getCameraController ( long userId )

Gets the camera controller object that can control any user's camera.

Parameters

userId Controls the user's own camera.

Returns: If the function succeeds, it returns the camera controller. Otherwise, this function fails and returns null.

◆ getCameraDeviceList()

List< CameraDevice > us.zoom.sdk.InMeetingVideoController.getCameraDeviceList ( )

Gets the list of all camera devices.

Returns: If the function succeeds, it returns the list of camera devices. Otherwise, this function fails and returns null.

◆ getMeetingVideoStatisticInfo()

MobileRTCASVStatisticInfo us.zoom.sdk.InMeetingVideoController.getMeetingVideoStatisticInfo ( )

Gets meeting video statistics information.

Returns: If the function succeeds, it returns a MobileRTCASVStatisticInfo instance containing video stats. Otherwise, this function fails and returns null if there is no ongoing meeting or if data is unavailable.

◆ getPinnedUser()

long us.zoom.sdk.InMeetingVideoController.getPinnedUser ( )

Gets the user's ID of the current pinned video.

Returns: If the function succeeds, it returns the user's ID in the meeting. Otherwise, this function fails and returns 0.

◆ getSelectedCameraId()

String us.zoom.sdk.InMeetingVideoController.getSelectedCameraId ( )

Gets the ID of the currently selected camera.

Returns: If the function succeeds, it returns the selected camera's ID. Otherwise, this function fails and returns null.

◆ getSetVideoOrderHelper()

ISetVideoOrderHelper us.zoom.sdk.InMeetingVideoController.getSetVideoOrderHelper ( )

Gets the video order helper.

Returns: If the function succeeds, it returns the video order helper. Otherwise, this function fails and returns null.

◆ getUserVideoSize()

VideoSize us.zoom.sdk.InMeetingVideoController.getUserVideoSize ( long userID )

Gets the size of the user's video.

Parameters

userID The user's ID in the meeting.

Returns: If the function succeeds, it returns the size of the user's video. Otherwise, this function fails and returns null.

◆ getVideoAutoFramingMode()

AutoFramingMode us.zoom.sdk.InMeetingVideoController.getVideoAutoFramingMode ( )

Gets the current mode of auto-framing.

Returns: If the function succeeds, it returns the auto-framing mode. Otherwise, this function fails and returns null.

◆ getVideoAutoFramingSetting()

AutoFramingParameter us.zoom.sdk.InMeetingVideoController.getVideoAutoFramingSetting ( AutoFramingMode mode )

Gets the setting of auto-framing.

Parameters

mode	The auto-framing mode.

Returns: If the function succeeds, it returns the auto-framing setting. Otherwise, this function fails and returns null.

◆ isAlphaChannelModeEnabled()

boolean us.zoom.sdk.InMeetingVideoController.isAlphaChannelModeEnabled ( )

Determines whether alpha channel mode is enabled.

Returns: true if alpha channel mode is enabled. Otherwise, false.

◆ isBackCamera()

boolean us.zoom.sdk.InMeetingVideoController.isBackCamera ( String cameraId )

Determines whether the camera is the back one.

Parameters

cameraId The camera's ID to be checked.

Returns: true if the camera is the back one. Otherwise, false.

◆ isFrontCamera()

boolean us.zoom.sdk.InMeetingVideoController.isFrontCamera ( String cameraId )

Determines whether the camera is the front one.

Parameters

cameraId The camera's ID to be checked.

Returns: true if the camera is the front one. Otherwise, false.

◆ isIncomingVideoStopped()

boolean us.zoom.sdk.InMeetingVideoController.isIncomingVideoStopped ( )

Determines whether the incoming video is stopped.

Returns: true if the incoming video is stopped. Otherwise, false.

◆ isMyVideoMuted()

boolean us.zoom.sdk.InMeetingVideoController.isMyVideoMuted ( )

Determines whether the current user's video is muted.

Returns: true if the video is muted. Otherwise, false.

◆ isShowAvatar()

boolean us.zoom.sdk.InMeetingVideoController.isShowAvatar ( )

Determines whether the meeting is showing the avatar.

Returns: true if the meeting is showing the avatar. Otherwise, false.

◆ isStopIncomingVideoSupported()

boolean us.zoom.sdk.InMeetingVideoController.isStopIncomingVideoSupported ( )

Determines whether stopping incoming video is supported.

Returns: true if stopping incoming video is supported. Otherwise, false.

◆ isUserPinned()

boolean us.zoom.sdk.InMeetingVideoController.isUserPinned ( long userId )

Determines whether the current user's video is pinned.

Parameters

userId The user's ID in the meeting.

Returns: true if the current user's video is pinned. Otherwise, false.

◆ isUserVideoSpotLighted()

boolean us.zoom.sdk.InMeetingVideoController.isUserVideoSpotLighted ( long userId )

Determines whether the user's video is spotlighted.

Parameters

userId The user's ID to be checked in the meeting.

Returns: true if the user's video is spotlighted. Otherwise, false.

◆ isVideoAutoFramingEnabled()

boolean us.zoom.sdk.InMeetingVideoController.isVideoAutoFramingEnabled ( )

Determines whether auto-framing is enabled.

Returns: true if auto-framing is enabled. Otherwise, false.

◆ muteMyVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.muteMyVideo ( boolean mute )

Mutes or unmutes the video.

Parameters

mute	true to mute, false to unmute.

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

◆ pinVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.pinVideo	(	boolean	on,
		long	userId )

Sets whether to pin the user's video, which means that during a video conference, the monitor will always display the specified user's view instead of the active speaker's video.

Parameters

on	true to pin the user's video, false otherwise.
userId	The user's ID.

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

◆ revokeCameraControlPrivilege()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.revokeCameraControlPrivilege ( )

Revokes camera control privilege.

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

◆ rotateMyVideo()

boolean us.zoom.sdk.InMeetingVideoController.rotateMyVideo ( int rotation )

Rotates the user's video.

Parameters

rotation 0: no rotation (natural orientation); 1: rotate 90 degrees; 2: rotate 180 degrees; 3: rotate 270 degrees.

Returns: true if the function succeeds. Otherwise, false.

◆ setFaceRecognitionFailStrategy()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.setFaceRecognitionFailStrategy ( FaceRecognitionFailStrategy strategy )

Sets the fail strategy of face recognition when auto-framing is enabled (mode is "AutoFramingMode_face_recognition").

Parameters

strategy The fail strategy of face recognition.

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

◆ setVideoAutoFramingMode()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.setVideoAutoFramingMode ( AutoFramingMode mode )

Sets the mode of auto-framing when auto-framing is started.

Parameters

mode	The mode of auto-framing.

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

◆ setVideoAutoFramingRatio()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.setVideoAutoFramingRatio ( float ratio )

Sets the zoom-in ratio of auto-framing when auto-framing is enabled.

Parameters

ratio The zoom-in ratio of auto-framing. Valid range of ratio: a. mode is "AutoFramingMode_center_coordinates", 1-10; b. mode is "AutoFramingMode_face_recognition", 0.1-10.

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

◆ setVideoCaptureSurfaceHolder()

void us.zoom.sdk.InMeetingVideoController.setVideoCaptureSurfaceHolder ( SurfaceHolder holder )

Sets a surface holder to capture video with the camera.

Parameters

holder The SurfaceHolder to capture video.

◆ setVideoQualityPreference()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.setVideoQualityPreference ( SDKVideoPreferenceSetting preferenceSetting )

Sets the video quality preference that automatically adjusts the user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Parameters

preferenceSetting Specifies the video quality preference.

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

◆ showAvatar()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.showAvatar ( boolean show )

Sets whether to show the last used avatar in the meeting.

Parameters

show	true to show the last used avatar, false otherwise.

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

◆ spotLightVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.spotLightVideo	(	boolean	on,
		long	userId )

Sets whether to spotlight the user's video.

Parameters

on	true to spotlight the user's video, false otherwise.
userId	The user's ID whose video will be spotlighted in the meeting.

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

◆ stopAttendeeVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.stopAttendeeVideo ( long userId )

Stops the attendee's video. The host can use this function.

Parameters

userId The user's ID to be stopped in the meeting.

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

◆ stopIncomingVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.stopIncomingVideo ( boolean bStop )

Stops the incoming video.

Parameters

bStop true to stop, false otherwise.

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

◆ switchCamera()

boolean us.zoom.sdk.InMeetingVideoController.switchCamera ( String cameraId )

Switches to the camera by ID.

Parameters

cameraId The camera's ID.

Returns: true if the function succeeds. Otherwise, false.

◆ switchToNextCamera()

boolean us.zoom.sdk.InMeetingVideoController.switchToNextCamera ( )

Switches to the next camera.

Returns: true if the function succeeds. Otherwise, false.

◆ unSpotlightAllVideos()

MobileRTCSDKError us.zoom.sdk.InMeetingVideoController.unSpotlightAllVideos ( )

Unspotlights all users' videos.

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

◆ zoomCamera()

boolean us.zoom.sdk.InMeetingVideoController.zoomCamera ( float zoomStep )

Zooms the camera.

Parameters

zoomStep Zoom step, between 1.0 and the maximum zoom factor.

Returns: true if zoom succeeds. Otherwise, false.

Public Member Functions

Detailed Description

Member Function Documentation

◆ activeVideoUserID()

◆ askAttendeeStartVideo()

◆ canEnableAlphaChannelMode()

◆ canPinVideo()

◆ canSwitchCamera()

◆ canUnmuteMyVideo()

◆ disableVideoAutoFraming()

◆ enableAlphaChannelMode()

◆ enableVideoAutoFraming()

◆ getCameraController()

◆ getCameraDeviceList()

◆ getMeetingVideoStatisticInfo()

◆ getPinnedUser()

◆ getSelectedCameraId()

◆ getSetVideoOrderHelper()

◆ getUserVideoSize()

◆ getVideoAutoFramingMode()

◆ getVideoAutoFramingSetting()

◆ isAlphaChannelModeEnabled()

◆ isBackCamera()

◆ isFrontCamera()

◆ isIncomingVideoStopped()

◆ isMyVideoMuted()

◆ isShowAvatar()

◆ isStopIncomingVideoSupported()

◆ isUserPinned()

◆ isUserVideoSpotLighted()

◆ isVideoAutoFramingEnabled()

◆ muteMyVideo()

◆ pinVideo()

◆ revokeCameraControlPrivilege()

◆ rotateMyVideo()

◆ setFaceRecognitionFailStrategy()

◆ setVideoAutoFramingMode()

◆ setVideoAutoFramingRatio()

◆ setVideoCaptureSurfaceHolder()

◆ setVideoQualityPreference()

◆ showAvatar()

◆ spotLightVideo()

◆ stopAttendeeVideo()

◆ stopIncomingVideo()

◆ switchCamera()

◆ switchToNextCamera()

◆ unSpotlightAllVideos()

◆ zoomCamera()