Video controller in meeting. More...

Public Member Functions
long	activeVideoUserID ()
	Get the ID of user whose video is active in the meeting.

boolean	isMyVideoMuted ()
	Query if the video of current user is muted or not.

boolean	canUnmuteMyVideo ()
	Query if user is able to unmute himself.

MobileRTCSDKError	muteMyVideo (boolean mute)
	Set to mute/unmute the video.

void	setVideoCaptureSurfaceHolder (SurfaceHolder holder)
	Set a surface holder to capture video with camera.

boolean	rotateMyVideo (int rotation)
	Set to rotate user's video.

boolean	canSwitchCamera ()
	Query if it is able to switch camera.

boolean	switchToNextCamera ()
	Switch to next camera.

boolean	switchCamera (String cameraId)
	Switch to camera by ID.

List< CameraDevice >	getCameraDeviceList ()
	Get the list of all camera devices.

String	getSelectedCameraId ()
	Get the ID of currently selected camera.

boolean	isFrontCamera (String cameraId)
	Query if the camera is the front one.

boolean	isBackCamera (String cameraId)
	Query if the camera is the back one.

MobileRTCSDKError	stopAttendeeVideo (long userId)
	Host can use the function to mute user's video.

MobileRTCSDKError	askAttendeeStartVideo (long userId)
	Host can use the function to ask the user to start video.

boolean	isUserVideoSpotLighted (long userId)
	Query if the user's video is spotlighted.

MobileRTCSDKError	spotLightVideo (boolean on, long userId)
	Set whether to spotlight user's video or not.

MobileRTCSDKError	unSpotlightAllVideos ()
	Set all user's video unSpotlight.

long	getPinnedUser ()
	Get the user ID of current pinned video.

boolean	isUserPinned (long userId)
	Query if the current user's video is pinned.

MobileRTCSDKError	pinVideo (boolean on, long userId)
	Set whether to pin user's video or not, which means that during a video conference, the monitor will always display the specified user's view instead of active speaker's video.

ISetVideoOrderHelper	getSetVideoOrderHelper ()

MobileRTCSDKError	stopIncomingVideo (boolean bStop)
	Stop the incoming video.

boolean	isIncomingVideoStopped ()
	Determine if the incoming video is stopped.

MobileRTCSDKError	showAvatar (boolean show)
	Determine if show the last used avatar in the meeting.

boolean	isShowAvatar ()
	Determine if the meeting is showing the avatar.

boolean	isStopIncomingVideoSupported ()
	Determine if the incoming video is supported.

MobileRTCSDKError	enableVideoAutoFraming (AutoFramingMode mode, AutoFramingParameter setting)
	Enable my video auto-framing.

boolean	isVideoAutoFramingEnabled ()
	Determine whether auto-framing is enabled.

AutoFramingMode	getVideoAutoFramingMode ()
	Get current mode of auto-framing.

MobileRTCSDKError	setVideoAutoFramingMode (AutoFramingMode mode)
	Set the mode of auto-framing when auto-framing is started.

MobileRTCSDKError	setVideoAutoFramingRatio (float ratio)
	Set the zoom in ratio of auto-framing when auto-framing is enabled.

MobileRTCSDKError	setFaceRecognitionFailStrategy (FaceRecognitionFailStrategy strategy)
	Set the fail strategy of face recognition when auto-framing is enabled(mode is "AutoFramingMode_face_recognition")

AutoFramingParameter	getVideoAutoFramingSetting (AutoFramingMode mode)
	Get the setting of auto-framing.

MobileRTCSDKError	disableVideoAutoFraming ()
	Stop video auto-framing.

boolean	canEnableAlphaChannelMode ()
	Determine if alpha channel mode can be enabled.

MobileRTCSDKError	enableAlphaChannelMode (boolean enable)
	Enable or disable alpha channel mode.

boolean	isAlphaChannelModeEnabled ()
	Determine if alpha channel mode is enabled.

VideoSize	getUserVideoSize (long userID)
	Get the size of user's video.

ICameraController	getCameraController (long userId)
	Get camera controller object that can control any user's camera.

MobileRTCSDKError	revokeCameraControlPrivilege ()
	Revoke camera control privilege.

boolean	zoomCamera (float zoomStep)
	Zoom the camera.

MobileRTCSDKError	setVideoQualityPreference (SDKVideoPreferenceSetting preferenceSetting)
	Set the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Detailed Description

Video controller in meeting.

Definition at line 11 of file InMeetingVideoController.java.

Member Function Documentation

◆ activeVideoUserID()

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

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

Returns: User ID.

◆ askAttendeeStartVideo()

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

Host can use the function to ask the user to start video.

Parameters

userId The ID of user who needs to turn on video in meeting.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ canEnableAlphaChannelMode()

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

Determine if alpha channel mode can be enabled.

Returns: true means it can be enabled. Otherwise false.

◆ canSwitchCamera()

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

Query if it is able to switch camera.

Returns: TRUE means able. FALSE not.

◆ canUnmuteMyVideo()

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

Query if user is able to unmute himself.

Returns: TRUE means able. FALSE not.

◆ disableVideoAutoFraming()

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

Stop video auto-framing.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ enableAlphaChannelMode()

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

Enable or disable alpha channel mode.

Parameters

enable true indicates to enable alpha channel mode. Otherwise, disable it.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ enableVideoAutoFraming()

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

