com.twilio.video

Class Camera2Capturer

java.lang.Object

com.twilio.video.Camera2Capturer

All Implemented Interfaces:

VideoCapturer

public class Camera2Capturer
extends Object
implements VideoCapturer

The Camera2Capturer class is used to provide video frames for a LocalVideoTrack from the provided cameraId. The frames are provided via a CameraCaptureSession. Camera2Capturer must be run on devices Build.VERSION_CODES.LOLLIPOP or higher.

This class represents an implementation of a VideoCapturer interface. Although public, these methods are not meant to be invoked directly.

Note: This capturer can be reused, but cannot be shared across multiple LocalVideoTracks simultaneously.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Camera2Capturer.Exception Camera2Capturer exception class.
static interface	Camera2Capturer.Listener Interface that provides events and errors related to Camera2Capturer.

Constructor Summary

Constructors

Constructor and Description
Camera2Capturer(android.content.Context context, String cameraId, Camera2Capturer.Listener listener) Constructs a Camera2Capturer instance.

Method Summary

Modifier and Type	Method and Description
String	getCameraId() Returns the currently set camera ID.
List<VideoFormat>	getSupportedFormats() Returns a list of all supported video formats.
boolean	isScreencast() Indicates that the camera2 capturer is not a screen cast.
static boolean	isSupported(android.content.Context context) Indicates if Camera2Capturer is compatible with device.
void	setSurfaceTextureHelper(SurfaceTextureHelper surfaceTextureHelper) This method enables SDK provided video capturers to capture to a surface texture.
void	startCapture(VideoFormat captureFormat, VideoCapturer.Listener videoCapturerListener) Starts capturing frames at the specified format.
void	stopCapture() Stops all frames being captured.
void	switchCamera(String newCameraId) Switches the current cameraId.
boolean	updateCaptureRequest(CaptureRequestUpdater captureRequestUpdater) Schedules a capture request update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Camera2Capturer

public Camera2Capturer(android.content.Context context,
                       String cameraId,
                       Camera2Capturer.Listener listener)

Constructs a Camera2Capturer instance.

Note: It is possible to construct multiple instances with different camera IDs, but there are often device limitations on how many camera2 sessions can be open.

Parameters:

context - application context

cameraId - unique identifier of the camera device to open that must be specified in CameraManager.getCameraIdList().

listener - listener of camera 2 capturer events

Method Detail

isSupported

public static boolean isSupported(android.content.Context context)

Indicates if Camera2Capturer is compatible with device.

This method checks that all the following conditions are true:

1. The device API level is at least Build.VERSION_CODES.LOLLIPOP.
2. All device cameras have hardware support level greater than CameraMetadata.INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY.

For more details on supported hardware levels see the Android documentation.

Parameters:

context - application context.

Returns:

true if device supports Camera2Capturer and false if not.

getSupportedFormats

public List<VideoFormat> getSupportedFormats()

Returns a list of all supported video formats. This list is based on what is specified by CameraCharacteristics, so can vary based on a device's camera capabilities.

Note: This method can be invoked for informational purposes, but is primarily used internally.

Specified by:

getSupportedFormats in interface VideoCapturer

Returns:

all supported video formats.

isScreencast

public boolean isScreencast()

Indicates that the camera2 capturer is not a screen cast.

Specified by:

isScreencast in interface VideoCapturer

Returns:

true if the video capturer is a screencast and false if not.

startCapture

public void startCapture(VideoFormat captureFormat,
                         VideoCapturer.Listener videoCapturerListener)

Starts capturing frames at the specified format. Frames will be provided to the given listener upon availability.

Note: This method is not meant to be invoked directly.

Specified by:

startCapture in interface VideoCapturer

Parameters:

captureFormat - the format in which to capture frames.

videoCapturerListener - consumer of available frames.

stopCapture

public void stopCapture()

Stops all frames being captured.

Note: This method is not meant to be invoked directly.

Specified by:

stopCapture in interface VideoCapturer

getCameraId

public String getCameraId()

Returns the currently set camera ID.

switchCamera

public void switchCamera(String newCameraId)

Switches the current cameraId.

Parameters:

newCameraId - the new camera id.

updateCaptureRequest

public boolean updateCaptureRequest(CaptureRequestUpdater captureRequestUpdater)

Schedules a capture request update.

A CaptureRequest.Builder optimal for capturing video for streaming will be provided for modification to the provided CaptureRequestUpdater. Modifications to the CaptureRequest.Builder will be applied to the CameraCaptureSession after the invocation of CaptureRequestUpdater.apply(CaptureRequest.Builder). updateCaptureRequest(CaptureRequestUpdater) can be invoked while capturing frames or not. If the Camera2Capturer is not capturing the CaptureRequestUpdater will be called when capturer resumes.

The following snippet demonstrates how to turn on the flash of a camera while capturing.

     // Create the camera2 capturer
     Camera2Capturer camera2Capturer = new Camera2Capturer(context, cameraId, camera2Listener);

     // Start the camera2 capturer
     LocalVideoTrack camera2VideoTrack = LocalVideoTrack.create(context, true, camera2Capturer);

     // Schedule the capture request update
     camera2Capturer.updateCaptureRequest(new CaptureRequestUpdater() {
          @Override
         public void apply(@NonNull CaptureRequest.Builder captureRequestBuilder) {
             captureRequestBuilder.set(CaptureRequest.FLASH_MODE, CaptureRequest.FLASH_MODE_TORCH);
         }
     }
 

The camera2 capturer will raise an Camera2Capturer.Exception to the provided Camera2Capturer.Listener with the code Camera2Capturer.Exception.CAPTURE_REQUEST_UPDATE_FAILED if a successfully scheduled capture request update failed to be applied.

Parameters:

captureRequestUpdater - capture request updater that receives the capture request builder that can be modified.

Returns:

true if the update was scheduled or false if an update is pending or could not be scheduled.

setSurfaceTextureHelper

public void setSurfaceTextureHelper(SurfaceTextureHelper surfaceTextureHelper)

Description copied from interface: VideoCapturer

This method enables SDK provided video capturers to capture to a surface texture. While this method is public, capturing to a surface texture is currently only supported with Camera2Capturer and ScreenCapturer.

Specified by:

setSurfaceTextureHelper in interface VideoCapturer