class SettingsDefinitions

@EXClassNullAway
 class SettingsDefinitions

Package:

dji.common.camera

Description:

This class contains all the enums and setting classes for the DJI Camera.

Class Members:

Settings

enum

LensType

enum LensType

enum LensType

Package:

dji.common.camera

Description:

Camera lens type. Only supported by Zenmuse H20 Series.

Enum Members:

ZOOM	Zoom lens.
WIDE	Wide lens.
INFRARED_THERMAL	Infrared Thermal lens.
UNKNOWN	Unknown.

Class Members:

enum

MultispectralDisplayMode

enum MultispectralDisplayMode

enum MultispectralDisplayMode

Package:

dji.common.camera

Description:

Display modes to coordinate the video feeds from both the RGB sensor and single-band sensors. Only supported by multispectral camera of P4 Multispectral.

Enum Members:

RGB_ONLY	Displays only the video feed from the RGB sensor.
NDVI	Displays the NVDI (normalized difference vegetation index) frames as video feed produced by the multispectral camera.
UNKNOWN	The multispectral camera video feed display mode is unknown.

Class Members:

enum

SpectrumBand

enum SpectrumBand

enum SpectrumBand

Package:

dji.common.camera

Description:

Enums represent the spectrum bands of a multispectral camera. For P4 Multispectral, the camera supports 5 bands. Only supported by multispectral camera of P4 Multispectral.

Enum Members:

BLUE	The blue spectrum.
GREEN	The green spectrum.
RED	The red spectrum.
NEAR_INFRARED	The near infrared spectrum.
RED_EDGE	The red edge spectrum.
UNKNOWN	Unknown.

Class Members:

enum

CameraMode

enum CameraMode

enum CameraMode

Package:	dji.common.camera
SDK Key:	CameraKey.MODE, CameraKey.MODE_RANGE

Description:

Camera work modes.

Enum Members:

SHOOT_PHOTO	Capture mode. In this mode, the user can capture pictures.
RECORD_VIDEO	Record mode. In this mode, the user can record videos.
PLAYBACK	Playback mode. In this mode, the user can preview photos and videos, and can delete files. It is supported by Phantom 3 Professional camera, X3, X5 and X5R cameras on aircraft and Phantom 4 camera. Playback mode is not supported by Z30, X5S, X4S, Phantom 4 Pro, Mavic Pro, Phantom 3 Standard, Phantom 3 Advanced, Phantom 3 4K and Osmo series.
MEDIA_DOWNLOAD	In this mode, the user can download media to the Mobile Device. Not supported by X5 camera nor X5R camera while mounted on aircraft.
BROADCAST	In this mode, live stream resolution and frame rate will be 1080i50 (PAL) or 720p60 (NTSC). In this mode videos can be recorded. Still photos can also be taken only when video is recording. The only way to exit broadcast mode is to change modes to `RECORD_VIDEO`. Only supported by Inspire 2.
UNKNOWN	The camera work mode is unknown.

Class Members:

enum

ShootPhotoMode

enum ShootPhotoMode

enum ShootPhotoMode

Package:	dji.common.camera
SDK Key:	CameraKey.SHOOT_PHOTO_MODE, CameraKey.SHOOT_PHOTO_MODE_RANGE

Description:

The ShootPhoto mode itself can have several modes. The default value is SINGLE.

Enum Members:

SINGLE	Sets the camera to take a single photo.
HDR	Sets the camera to take an HDR photo. X5 camera, X5R camera, XT camera, Z30 camera, Phantom 4 Pro camera, X4S camera and X5S camera do not support HDR mode.
BURST	Set the camera to take multiple photos at once. XT camera does not support Burst mode.
AEB	Automatic Exposure Bracketing (AEB) capture. In this mode you can quickly take multiple shots (the default is 3) at different exposures without having to manually change any settings between frames. XT camera and Z30 camera does not support AEB mode.
INTERVAL	Sets the camera to take a picture (or multiple pictures) continuously at a set time interval. The minimum interval for JPEG format of any quality is 2s. For all cameras except X4S, X5S and Phantom 4 Pro camera: The minimum interval for RAW or RAW+JPEG format is 10s. For the X4S, X5S and Phantom 4 Pro cameras the minimum interval for RAW or RAW+JPEG dformat is 5s.
TIME_LAPSE	Sets the camera to take a picture (or multiple pictures) continuously at a set time interval. The camera will merge the photo sequence and the output is a video. The minimum interval for Video only format is 1 s. The minimum interval for Video+Photo format is 2 s. For the new Osmo firmware version, no video feed will be received if the camera is shooting photos with Time-lapse mode. Instead, user can receive a sequence of preview images using the delegate method `onGenerate`. Supported only by Osmo camera (Z3 and X3).
PANORAMA	In panorama mode, the aircraft takes a series of photos with different gimbal and aircraft heading positions. The photos can be stitched with a third-party library. It is supported by Spark, Mavic Air, Mavic 2, Mavic 2 Pro, Mavic 2 Zoom, Mavic 2 Eneterprise, Mavic 2 Enterprise Dual.
EHDR	Sets the camera to take an enhanced-HDR photo. It blends a sequence of photos for ghost-free high dynamic range photos. It is supported by Mavic 2 Zoom and Mavic 2 Pro.
HYPER_LIGHT	Sets the camera to take photos in HyperLight mode. It is a setting for low-light environment to enhance the photo quality while reducing noise significantly. It is supported by Mavic 2 Zoom and Mavic 2 Pro.
HIGH_RESOLUTION	Indicates that the photo was taken in high resolution mode(48 MP 8000×6000 pixel). Supported by Mavic Air 2.
RAW_BURST	Sets the camera to take a burst of RAW photos. Use `getRAWPhotoBurstCount` to check how many photos have been shot. Only supported by X5S.
SHALLOW_FOCUS	Sets the camera to take a series of photos while the aircraft moves up and down automatically. The image's depth of field can be computed with a third-party library to produce a photo with the bokeh effect. Note: 1. It is only suitable for shooting still scenes. 2. The aircraft will ascend about 20cm before shooting. Ensure that there is no obstacle about the aircraft. 3. The suitable range of shooting is within 30m. It is only supported by Spark.
UNKNOWN	The shoot photo mode is unknown.

Class Members:

enum

ExposureMode

enum ExposureMode

enum ExposureMode

Package:	dji.common.camera
SDK Key:	CameraKey.EXPOSURE_MODE, CameraKey.EXPOSURE_MODE_RANGE

Description:

Camera exposure modes. The default value is PROGRAM. The different exposure modes define whether Aperture, Shutter Speed, ISO can be set automatically or manually. Exposure compensation can be changed in all modes except Manual mode where it is not settable.
X5, X5R, Phantom 4 Pro camera, X4S and X5S:
Program Mode: Shutter: Auto Aperture: Auto ISO: Manual or Auto
Shutter Priority: Shutter: Manual Aperture: Auto ISO: Manual or Auto
Aperture Priority: Shutter: Auto Aperture: Manual ISO: Manual or Auto
Manual Mode: Shutter: Manual Aperture: Manual ISO: Manual

All other cameras:
Program Mode: Shutter: Auto Aperture: Fixed ISO: Auto
Shutter Priority: Shutter: Manual Aperture: Fixed ISO: Auto
Aperture Priority: NA
Manual Mode: Shutter: Manual Aperture: Manual ISO: Manual

Enum Members:

PROGRAM	Program mode.
SHUTTER_PRIORITY	Shutter priority mode.
APERTURE_PRIORITY	Aperture priority mode.
MANUAL	Manual mode.
UNKNOWN	The camera exposure mode is unknown.

Class Members:

enum

ShutterSpeed

enum ShutterSpeed

enum ShutterSpeed

Package:	dji.common.camera
SDK Key:	CameraKey.SHUTTER_SPEED, CameraKey.SHUTTER_SPEED_RANGE

Description:

Camera's shutter speed options.

Enum Members:

SHUTTER_SPEED_1_20000	Camera's shutter speed 1/20000 s.
SHUTTER_SPEED_1_16000	Camera's shutter speed 1/16000 s.
SHUTTER_SPEED_1_12800	Camera's shutter speed 1/12800 s.
SHUTTER_SPEED_1_10000	Camera's shutter speed 1/10000 s.
SHUTTER_SPEED_1_8000	Camera's shutter speed 1/8000 s.
SHUTTER_SPEED_1_6400	Camera's shutter speed 1/6400 s.
SHUTTER_SPEED_1_6000	Camera's shutter speed 1/6000 s.
SHUTTER_SPEED_1_5000	Camera's shutter speed 1/5000 s.
SHUTTER_SPEED_1_4000	Camera's shutter speed 1/4000 s.
SHUTTER_SPEED_1_3200	Camera's shutter speed 1/3200 s.
SHUTTER_SPEED_1_3000	Camera's shutter speed 1/3000 s.
SHUTTER_SPEED_1_2500	Camera's shutter speed 1/2500 s.
SHUTTER_SPEED_1_2000	Camera's shutter speed 1/2000 s.
SHUTTER_SPEED_1_1600	Camera's shutter speed 1/1600 s.
SHUTTER_SPEED_1_1500	Camera's shutter speed 1/1500 s.
SHUTTER_SPEED_1_1250	Camera's shutter speed 1/1250 s.
SHUTTER_SPEED_1_1000	Camera's shutter speed 1/1000 s.
SHUTTER_SPEED_1_800	Camera's shutter speed 1/800 s.
SHUTTER_SPEED_1_725	Camera's shutter speed 1/725 s.
SHUTTER_SPEED_1_640	Camera's shutter speed 1/640 s.
SHUTTER_SPEED_1_500	Camera's shutter speed 1/500 s.
SHUTTER_SPEED_1_400	Camera's shutter speed 1/400 s.
SHUTTER_SPEED_1_350	Camera's shutter speed 1/350 s.
SHUTTER_SPEED_1_320	Camera's shutter speed 1/320 s.
SHUTTER_SPEED_1_250	Camera's shutter speed 1/250 s.
SHUTTER_SPEED_1_240	Camera's shutter speed 1/240 s.
SHUTTER_SPEED_1_200	Camera's shutter speed 1/200 s.
SHUTTER_SPEED_1_180	Camera's shutter speed 1/180 s.
SHUTTER_SPEED_1_160	Camera's shutter speed 1/160 s.
SHUTTER_SPEED_1_125	Camera's shutter speed 1/125 s.
SHUTTER_SPEED_1_120	Camera's shutter speed 1/120 s.
SHUTTER_SPEED_1_100	Camera's shutter speed 1/100 s.
SHUTTER_SPEED_1_90	Camera's shutter speed 1/90 s.
SHUTTER_SPEED_1_80	Camera's shutter speed 1/80 s.
SHUTTER_SPEED_1_60	Camera's shutter speed 1/60 s.
SHUTTER_SPEED_1_50	Camera's shutter speed 1/50 s.
SHUTTER_SPEED_1_40	Camera's shutter speed 1/40 s.
SHUTTER_SPEED_1_30	Camera's shutter speed 1/30 s.
SHUTTER_SPEED_1_25	Camera's shutter speed 1/25 s.
SHUTTER_SPEED_1_20	Camera's shutter speed 1/20 s.
SHUTTER_SPEED_1_15	Camera's shutter speed 1/15 s.
SHUTTER_SPEED_1_12_DOT_5	Camera's shutter speed 1/12.5 s.
SHUTTER_SPEED_1_10	Camera's shutter speed 1/10 s.
SHUTTER_SPEED_1_8	Camera's shutter speed 1/8 s.
SHUTTER_SPEED_1_6_DOT_25	Camera's shutter speed 1/6.25 s.
SHUTTER_SPEED_1_5	Camera's shutter speed 1/5 s.
SHUTTER_SPEED_1_4	Camera's shutter speed 1/4 s.
SHUTTER_SPEED_1_3	Camera's shutter speed 1/3 s.
SHUTTER_SPEED_1_2_DOT_5	Camera's shutter speed 1/2.5 s.
SHUTTER_SPEED_1_2	Camera's shutter speed 1/2 s.
SHUTTER_SPEED_1_1_DOT_67	Camera's shutter speed 1/1.67 s.
SHUTTER_SPEED_1_1_DOT_25	Camera's shutter speed 1/1.25 s.
SHUTTER_SPEED_1	Camera's shutter speed 1.0 s.
SHUTTER_SPEED_1_DOT_3	Camera's shutter speed 1.3 s.
SHUTTER_SPEED_1_DOT_6	Camera's shutter speed 1.6 s.
SHUTTER_SPEED_2	Camera's shutter speed 2.0 s.
SHUTTER_SPEED_2_DOT_5	Camera's shutter speed 2.5 s.
SHUTTER_SPEED_3	Camera's shutter speed 3.0 s.
SHUTTER_SPEED_3_DOT_2	Camera's shutter speed 3.2 s.
SHUTTER_SPEED_4	Camera's shutter speed 4.0 s.
SHUTTER_SPEED_5	Camera's shutter speed 5.0 s.
SHUTTER_SPEED_6	Camera's shutter speed 6.0 s.
SHUTTER_SPEED_7	Camera's shutter speed 7.0 s.
SHUTTER_SPEED_8	Camera's shutter speed 8.0 s.
SHUTTER_SPEED_9	Camera's shutter speed 9.0 s.
SHUTTER_SPEED_10	Camera's shutter speed 10.0 s.
SHUTTER_SPEED_13	Camera's shutter speed 13.0 s.
SHUTTER_SPEED_15	Camera's shutter speed 15.0 s.
SHUTTER_SPEED_20	Camera's shutter speed 20.0 s.
SHUTTER_SPEED_25	Camera's shutter speed 25.0 s.
SHUTTER_SPEED_30	Camera's shutter speed 30.0 s.
UNKNOWN	Camera's shutter speed unknown.

Class Members:

enum

ISO

enum ISO

enum ISO

Package:	dji.common.camera
SDK Key:	CameraKey.ISO, CameraKey.ISO_RANGE

Description:

Camera ISO values.

Enum Members:

AUTO	The ISO value is automatically set. This cannot be used for all cameras when in Manual mode.
ISO_50	The ISO value is set to 50.
ISO_100	The ISO value is set to 100.
ISO_200	The ISO value is set to 200.
ISO_400	The ISO value is set to 400.
ISO_800	The ISO value is set to 800.
ISO_1600	The ISO value is set to 1600.
ISO_3200	The ISO value is set to 3200.
ISO_6400	The ISO value is set to 6400.
ISO_12800	The ISO value is set to 12800.
ISO_25600	The ISO value is set to 25600.
ISO_51200	The ISO value is set to 51200.
ISO_102400	The ISO value is set to 102400.
FIXED	ISO value is fixed by the camera firmware. When the camera color is set to `D_LOG`, camera will fix the ISO to a specific value in order to optimize the performance. The value set by camera can be accessed from `getISO`.
UNKNOWN	The ISO value is set to Unknown value.

Class Members:

enum

Aperture

enum Aperture

enum Aperture

Package:	dji.common.camera
SDK Key:	CameraKey.APERTURE, CameraKey.APERTURE_RANGE

Description:

Camera aperture values. Zenmuse P1, X5, X5R, Z30, Phantom 4 Pro camera, X4S and X5S support this setting.

Enum Members:

F_1	The Aperture value is f/1.
F_1_DOT_2	The Aperture value is f/1.2.
F_1_DOT_3	The Aperture value is f/1.3.
F_1_DOT_4	The Aperture value is f/1.4.
F_1_DOT_6	The Aperture value is f/1.6. It is only supported by Z30 camera.
F_1_DOT_7	The Aperture value is f/1.7.
F_1_DOT_8	The Aperture value is f/1.8.
F_2	The Aperture value is f/2.
F_2_DOT_2	The Aperture value is f/2.2.
F_2_DOT_4	The Aperture value is f/2.4. It is only supported by Z30 camera.
F_2_DOT_5	The Aperture value is f/2.5.
F_2_DOT_6	The Aperture value is f/2.6.
F_2_DOT_8	The Aperture value is f/2.8.
F_3_DOT_2	The Aperture value is f/3.2.
F_3_DOT_4	The Aperture value is f/3.4.
F_3_DOT_5	The Aperture value is f/3.5.
F_4	The Aperture value is f/4.
F_4_DOT_5	The Aperture value is f/4.5.
F_4_DOT_8	The Aperture value is f/4.8.
F_5	The Aperture value is f/5.
F_5_DOT_6	The Aperture value is f/5.6.
F_6_DOT_3	The Aperture value is f/6.3.
F_6_DOT_8	The Aperture value is f/6.8.
F_7_DOT_1	The Aperture value is f/7.1.
F_8	The Aperture value is f/8.
F_9	The Aperture value is f/9.
F_9_DOT_6	The Aperture value is f/9.6.
F_10	The Aperture value is f/10.
F_11	The Aperture value is f/11.
F_13	The Aperture value is f/13.
F_14	The Aperture value is f/14.
F_16	The Aperture value is f/16.
F_18	The Aperture value is f/18.
F_19	The Aperture value is f/19.
F_20	The Aperture value is f/20.
F_22	The Aperture value is f/22.
F_25	The Aperture value is f/25.
F_28	The Aperture value is f/28.
F_32	The Aperture value is f/32.
F_37	The Aperture value is f/37.
F_41	The Aperture value is f/41.
F_45	The Aperture value is f/45.
F_52	The Aperture value is f/52.
F_58	The Aperture value is f/58.
F_64	The Aperture value is f/64.
UNKNOWN	The Aperture value is Unknown.

Class Members:

enum

WhiteBalancePreset

enum WhiteBalancePreset

enum WhiteBalancePreset

Package:	dji.common.camera
SDK Key:	CameraKey.WHITE_BALANCE, CameraKey.WHITE_BALANCE_PRESENT_RANGE

Description:

Camera white balance. The default value is Auto.

Enum Members:

AUTO	The camera's white balance is automatically set.
SUNNY	The camera's white balance is set to sunny.
CLOUDY	The camera's white balance is set to cloudy.
WATER_SURFACE	The camera's white balance is set to water surface.
INDOOR_INCANDESCENT	The camera's white balance is set to indoors and incandescent light.
INDOOR_FLUORESCENT	The camera's white balance is set to indoors and fluorescent light.
CUSTOM	The camera's white balance is set to custom color temperature. By using this white balance value, user can set a specific value for the color temperature.
UNKNOWN	The camera's white balance is unknown.
PRESET_NEUTRAL	The camera's white balance is set to neutral. It is only supported by the X7.

Class Members:

enum

MeteringMode

enum MeteringMode

enum MeteringMode

Package:	dji.common.camera
SDK Key:	CameraKey.METERING_MODE

Description:

Camera exposure metering. The default value is Center.

Enum Members:

CENTER	The camera's exposure metering is set to the center.
AVERAGE	The camera's exposure metering is set to average.
SPOT	The camera's exposure metering is set to a single spot.
UNKNOWN	The camera's exposure metering is unknown.

Class Members:

enum

ExposureCompensation

enum ExposureCompensation

enum ExposureCompensation

Package:	dji.common.camera
SDK Key:	CameraKey.EXPOSURE_COMPENSATION, CameraKey.EXPOSURE_COMPENSATION_RANGE

Description:

Camera exposure compensation.

Enum Members:

N_5_0	The camera's exposure compensation is -5.0ev.
N_4_7	The camera's exposure compensation is -4.7ev.
N_4_3	The camera's exposure compensation is -4.3ev.
N_4_0	The camera's exposure compensation is -4.0ev.
N_3_7	The camera's exposure compensation is -3.7ev.
N_3_3	The camera's exposure compensation is -3.3ev.
N_3_0	The camera's exposure compensation is -3.0ev.
N_2_7	The camera's exposure compensation is -2.7ev.
N_2_3	The camera's exposure compensation is -2.3ev.
N_2_0	The camera's exposure compensation is -2.0ev.
N_1_7	The camera's exposure compensation is -1.7ev.
N_1_3	The camera's exposure compensation is -1.3ev.
N_1_0	The camera's exposure compensation is -1.0ev.
N_0_7	The camera's exposure compensation is -0.7ev.
N_0_3	The camera's exposure compensation is -0.3ev.
N_0_0	The camera's exposure compensation is 0.0ev.
P_0_3	The camera's exposure compensation is +0.3ev.
P_0_7	The camera's exposure compensation is +0.7ev.
P_1_0	The camera's exposure compensation is +1.0ev.
P_1_3	The camera's exposure compensation is +1.3ev.
P_1_7	The camera's exposure compensation is +1.7ev.
P_2_0	The camera's exposure compensation is +2.0ev.
P_2_3	The camera's exposure compensation is +2.3ev.
P_2_7	The camera's exposure compensation is +2.7ev.
P_3_0	The camera's exposure compensation is +3.0ev.
P_3_3	The camera's exposure compensation is +3.3ev.
P_3_7	The camera's exposure compensation is +3.7ev.
P_4_0	The camera's exposure compensation is +4.0ev.
P_4_3	The camera's exposure compensation is +4.3ev.
P_4_7	The camera's exposure compensation is +4.7ev.
P_5_0	The camera's exposure compensation is +5.0ev.
FIXED	The camera's exposure compensation is fixed by the camera.
UNKNOWN	The camera's exposure compensation is unknown.

Class Members:

class

ExposureSettings

enum

DisplayMode

enum DisplayMode

enum DisplayMode

Package:	dji.common.camera
SDK Key:	CameraKey.DISPLAY_MODE

Description:

Display modes to coordinate the video feeds from both the visual camera and the thermal camera. Only supported by XT2 camera and and Mavic 2 Enterprise Dual Camera.

Enum Members:

VISUAL_ONLY	Displays only the video feed from the visual camera.
THERMAL_ONLY	Displays only the video feed from the thermal camera.
PIP	Displays the video feed from the visual camera as the main subject, and the video from the thermal camera in a window not bigger than the main subject. The position of the thermal camera window can be adjusted with `PIPPosition`. Not supported by Mavic 2 Enterprise Dual.
MSX	Multi-Spectral Dynamic Imaging. Fuse the video feeds from both the visual camera and the thermal camera as one. Adds visible spectrum definition to IR images by detecting the edges of objects and including that detail in the thermal image.
OTHER	The thermal video feed display mode is unknown.

Class Members:

enum

PIPPosition

enum PIPPosition

enum PIPPosition

Package:	dji.common.camera
SDK Key:	CameraKey.PIP_POSITION

Description:

Possible positions to place the window of the thermal camera video feed when the display mode is PIP. Only supported by XT2 camera and Mavic 2 Enterprise Dual Light Camera.

Enum Members:

IR_CENTER	Position the window to the vertical center and the horizontal center.
IR_BOTTOM_RIGHT	Position the window to be bottom right.
IR_CENTER_RIGHT	Position the window to be centered on the right.
IR_TOP_RIGHT	Position the window to be top right.
IR_BOTTOM_CENTER	Position the window to be centered at bottom.
IR_TOP_CENTER	Position the window to be centered at top.
IR_BOTTOM_LEFT	Position the window to be bottom left.
IR_CENTER_LEFT	Position the window to be centered on the left.
IR_TOP_LEFT	Position the window to be top left.
SIDE_BY_SIDE	Position the thermal window on the right side of the main window (the visual camera video feed). Scale both windows with the same height.
ALIGN	Position the thermal window on top of the main window (the visual camera video feed). Then align the object in the thermal window with the same object in the main window. The alignment offset can be adjusted by `setDualFeedHorizontalAlignmentOffset` and `setDualFeedVerticalAlignmentOffset`.
OTHER	Unknown.

Class Members:

class

OpticalZoomSpec

enum

ZoomDirection

enum ZoomDirection

enum ZoomDirection

Package:	dji.common.camera
SDK Key:	CameraKey.START_CONTINUOUS_OPTICAL_ZOOM

Description:

The direction to adjust the camera zoom (camera focal length). Supported by X5, X5R and X5S with zoom lens, Z3 camera and Z30 camera.

Enum Members:

ZOOM_IN	Lens will zoom in. The focal length increases, field of view becomes narrower and magnification is higher.
ZOOM_OUT	Lens will zoom out. The focal length decreases, field of view becomes wider and magnification is lower.

Class Members:

class

HybridZoomSpec

enum

ZoomSpeed

enum ZoomSpeed

enum ZoomSpeed

Package:	dji.common.camera
SDK Key:	CameraKey.START_CONTINUOUS_OPTICAL_ZOOM