Enable my video auto-framing.

Parameters

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

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ getCameraController()

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

Get camera controller object that can control any user's camera.

Parameters

userId Controls user's own camera

Returns: See ICameraController

◆ getCameraDeviceList()

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

Get the list of all camera devices.

Returns: The list defined in CameraDevice.

◆ getPinnedUser()

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

Get the user ID of current pinned video.

Returns: userId The user ID in meeting.

◆ getSelectedCameraId()

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

Get the ID of currently selected camera.

Returns: The selected camera ID.

◆ getSetVideoOrderHelper()

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

Returns: video order helperISetVideoOrderHelper

◆ getUserVideoSize()

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

Get the size of user's video.

Parameters

userID The ID of user in the meeting

Returns: The size of user's video.

◆ getVideoAutoFramingMode()

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

Get current mode of auto-framing.

Returns: the auto-framing mode.

◆ getVideoAutoFramingSetting()

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

Get the setting of auto-framing.

Parameters

mode	auto-framing.

Returns: Auto framing setting.

◆ isAlphaChannelModeEnabled()

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

Determine if alpha channel mode is enabled.

Returns: TRUE indicates is in alpha channel mode. Otherwise false.

◆ isBackCamera()

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

Query if the camera is the back one.

Parameters

cameraId The ID of camera to be checked}.

Returns: TRUE means back. FALSE not.

◆ isFrontCamera()

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

Query if the camera is the front one.

Parameters

cameraId The ID of camera to be checked.

Returns: TRUE means front. FALSE not.

◆ isIncomingVideoStopped()

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

Determine if the incoming video is stopped.

Returns: true indicates to the incoming video is stopped.

◆ isMyVideoMuted()

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

Query if the video of current user is muted or not.

Returns: TRUE means muted.

◆ isShowAvatar()

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

Determine if the meeting is showing the avatar.

Returns: indicates the meeting is showing the avatar.

◆ isStopIncomingVideoSupported()

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

Determine if the incoming video is supported.

Returns: true indicates to the incoming video is supported.

◆ isUserPinned()

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

Query if the current user's video is pinned.

Parameters

userId The user ID in meeting.

Returns: TRUE means that the current user's video is pinned. FALSE not.

◆ isUserVideoSpotLighted()

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

Query if the user's video is spotlighted.

Parameters

userId The user ID to be checked in meeting.

Returns: TRUE means that user's video is spotlighted. FALSE not.

◆ isVideoAutoFramingEnabled()

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

Determine whether auto-framing is enabled.

Returns: true indicates enabled. false not.

◆ muteMyVideo()

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

Set to mute/unmute the video.

Parameters

mute	TRUE means to mute, FALSE not.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ pinVideo()

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

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

Parameters

on	TRUE means the user's video is pinned. FALSE not.
userId	The user ID.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ revokeCameraControlPrivilege()

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

Revoke camera control privilege.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ rotateMyVideo()

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

Set to rotate user's video.

Parameters

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

Returns: If the function succeeds, the return value is SDKErr_Success.

◆ setFaceRecognitionFailStrategy()

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

Set 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 will return SDKERR_SUCCESS. Otherwise failed.

◆ setVideoAutoFramingMode()

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

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

Parameters

mode	AutoFramingMode the mode of auto-framing.`AutoFramingMode`

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ setVideoAutoFramingRatio()

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

Set 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 will return SDKERR_SUCCESS. Otherwise failed.

◆ setVideoCaptureSurfaceHolder()

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

Set a surface holder to capture video with camera.

Parameters

holder The SurfaceHolder to capture video.

◆ setVideoQualityPreference()

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

Set the video quality preference that automatically adjust 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 will return SDKERR_SUCCESS. Otherwise failed.

◆ showAvatar()

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

Determine if show the last used avatar in the meeting.

Parameters

show	true indicates to show the last used avatar.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ spotLightVideo()

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

Set whether to spotlight user's video or not.

Parameters

on	TRUE means to spotlight user's video; FALSE not.
userId	The ID of user whose video will be spotlighted in the meeting.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ stopAttendeeVideo()

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

Host can use the function to mute user's video.

Parameters

userId The ID of user to be muted in meeting.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ stopIncomingVideo()

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

Stop the incoming video.

Parameters

bStop true means stop

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ switchCamera()

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

Switch to camera by ID.

Parameters

cameraId The ID of the camera.

Returns: If the function succeeds, it will return true. Otherwise false.

◆ switchToNextCamera()

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

Switch to next camera.

Returns: If the function succeeds, it will return true. Otherwise false.

◆ unSpotlightAllVideos()

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

Set all user's video unSpotlight.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ zoomCamera()

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

Zoom the camera.

Parameters

zoomStep Zoom step, between 1.0 to the CameraDevice.getMaxZoomFactor().

Returns: true means zoom successfully. false not.

Public Member Functions

Detailed Description

Member Function Documentation

◆ activeVideoUserID()

◆ askAttendeeStartVideo()

◆ canEnableAlphaChannelMode()

◆ canSwitchCamera()

◆ canUnmuteMyVideo()

◆ disableVideoAutoFraming()

◆ enableAlphaChannelMode()

◆ enableVideoAutoFraming()

◆ getCameraController()

◆ getCameraDeviceList()

◆ 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()