Constructor Detail

• CameraView

  CameraView(Context context)

• CameraView

  CameraView(Context context, AttributeSet attrs)

Method Detail

• mapGesture

   boolean mapGesture(@NonNull() Gesture gesture, @NonNull() GestureAction action)

  Maps a Gesture to a certain gesture action.For example, you can assign zoom control to the pinch gesture by just calling:cameraView.mapGesture(Gesture.PINCH, GestureAction.ZOOM);Not all actions can be assigned to a certain gesture. For example, zoom control can't beassigned to the Gesture.TAP gesture. Look at Gesture to know more.This method returns false if they are not assignable.

  Parameters:

  gesture - which gesture to map

  action - which action should be assigned

• clearGesture

   void clearGesture(@NonNull() Gesture gesture)

  Clears any action mapped to the given gesture.

  Parameters:

  gesture - which gesture to clear

• getGestureAction

  @NonNull() GestureAction getGestureAction(@NonNull() Gesture gesture)

  Returns the action currently mapped to the given gesture.

  Parameters:

  gesture - which gesture to inspect

• onInterceptTouchEvent

   boolean onInterceptTouchEvent(MotionEvent ev)

• onTouchEvent

   boolean onTouchEvent(MotionEvent event)

• setRequestPermissions

   void setRequestPermissions(boolean requestPermissions)

  Sets permissions flag if you want enable auto check permissions or disable it.

  Parameters:

  requestPermissions - - true: auto check permissions enabled, false: auto check permissions disabled.

• isOpened

   boolean isOpened()

  Returns whether the camera engine has started.

• setLifecycleOwner

   void setLifecycleOwner(@Nullable() LifecycleOwner owner)

  Sets the lifecycle owner for this view. This means you don't needto call open, close or destroy at all.If you want that lifecycle stopped controlling the state of the camera,pass null in this method.

  Parameters:

  owner - the owner activity or fragment

• open

   void open()

  Starts the camera preview, if not started already.This should be called onResume(), or when you are ready with permissions.

• close

   void close()

  Stops the current preview, if any was started.This should be called onPause().

• destroy

   void destroy()

  Destroys this instance, releasing immediatelythe camera resource.

• setExperimental

   void setExperimental(boolean experimental)

  Sets the experimental flag which occasionally can enablenew, unstable beta features.

  Parameters:

  experimental - true to enable new features

• set

   void set(@NonNull() Control control)

  Shorthand for the appropriate set* method.For example, if control is a Grid, this calls setGrid.

  Parameters:

  control - desired value

• get

  @NonNull() <T extends Control> T get(@NonNull() Class<T> controlClass)

  Shorthand for the appropriate get* method.For example, if control class is a Grid, this calls getGrid.

  Parameters:

  controlClass - desired value class

• setPreview

   void setPreview(@NonNull() Preview preview)

  Controls the preview engine. Should only be calledif this CameraView was never added to any window(like if you created it programmatically).Otherwise, it has no effect.

  Parameters:

  preview - desired preview engine

• getPreview

  @NonNull() Preview getPreview()

  Returns the current preview control.

• setEngine

   void setEngine(@NonNull() Engine engine)

  Controls the core engine. Should only be calledif this CameraView is closed (open() was never called).Otherwise, it has no effect.

  Parameters:

  engine - desired engine

• getEngine

  @NonNull() Engine getEngine()

  Returns the current engine control.

• getCameraOptions

  @Nullable() CameraOptions getCameraOptions()

  Returns a CameraOptions instance holding supported options for this camerasession. This might change over time. It's better to hold a reference from onCameraOpened.

• setExposureCorrection

   void setExposureCorrection(float EVvalue)

  Sets exposure adjustment, in EV stops. A positive value will mean brighter picture.If camera is not opened, this will have no effect.If isExposureCorrectionSupported is false, this will have no effect.The provided value should be between the bounds returned by CameraOptions, or it willbe capped.

  Parameters:

  EVvalue - exposure correction value.

• getExposureCorrection

   float getExposureCorrection()

  Returns the current exposure correction value, typically 0at start-up.