Description:

The speed of lens to zoom. The speed of lens to zoom. Supported by X5, X5R and X5S with zoom lens, Z3 camera and Z30 camera.

Enum Members:

SLOWEST	Lens zooms very in slowest speed.
SLOW	Lens zooms in slow speed.
MODERATELY_SLOW	Lens zooms in speed slightly slower than normal speed.
NORMAL	Lens zooms in normal speed.
MODERATELY_FAST	Lens zooms very in speed slightly faster than normal speed.
FAST	Lens zooms very in fast speed.
FASTEST	Lens zooms very in fastest speed.

Class Members:

enum

TapZoomState

enum TapZoomState

enum TapZoomState

Package:

dji.common.camera

Description:

The state of the tap zoom action. Only supported by Z30 camera. For Zenmuse H20 Series and Mavic 2 Enterprise Advanced, please access the value through class Lens.

Enum Members:

IDLE	The tap zoom is not triggered yet. It will always push `IDLE` if camera is not zooming.
ZOOM_IN	The camera is zooming in. The focal length increases, field of view becomes narrower and magnification is higher.
ZOOM_OUT	The camera is zooming in the focal length decreases, field of view becomes wider and magnification is lower.
ZOOM_LIMITED	It means the camera has reached its maximum focus length. It will always push `ZOOM_LIMITED` if the camera reaches its maximum focus length.

Class Members:

enum

FocusMode

enum FocusMode

enum FocusMode

Package:	dji.common.camera
SDK Key:	CameraKey.FOCUS_MODE

Description:

Camera focus mode. It is settable only when isAdjustableFocalPointSupported returns true and the physical AF switch on the camera is set to auto.

Enum Members:

MANUAL	The camera's focus mode is set to manual. In this mode, user sets the focus ring value to adjust the focal distance.
AUTO	The camera's focus mode is set to auto. For the Z30 camera, the focus is calculated completely automatically. For all other cameras, a focus target can be set by the user, which is used to calculate focus automatically.
AFC	The camera's focus mode is set to Continuous AF. It is only supported by Mavic Pro with firmware version V01.03.0000 or above, X4S camera, Mavic 2 Zoom camera and Mavic 2 Pro camera, DJI Air 2S.
UNKNOWN	The camera's focus mode is unknown.

Class Members:

enum

FocusStatus

enum FocusStatus

enum FocusStatus

Package:	dji.common.camera
SDK Key:	CameraKey.FOCUS_STATUS

Description:

The focusing status of the camera's lens.

Enum Members:

IDLE	The lens is idle. No focus target has been set.
FOCUSING	The lens is focusing on the target.
SUCCESSFUL	The lens succeeded to focus on the target.
FAILED	The lens failed to focus on the target. This happens when the target is too close, or the camera cannot distinguish the object to focus (e.g. a white wall).
UNKNOWN	The lens focus status is unknown.

Class Members:

enum

SensorCleaningState

enum SensorCleaningState

enum SensorCleaningState

Package:	dji.common.camera
SDK Key:	CameraKey.SENSOR_CLEANING_STATE

Description:

The states of the sensor cleaning operation.

Enum Members:

IDLE	Not in sensor cleaning mode.
INITIATING	The camera is initiating sensor cleaning mode.
WAITING_FOR_LENS_REMOVAL	Remove the lens from the camera to continue cleaning operation.
READY	The camera is ready to start the sensor cleaning. Call `startSensorCleaning` to start the operation.
CLEANING	The camera is executing sensor cleaning.
FINISHING	The sensor cleaning process is finishing. No action is required in this state and the state will change to `WAITING_FOR_LENS_REMOUNT` automatically.
WAITING_FOR_LENS_REMOUNT	The sensor cleaning is finished and the camera is waiting for the lens to be remounted. When the lens is mounted, the state will change to `IDLE`.
UNKNOWN	Unknown.

Class Members:

enum

PhotoFileFormat

enum PhotoFileFormat

enum PhotoFileFormat

Package:	dji.common.camera
SDK Key:	CameraKey.PHOTO_FILE_FORMAT, CameraKey.PHOTO_FILE_FORMAT_RANGE, CameraKey.PANO_ORIGINAL_IMAGES_FORMAT_RANGE

Description:

Camera photo file formats. The default value is JPEG.

Enum Members:

RAW	The camera's photo storage format is RAW.
JPEG	The camera's photo storage format is JPEG.
RAW_AND_JPEG	The camera stores both the RAW and JPEG formats of the photo.
TIFF_14_BIT	The camera's photo storage format is TIFF (14bit).
RADIOMETRIC_JPEG	The camera's photo storage format is Radiometric JPEG (a special JPEG format with temperature information). A radiometric JPEG has the .jpg suffix and can be viewed as a normal JPEG file would. At the same time, the temperature data is also stored in the file as meta data. PC software is required to analyze the file and it is accessible at FLIR's website http://www.flir.com/instruments/display/?id=54865. Only supported by XT camera with firmware version 1.16.1.70 or above.
TIFF_14_BIT_LINEAR_LOW_TEMP_RESOLUTION	The camera's photo storage format is TIFF Linear Low. In this mode each pixel is 14 bits and linearly proportional with temperature, covering a high dynamic range of temperature which results in a lower temperature resolution. Supported only by Zenmuse XT containing Advanced Radiometry capabilities with firmware version 1.17.1.80 or lower. For newer firmwares, the temperature resolution preference is coupled with the thermal gain mode.
TIFF_14_BIT_LINEAR_HIGH_TEMP_RESOLUTION	The camera's photo storage format is TIFF Linear High. In this mode each pixel is 14 bits and linearly proportional with temperature, covering a low dynamic range of temperature which results in a higher temperature resolution. Supported only by Zenmuse XT containing Advanced Radiometry capabilities with firmware version 1.17.1.80 or lower. For newer firmwares, the temperature resolution preference is coupled with the thermal gain mode.
UNKNOWN	The camera's photo storage format is unknown.

Class Members:

enum

PhotoAspectRatio

enum PhotoAspectRatio

enum PhotoAspectRatio

Package:	dji.common.camera
SDK Key:	CameraKey.PHOTO_ASPECT_RATIO, CameraKey.PHOTO_ASPECT_RATIO_RANGE

Description:

Photo aspect ratio, where the first value is the width and the second value is the height. The default value is RATIO_4_3.

Enum Members:

RATIO_4_3	The camera's photo ratio is 4 : 3.
RATIO_16_9	The camera's photo ratio is 16 : 9.
RATIO_3_2	The camera's photo ratio is 3:2.
RATIO_5_4	The camera's photo ratio is 5:4.
UNKNOWN	The camera's photo ratio is unknown.

Class Members:

enum

PhotoBurstCount

enum PhotoBurstCount

enum PhotoBurstCount

Package:	dji.common.camera
SDK Key:	CameraKey.PHOTO_BURST_COUNT, CameraKey.PHOTO_RAW_BURST_COUNT

Description:

The number of photos taken in one burst shot (shooting photo in burst mode).

Enum Members:

BURST_COUNT_2	The camera burst shoot count is set to capture 2 pictures at once when the camera shoots a photo.
BURST_COUNT_3	The camera burst shoot count is set to capture 3 pictures at once when the camera shoots a photo.
BURST_COUNT_5	The camera burst shoot count is set to capture 5 pictures at once when the camera takes a photo.
BURST_COUNT_7	The camera burst shoot count is set to capture 7 pictures at once when the camera takes a photo. It is not supported by Z30 camera.
BURST_COUNT_10	The camera burst shoot count is set to capture 10 pictures at once when the camera takes a photo. Only supported by X4S camera, X5S camera and Phantom 4 Pro camera.
BURST_COUNT_14	The camera burst shoot count is set to capture 14 pictures at once when the camera takes a photo. Only supported by X4S camera, X5S camera and Phantom 4 Pro camera.
CONTINUOUS	The camera burst shoot count is set to capture RAW pictures continuously until `stopShootPhoto` command is sent. It is only supported by Inspire 2 when the photo shoot mode is RAW burst.
UNKNOWN	The camera burst shoot count value is unknown.

Class Members:

enum

PhotoTimeLapseFileFormat

enum PhotoTimeLapseFileFormat

enum PhotoTimeLapseFileFormat

