com.twilio.video

Class CameraCapturer

java.lang.Object

com.twilio.video.CameraCapturer

All Implemented Interfaces:

VideoCapturer

public class CameraCapturer
extends Object
implements VideoCapturer

The CameraCapturer class is used to provide video frames for a LocalVideoTrack from a given CameraCapturer.CameraSource. The frames are provided via the preview API of Camera.

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	CameraCapturer.CameraSource Camera source types.
static interface	CameraCapturer.Error
static interface	CameraCapturer.Listener Interface that provides events and errors related to CameraCapturer.
static interface	CameraCapturer.PictureListener Interface that provides events related to taking a picture while capturing.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_CAMERA_FREEZE
static int	ERROR_CAMERA_PERMISSION_NOT_GRANTED
static int	ERROR_CAMERA_SERVER_STOPPED
static int	ERROR_CAMERA_SWITCH_FAILED
static int	ERROR_UNKNOWN
static int	ERROR_UNSUPPORTED_SOURCE

Constructor Summary

Constructors

Constructor and Description
CameraCapturer(android.content.Context context, CameraCapturer.CameraSource cameraSource)
CameraCapturer(android.content.Context context, CameraCapturer.CameraSource cameraSource, CameraCapturer.Listener listener)

Method Summary

Modifier and Type	Method and Description
CameraCapturer.CameraSource	getCameraSource() Returns the currently specified camera source.
List<VideoFormat>	getSupportedFormats() Returns a list of all supported video formats.
boolean	isScreencast() Indicates that the camera capturer is not a screen cast.
static boolean	isSourceAvailable(CameraCapturer.CameraSource cameraSource) Indicates if a camera source is available on the device.
void	startCapture(VideoFormat captureFormat, VideoCapturer.Listener videoCapturerListener) Starts capturing frames at the specified format.
void	stopCapture() Stops all frames being captured.
void	switchCamera() Switches the current CameraCapturer.CameraSource.
boolean	takePicture(CameraCapturer.PictureListener pictureListener) Schedules an image capture.
boolean	updateCameraParameters(CameraParameterUpdater cameraParameterUpdater) Schedules a camera parameter update.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_CAMERA_FREEZE

public static final int ERROR_CAMERA_FREEZE

See Also:

Constant Field Values

ERROR_CAMERA_SERVER_STOPPED

public static final int ERROR_CAMERA_SERVER_STOPPED

See Also:

Constant Field Values

ERROR_UNSUPPORTED_SOURCE

public static final int ERROR_UNSUPPORTED_SOURCE

See Also:

Constant Field Values

ERROR_CAMERA_PERMISSION_NOT_GRANTED

public static final int ERROR_CAMERA_PERMISSION_NOT_GRANTED

See Also:

Constant Field Values

ERROR_CAMERA_SWITCH_FAILED

public static final int ERROR_CAMERA_SWITCH_FAILED

See Also:

Constant Field Values

ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

See Also:

Constant Field Values

Constructor Detail

CameraCapturer

public CameraCapturer(android.content.Context context,
                      CameraCapturer.CameraSource cameraSource)

CameraCapturer

public CameraCapturer(android.content.Context context,
                      CameraCapturer.CameraSource cameraSource,
                      CameraCapturer.Listener listener)

Method Detail

isSourceAvailable

public static boolean isSourceAvailable(CameraCapturer.CameraSource cameraSource)

Indicates if a camera source is available on the device.

Parameters:

cameraSource - the camera source

Returns:

true if source is available on device and false otherwise.

getSupportedFormats

public List<VideoFormat> getSupportedFormats()

Returns a list of all supported video formats. This list is based on what is specified by Camera.Parameters, 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 camera 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. The Camera interface should be available for use upon completion.

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

Specified by:

stopCapture in interface VideoCapturer

getCameraSource

public CameraCapturer.CameraSource getCameraSource()

Returns the currently specified camera source.

switchCamera

public void switchCamera()

Switches the current CameraCapturer.CameraSource. This method can be invoked while capturing frames or not.

updateCameraParameters

public boolean updateCameraParameters(CameraParameterUpdater cameraParameterUpdater)

Schedules a camera parameter update. The current camera's Camera.Parameters will be provided for modification via CameraParameterUpdater.apply(Camera.Parameters). Any changes to the parameters will be applied after the invocation of this callback. This method can be invoked while capturing frames or not.

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

     // Create camera capturer
     CameraCapturer cameraCapturer = new CameraCapturer(context,
          CameraCapturer.CameraSource.BACK_CAMERA, null);

     // Start camera capturer
     LocalVideoTrack cameraVideoTrack = LocalVideoTrack.create(context, true, cameraCapturer);

     // Schedule camera parameter update
     cameraCapturer.updateCameraParameters(new CameraParameterUpdater() {
         @Override
         public void apply(Camera.Parameters cameraParameters) {
             // Ensure camera supports flash and turn on
             if (cameraParameters.getFlashMode() != null) {
                  cameraParameters.setFlashMode(Camera.Parameters.FLASH_MODE_TORCH);
             }
         }
     });
 

Parameters:

cameraParameterUpdater - camera parameter updater that receives current camera parameters for modification.

Returns:

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

takePicture

public boolean takePicture(CameraCapturer.PictureListener pictureListener)

Schedules an image capture.

The following snippet demonstrates how to capture and image and decode to a Bitmap.

     // Create camera capturer
     CameraCapturer cameraCapturer = new CameraCapturer(context,
          CameraCapturer.CameraSource.BACK_CAMERA, null);

     // Start camera capturer
     LocalVideoTrack cameraVideoTrack = LocalVideoTrack.create(context, true, cameraCapturer)

     // Schedule an image capture
     cameraCapturer.takePicture(new CameraCapturer.PictureListener() {
         @Override
         public void onShutter() {
             // Show some UI or play a sound
         }

         @Override
         public void onPictureTaken(byte[] pictureData) {
             Bitmap bitmap = BitmapFactory.decodeByteArray(pictureData, 0,
                 pictureData.length);
         }
     });
 

Parameters:

pictureListener - listener that that receives the callback for the shutter and picture taken event.

Returns:

true if picture was scheduled to be taken or false if a picture is pending or could not be scheduled.