• setZoom

   void setZoom(float zoom)

  Sets a zoom value. This is not guaranteed to be supported by the current device,but you can take a look at isZoomSupported.This will have no effect if called before the camera is opened.Zoom value should be between 0 and 1, where 1 will be the maximum available zoom.If it's not, it will be capped.

  Parameters:

  zoom - value in [0,1]

• getZoom

   float getZoom()

  Returns the current zoom value, something between 0 and 1.

• setGrid

   void setGrid(@NonNull() Grid gridMode)

  Controls the grids to be drawn over the current layout.

  Parameters:

  gridMode - desired grid mode

• getGrid

  @NonNull() Grid getGrid()

  Gets the current grid mode.

• setGridColor

   void setGridColor(@ColorInt() int color)

  Controls the color of the grid lines that will be drawnover the current layout.

  Parameters:

  color - a resolved color

• getGridColor

   int getGridColor()

  Returns the current grid color.

• setHdr

   void setHdr(@NonNull() Hdr hdr)

  Controls the grids to be drawn over the current layout.

  Parameters:

  hdr - desired hdr value

• getHdr

  @NonNull() Hdr getHdr()

  Gets the current hdr value.

• setLocation

   void setLocation(double latitude, double longitude)

  Set location coordinates to be found later in the EXIF header

  Parameters:

  latitude - current latitude

  longitude - current longitude

• setLocation

   void setLocation(@Nullable() Location location)

  Set location values to be found later in the EXIF header

  Parameters:

  location - current location

• getLocation

  @Nullable() Location getLocation()

  Retrieves the location previously applied with setLocation().

• setWhiteBalance

   void setWhiteBalance(@NonNull() WhiteBalance whiteBalance)

  Sets desired white balance to current camera session.

  Parameters:

  whiteBalance - desired white balance behavior.

• getWhiteBalance

  @NonNull() WhiteBalance getWhiteBalance()

  Returns the current white balance behavior.

• setFacing

   void setFacing(@NonNull() Facing facing)

  Sets which camera sensor should be used.

  Parameters:

  facing - a facing value.

• getFacing

  @NonNull() Facing getFacing()

  Gets the facing camera currently being used.

• toggleFacing

   Facing toggleFacing()

  Toggles the facing value between BACK and FRONT.

• setFlash

   void setFlash(@NonNull() Flash flash)

  Sets the flash mode.

  Parameters:

  flash - desired flash mode.

• getFlash

  @NonNull() Flash getFlash()

  Gets the current flash mode.

• setAudio

   void setAudio(@NonNull() Audio audio)

  Controls the audio mode.

  Parameters:

  audio - desired audio value

• getAudio

  @NonNull() Audio getAudio()

  Gets the current audio value.

• setAutoFocusMarker

   void setAutoFocusMarker(@Nullable() AutoFocusMarker autoFocusMarker)

  Sets an AutoFocusMarker to be notified of metering start, end and fail eventsso that it can draw elements on screen.

  Parameters:

  autoFocusMarker - the marker, or null

• setAutoFocusResetDelay

   void setAutoFocusResetDelay(long delayMillis)

  Sets the current delay in milliseconds to reset the focus after a metering event.

  Parameters:

  delayMillis - desired delay (in milliseconds).

• getAutoFocusResetDelay

   long getAutoFocusResetDelay()

  Returns the current delay in milliseconds to reset the focus after a metering event.

• startAutoFocus

   void startAutoFocus(float x, float y)

  Starts a 3A touch metering process at the given coordinates, with respectto the view width and height.

  Parameters:

  x - should be between 0 and getWidth()

  y - should be between 0 and getHeight()

• startAutoFocus

   void startAutoFocus(@NonNull() RectF region)

  Starts a 3A touch metering process at the given coordinates, with respectto the view width and height.

  Parameters:

  region - should be between 0 and getWidth() / getHeight()

• setPreviewStreamSize

   void setPreviewStreamSize(@NonNull() SizeSelector selector)

  ADVANCED FEATURE - sets a size selector for the preview stream.The SizeSelector will be invoked with the list of available sizes, and the firstacceptable size will be accepted and passed to the internal engine and surface.This is typically NOT NEEDED. The default size selector is already smart enough to respectthe picture/video output aspect ratio, and be bigger than the surface so that there is noupscaling. If all you want is set an aspect ratio, use setPictureSize and setVideoSize.When stream size changes, the CameraView is remeasured so any WRAP_CONTENT dimensionis recomputed accordingly.See the SizeSelectors class for handy utilities for creating selectors.

  Parameters:

  selector - a size selector