Package:	dji.common.camera
SDK Key:	CameraKey.PHOTO_TIME_LAPSE_SETTINGS

Description:

File format for camera when it is in time-lapse mode. The default file format is video. If video+JPEG is selected the minimum interval will be 2 seconds.

Enum Members:

VIDEO	The camera in time-lapse mode will generate video.
JPEG_AND_VIDEO	The camera in time-lapse mode will generate video and JPEG.
UNKNOWN	The file format is unknown.

Class Members:

class

PhotoTimeIntervalSettings

enum

VideoFileFormat

enum VideoFileFormat

enum VideoFileFormat

Package:	dji.common.camera
SDK Key:	CameraKey.VIDEO_FILE_FORMAT, CameraKey.VIDEO_FILE_FORMAT_RANGE

Description:

Video storage formats.

Enum Members:

MOV	The video storage format is MOV.
MP4	The video storage format is MP4.
TIFF_SEQ	The video storage format is TIFF Sequence.
SEQ	The video storage format is SEQ. The raw data from the infrared camera is stored.
UNKNOWN	The video storage format is unknown.

Class Members:

enum

VideoResolution

enum VideoResolution

enum VideoResolution

Package:	dji.common.camera
SDK Key:	CameraKey.VIDEO_RESOLUTION_FRAME_RATE_RANGE, CameraKey.SSD_VIDEO_RESOLUTION_RANGE

Description:

Camera video resolution values. The resolutions available for a product are in videoResolutionAndFrameRateRange.

Enum Members:

RESOLUTION_336x256	The camera's video resolution is 336x256.
RESOLUTION_640x360	The camera's video resolution is 640x360. Supported by Mavic 2 Enterprise Dual thermal camera.
RESOLUTION_720x576	The camera's video resolution is 720x576.
RESOLUTION_640x480	The camera's video resolution is 640x480.
RESOLUTION_640x512	The camera's video resolution is 640x512.
RESOLUTION_1280x720	The camera's video resolution is 1280x720.
RESOLUTION_1920x1080	The camera's video resolution is 1920x1080.
RESOLUTION_2704x1520	The camera's video resolution is 2704x1520.
RESOLUTION_2720x1530	The camera's video resolution is 2720x1530.
RESOLUTION_3712x2088	The camera's video resolution is 3712x2088. It's only used by X7 camera.
RESOLUTION_3840x1572	The camera's video resolution is 3840x1572.
RESOLUTION_3840x2160	The camera's video resolution is 3840x2160.
RESOLUTION_3944x2088	The camera's video resolution is 3944x2088. It's only used by X7 camera.
RESOLUTION_4096x2160	The camera's video resolution is 4096x2160.
RESOLUTION_4608x2160	The camera's video resolution is 4608x2160.
RESOLUTION_4608x2592	The camera's video resolution is 4608x2592.
RESOLUTION_5280x2160	The camera's video resolution is 5280x2160.
RESOLUTION_5472x3078	The camera's video resolution is 5472x3078.
RESOLUTION_5760X3240	The camera's video resolution is 5760x3240.
RESOLUTION_6016X3200	The camera's video resolution is 6016x3200.
RESOLUTION_MAX	The camera's video resolution will be maximum resolution supported by the camera sensor. For X5S and X4S, the maximum resolution is 5280x2972.
NO_SSD_VIDEO	The camera's SSD video resolution is unset. When the SSD resolution is unset, camera will not store video to SSD. SSD's resolution is determined by both license key and SD card's video frame rate. If there is no supported resolution with the current configuration, `DJICameraVideoResolutionUnset` will be selected and user should adjust either the license or the frame rate.
RESOLUTION_2048x1080	The camera's video resolution is 2048x1080.
RESOLUTION_2688x1512	The camera's video resolution is 2688x1512.
RESOLUTION_5280x2972	The camera's video resolution is 5280x2972.
UNKNOWN	The camera's video resolution is unknown.

Class Members:

enum

VideoFrameRate

enum VideoFrameRate

enum VideoFrameRate

Package:	dji.common.camera
SDK Key:	CameraKey.VIDEO_RESOLUTION_FRAME_RATE_RANGE

Description:

Camera video frame rate values. The frame rates available for a product are in videoResolutionAndFrameRateRange.

Enum Members:

FRAME_RATE_23_DOT_976_FPS	The camera's video frame rate is 23.976fps (frames per second).
FRAME_RATE_24_FPS	The camera's video frame rate is 24fps (frames per second).
FRAME_RATE_25_FPS	The camera's video frame rate is 25fps (frames per second).
FRAME_RATE_29_DOT_970_FPS	The camera's video frame rate is 29.97fps (frames per second).
FRAME_RATE_30_FPS	The camera's video frame rate is 30fps (frames per second).
FRAME_RATE_47_DOT_950_FPS	The camera's video frame rate is 47.95fps (frames per second).
FRAME_RATE_48_FPS	The camera's video frame rate is 48fps (frames per second).
FRAME_RATE_50_FPS	The camera's video frame rate is 50fps (frames per second).
FRAME_RATE_59_DOT_940_FPS	The camera's video frame rate is 59.94fps (frames per second).
FRAME_RATE_60_FPS	The camera's video frame rate is 60fps (frames per second).
FRAME_RATE_90_FPS	The camera's video frame rate is 90fps (frames per second).
FRAME_RATE_96_FPS	The camera's video frame rate is 96fps (frames per second).
FRAME_RATE_100_FPS	The camera's video frame rate is 100fps (frames per second). This frame rate can only be used when `isSlowMotionSupported` returns `true`.
FRAME_RATE_120_FPS	The camera's video frame rate is 120fps (frames per second). This frame rate can only be used when `isSlowMotionSupported` returns `true`.
FRAME_RATE_240_FPS	The camera's video frame rate is 240fps (frames per second). This frame rate can only be used when `isSlowMotionSupported` returns `true`.
FRAME_RATE_8_DOT_7_FPS	The camera's video frame rate is 8.7fps (frames per second). Supported by Mavic 2 Enterprise Dual thermal camera.
UNKNOWN	The camera's video frame rate is unknown.

Class Members:

enum

VideoFov

enum VideoFov

enum VideoFov

Package:

dji.common.camera

Description:

FOV (field-of-view) to use for recording a video.

Enum Members:

DEFAULT	The default FOV. Use this value if the FOV is not configurable for the camera.
NARROW	Use a narrow FOV to record videos.
WIDE	Use a wide FOV to record videos.
UNKNOWN	UNKNOWN

Class Members:

enum

VideoStandard

enum VideoStandard

enum VideoStandard

Package:	dji.common.camera
SDK Key:	CameraKey.VIDEO_STANDARD, CameraKey.VIDEO_STANDARD_RANGE

Description:

Video standard values. The default value is NTSC. For Zenmuse H20 Series, please access the value through class Lens.

Enum Members:

PAL	The camera video standard value is set to PAL.
NTSC	The camera video standard value is set to NTSC.
UNKNOWN	The camera video standard value is unknown.

Class Members:

enum

VideoFileCompressionStandard

enum VideoFileCompressionStandard

enum VideoFileCompressionStandard

Package:	dji.common.camera
SDK Key:	CameraKey.VIDEO_FILE_COMPRESSION_STANDARD

Description:

The compression standard used to store the video files. It is only supported X4S, X5S and Phantom 4 Pro cameras.

Enum Members:

H264	H.264 compression standard.
H265	H.265 compression standard.
Unknown	Unknown.

Class Members:

enum

CameraSSDVideoLicense

enum CameraSSDVideoLicense

@EXClassNullAway
 enum CameraSSDVideoLicense

Package:	dji.common.camera
SDK Key:	CameraKey.ACTIVATE_SSD_VIDEO_LICENSE, CameraKey.SSD_VIDEO_LICENSES

Description:

DJI camera's license keys. An Inspire 2 License Key activates the usage permission of CinemaDNG or Apple ProRes inside CineCore 2.0. License keys are obtained by by purchase from the DJI store website using the Inspire 2 serial number. The Inspire 2 is then connected to DJI Assistant 2, and the license keys downloaded to it. It is only supported X5S and X7 cameras.

Enum Members:

LicenseKeyTypeCinemaDNG	CinemaDNG.
LicenseKeyTypeProRes422HQ	Apple ProRes 422 HQ.
LicenseKeyTypeProRes4444XQ	Apple ProRes 4444 XQ(no alpha).
Unknown	Unknown.

Class Members:

enum

SSDLegacyColor

enum SSDLegacyColor

enum SSDLegacyColor

Package:	dji.common.camera
SDK Key:	CameraKey.SSD_LEGACY_COLOR

Description:

The legacy camera color for videos that will be stored in SSD. The default value is NONE. It is only supported Inspire 2 with firmware package versions lower than 01.0.0240.

Enum Members:

NONE	The camera color is set to none. It is only supported by X5S on Inspire 2.
D_CINELIKE	The camera color is set to DCinelike. It is only supported by X5S on Inspire 2.
D_LOG	The camera color is set to DLog. It is only supported by X5S on Inspire 2.
D_COLOR_1	The camera color is set to DColor1. It is only supported by X5S on Inspire 2.
D_Color_2	The camera color is set to DColor2. It is only supported by X5S on Inspire 2.
D_COLOR_3	The camera color is set to DColor3. It is only supported by X5S on Inspire 2.
UNKNOWN	The camera color is unknown.

Class Members:

enum

SSDColor

enum SSDColor

enum SSDColor

Package:	dji.common.camera
SDK Key:	CameraKey.SSD_COLOR, CameraKey.SSD_COLOR_RANGE

Description:

Camera colors for videos that will be stored in SSD. It is only supported Inspire 2 with the firmware package version 01.0.0240 or later.

Enum Members:

STANDARD	Standard. It is available when the camera is in ISO mode and the SSD license is `LicenseKeyTypeProRes422HQ` or `LicenseKeyTypeProRes4444XQ`.
DLOG	D-Log. It is available when the camera is in EI mode and the SSD license is `LicenseKeyTypeProRes422HQ` or `LicenseKeyTypeProRes4444XQ`.
REC709	Rec.709. It is available when the camera is in EI mode and the SSD license is `LicenseKeyTypeProRes422HQ` or `LicenseKeyTypeProRes4444XQ`.
CINE_LIKE	Cine-like. It is available when the camera is in ISO mode and the SSD license is `LicenseKeyTypeProRes422HQ` or `LicenseKeyTypeProRes4444XQ`.
RAW_COLOR	Raw color. This is the only for `LicenseKeyTypeCinemaDNG`.
UNKNOWN	Unknown.

Class Members:

enum

ExposureSensitivityMode

enum ExposureSensitivityMode

enum ExposureSensitivityMode

Package:	dji.common.camera
SDK Key:	CameraKey.EXPOSURE_SENSITIVITY_MODE

Description:

The exposure sensitivity modes.

Enum Members:

ISO	ISO mode.
EI	EI (exposure index) mode. In this mode, the camera mimics the way a film camera works to help cinematographers capture as much information as possible while balancing the dynamic range and noise with different log curves. This mode only takes effect when the camera mode is in `RECORD_VIDEO`.
UNKNOWN	Unknown.

Class Members:

enum

AntiFlickerFrequency

enum AntiFlickerFrequency

enum AntiFlickerFrequency

Package:	dji.common.camera
SDK Key:	CameraKey.ANTI_FLICKER_FREQUENCY, CameraKey.ANTI_FLICKER_RANGE

Description:

Camera anti-flickers. The default value is MANUAL_50HZ.

Enum Members:

AUTO	The camera's anti-flicker is automatically set. It is not supported by Z30 camera.
MANUAL_60HZ	The camera's anti-flicker is 60 Hz.
MANUAL_50HZ	The camera's anti-flicker is 50 Hz.
DISABLED	The anti-flicker is disabled. Only supported by Mavic Air.
UNKNOWN	The camera's anti-flicker is unknown.

Class Members:

enum

ExposureState

enum ExposureState

enum ExposureState

Package:

dji.common.camera

Description:

Camera exposure state.

Enum Members:

NORMAL	The camera exposure state is normal.
UNDEREXPOSED	The camera exposure state is underexposed.
OVEREXPOSED	The camera exposure state is overexposed.
UNKNOWN	The camera exposure state is unknown.

Class Members:

enum

SSDOperationState

enum SSDOperationState

@EXClassNullAway
 enum SSDOperationState

Package:	dji.common.camera
SDK Key:	CameraKey.SSD_OPERATION_STATE

Description:

Solid State Drive (SSD) State.

Enum Members:

NOT_FOUND	SSD is not found.
IDLE	SSD is idle.
SAVING	SSD is Saving.
FORMATTING	SSD is formatting.
INITIALIZING	SSD is initializing.
ERROR	SSD validation error.
FULL	SSD is full.
POOR_CONNECTION	Communication to SSD is not stable. User can re-plugin SSD. It is supported by X5S.
SWITCHING_LICENSE	SSD is switching the license key. It is supported by X5S.
FORMATTING_REQUIRED	Formatting is required. It is supported by X5S.
NOT_INITIALIZED	Not initialized yet. It is supported by X7.
INVALID_FILE_SYSTEM	The file system is not supported. It is supported by X7.
UNKNOWN	SSD state is unknown. This happens in the first 2 seconds after turning the camera power on as during this time the camera cannot check the state of the SSD.

Class Members:

enum

SSDCapacity

enum SSDCapacity

@EXClassNullAway
 enum SSDCapacity

Package:	dji.common.camera
SDK Key:	CameraKey.SSD_TOTAL_SPACE

Description:

Solid State Drive (SSD) Capacity.

Enum Members:

CAPACITY_256_GB	SSD capacity is 256G.
CAPACITY_512_GB	SSD capacity is 512G.
CAPACITY_1_TB	SSD capacity is 1T.
UNKNOWN	SSD capacity is unknown.

Class Members:

enum

FileIndexMode

enum FileIndexMode

enum FileIndexMode

Package:	dji.common.camera
SDK Key:	CameraKey.FILE_INDEX_MODE

Description:

File index modes.

Enum Members:

RESET	Camera will reset the newest file's index to be one larger than the largest number of photos taken on the SD card.
SEQUENCE	Camera will set the newest file's index to the larger of either the maximum number of photos taken on the SD card or the camera.
UNKNOWN	The mode is unknown.

Class Members:

enum

NDFilterMode

enum NDFilterMode

enum NDFilterMode

Package:	dji.common.camera
SDK Key:	CameraKey.NDFILTER_MODE

Description:

Modes of ND filter.

Enum Members:

AUTO	Auto. ND filter will be enabled or disabled automatically by the camera.
ON	The ND filter is on.
OFF	The ND filter is off.
UNKNOWN	Unknown.

Class Members:

enum

CustomSettingsProfile

enum CustomSettingsProfile

enum CustomSettingsProfile

Package:	dji.common.camera
SDK Key:	CameraKey.SAVE_SETTINGS_TO_PROFILE, CameraKey.LOAD_SETTINGS_FROM_PROFILE

Description:

Camera user settings. A user can save or load camera settings to or from the specified user.

Enum Members:

DEFAULT	Default user.
PROFILE_1	Settings for user 1.
PROFILE_2	Settings for user 2.
PROFILE_3	Settings for user 3.
PROFILE_4	Settings for user 4.
UNKNOWN	The user is unknown.

Class Members:

enum

CameraColor

enum CameraColor

enum CameraColor

Package:	dji.common.camera
SDK Key:	CameraKey.CAMERA_COLOR, CameraKey.CAMERA_COLOR_RANGE

Description:

Camera color. The default value is NONE. Z30 camera only supports NONE, BLACK_AND_WHITE and INVERSE.

Enum Members:

NONE	The camera color is set to none or no filter.
ART	The camera color is set to art.
BLACK_AND_WHITE	The camera color is set to black and white.
BRIGHT	The camera color is set to bright.
D_CINELIKE	The camera color is set to D-Cinelike (called movie before).
PORTRAIT	The camera color is set to portrait. Only supported by Osmo with X3 camera.
M_31	The camera color is set to M31.
K_DX	The camera color is set to kDX.
PRISMO	The camera color is set to prismo.
JUGO	The camera color is set to jugo.
D_LOG	The camera color is set to D-Log (called neutral before). For Mavic 2 Pro, setting to this color can enable 10-bit DLog-M color profile.
TRUE_COLOR	The camera color is set to true color. It is only supported by Phantom 4 with firmware v1.2.503 or above.
INVERSE	The camera color is set to inverse.
REMINISCENCE	The camera color is set to reminiscence.
SOLARIZE	The camera color is set to solarize.
POSTERIZE	The camera color is set to posterize.
WHITEBOARD	The camera color is set to whiteboard.
BLACKBOARD	The camera color is set to blackboard.
AQUA	The camera color is set to aqua.
DELTA	The camera color is set to delta.
DK79	The camera color is set to dk79.
VISION_4	The camera color is set to vision4.
VISION_6	The camera color is set to vision6.
TRUE_COLOR_EXT	The camera color is set to true color extend.
FILM_A	The camera color is set to Film A.
FILM_B	The camera color is set to Film B.
FILM_C	The camera color is set to Film C.
FILM_D	The camera color is set to Film D.
FILM_E	The camera color is set to Film E.
FILM_F	The camera color is set to Film F.
FILM_G	The camera color is set to Film G.
FILM_H	The camera color is set to Film H.
FILM_I	The camera color is set to Film I.
HLG	The camera color is set to HLG (Hybrid Log-Gamma).
UNKNOWN	The camera color is unknown.

Class Members:

enum

EIColor

enum EIColor

enum EIColor

Package:	dji.common.camera
SDK Key:	CameraKey.EI_COLOR

Description:

Camera colors for EI mode.

Enum Members:

D_LOG	The EI color is set to D-Log.
REC_709	The EI color is set to Rec.709.
UNKNOWN	Unknown.

Class Members:

enum

Orientation

enum Orientation

enum Orientation

Package:	dji.common.camera
SDK Key:	CameraKey.ORIENTATION, CameraKey.ORIENTATION_RANGE

Description:

Physical orientation of the camera.

Enum Members:

LANDSCAPE	By default, the camera is in landscape orientation.
PORTRAIT	The camera is in the portrait orientation, which is rotated 90 degrees in the clockwise direction from the default landscape orientation.
UNKNOWN	Unknown.

Class Members:

enum

PictureStylePresetType

enum PictureStylePresetType

enum PictureStylePresetType

Package:	dji.common.camera
SDK Key:	CameraKey.PICTURE_STYLE_PRESET

Description:

Camera preset type, a combine of Saturation, Contrast, Sharpness.

Enum Members:

STANDARD	Saturation 0, Contrast 0, Sharpness 0.
LANDSCAPE	Saturation 0, Contrast 1, Sharpness 1.
SOFT	Saturation 0, Contrast 0, Sharpness -1.
CUSTOM	Custom preset type
UNKNOWN	Unknown preset type

Class Members:

enum

TemperatureUnit

enum TemperatureUnit

enum TemperatureUnit

Package:	dji.common.camera
SDK Key:	CameraKey.TEMPERATURE_UNIT

Description:

The temperature units.

Enum Members:

FAHRENHEIT	Use degree Fahrenheit as the unit.
CELSIUS	Use degree Celsius as the unit.
OTHER	Unknown.

Class Members:

class

PictureStylePreset

enum

StorageLocation

enum StorageLocation

enum StorageLocation

Package:	dji.common.camera
SDK Key:	CameraKey.CAMERA_STORAGE_LOCATION

Description:

Different storage locations supported by the camera.

Enum Members:

SDCARD	SD card.
INTERNAL_STORAGE	The internal storage embedded in the aircraft. When it is available, the camera can shoot photos or record videos without SD card. It is only supported by Mavic Air.
UNKNOWN	Unknown.

Class Members:

enum

IRFilterMode

enum IRFilterMode

enum IRFilterMode

Package:

dji.common.camera

Description:

The IR filter mode.

Enum Members:

OFF	Off.
ON	On.
AUTO	Auto.

Class Members:

Thermal

enum

ThermalROI

enum ThermalROI

enum ThermalROI

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_ROI

Description:

Region of interest. Use this feature to manage color range distribution across the screen to maximize contrast for regions of highest interest.

Enum Members:

FULL	Causes the color spectrum to be evenly distributed across the entire image depending the default settings.
SKY_EXCLUDED_33	Ignores areas of the sky 33% so that most of the spectrum can be allocated to remaining areas, providing higher contrast and utility for analysis.
SKY_EXCLUDED_50	Ignores areas of the sky 50% so that most of the spectrum can be allocated to remaining areas, providing higher contrast and utility for analysis.
UNKNOWN	The ROI type is unknown.

Class Members:

enum

ThermalPalette

enum ThermalPalette

enum ThermalPalette

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_PALETTE

Description:

The different colors are used to show various temperatures in the thermal imagery image. The colors are not actually related to wavelengths of light, but rather the grayscale intensity.

Enum Members:

WHITE_HOT	Without Isotherm enabled, the Palette type is WhiteHot. With Isotherm enabled, the Palette type is WhiteHotIso.
BLACK_HOT	Without Isotherm enabled, the Palette type is BlackHot. With Isotherm enabled, the Palette type is BlackHotIso.
RED_HOT	Without Isotherm enabled, the Palette type is RedHot. With Isotherm enabled, the Palette type is RedHotIso. Shown as Tint in DJI Pilot.
GREEN_HOT	Without Isotherm enabled, the Palette type is GreenHot. With Isotherm enabled, the Palette type is GreenHotIso. Shown as Medical in DJI Pilot.
FUSION	Without Isotherm enabled, the Palette type is Fusion. With Isotherm enabled, the Palette type is FusionIso.
RAINBOW	Without Isotherm enabled, the Palette type is Rainbow. With Isotherm enabled, the Palette type is RainbowIso. Shown as Rainbow1 in DJI Pilot.
IRONBOW_1	Without Isotherm enabled, the Palette type is Ironbow1. With Isotherm enabled, the Palette type is IronbowWHIso. Shown as IronRed in DJI Pilot.
IRONBOW_2	Without Isotherm enabled, the Palette type is Ironbow2. With Isotherm enabled, the Palette type is IronbowBHIso.
ICE_FIRE	Without Isotherm enabled, the Palette type is IceFire. With Isotherm enabled, the Palette type is IceFireIso. Shown as Arctic in DJI Pilot.
SEPIA	Without Isotherm enabled, the Palette type is Sepia. With Isotherm enabled, the Palette type is SepiaIso.
GLOWBOW	Without Isotherm enabled, the Palette type is Glowbow. With Isotherm enabled, the Palette type is GlowbowIso.
COLOR_1	Without Isotherm enabled, the Palette type is Color1. With Isotherm enabled, the Palette type is MidRangeWHIso. Shown as Fulgurite in DJI Pilot.
COLOR_2	Without Isotherm enabled, the Palette type is Color2. With Isotherm enabled, the Palette type is MidRangeBHIso. Shown as HotIron in DJI Pilot.
RAIN	Without Isotherm enabled, the Palette type is Rain. With Isotherm enabled, the Palette type is RainbowHCIso. Shown as Rainbow2 in DJI Pilot.
HOT_SPOT	Without Isotherm enabled, the Palette type is HotSpot. With Isotherm enabled, the Palette type is HotSpotIso. Only supported by Mavic 2 Enterprise Dual.
RAINBOW2	Without Isotherm enabled, the Palette type is Rainbow2. With Isotherm enabled, the Palette type is Rainbow2Iso. Only supported by Mavic 2 Enterprise Dual.
GRAY	Without Isotherm enabled, the Palette type is Gray. With Isotherm enabled, the Palette type is GrayIso. Only supported by Mavic 2 Enterprise Dual.
HOT_METAL	Without Isotherm enabled, the Palette type is HotMetal. With Isotherm enabled, the Palette type is HotMetalIso. Only supported by Mavic 2 Enterprise Dual.
COLD_SPOT	Without Isotherm enabled, the Palette type is ColdSpot. With Isotherm enabled, the Palette type is ColdSpotIso. Only supported by Mavic 2 Enterprise Dual.
UNKNOWN	The palette type is unknown.

Class Members:

enum

ThermalScene

enum ThermalScene

enum ThermalScene

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_SCENE

Description:

Uses the Scene option to instantly enhance your image.

Enum Members:

LINEAR	Linearly transforms the 14-bit sensor pixel data to 8-bit JPEG/MP4 pixel data.
DEFAULT	Automatically adjusts DDE, ACE, SSO, brightness and contrast.
SEA_SKY	Automatically adjusts DDE, ACE, SSO, brightness and contrast with presets optimized for scenes composed of the sea and the sky scenes.
OUTDOOR	Automatically adjusts DDE, ACE, SSO, brightness and contrast with presets optimized for outdoor scenes.
INDOOR	Automatically adjusts DDE, ACE, SSO, brightness and contrast with presets optimized for indoor scenes.
MANUAL	Allows manual setting of DDE, ACE, SSO, brightness and contrast.
PROFILE_1	First saved settings of DDE, ACE, SSO, brightness and contrast.
PROFILE_2	Second saved settings of DDE, ACE, SSO, brightness and contrast.
PROFILE_3	Third saved settings of DDE, ACE, SSO, brightness and contrast.
INSPECTION	Automatically adjusts DDE, ACE, SSO, brightness and contrast with presets optimized for inspection scenes.
UNKNOWN	The Scene type is unknown.

Class Members:

enum

ThermalIsothermUnit

enum ThermalIsothermUnit

enum ThermalIsothermUnit

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_ISOTHERM_UNIT

Description:

The unit for Isotherm. For Zenmuse H20T and H20N, please access the value through class Lens.

Enum Members:

PERCENTAGE	The unit type is percentage. The allowed range is [0, 100].
CELSIUS	The unit type is degrees Celsius. The allowed range is [-40, 1000].
UNKNOWN	The unit type is unknown.

Class Members:

enum

ThermalGainMode

enum ThermalGainMode

enum ThermalGainMode

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_GAIN_MODE

Description:

The gain mode.

Enum Members:

AUTO	The camera will automatically select the optimal gain mode according to the temperature range of the image.
LOW	The camera covers a wider temperature range but is less sensitive to temperature differences.
HIGH	The camera covers a smaller temperature range but is more sensitive to temperature differences.
UNKNOWN	The gain mode is unknown.

Class Members:

enum

ThermalResolution

enum ThermalResolution

enum ThermalResolution

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_PROFILE

Description:

The resolution of thermal imaging camera.

Enum Members:

RESOLUTION_336x256	The thermal imaging camera resolution is 336x256.
RESOLUTION_640x512	The thermal imaging camera resolution is 640x512.
RESOLUTION_384x288	The thermal imaging camera resolution is 384x288.
RESOLUTION_1024x768	The thermal imaging camera resolution is 1024x768.
UNKNOWN	The thermal imaging camera resolution is unknown.

Class Members:

enum

ThermalFrameRateUpperBound

enum ThermalFrameRateUpperBound

enum ThermalFrameRateUpperBound

Package:

dji.common.camera

Description:

The frame rate upper bound supported by the thermal camera.

Enum Members:

UPPER_BOUND_8_DOT_3_HZ	The thermal imaging camera frame rate upper bound is 8.3Hz.
UPPER_BOUND_30_HZ	The thermal imaging camera frame rate upper bound is 30Hz.
UNKNOWN	The thermal imaging camera frame rate upper bound is unknown.

Class Members:

enum

ThermalLensFocalLength

enum ThermalLensFocalLength

enum ThermalLensFocalLength

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_PROFILE

Description:

The focal length of the thermal imaging camera.

Enum Members:

LENGTH_6_DOT_8_MM	The thermal imaging camera's lens focal length is 6.8 mm.
LENGTH_7_DOT_5_MM	The thermal imaging camera lens focal length is 7.5mm.
LENGTH_9_MM	The thermal imaging camera's lens focal length is 9 mm.
LENGTH_13_MM	The thermal imaging camera's lens focal length is 13 mm.
LENGTH_19_MM	The thermal imaging camera's lens focal length is 19 mm.
UNKNOWN	The thermal imaging camera's lens focal length is unknown.

Class Members:

enum

ThermalVersion

enum ThermalVersion

@EXClassNullAway
 enum ThermalVersion

Package:

dji.common.camera

Description:

There is a standard version and version with Advanced Radiometry capabilities of the Zenmuse XT thermal camera. This enum defines the versions.

Enum Members:

XT_STANDARD	The thermal camera is Zenmuse XT Standard version.
XT_ADVANCED_RADIOMETRY_ENABLED	The thermal camera is Zenmuse XT Advanced Radiometry version.

Class Members:

enum

ThermalCustomExternalSceneSettingsProfile

enum ThermalCustomExternalSceneSettingsProfile

enum ThermalCustomExternalSceneSettingsProfile

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_CUSTOM_EXTERNAL_SCENE_SETTINGS_PROFILE

Description:

User defined parameters.

Enum Members:

PROFILE_1	Custom thermal external scene settings for user 1.
PROFILE_2	Custom thermal external scene settings for user 2.
PROFILE_3	Custom thermal external scene settings for user 3.
UNKNOWN	The user is unknown.

Class Members:

enum

ThermalFFCMode

enum ThermalFFCMode

enum ThermalFFCMode

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_FFC_MODE

Description:

Flat-field correction mods.

Enum Members:

AUTO	Automatic flat-field correction mode.
MANUAL	Manual flat-field correction mode.
UNKNOWN	Unknown flat-field correction mode.

Class Members:

class

ThermalProfile

enum

ThermalDigitalZoomFactor

enum ThermalDigitalZoomFactor

enum ThermalDigitalZoomFactor

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_DIGITAL_ZOOM_FACTOR

Description:

Thermal camera digital zoom scale. The default value is x1.

Enum Members:

X_1	Digital zoom factor x1.
X_2	Digital Zoom factor is x2.
X_4	Digital Zoom factor is x4.
X_8	Digital Zoom factor is x8. Not support by Mavic 2 Enterprise Dual Light Camera.
X_16	Digital Zoom factor is x16. Not support by Mavic 2 Enterprise Dual Light Camera.
X_32	Digital Zoom factor is x32. Not support by Mavic 2 Enterprise Dual Light Camera.
UNKNOWN	Digital Zoom factor is unknown.

Class Members:

enum

ThermalMeasurementMode

enum ThermalMeasurementMode

@EXClassNullAway
 enum ThermalMeasurementMode

Package:	dji.common.camera
SDK Key:	CameraKey.THERMAL_MEASUREMENT_MODE

Description:

Thermal camera temperature measurement mode. The default value is Disabled.

Enum Members:

DISABLED	Disable temperature measuring.
SPOT_METERING	Enable temperature measurement and set mode to spot metering. Use `setThermalTemperatureCallback` to receive the updated temperature data. In this mode, the advanced radiometry version XT camera can change the metering point using `setThermalSpotMeteringTargetPoint`.
AREA_METERING	Enable temperature measurement and set mode to area metering. Use `onUpdate` to receive the updated temperature data. Only supported by the advanced radiometry version XT camera.
UNKNOWN	Thermal camera's temperature measurement mode is unknown.

Class Members:

class

ThermalAreaTemperatureAggregations

class

ThermalExternalSceneSettings

Mobile SDK

class SettingsDefinitions

Description:

Class Members:

Related:

enum LensType

Description:

Enum Members:

Class Members:

enum MultispectralDisplayMode

Description:

Enum Members:

Class Members:

enum SpectrumBand

Description:

Enum Members:

Class Members:

enum CameraMode

Description:

Enum Members:

Class Members:

enum ShootPhotoMode

Description:

Enum Members:

Class Members:

enum ExposureMode

Description:

Enum Members:

Class Members:

enum ShutterSpeed

Description:

Enum Members:

Class Members:

enum ISO

Description:

Enum Members:

Class Members:

enum Aperture

Description:

Enum Members:

Class Members:

enum WhiteBalancePreset

Description:

Enum Members:

Class Members:

enum MeteringMode

Description:

Enum Members:

Class Members:

enum ExposureCompensation

Description:

Enum Members:

Class Members:

enum DisplayMode

Description:

Enum Members:

Class Members:

enum PIPPosition

Description:

Enum Members:

Class Members:

enum ZoomDirection

Description:

Enum Members:

Class Members:

enum ZoomSpeed

Description:

Enum Members:

Class Members:

enum TapZoomState

Description:

Enum Members:

Class Members:

enum FocusMode

Description:

Enum Members:

Class Members:

enum FocusStatus

Description:

Enum Members: