InMeetingVideoController (Zoom.us SDK API Document)

public interface InMeetingVideoController

Video controller in meeting.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`activeVideoUserID()` Get the ID of user whose video is active in the meeting.
`MobileRTCSDKError`	`askAttendeeStartVideo(long userId)` Host can use the function to ask the user to start video.
`boolean`	`canSwitchCamera()` Query if it is able to switch camera.
`boolean`	`canUnmuteMyVideo()` Query if user is able to unmute himself.
`java.util.List<CameraDevice>`	`getCameraDeviceList()` Get the list of all camera devices.
`long`	`getPinnedUser()` Get the user ID of current pinned video.
`java.lang.String`	`getSelectedCameraId()` Get the ID of currently selected camera.
`boolean`	`isBackCamera(java.lang.String cameraId)` Query if the camera is the back one.
`boolean`	`isFrontCamera(java.lang.String cameraId)` Query if the camera is the front one.
`boolean`	`isMyVideoMuted()` Query if the video of current user is muted or not.
`boolean`	`isUserPinned(long userId)` Query if the current user's video is pinned.
`boolean`	`isUserVideoSpotLighted(long userId)` Query if the user's video is spotlighted.
`MobileRTCSDKError`	`muteMyVideo(boolean mute)` Set to mute/unmute the video.
`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.
`boolean`	`rotateMyVideo(int rotation)` Set to rotate user's video.
`void`	`setVideoCaptureSurfaceHolder(android.view.SurfaceHolder holder)` Set a surface holder to capture video with camera.
`MobileRTCSDKError`	`spotLightVideo(boolean on, long userId)` Set whether to spotlight user's video or not.
`MobileRTCSDKError`	`stopAttendeeVideo(long userId)` Host can use the function to mute user's video.
`boolean`	`switchCamera(java.lang.String cameraId)` Switch to camera by ID.
`boolean`	`switchToNextCamera()` Switch to next camera.

- Method Detail
  - activeVideoUserID
```
long activeVideoUserID()
```
    Get the ID of user whose video is active in the meeting.
    
    Returns:
    
    User ID.
  - isMyVideoMuted
```
boolean isMyVideoMuted()
```
    Query if the video of current user is muted or not.
    
    Returns:
    
    TRUE means muted.
  - canUnmuteMyVideo
```
boolean canUnmuteMyVideo()
```
    Query if user is able to unmute himself.
    
    Returns:
    
    TRUE means able. FALSE not.
  - muteMyVideo
```
MobileRTCSDKError muteMyVideo(boolean mute)
```
    Set to mute/unmute the video.
    
    Parameters:
    
    mute - TRUE means to mute, FALSE not.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - setVideoCaptureSurfaceHolder
```
void setVideoCaptureSurfaceHolder(android.view.SurfaceHolder holder)
```
    Set a surface holder to capture video with camera.
    
    Parameters:
    
    holder - The SurfaceHolder to capture video, see SurfaceHolder
  - rotateMyVideo
```
boolean 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. Otherwise failed, for more details, see MobileRTCSDKError.
  - canSwitchCamera
```
boolean canSwitchCamera()
```
    Query if it is able to switch camera.
    
    Returns:
    
    TRUE means able. FALSE not.
  - switchToNextCamera
```
boolean switchToNextCamera()
```
    Switch to next camera.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - switchCamera
```
boolean switchCamera(java.lang.String cameraId)
```
    Switch to camera by ID.
    
    Parameters:
    
    cameraId - The ID of the camera, see CameraDevice.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - getCameraDeviceList
```
java.util.List<CameraDevice> getCameraDeviceList()
```
    Get the list of all camera devices.
    
    Returns:
    
    The list defined in CameraDevice.
  - getSelectedCameraId
```
java.lang.String getSelectedCameraId()
```
    Get the ID of currently selected camera.
    
    Returns:
    
    The selected camera ID.
  - isFrontCamera
```
boolean isFrontCamera(java.lang.String cameraId)
```
    Query if the camera is the front one.
    
    Parameters:
    
    cameraId - The ID of camera to be checked, see CameraDevice.
    
    Returns:
    
    TRUE means front. FALSE not.
  - isBackCamera
```
boolean isBackCamera(java.lang.String cameraId)
```
    Query if the camera is the back one.
    
    Parameters:
    
    cameraId - The ID of camera to be checked, see CameraDevice.
    
    Returns:
    
    TRUE means back. FALSE not.
  - stopAttendeeVideo
```
MobileRTCSDKError 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, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - askAttendeeStartVideo
```
MobileRTCSDKError 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, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - isUserVideoSpotLighted
```
boolean 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.
  - spotLightVideo
```
MobileRTCSDKError 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, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - getPinnedUser
```
long getPinnedUser()
```
    Get the user ID of current pinned video.
    
    Returns:
    
    userId The user ID in meeting.
  - isUserPinned
```
boolean 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.
  - pinVideo
```
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.
    
    Parameters:
    
    on - TRUE means the user's video is pinned. FALSE not.
    
    userId - The user ID.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

Interface InMeetingVideoController

Method Summary

Method Detail

activeVideoUserID

isMyVideoMuted

canUnmuteMyVideo

muteMyVideo

setVideoCaptureSurfaceHolder

rotateMyVideo

canSwitchCamera

switchToNextCamera

switchCamera

getCameraDeviceList

getSelectedCameraId

isFrontCamera

isBackCamera

stopAttendeeVideo

askAttendeeStartVideo

isUserVideoSpotLighted

spotLightVideo

getPinnedUser

isUserPinned

pinVideo