• setMode

   void setMode(@NonNull() Mode mode)

  Set the current session type to either picture or video.

  Parameters:

  mode - desired session type.

• getMode

  @NonNull() Mode getMode()

  Gets the current mode.

• setPictureSize

   void setPictureSize(@NonNull() SizeSelector selector)

  Sets a capture size selector for picture mode.The SizeSelector will be invoked with the list of available sizes, and the firstacceptable size will be accepted and passed to the internal engine.See the SizeSelectors class for handy utilities for creating selectors.

  Parameters:

  selector - a size selector

• setPictureMetering

   void setPictureMetering(boolean enable)

  Whether the engine should perform a metering sequence before taking pictures requestedwith takePicture. A metering sequence includes adjusting focus, exposureand white balance to ensure a good quality of the result.When this parameter is true, the quality of the picture increases, but the latencyincreases as well. Defaults to true.This is a CAMERA2 only API. On CAMERA1, picture metering is always enabled.

  Parameters:

  enable - true to enable

• getPictureMetering

   boolean getPictureMetering()

  Whether the engine should perform a metering sequence before taking pictures requestedwith takePicture. See setPictureMetering.

• setPictureSnapshotMetering

   void setPictureSnapshotMetering(boolean enable)

  Whether the engine should perform a metering sequence before taking pictures requestedwith takePictureSnapshot. A metering sequence includes adjusting focus,exposure and white balance to ensure a good quality of the result.When this parameter is true, the quality of the picture increases, but the latencyincreases as well. To keep snapshots fast, this defaults to false.This is a CAMERA2 only API. On CAMERA1, picture snapshot metering is always disabled.

  Parameters:

  enable - true to enable

• getPictureSnapshotMetering

   boolean getPictureSnapshotMetering()

  Whether the engine should perform a metering sequence before taking pictures requestedwith takePictureSnapshot. See setPictureSnapshotMetering.

• setPictureFormat

   void setPictureFormat(@NonNull() PictureFormat pictureFormat)

  Sets the format for pictures taken with takePicture. This format does not applyto picture snapshots taken with takePictureSnapshot.The JPEG is always supported - for other values, please checkthe getSupportedPictureFormats value.

  Parameters:

  pictureFormat - new format

• getPictureFormat

  @NonNull() PictureFormat getPictureFormat()

  Returns the current picture format.

• setVideoSize

   void setVideoSize(@NonNull() SizeSelector selector)

  Sets a capture size selector for video mode.The SizeSelector will be invoked with the list of available sizes, and the firstacceptable size will be accepted and passed to the internal engine.See the SizeSelectors class for handy utilities for creating selectors.

  Parameters:

  selector - a size selector

• setVideoBitRate

   void setVideoBitRate(int bitRate)

  Sets the bit rate in bits per second for video capturing.Will be used by both takeVideo and takeVideoSnapshot.

  Parameters:

  bitRate - desired bit rate

• getVideoBitRate

   int getVideoBitRate()

  Returns the current video bit rate.

• setPreviewFrameRateExact

   void setPreviewFrameRateExact(boolean videoFrameRateExact)

  A flag to control the behavior when calling setPreviewFrameRate.If the value is set to true, setPreviewFrameRate will choose the previewframe range as close to the desired new frame rate as possible. Which mean it may choose anarrow range around the desired frame rate. Note: This option will give you as exact fps asyou want but the sensor will have less freedom when adapting the exposure to the environment,which may lead to dark preview.If the value is set to false, setPreviewFrameRate will choose as broad rangeas it can.

  Parameters:

  videoFrameRateExact - whether want a more exact preview frame range

• getPreviewFrameRateExact

   boolean getPreviewFrameRateExact()

  Returns whether we want to set preview fps as exact as we set through setPreviewFrameRate.

• setPreviewFrameRate

   void setPreviewFrameRate(float frameRate)

  Sets the preview frame rate in frames per second.This rate will be used, for example, by the frame processor and in videosnapshot taken through takeVideo.A value of 0F will restore the rate to a default value.

  Parameters:

  frameRate - desired frame rate

