groundsdk 7.7.2 API/com.parrot.drone.groundsdk.device.peripheral.camera/Camera

Camera

interface Camera

Base camera interface.

Provides control of drone camera in order to take pictures and to record videos. Also provides access to various camera settings, such as:

  • Exposure,
  • EV compensation,
  • White balance,
  • Zoom,
  • Recording mode, resolution and framerate selection,
  • Photo mode, format and file format selection.

Inheritors

Types

Link copied to clipboard
enum Mode
Camera operating mode.

Functions

Link copied to clipboard
@Nullable
abstract fun alignment(): CameraAlignment.Setting
Gives access to the camera alignment setting.
Link copied to clipboard
@NonNull
abstract fun autoHdr(): OptionalBooleanSetting
Gives access to the camera automatic High Dynamic Range (HDR) setting.
Link copied to clipboard
@NonNull
abstract fun autoRecord(): OptionalBooleanSetting
Gives access to the auto-record setting.
Link copied to clipboard
abstract fun canStartPhotoCapture(): Boolean
Tells whether it is currently possible to start photo(s) capture.
Link copied to clipboard
abstract fun canStartRecording(): Boolean
Tells whether it is currently possible to start recording a video.
Link copied to clipboard
abstract fun canStopPhotoCapture(): Boolean
Tells whether it is currently possible to stop photo(s) capture.
Link copied to clipboard
abstract fun canStopRecording(): Boolean
Tells whether it is currently possible to stop recording a video.
Link copied to clipboard
@NonNull
abstract fun exposure(): CameraExposure.Setting
Gives access to the camera exposure setting.
Link copied to clipboard
@NonNull
abstract fun exposureCompensation(): EnumSetting<CameraEvCompensation>
Gives access to the camera EV (Exposure Value) compensation setting.
Link copied to clipboard
@Nullable
abstract fun exposureLock(): CameraExposureLock
Gives access to the camera exposure lock setting.
Link copied to clipboard
abstract fun isActive(): Boolean
Tells whether the camera is active or not.
Link copied to clipboard
abstract fun isHdrActive(): Boolean
Tells if HDR is currently active.
Link copied to clipboard
abstract fun isHdrAvailable(): Boolean
Tells if HDR is available in the current mode and configuration.
Link copied to clipboard
@NonNull
abstract fun mode(): EnumSetting<Camera.Mode>
Gives access to the camera mode setting.
Link copied to clipboard
@NonNull
abstract fun photo(): CameraPhoto.Setting
Gives access to the camera photo mode setting.
Link copied to clipboard
@NonNull
abstract fun photoState(): CameraPhoto.State
Retrieves the current state of the photo function.
Link copied to clipboard
@NonNull
abstract fun recording(): CameraRecording.Setting
Gives access to the camera recording mode setting.
Link copied to clipboard
@NonNull
abstract fun recordingState(): CameraRecording.State
Retrieves the current state of the recording function.
Link copied to clipboard
abstract fun startPhotoCapture()
Requests photo capture to start.
Link copied to clipboard
abstract fun startRecording()
Requests video recording to start.
Link copied to clipboard
abstract fun stopPhotoCapture()
Requests photo capture to stop.
Link copied to clipboard
abstract fun stopRecording()
Requests video recording to stop.
Link copied to clipboard
@NonNull
abstract fun style(): CameraStyle.Setting
Gives access to the camera image style setting.
Link copied to clipboard
@NonNull
abstract fun whiteBalance(): CameraWhiteBalance.Setting
Gives access to the camera white balance setting.
Link copied to clipboard
@Nullable
abstract fun whiteBalanceLock(): CameraWhiteBalanceLock
Gives access to the camera white balance lock setting.
Link copied to clipboard
@Nullable
abstract fun zoom(): CameraZoom
Retrieves the camera zoom sub-peripheral.