| Package: | dji.sdk.keyvalue.key |
| Inherits From: | DJICameraKey |
CameraKey
CameraKeyprovides a set of methods to set and get the camera parameters including camera type, camera settings, etc.
Description:
Basic Information
KeyConnection
static final DJIKeyInfo |
Parameter: Boolean
true means that camera is connected.
KeyCameraType
static final DJIKeyInfo |
Parameter: CameraType
To get camera type.
KeyFirmwareVersion
static final DJIKeyInfo |
Parameter: String
Get Firmware Version.
Camera Settings
KeyCameraModeRange
static final DJIKeyInfo |
Parameter:list<CameraMode>
To get the mode of camera that can be set currently.
KeyCameraMode
static final DJIKeyInfo |
Parameter:CameraMode
To set working mode of the camera, including shooting photo and recording video. The mode of the camera that can be set currently can get through KeyCameraModeRange. This mode takes effect for all lenses.
Notic:
Panoramic photo mode can only be activated after the aircraft takes off.
KeyIsShootingPhoto
static final DJIKeyInfo |
Parameter: Boolean
true means camera is shooting.
KeyStartShootPhoto
static final DJIActionKeyInfo |
Start shooting photo. The camera must be in shooting photo mode. For infrared lenses, users can take photos while recording video. If the shooting photo mode is PHOTO_INTERVAL, you need to call KeyStopShootPhoto to stop the camera from shooting photo. Before using this method, you should check the SD Card status to make sure enough space.
KeyStopShootPhoto
static final DJIActionKeyInfo |
Stop shooting photo. When the camera shooting mode is PHOTO_INTERVAL, PHOTO_SUPER_RESOLUTION and PHOTO_PANORAMA, and KeyStartShootPhotois called to start shooting, you can call this interface to stop shooting. If the camera shooting mode is set to be single shooting, the camera will stop shooting automatically after a single photo is shoot, there is no need to call this interface.
KeyCaptureCameraStreamSettings
static final DJIKeyInfo |
Parameter:CameraStreamSettingsInfo
Multi-lens photo storage settings. All lenses of this camera take photos by default, and the photos are stored in the SD Card. You can call this interface to select the required lens for shooting photo and storage. Before calling this interface, you need to call KeyCameraMode to set the camera shooting mode to PHOTO_NORMAL.
For DJI Mavic 3M, only the following two settings are supported:
1. Store only RGB photos:[RGB_CAMERA]
2. Store RGB and multispectral photos:[RGB_CAMERA, NDVI_CAMERA, MS_G_CAMERA, MS_R_CAMERA, MS_RE_CAMERA, MS_NIR_CAMERA]
KeyPhotoFileFormatRange
static final DJIKeyInfo |
Parameter:list<PhotoFileFormat>
To get the camera’s photo format range.
KeyPhotoFileFormat
static final DJIKeyInfo |
Parameter:PhotoFileFormat
To set and get the photo format supported by the camera, and can only be set when the KeyCameraMode is photo mode.
KeyPhotoCSize
static final DJIKeyInfo |
Parameter:PhotoSize
To set and get the photo size supported by the camera.
1. It can only be set when
KeyCameraMode is in camera mode.2. M30, M30T, Mavic 3T can support settings:
SIZE_DEFAULT and SIZE_LARGE. 3. The photo size of other types of cameras defaults to SIZE_DEFAULT and does not need to be set.KeyPhotoIntervalShootSettings
static final DJIKeyInfo |
Parameter:PhotoIntervalShootSettings
Set and get the number of pictures and the interval time between pictures, and is used when KeyCameraMode is PHOTO_INTERVAL.
KeyPhotoIntervalCountdown
static final DJIKeyInfo |
Parameter:Integer
To get the countdown of interval photo shooting. When the interval shooting mode is set, after calling KeyStartShootPhoto to start shooting, the camera will count down the interval time between photos and will shoot one photo after the countdown reaches 0.
KeySuperResolutionInfo
static final DJIKeyInfo |
Parameter:SuperResolutionInfo
To get the status and information of ultra-clear matrix photo, and is used when KeyCameraMode is PHOTO_SUPER_RESOLUTION.
KeySuperResolutionCaptureArea
static final DJIKeyInfo |
Parameter:DoubleRect4Sides
To set the area of ultra-clear matrix photo shooting, and is used when KeyCameraMode is PHOTO_SUPER_RESOLUTION. Area range: getMaxArea.
KeyPhotoPanoramaMode
static final DJIKeyInfo |
Parameter:PhotoPanoramaMode
To set the panorama photo shooting mode, and is used when KeyCameraMode is PHOTO_PANORAMA.
KeyIsShootingPhotoPanorama
static final DJIKeyInfo |
Parameter:Boolean
true means panorama photo is being shot and is used when KeyCameraMode is PHOTO_PANORAMA.
KeyPhotoPanoramaProgress
static final DJIKeyInfo |
Parameter:Integer
To get the percentage of panorama photo shooting, and is used when KeyCameraMode is PHOTO_PANORAMA.
KeyIsRecording
static final DJIKeyInfo |
Parameter: Boolean
true means that camera is recording video.
KeyStartRecord
static final DJIActionKeyInfo |
Start recording video. It is required that calling KeyCameraMode to set camera working mode to VIDEO_NORMAL. For the Infrared lens, the user can shooting photo when the video is recording. Before using this method, SD Card status should be checked to make sure there has enough space.
KeyStopRecord
static final DJIActionKeyInfo |
Stop recording video.
KeyRecordingTime
static final DJIKeyInfo |
The duration of the video currently recorded by the camera. Unit:second.
KeyVideoRecordPlan
static final DJIKeyInfo |
Parameter:VideoRecordPlanInfo
Turn on or off the camera pre-recording function. Pre-recording will automatically record the number of seconds you set before recording the video and add it to the video, which consumes device storage space and affects the writing life of the SD card. Please try to avoid pulling out the card during pre-recording. You can call KeyVideoPreRecordDuration to set the pre-recording duration. You can call KeyVideoRecordingStatus to obtain the pre-recording status.
Only H30 series cameras support this feature.
KeyVideoPreRecordDuration
static final DJIKeyInfo |
Parameter:VideoPreRecordDurationInfo
Set the camera pre-recording duration.
Only H30 series cameras support this feature.
KeyVideoRecordingStatus
static final DJIKeyInfo |
Parameter:VideoRecordingStatus
Get camera pre-recording status. When the status is STARTING and STOPPING, the camera cannot take pictures and record videos.。
Only H30 series cameras support this feature.
KeyRecordCameraStreamSettings
static final DJIKeyInfo |
Parameter:CameraStreamSettingsInfo
Multi-lens recording storage setting. By default, all lenses of this camera can record video and the video will store in SD Card. You can call this interface to choose the required lens to record video and store. Before calling this interface, KeyCameraMode should be called to set camera working mode to VIDEO_NORMAL.
For DJI Mavic 3M, only the following two settings are supported:
1. Store only RGB video:[RGB_CAMERA]
2. Store RGB and NDVI video:[RGB_CAMERA, NDVI_CAMERA]
KeyVideoFileFormatRange
static final DJIKeyInfo |
Parameter:list<VideoFileFormat>
To get recording format range of the camera.
KeyVideoFileFormat
static final DJIKeyInfo |
Parameter:VideoFileFormat
To set and get video format supported by the camera, and can only be set when the KeyCameraMode is video mode.
KeyVideoBitrateMode
static final DJIKeyInfo |
Parameter:VideoBitrateMode
Set and get the video bitrate mode supported by the camera. It can only be set when KeyCameraMode is in recording mode.
Only H30 series cameras support this feature.
KeyVideoMimeType
static final DJIKeyInfo |
Parameter:VideoMimeType
Set and get the video mime type supported by the camera. It can only be set when KeyCameraMode is in recording mode.
Only H30 series cameras support this feature.
KeyNewlyGeneratedMediaFile
static final DJIKeyInfo |
Parameter:GeneratedMediaFileInfo
After the photo shooting and video recording are started, the camera will generate new photo or video. This interface can be used to get media file information generated.
KeyCustomExpandDirectoryNameSettings
static final DJIKeyInfo |
Parameter:CustomExpandNameSettings
To set and get the extension name of the customized file folder. After calling this interface, the newly generated media file (video or photo) will be stored in a new file folder. Default file folder name plus the extension name you set will be the name of the new file folder. For example, the default file folder name is “DJI_202001012359_01”, and the customized extension name of the file folder is “Mission1”, therefore the new file folder name will be “DJI_202001012359_01_Mission1”. In one flight, you can set multiple extension directory names to create multiple customized folders.
1. Do not set the extension name of the customized file folder during video recording.
2. Do not use pure numbers and special characters as the extension name, otherwise the multimedia file will fail to download. It is recommended to use a combination of numbers and letters as the extension name.
3. The length of the multimedia file name [original file name + extension name] is less than 128 bytes.
KeyCustomExpandFileNameSettings
static final DJIKeyInfo |
Parameter:CustomExpandNameSettings
To set and get extension name of the customized file. After calling this interface, the default file name plus the extension name you set will be the name of the nest media file(video or photo). For example, the default name photo name is “DJI_2020012091415_999_WIDE.JPG”, and the extension name of the customized file you set is “Waypoint1”, therefore the name of the new photo will be “DJI_2020012091415_999_WIDE_Waypoint1.JPG”. This operation only takes effect once. If it is required that all media files in one flight have the same extension name, you need to set the same extension name before each photo shooting.
1. Do not set the extension name of the customized file during video recording.
2. Do not use pure numbers and special characters as the extension name, otherwise the multimedia file will fail to download. It is recommended to use a combination of numbers and letters as the extension name.
3. The length of the multimedia file name [original file name + extension name] is less than 128 bytes.
KeyCameraStorageInfos
static final DJIKeyInfo |
Parameter:CameraStorageInfos
To get the storage information of the camera SD Card and onboard memory. The onboard memory of M30 and M30T cameras are for internal use only.
KeyCameraVideoCaptionEnabled
static final DJIKeyInfo |
Parameter:Boolean
true means that video subtitles are opened. The location of aircraft, flight time and camera parameters will be stored in video subtitles srt file in SD Card.
If you want to use this function, please use
KeyCameraMode to set the camera mode to VIDEO_NORMAL.KeyCameraWatermarkSettings
static final DJIKeyInfo |
Parameter:CameraWatermarkSettings
Watermark setting of the camera. It can be set whether to generate watermark in photo or video or not. You can set the content that needs to be displayed in the watermark through KeyWatermarkDisplayContentSettings. Set custom watermark text via KeyWatermarkUserCustomInfo.
KeyWatermarkDisplayContentSettings
static final DJIKeyInfo |
Parameter:WatermarkDisplayContentSettings
Content setting of the camera watermark. Content of watermark that needs to display in photo and video can be set. You can set customized content of watermark through KeyWatermarkUserCustomInfo.
KeyWatermarkUserCustomInfo
static final DJIKeyInfo |
Parameter:String
To set and get the customized copywriting in watermark. You can set whether to display customized copywriting through KeyWatermarkDisplayContentSettings.
KeyLockGimbalDuringShootPhotoEnabled
static final DJIKeyInfo |
Parameter: Boolean
true means that the gimbal will be locked when shooting photo. If this function is opened, flight movement influence on image effect can be avoided.
KeyAutoTurnOffLEDMode
static final DJIKeyInfo |
Parameter: AutoTurnOffLEDMode
To set LED automatically turn off when shooting photo and recording video. The LEDs include the front arm LED, rear arm LED and navigation LED.
KeyLaserWorkMode
static final DJIKeyInfo |
Parameter: LaserWorkMode
To set laser working mode. You can choose to enhance mode or open laser according to requirement. The laser module will revert to enhance mode after the camera restarts.
KeyLaserMeasureEnabled
static final DJIKeyInfo |
Parameter: Boolean
To open or close the laser module. When KeyLaserWorkModeis set to be OPEN_ON_DEMAND, you can open the laser module through this interface.
KeyLaserMeasureInformation
static final DJIKeyInfo |
Parameter:LaserMeasureInformation
Gets the information of the laser sensor, including the location information of the target point, the distance between the target point and the laser sensor, the position of the target point on the camera screen and the status of the laser sensor. The laser sensor must be at least 3m away from the target point.
KeyTapZoomAtTarget
static final DJIActionKeyInfo |
Parameter:ZoomTargetPointInfo
Tap zoom at target function, double-click the target point on the screen, the gimbal will automatically rotate to place the target point in the center of the screen. You only need to pass in the target coordinates of the screen, other parameters are reserved fields and can be ignored.
KeyInfinityCalibrationState
static final DJIKeyInfo |
Parameter: InfinityCalibrationState
Get the status of infinity calibration. If the state is NOT_CALIBRATE, please call KeyStartInfinityCalibration for infinity calibration.
Only Zenmuse P1 supports infinity calibration.
KeyStartInfinityCalibration
static final DJIActionKeyInfo |
Start the camera infinity calibration. If you encounter the following situations, please call this interface for infinity calibration.
KeyInfinityCalibrationState. If the state is NOT_CALIBRATE, please recalibrate. addDJIDeviceHealthInfoChangeListener. If you get the following error code, please recalibrate. 1. hms_0x1C000D02: The camera calibration file failed to load, please perform infinity calibration.
2. hms_0x1C000D03: Infinity calibration data has expired, please perform infinity calibration again.
3. hms_0x1C000D04: Infinity calibration data has expired, please perform infinity calibration again.
The following are the infinity calibration steps:
KeyStartInfinityCalibration to start calibration, and the calibration state will change to WAITING_FOR_CALIBRATE. KeyCameraFocusTarget to set the object with multiple distinct visual patterns at the center of the camera view as focus, and then the calibration state will be changed to CALIBRATING. CALIBRATED. You can use KeyInfinityCalibrationResult to listen the calibration results. Note:
Only Zenmuse P1 supports infinity calibration.
Supported since MSDK 5.9.0
KeyStopInfinityCalibration
static final DJIActionKeyInfo |
Stop the camera infinity calibration.
Only Zenmuse P1 supports infinity calibration.
KeyInfinityCalibrationResult
static final DJIKeyInfo |
Parameter: InfinityCalibrationResult
Get the result of infinity calibration.
Only Zenmuse P1 supports infinity calibration.
KeyLensCalibratedInfinityValue
static final DJIKeyInfo |
Parameter: Integer
Calibrated infinity focus. Make sure you have calibrated the lens’ infinity focusing with KeyStartInfinityCalibration. When in use, the lens uses infinity focus as calibrated. To help ensure focusing accuracy, recalibrate the infinity focus when there is a large temperature difference between the mission environment and the calibration environment (>15 degrees Celsius).
Only Zenmuse P1 supports infinity calibration.
KeyAntiFlicker
static final DJIKeyInfo |
Parameter:CameraAntiFlicker
Sets anti flicker. Typically used in consumer aircraft.
KeyCameraWhiteBalanceRange
static final DJIKeyInfo |
Parameter:list<CameraWhiteBalanceMode>
To get the white balance range of camera.
KeyWhiteBalance
static final DJIKeyInfo |
Parameter:CameraWhiteBalanceInfo
Sets white balance. The settable white balance can be obtained through KeyCameraWhiteBalanceRange.
KeyCameraNightSceneMode
static final DJIKeyInfo |
Parameter:CameraNightSceneMode
Night scene mode settings. Turning on night scene mode can improve the camera’s shooting effect in low-density environments.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA or WIDE_CAMERA. 2. When using
KeyTools to create a DJIKey instance, Set CameraLensType to CAMERA_LENS_ZOOM or CAMERA_LENS_WIDE. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT. 3. Taking photos and videos in night scene mode only supports 1080P.
KeyCameraDenoiseLevel
static final DJIKeyInfo |
Parameter:CameraDenoiseLevel
Denoise level settings, the higher the denoise level, the lower the frame rate. Take the H30 series camera as an example: the default image transmission and video frame rate is 25fps. When the denoise level is low, the frame rate is 25fps. When the denoise level is medium, the frame rate is 15fps. When the denoise level is high, the frame rate is 5fps.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA or WIDE_CAMERA. 2. When using
KeyTools to create a DJIKey instance, Set CameraLensType to CAMERA_LENS_ZOOM or CAMERA_LENS_WIDE. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT. 3. Please call
KeyCameraNightSceneMode to set the night scene mode to ENABLE. 4. Only H20N and H30 series cameras support the enhanced noise reduction level function.
KeyLaserFillLightEnabled
static final DJIKeyInfo |
Parameter:Boolean
Laser fill light settings. When the laser fill light is turned on, KeyIRCutEnabled will be turned on at the same time.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA or WIDE_CAMERA. 2. When using
KeyTools to create a DJIKey instance, Set CameraLensType to CAMERA_LENS_ZOOM or CAMERA_LENS_WIDE. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT. 3. Please call
KeyCameraNightSceneMode to set the night scene mode to ENABLE. 4. Only H20N and H30 series cameras support the laser fill light function.
KeyIRCutEnabled
static final DJIKeyInfo |
Parameter:Boolean
true means to turn on the IR Cut function. When IR Cut is turned on, the image transmission of the zoom lens will become black and white.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA or WIDE_CAMERA. 2. When using
KeyTools to create a DJIKey instance, Set CameraLensType to CAMERA_LENS_ZOOM or CAMERA_LENS_WIDE. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT. 3. Please call
KeyCameraNightSceneMode to set the night scene mode to ENABLE. KeyDehazeMode
static final DJIKeyInfo |
Parameter:DehazeMode
Dehaze mode settings. Enable the dehaze mode to improve screen transparency in hazy weather. Only H30 series cameras support this feature.
1. To use this function, please call
KeyCameraVideoStreamSource and set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, Set CameraLensType to CAMERA_LENS_ZOOM. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT. 3. This function can be used only when the night scene mode
KeyCameraNightSceneMode is disabled. KeyDehazeLevel
static final DJIKeyInfo |
Parameter:DehazeLevel
Dehaze level Settings. The dehaze level can only be set when KeyDehazeMode is set to ENABLE. Only H30 series cameras support this feature.
1. To use this function, please call
KeyCameraVideoStreamSource and set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, Set CameraLensType to CAMERA_LENS_ZOOM. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT. KeyCleanFog
static final DJIActionKeyInfo |
To perform once lens defogging operation, Lens clean fog requires continuous heating for 5 seconds.
Lens Settings
KeyCameraVideoStreamSourceRange
static final DJIKeyInfo |
Parameter:list<CameraVideoStreamSourceType>
To get the video source range of camera.
KeyCameraVideoStreamSource
static final DJIKeyInfo |
Parameter:CameraVideoStreamSourceType
To set camera video source. For camera with multiple lenses, video have different lens sources. After setting the camera video source, the current live video stream will be switched to the set lens video stream. You can get the list of lens types supported by the current camera through KeyCameraVideoStreamSourceRange. For single lens cameras, DEFAULT_CAMERA is used by default.
When
CameraMode is PHOTO_SUPER_RESOLUTION, the camera video source cannot be set to INFRARED_CAMERA.KeyExposureModeRange
static final DJIKeyInfo |
Parameter:list<CameraExposureMode>
To get the exposure mode range of selected lens.
KeyExposureMode
static final DJIKeyInfo |
Parameter:CameraExposureMode
To set the exposure mode of the selected lens. The exposure mode decides whether the aperture, shutter speed and ISO can be set automatically or manually. The settable exposure mode can be obtained through KeyExposureModeRange. When CameraVideoStreamSourceType is INFRARED_CAMERA, exposure mode can not be set.
1. Exposure mode settings can only be performed on the lens of the current liveview stream source, otherwise the settings will be unsuccessful.
2. You could obtain the liveview camera source through
KeyCameraVideoStreamSource. Then set the CameraLensType with the current liveview camera source when the DJIKey instance was created using KeyTools. 3. In the super resolution photo mode, the exposure mode cannot be set.
KeyExposureCompensationRange
static final DJIKeyInfo |
Parameter:list<CameraExposureCompensation>
To get the exposure compensation range of camera lens.
KeyExposureCompensation
static final DJIKeyInfo |
Parameter:CameraExposureCompensation
To set exposure compensation value of camera lens. Settable exposure compensation value can be obtained through KeyExposureCompensationRange. To use this function, the CameraExposureMode of the current liveview stream source must be set to PROGRAM.
1. Exposure mode settings can only be performed on the lens of the current liveview stream source, otherwise the settings will be unsuccessful.
2. You could obtain the liveview camera source through
KeyCameraVideoStreamSource.3.Then set the
CameraLensType with the current liveview camera source when the DJIKey instance was created using KeyTools. KeyAELockEnabled
static final DJIKeyInfo |
Parameter:Boolean
The automatic exposure lock of camera lens. To use this function, the CameraExposureMode of the current liveview stream source must be set to PROGRAM.
KeyCameraMeteringMode
static final DJIKeyInfo |
Parameter:CameraMeteringMode
To set metering mode of camera lens. If you want to use center metering or average metering function, you only need to set CENTER or AVERAGE once, the lens will operate metering once. If you want to use spot or area metering function, KeySpotMeteringPoint or KeyRegionMeteringArea should be called to set meiering parameters, and the lens will perform spot or area metering once.
Caution: If you want to use metering function, please use KeyExposureMode to set the exposure mode to PROGRAM, SHUTTER_PRIORITY or APERTURE_PRIORITY, and call KeyAELockEnabled to set AE Lock to false.
KeySpotMeteringPoint
static final DJIKeyInfo |
Parameter:DoublePoint2D
Spot metering of the camera lens. (x,y) of DoublePoint2D is the center point coordinate of normalized (0-1).
KeyRegionMeteringArea
static final DJIKeyInfo |
Parameter:DoubleRect
Area metering of the camera lens. (x,y) is the upper left coordinate, and is the coordinate position of normalized (0-1). Width and height are the area size of normalized (0-1) and width and height can not be 0.
KeyISORange
static final DJIKeyInfo |
Parameter:list<CameraISO>
To get ISO range of camera lens.
KeyISO
static final DJIKeyInfo |
Parameter:CameraISO
To set and get the ISO value of the camera lens. The ISO range can be obtained through KeyISORange.
1. Exposure mode settings can only be performed on the lens of the current liveview stream source, otherwise the settings will be unsuccessful.
2. You could obtain the liveview camera source through
KeyCameraVideoStreamSource.3.Then set the
CameraLensType with the current liveview camera source when the DJIKey instance was created using KeyTools. 4.Call
KeyExposureMode set the exposure mode to MANUAL.KeyShutterSpeedRange
static final DJIKeyInfo |
Parameter:list<CameraShutterSpeed>
To get shutter speed range of camera lens.
KeyShutterSpeed
static final DJIKeyInfo |
Parameter:CameraShutterSpeed
To set shutter speed value of camera lens. Settable shutter speed can be obtained through KeyShutterSpeedRange.
1. Exposure mode settings can only be performed on the lens of the current liveview stream source, otherwise the settings will be unsuccessful.
2. You could obtain the liveview camera source through
KeyCameraVideoStreamSource.3.Then set the
CameraLensType with the current liveview camera source when the DJIKey instance was created using KeyTools. 4.Call
KeyExposureMode set the exposure mode to MANUAL.KeyPhotoRatioRange
static final DJIKeyInfo |
Parameter:list<PhotoRatio>
To get photo ratio of camera lens.
1. Photo ratio settings can only be performed on the lens of the current liveview stream source, otherwise the settings will be unsuccessful.
2. You could obtain the liveview camera source through
KeyCameraVideoStreamSource.3.Then set the
CameraLensType with the current liveview camera source when the DJIKey instance was created using KeyTools. 4.You need to call
KeyCameraMode to set the camera shooting mode to PHOTO_NORMALKeyPhotoRatio
static final DJIKeyInfo |
Parameter:PhotoRatio
To set photo ratio of the camera lens. The settable photo ratio can be obtained through KeyPhotoRatioRange.
1. Photo ratio settings can only be performed on the lens of the current liveview stream source, otherwise the settings will be unsuccessful.
2. You could obtain the liveview camera source through
KeyCameraVideoStreamSource.3.Then set the
CameraLensType with the current liveview camera source when the DJIKey instance was created using KeyTools. 4.You need to call
KeyCameraMode to set the camera shooting mode to PHOTO_NORMALKeyVideoResolutionFrameRateRange
static final DJIKeyInfo |
Parameter:list<VideoResolutionFrameRate>
To get the video resolution and frame rate range of camera lens.
KeyVideoResolutionFrameRate
static final DJIKeyInfo |
Parameter:VideoResolutionFrameRate
To set the video resolution and frame rate range of the camera lens. Settable video resolution and frame rate can be obtained through KeyVideoResolutionFrameRateRange.
If you want to use this function, please use
KeyCameraMode to set the camera mode to VIDEO_NORMAL.KeyCameraZoomRatiosRange
static final DJIKeyInfo |
Parameter:list<ZoomRatiosRange>
To get the zoom ratios range of camera lens.
KeyCameraZoomRatios
static final DJIKeyInfo |
Parameter:Double
Set the zoom ratios of the camera lens. The recommended minimum accuracy is 0.1. Different lenses have different camera ratios ranges, please call KeyCameraZoomRatiosRange to get the zoom ratios supported by the lens.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_ZOOM. If it is an M3M aircraft, set it to CAMERA_LENS_RGB. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT.KeyCameraZoomFocalLength
static final DJIKeyInfo |
Parameter:Interger
Gets the focal length of the zoom lens, unit: mm. Please use KeyCameraZoomRatios to set the zoom ratios.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_ZOOM. If it is an M3M aircraft, set it to CAMERA_LENS_RGB. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT.KeyCameraFocusMode
static final DJIKeyInfo |
Parameter:CameraFocusMode
To set and get focus mode of zoom lens.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_ZOOM. If it is an M3M aircraft, set it to CAMERA_LENS_RGB. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT.3. Zenmuse P1, Mini 3 and Mini 3 Pro only support settings:
MANUAL and AF.KeyCameraFocusRingMinValue
static final DJIKeyInfo |
Parameter:Integer
The minimum settable value that the camera manually focusing.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_ZOOM. If it is an M3M aircraft, set it to CAMERA_LENS_RGB. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT.KeyCameraFocusRingMaxValue
static final DJIKeyInfo |
Parameter:Integer
The maximum settable value that the camera manually focusing.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_ZOOM. If it is an M3M aircraft, set it to CAMERA_LENS_RGB. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT.KeyCameraFocusRingValue
static final DJIKeyInfo |
Parameter:Integer
The manually focusing value of the camera. The maximum and minimum settable value that the camera manually focusing can be obtained through KeyCameraFocusRingMinValue and KeyCameraFocusRingMaxValue. In MANUAL mode, camera will focus once with the center point of the screen as the focus target after setting the focus value.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_ZOOM. If it is an M3M aircraft, set it to CAMERA_LENS_RGB. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT.KeyCameraFocusTarget
static final DJIKeyInfo |
Parameter:DoublePoint2D
The focus target of camera automaic focus. [0,0] means the upper left corner of camera screen. [1,1] means the lower right corner of camera screen. In AF mode, camera will automatically focus on the focus target once after setting focus target.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to ZOOM_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_ZOOM. If it is an M3M aircraft, set it to CAMERA_LENS_RGB. If it is a DJI single-lens camera or PSDK single-lens camera, set it to CAMERA_LENS_DEFAULT.Infrared Function
KeyThermalTemperatureMeasureMode
static final DJIKeyInfo |
Parameter:ThermalTemperatureMeasureMode
To set the temperature measurement mode. It supports two modes: spot measurement and region temperature measurement.
KeyThermalSpotMetersurePoint
static final DJIKeyInfo |
Parameter: DoublePoint2D
To set the location of the point that needs to be measured. [0,0] means the upper left corner of camera screen. [1,1] means the lower right corner of camera screen. After setting the location of temperature measuring point, current temperature of measuring point can be obtained through KeyThermalSpotMetersureTemperature.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. 3. Call
KeyThermalTemperatureMeasureMode to set ThermalTemperatureMeasureMode to SPOT.KeyThermalSpotMetersureTemperature
static final DJIKeyInfo |
Parameter: Double
To get current temperature of measuring point. Calling KeyThermalSpotMetersurePoint to set current location of temperature measuring point.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. 3. Call
KeyThermalTemperatureMeasureMode to set ThermalTemperatureMeasureMode to SPOT.KeyThermalRegionMetersureArea
static final DJIKeyInfo |
Parameter: DoubleRect
To set regional location that needs temperature measurement. [0,0] means the upper left corner of camera screen. [1,1] means the lower right corner of camera screen. After setting the location of temperature measuring point, temperature information of current temperature measuring region can be obtained through KeyThermalRegionMetersureTemperature.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. 3. Call
KeyThermalTemperatureMeasureMode to set ThermalTemperatureMeasureMode to REGION.KeyThermalRegionMetersureTemperature
static final DJIKeyInfo |
Parameter: ThermalAreaMetersureTemperature
To get current temperature information of current temperature measuring region. The information includes average temperatur, minimum temperature and maximum temperature. Regional location that needs temperature measurement can be obtained through KeyThermalRegionMetersureArea.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. 3. Call
KeyThermalTemperatureMeasureMode to set ThermalTemperatureMeasureMode to REGION.KeyThermalGainMode
static final DJIKeyInfo |
Parameter: ThermalGainMode
To set and get gain mode. The setting operation is time-consuming and takes 3 to 5 seconds to take effect. The temperature applicable range under different gain modes can be obtained through KeyThermalGainModeTemperatureRange. In high gain mode, a narrower temperature range can be captured with a higher sensitivity to temperature differences. In low gain mode, a wider temperature range can be captured with a lower sensitivity to temperature difference.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalGainModeTemperatureRange
static final DJIKeyInfo |
Parameter: ThermalGainModeTemperatureRange
To get temperature range of different gain modes.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalPaletteRange
static final DJIKeyInfo |
Parameter:list<CameraThermalPalette>
To get settable palette range of infrared lens.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalPalette
static final DJIKeyInfo |
Parameter: CameraThermalPalette
To set palette type. Settable palette range can be obtained through KeyThermalPaletteRange. Distinct colors are used to show temperature differences in the thermal image, which are related to grayscale intensity. The temperature range of the image is mapped to 256 colors and displayed in the 8-bit JPEG or MP4 format.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalIsothermEnabled
static final DJIKeyInfo |
Parameter: Boolean
Enable or disable isotherms. Turn on the isotherm function to see objects in the specified temperature range more intuitively. The temperature range is set by two thresholds of high temperature and low temperature. When disabled, all 256 values (8-bits) are dedicated to the temperature histogram of the scene. When enabled, only 128 values (0-127) are mapped linearly to temperature. Then three bands 128-175, 176-223 and 224-255 can be mapped to the user defined temperatures to highlight them to the user. Using some of the false color palettes (like RainbowIso) results in a thermal image that is grey scale except for three specific bands highlighted by either reds, blues or greens.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalIsothermUnit
static final DJIKeyInfo |
Parameter: ThermalIsothermUnit
Units for isotherms. Sets the unit of the Isotherm ranges to either Celsius or percent. Different units results in different value ranges for Isotherms. If the unit is percent, the settable value range is [0,100]. If the unit is Celsius, the settable upper value and lower value can refer to KeyThermalGainModeTemperatureRange.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalIsothermUpperValue
static final DJIKeyInfo |
Parameter: Integer
The upper threshold value for Isotherm. All temperature values above this value will use the colors 224-255 in the palette.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalIsothermLowerValue
static final DJIKeyInfo |
Parameter: Integer
The lower threshold value for Isotherm. Temperature values between the lower and medium isotherm thresholds will be displayed in 128-175 colors in the palette.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalDisplayMode
static final DJIKeyInfo |
Parameter: ThermalDisplayMode
To set display mode of infrared lens. The mode includes infrared display and split screen display.
If you need to set the infrared lens to the split screen display mode, please call this interface to set the display mode to PIP, and then call KeyThermalPIPPosition to set the display position to SIDE_BY_SIDE.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalPIPPosition
static final DJIKeyInfo |
Parameter: ThermalPIPPosition
Sets the display position of the infrared lens split screen. Please call KeyThermalDisplayMode to set the display mode to split screen display PIP. Then call this interface to set the display position to SIDE_BY_SIDE.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalFFCMode
static final DJIKeyInfo |
Parameter: ThermalFFCMode
To set FFC calibration mode. FFC calibration is a function of infrared lens. Image quality will be improved after the calibration.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalTriggerFFC
static final DJIActionKeyInfo |
Manually trigger the FFC calibration mode once. During the calibration process, the camera screen may pause for 1 second, and the camera will make a “click” sound.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalZoomRatios
static final DJIKeyInfo |
Parameter: Double
To set the infrared zoom ratio. And 1x, 2x, 4x and 8x zoom ratio is supported.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyLinkZoomEnabled
static final DJIKeyInfo |
Parameter:Boolean
Enable or disable the link zoom function. After enabling the link zoom function, call KeyThermalZoomRatios to achieve synchronous zooming of the infrared lens and the zoom lens. In the split-screen mode PIP, the user can compare the images of the infrared lens and the zoom lens more efficiently.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalSuperResolution
static final DJIKeyInfo |
Parameter: Boolean
To set the infrared super resolution open and close.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalROI
static final DJIKeyInfo |
Parameter: ThermalROI
To set the region of interest (ROI). User can choose ROI based on their needs. When the region of interest is full screen, the color levels of the entire image will be distributed in the default configuration. For instance, if there is a large patch of sky (relatively low temperature) in your image, much of the color spectrum will be allocated to the lower range, meaning that other parts of the spectrum will have a lower contrast. In this case, you may select “Sky excluded (33%)” or “Sky excluded (50%)” to ignore areas of the sky so that most of the spectrum can be allocated to remaining areas, providing higher contrast and utility for analysis.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalScene
static final DJIKeyInfo |
Parameter: ThermalScene
To set thermal scene. It supports default and inspection scenarios, as well as custom scenarios. Users can set and save customized parameters according to their needs. The camera will adjust the camera parameters according to different scenes to optimize the image processing.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalDDE
static final DJIKeyInfo |
Parameter: Integer
To set thermal Digital Detail Enhancement (DDE). The sharpness of images and outlines can be improved. Manual setting is only possible when the KeyThermalScene is MANUAL.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL. KeyThermalContrast
static final DJIKeyInfo |
Parameter: Integer
To set thermal contrast. The ratio of screen black to white. The larger the ratio, the richer the color performance. Manual setting is only possible when the KeyThermalScene is Scene MANUAL.
1. To use this function, please call
KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA. 2. When using
KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL.
methodKeyThermalBrightness
static final DJIKeyInfo<Integer> KeyThermalBrightness = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"ThermalBrightness", SingleValueConverter.IntegerConverter).canGet(true).canSet(true).canListen(true).canPerformAction(false).setIsEvent(false)
Parameter: Integer
To set thermal brightness. Manual setting is only possible when the KeyThermalScene is MANUAL.
Note
1. To use this function, please call KeyCameraVideoStreamSource to set the video source to INFRARED_CAMERA.
2. When using KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_THERMAL.
Multispectral
methodKeyMultiSpectralFusionType
static final DJIKeyInfo<MultiSpectralFusionType> KeyMultiSpectralFusionType = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"MultiSpectralFusionType", new SingleValueConverter<>(MultiSpectralFusionType.class,MultiSpectralFusionTypeMsg.class)).canGet(true).canSet(true).canListen(true).canPerformAction(false).setIsEvent(false)
Parameter: MultiSpectralFusionType
Sets the fusion type to coordinate the video feeds from both the RGB sensor and single-band sensors.
Note
1. To use this function, please call KeyCameraVideoStreamSource to set the video source to NDVI_CAMERA.
2. When using KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_MS_NDVI.
methodKeyMultiSpectralFusionDisplayRange
static final DJIKeyInfo<MultiSpectralFusionDisplayRange> KeyMultiSpectralFusionDisplayRange = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"MultiSpectralFusionDisplayRange", new DJIValueConverter<>(MultiSpectralFusionDisplayRange.class)).canGet(true).canSet(true).canListen(true).canPerformAction(false).setIsEvent(false)
Parameter: MultiSpectralFusionDisplayRange
Sets the multispectral fusion display range. the settable value range is [-10,10]. In the pilot this range is mapped to [-1,1].
Note
1. To use this function, please call KeyCameraVideoStreamSource to set the video source to NDVI_CAMERA.
2. When using KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_MS_NDVI.
methodKeyMultiSpectralDisplayMode
static final DJIKeyInfo<MultiSpectralDisplayMode> KeyMultiSpectralDisplayMode = new KeyMultiSpectralDisplayMode()
.canGet(true).canSet(true).canListen(true).canPerformAction(false).setIsEvent(false)
Parameter: MultiSpectralDisplayMode
To set display mode of NDVI lens. The mode includes NDVI display and split screen display.
If you need to set the NDVI lens to the split screen display mode, please call this interface to set the display mode to PIP
Note
1. To use this function, please call KeyCameraVideoStreamSource to set the video source to NDVI_CAMERA.
2. When using KeyTools to create a DJIKey instance, please set CameraLensType to CAMERA_LENS_MS_NDVI.
Basic Setting
methodKeyResetCameraSetting
static final DJIActionKeyInfo<EmptyMsg,EmptyMsg> KeyResetCameraSetting = new DJIActionKeyInfo<>(componentType.value(),subComponentType.value(),"ResetCameraSetting", EmptyValueConverter.converter,EmptyValueConverter.converter).canGet(false).canSet(false).canListen(false).canPerformAction(true).setIsEvent(false)
To reset camera parameters.
methodKeyFormatStorage
static final DJIActionKeyInfo<CameraStorageLocation,EmptyMsg> KeyFormatStorage = new DJIActionKeyInfo<>(componentType.value(),subComponentType.value(),"FormatStorage", new SingleValueConverter<>(CameraStorageLocation.class,CameraStorageLocationMsg.class),EmptyValueConverter.converter).canGet(false).canSet(false).canListen(false).canPerformAction(true).setIsEvent(false)
Parameter:CameraStorageLocation
To format storage. M30 and M30T camera only supports SD Card.