• getPreviewFrameRate

   float getPreviewFrameRate()

  Returns the current preview frame rate.This can return 0F if no frame rate was set.

• setAudioBitRate

   void setAudioBitRate(int bitRate)

  Sets the bit rate in bits per second for audio capturing.Will be used by both takeVideo and takeVideoSnapshot.

  Parameters:

  bitRate - desired bit rate

• getAudioBitRate

   int getAudioBitRate()

  Returns the current audio bit rate.

• setAudioCodec

   void setAudioCodec(@NonNull() AudioCodec codec)

  Sets the encoder for audio recordings.Defaults to DEVICE_DEFAULT.

  Parameters:

  codec - requested audio codec

• getAudioCodec

  @NonNull() AudioCodec getAudioCodec()

  Gets the current encoder for audio recordings.

• addCameraListener

   void addCameraListener(@NonNull() CameraListener cameraListener)

  Adds a CameraListener instance to be notified of allinteresting events that happen during the camera lifecycle.

  Parameters:

  cameraListener - a listener for events.

• removeCameraListener

   void removeCameraListener(@NonNull() CameraListener cameraListener)

  Remove a CameraListener that was previously registered.

  Parameters:

  cameraListener - a listener for events.

• clearCameraListeners

   void clearCameraListeners()

  Clears the list of CameraListener that are registeredto camera events.

• takePicture

   void takePicture()

  Asks the camera to capture an image of the current scene.This will trigger onPictureTaken if a listenerwas registered.

• takePictureSnapshot

   void takePictureSnapshot()

  Asks the camera to capture a snapshot of the current preview.This eventually triggers onPictureTaken if a listenerwas registered.The difference with takePicture is that this capture is faster, so it might bebetter on slower cameras, though the result can be generally blurry or low quality.

• takeVideo

   void takeVideo(@NonNull() File file)

  Starts recording a video. Video will be written to the given file,so callers should ensure they have appropriate permissions to write to the file.

  Parameters:

  file - a file where the video will be saved

• takeVideo

   void takeVideo(@NonNull() FileDescriptor fileDescriptor)

  Starts recording a video. Video will be written to the given file,so callers should ensure they have appropriate permissions to write to the file.

  Parameters:

  fileDescriptor - a file descriptor where the video will be saved

• takeVideoSnapshot

   void takeVideoSnapshot(@NonNull() File file)

  Starts recording a fast, low quality video snapshot. Video will be written to the given file,so callers should ensure they have appropriate permissions to write to the file.Throws an exception if API level is below 18, or if the preview being used is not GL_SURFACE.

  Parameters:

  file - a file where the video will be saved

• takeVideo

   void takeVideo(@NonNull() File file, int durationMillis)

  Starts recording a video. Video will be written to the given file,so callers should ensure they have appropriate permissions to write to the file.Recording will be automatically stopped after the given duration, overridingtemporarily any duration limit set by setVideoMaxDuration.

  Parameters:

  file - a file where the video will be saved

  durationMillis - recording max duration

• takeVideo

   void takeVideo(@NonNull() FileDescriptor fileDescriptor, int durationMillis)

  Starts recording a video. Video will be written to the given file,so callers should ensure they have appropriate permissions to write to the file.Recording will be automatically stopped after the given duration, overridingtemporarily any duration limit set by setVideoMaxDuration.

  Parameters:

  fileDescriptor - a file descriptor where the video will be saved

  durationMillis - recording max duration

• takeVideoSnapshot

   void takeVideoSnapshot(@NonNull() File file, int durationMillis)

  Starts recording a fast, low quality video snapshot. Video will be written to the given file,so callers should ensure they have appropriate permissions to write to the file.Recording will be automatically stopped after the given duration, overridingtemporarily any duration limit set by setVideoMaxDuration.Throws an exception if API level is below 18, or if the preview being used is not GL_SURFACE.

  Parameters:

  file - a file where the video will be saved

  durationMillis - recording max duration

• stopVideo

   void stopVideo()

  Stops capturing video or video snapshots being recorded, if there was any.This will fire onVideoTaken.

• setSnapshotMaxWidth

   void setSnapshotMaxWidth(int maxWidth)

  Sets the max width for snapshots taken with takePictureSnapshot or takeVideoSnapshot. If the snapshot width exceeds this value, the snapshotwill be scaled down to match this constraint.

  Parameters:

  maxWidth - max width for snapshots

• setSnapshotMaxHeight

   void setSnapshotMaxHeight(int maxHeight)

  Sets the max height for snapshots taken with takePictureSnapshot or takeVideoSnapshot. If the snapshot height exceeds this value, the snapshotwill be scaled down to match this constraint.

  Parameters:

  maxHeight - max height for snapshots

• getSnapshotMaxWidth

   int getSnapshotMaxWidth()

  The max width for snapshots.

• getSnapshotMaxHeight

   int getSnapshotMaxHeight()

  The max height for snapshots.

• getSnapshotSize

  @Nullable() Size getSnapshotSize()

  Returns the size used for snapshots, or null if it hasn't been computed(for example if the surface is not ready). This is the preview size, rotated to matchthe output orientation, and cropped to the visible part.This also includes the setSnapshotMaxWidth and setSnapshotMaxHeight constraints.This does NOT include any constraints specific to video encoding, which aredevice specific and depend on the capabilities of the device codec.

• getPictureSize

  @Nullable() Size getPictureSize()

  Returns the size used for pictures taken with takePicture,or null if it hasn't been computed (for example if the surface is not ready),or null if we are in video mode.The size is rotated to match the output orientation.

• getVideoSize

  @Nullable() Size getVideoSize()

  Returns the size used for videos taken with takeVideo,or null if it hasn't been computed (for example if the surface is not ready),or null if we are in picture mode.The size is rotated to match the output orientation.

• setPlaySounds

   void setPlaySounds(boolean playSounds)

  Controls whether CameraView should play sound effects on certainevents (picture taken, focus complete). Note that:- On API level {@literal <} 16, this flag is always false- Camera1 will always play the shutter sound when taking pictures

  Parameters:

  playSounds - whether to play sound effects

• getPlaySounds

   boolean getPlaySounds()

  Gets the current sound effect behavior.

• setUseDeviceOrientation

   void setUseDeviceOrientation(boolean useDeviceOrientation)

  Controls whether picture and video output should consider the current device orientation.For example, when true, if the user rotates the device before taking a picture, the picturewill be rotated as well.

  Parameters:

  useDeviceOrientation - true to consider device orientation for outputs

• getUseDeviceOrientation

   boolean getUseDeviceOrientation()

  Gets the current behavior for considering the device orientation when returning pictureor video outputs.

• setVideoCodec

   void setVideoCodec(@NonNull() VideoCodec codec)

  Sets the encoder for video recordings.Defaults to DEVICE_DEFAULT.

  Parameters:

  codec - requested video codec

• getVideoCodec

  @NonNull() VideoCodec getVideoCodec()

  Gets the current encoder for video recordings.

• setVideoMaxSize

   void setVideoMaxSize(long videoMaxSizeInBytes)

  Sets the maximum size in bytes for recorded video files.Once this size is reached, the recording will automatically stop.Defaults to unlimited size. Use 0 or negatives to disable.

  Parameters:

  videoMaxSizeInBytes - The maximum video size in bytes

• getVideoMaxSize

   long getVideoMaxSize()

  Returns the maximum size in bytes for recorded video files, or 0if no size was set.

• setVideoMaxDuration

   void setVideoMaxDuration(int videoMaxDurationMillis)

  Sets the maximum duration in milliseconds for video recordings.Once this duration is reached, the recording will automatically stop.Defaults to unlimited duration. Use 0 or negatives to disable.

  Parameters:

  videoMaxDurationMillis - The maximum video duration in milliseconds

• getVideoMaxDuration

   int getVideoMaxDuration()

  Returns the maximum duration in milliseconds for video recordings, or 0if no limit was set.

• isTakingVideo

   boolean isTakingVideo()

  Returns true if the camera is currently recording a video

• isTakingPicture

   boolean isTakingPicture()

  Returns true if the camera is currently capturing a picture

• setDrawHardwareOverlays

   void setDrawHardwareOverlays(boolean on)

  Sets the overlay layout hardware canvas capture mode to allow hardwareaccelerated views to be captured in snapshots

  Parameters:

  on - true if enabled

• getDrawHardwareOverlays

   boolean getDrawHardwareOverlays()

  Returns true if the overlay layout is set to capture the hardware canvasof child views

• addFrameProcessor

   void addFrameProcessor(@Nullable() FrameProcessor processor)

  Adds a FrameProcessor instance to be notified ofnew frames in the preview stream.

  Parameters:

  processor - a frame processor.

• removeFrameProcessor

   void removeFrameProcessor(@Nullable() FrameProcessor processor)

  Remove a FrameProcessor that was previously registered.

  Parameters:

  processor - a frame processor

• clearFrameProcessors

   void clearFrameProcessors()

  Clears the list of FrameProcessor that have been registeredto preview frames.

• setFrameProcessingMaxWidth

   void setFrameProcessingMaxWidth(int maxWidth)

  Sets the max width for frame processing Frames.This option is only supported by CAMERA2 and will have no effecton other engines.

  Parameters:

  maxWidth - max width for frames

• setFrameProcessingMaxHeight

   void setFrameProcessingMaxHeight(int maxHeight)

  Sets the max height for frame processing Frames.This option is only supported by CAMERA2 and will have no effecton other engines.

  Parameters:

  maxHeight - max height for frames

• getFrameProcessingMaxWidth

   int getFrameProcessingMaxWidth()

  The max width for frame processing frames.

• getFrameProcessingMaxHeight

   int getFrameProcessingMaxHeight()

  The max height for frame processing frames.

• setFrameProcessingFormat

   void setFrameProcessingFormat(int format)

  Sets the android.graphics.ImageFormat for frame processing.Before applying you should check getSupportedFrameProcessingFormats.

  Parameters:

  format - image format

• getFrameProcessingFormat

   int getFrameProcessingFormat()

  Returns the current frame processing format.

• setFrameProcessingPoolSize

   void setFrameProcessingPoolSize(int poolSize)

  Sets the frame processing pool size. This is (roughly) the max number of Frame instances that can exist at a given moment in the frame pipeline,excluding frozen frames.Defaults to 2 - higher values will increase the memory usage with little benefit.Can be higher than 2 if setFrameProcessingExecutors is used.These values should be tuned together. We recommend setting a pool size that's equal tothe number of executors plus 1, so that there's always a free Frame for the camera engine.Changing this value after camera initialization will have no effect.

  Parameters:

  poolSize - pool size

• getFrameProcessingPoolSize

   int getFrameProcessingPoolSize()

  Returns the current frame processing pool size.

• setFrameProcessingExecutors

   void setFrameProcessingExecutors(int executors)

  Sets the thread pool size for frame processing. This means that if the processing rateis slower than the preview rate, you can set this value to something bigger than 1to avoid losing frames.Defaults to 1 and this should be OK for most applications.Should be tuned depending on the task, the processor implementation, and along with setFrameProcessingPoolSize. We recommend choosing a pool size that isequal to the executors plus 1.

  Parameters:

  executors - thread count

• getFrameProcessingExecutors

   int getFrameProcessingExecutors()

  Returns the current executors count.

• generateLayoutParams

   FrameLayout.LayoutParams generateLayoutParams(AttributeSet attributeSet)

• addView

   void addView(View child, int index, ViewGroup.LayoutParams params)

• removeView

   void removeView(View view)

• setFilter

   void setFilter(@NonNull() Filter filter)

  Applies a real-time filter to the camera preview, if it supports it.The only preview type that does so is currently GL_SURFACE.The filter will be applied to any picture snapshot taken with takePictureSnapshot and any video snapshot taken with takeVideoSnapshot.Use NoFilter to clear the existing filter,and take a look at the Filters class for commonly used filters.This method will throw an exception if the current preview does not support real-timefilters. Make sure you use GL_SURFACE (the default).

  Parameters:

  filter - a new filter

• getFilter

  @NonNull() Filter getFilter()

  Returns the current real-time filter applied to the camera preview.This method will throw an exception if the current preview does not support real-timefilters. Make sure you use GL_SURFACE (the default).