From b1b88daa43f404ce099217b28b594de1ab146dfe Mon Sep 17 00:00:00 2001 From: "daniel.chen" Date: Fri, 18 Mar 2022 17:22:15 +0800 Subject: [PATCH] update 4.16.1 --- README.md | 8 +- Sample Code/app/build.gradle | 12 +- Sample Code/app/src/main/AndroidManifest.xml | 4 +- .../sample/demo/utmiss/UTMISSActivity.java | 19 +- .../sdk/sample/internal/view/MainContent.java | 4 +- .../BaseClasses/DJIBaseProduct.html | 2 +- .../Components/Camera/DJICamera.html | 681 +++++++++--------- .../Components/Camera/DJICamera_DJILens.html | 2 +- .../Diagnostics/DJIDiagnostics.html | 2 +- .../FlightController/DJIFlightController.html | 273 ++++--- .../DJIFlightAssistantPerceptionState.html | 2 +- .../Components/KeyManager/DJICameraKey.html | 6 +- .../DJILiveStreamManager.html | 4 +- .../DJIActiveTrackMissionOperator.html | 4 +- ...intV2MissionOperatorListenerInterface.html | 3 +- .../RemoteController/DJIRemoteController.html | 2 +- .../DJIError_DJIFlightControllerError.html | 48 +- .../SDKError/DJIError_DJIWaypointV2Error.html | 162 +++-- docs/API Reference/index.html | 2 +- .../API Reference/javascripts/search_index.js | 586 +++++++-------- docs/API Reference/stylesheets/doc-app.css | 2 +- docs/API Reference/stylesheets/doc-vendor.css | 2 +- .../4.16_4.16.1_android_diff.html | 54 ++ 23 files changed, 961 insertions(+), 923 deletions(-) create mode 100644 docs/SDK APIs Diff/4.16_4.16.1_android_diff.html diff --git a/README.md b/README.md index 9872bc9e..00e5a43c 100644 --- a/README.md +++ b/README.md @@ -12,21 +12,21 @@ Declare dependency via Maven: com.dji dji-sdk - 4.16 + 4.16.1 com.dji dji-sdk-provided - 4.16 + 4.16.1 ~~~ or Gradle: ~~~groovy -compile 'com.dji:dji-sdk:4.16' -provided 'com.dji:dji-sdk-provided:4.16' +compile 'com.dji:dji-sdk:4.16.1' +provided 'com.dji:dji-sdk-provided:4.16.1' ~~~ For further detail on how to integrate the DJI Android SDK into your Android Studio project, please check the [Integrate SDK into Application](http://developer.dji.com/mobile-sdk/documentation/application-development-workflow/workflow-integrate.html#import-maven-dependency) tutorial. diff --git a/Sample Code/app/build.gradle b/Sample Code/app/build.gradle index c627e37d..b3690c44 100644 --- a/Sample Code/app/build.gradle +++ b/Sample Code/app/build.gradle @@ -8,14 +8,14 @@ repositories { } android { - compileSdkVersion 30 - buildToolsVersion '30.0.2' + compileSdkVersion 31 + buildToolsVersion '31.0.0' useLibrary 'org.apache.http.legacy' defaultConfig { applicationId "com.dji.sdk.sample" minSdkVersion 23 - targetSdkVersion 30 + targetSdkVersion 31 multiDexEnabled true versionCode 1 ndk { @@ -77,7 +77,7 @@ android { dependencies { implementation 'androidx.multidex:multidex:2.0.0' implementation 'com.squareup:otto:1.3.8' - implementation('com.dji:dji-sdk:4.16', { + implementation('com.dji:dji-sdk:4.16.1', { /** * Uncomment the "library-anti-distortion" if your app does not need Anti Distortion for Mavic 2 Pro and Mavic 2 Zoom. * Uncomment the "fly-safe-database" if you need database for release, or we will download it when DJISDKManager.getInstance().registerApp @@ -87,7 +87,7 @@ dependencies { exclude module: 'library-anti-distortion' //exclude module: 'fly-safe-database' }) - compileOnly 'com.dji:dji-sdk-provided:4.16' + compileOnly 'com.dji:dji-sdk-provided:4.16.1' implementation 'androidx.appcompat:appcompat:1.0.0' implementation 'androidx.core:core:1.0.0' @@ -115,4 +115,4 @@ dependencies { implementation 'com.davemorrissey.labs:subsampling-scale-image-view:3.10.0' implementation 'io.reactivex.rxjava2:rxjava:2.2.4' implementation 'io.reactivex.rxjava2:rxandroid:2.1.0' -} +} \ No newline at end of file diff --git a/Sample Code/app/src/main/AndroidManifest.xml b/Sample Code/app/src/main/AndroidManifest.xml index 69e86aae..bbaa4053 100644 --- a/Sample Code/app/src/main/AndroidManifest.xml +++ b/Sample Code/app/src/main/AndroidManifest.xml @@ -34,6 +34,7 @@ android:supportsRtl="true" android:theme="@style/AppTheme" android:extractNativeLibs="true" + tools:replace="label" tools:ignore="AllowBackup,GoogleAppIndexingWarning"> @@ -55,7 +56,8 @@ android:screenOrientation="portrait" android:launchMode="singleTop" android:configChanges="orientation|keyboardHidden|screenSize" - android:theme="@style/AppTheme"> + android:theme="@style/AppTheme" + android:exported="true"> diff --git a/Sample Code/app/src/main/java/com/dji/sdk/sample/demo/utmiss/UTMISSActivity.java b/Sample Code/app/src/main/java/com/dji/sdk/sample/demo/utmiss/UTMISSActivity.java index 5a2b39dd..0ef7283f 100644 --- a/Sample Code/app/src/main/java/com/dji/sdk/sample/demo/utmiss/UTMISSActivity.java +++ b/Sample Code/app/src/main/java/com/dji/sdk/sample/demo/utmiss/UTMISSActivity.java @@ -26,21 +26,13 @@ public class UTMISSActivity extends AppCompatActivity { - @BindView(R.id.txt_db_path) TextView mTvDbPath; - @BindView(R.id.txt_status) TextView mTvStatus; - @BindView(R.id.txt_info) TextView mTvInfo; - @BindView(R.id.edt_token_key) EditText mEdtTokenKey; - @BindView(R.id.edt_manufactureId) EditText mEdtManufactureId; - @BindView(R.id.edt_uasId) EditText mEdtUasId; - - @BindView(R.id.btn_start) Button mBtnInit; String dbPath; @@ -50,6 +42,17 @@ protected void onCreate(@Nullable Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_utmiss); ButterKnife.bind(this); + initUI(); + } + + private void initUI(){ + mTvDbPath = findViewById(R.id.txt_db_path); + mTvStatus = findViewById(R.id.txt_status); + mTvInfo = findViewById(R.id.txt_info); + mEdtTokenKey = findViewById(R.id.edt_token_key); + mEdtManufactureId = findViewById(R.id.edt_manufactureId); + mEdtUasId = findViewById(R.id.edt_uasId); + mBtnInit = findViewById(R.id.btn_start); init(); } diff --git a/Sample Code/app/src/main/java/com/dji/sdk/sample/internal/view/MainContent.java b/Sample Code/app/src/main/java/com/dji/sdk/sample/internal/view/MainContent.java index 46f21df4..a63d36bc 100644 --- a/Sample Code/app/src/main/java/com/dji/sdk/sample/internal/view/MainContent.java +++ b/Sample Code/app/src/main/java/com/dji/sdk/sample/internal/view/MainContent.java @@ -85,7 +85,6 @@ public class MainContent extends RelativeLayout { Manifest.permission.RECORD_AUDIO // Speaker accessory }; private static final int REQUEST_PERMISSION_CODE = 12345; - private List missingPermission = new ArrayList<>(); private AtomicBoolean isRegistrationInProgress = new AtomicBoolean(false); private int lastProcess = -1; private Handler mHander = new Handler(); @@ -465,6 +464,7 @@ public void onFailure(DJIError djiError) { */ private void checkAndRequestPermissions() { // Check for permissions + List missingPermission = new ArrayList<>(); for (String eachPermission : REQUIRED_PERMISSION_LIST) { if (ContextCompat.checkSelfPermission(mContext, eachPermission) != PackageManager.PERMISSION_GRANTED) { missingPermission.add(eachPermission); @@ -665,7 +665,7 @@ public void onFailure(DJIError djiError) { } }); } - },1000); + },5000); } private void hideProcess(){ diff --git a/docs/API Reference/BaseClasses/DJIBaseProduct.html b/docs/API Reference/BaseClasses/DJIBaseProduct.html index 4f73f274..850a9741 100644 --- a/docs/API Reference/BaseClasses/DJIBaseProduct.html +++ b/docs/API Reference/BaseClasses/DJIBaseProduct.html @@ -1570,7 +1570,7 @@
Class Members:
Description:

Class containing all product strings.

Enum Members:
-
UNKNOWN_AIRCRAFTThe Aircraft's model name is unknown.
INSPIRE_1The aircraft's model name is Inspire 1.
INSPIRE_1_PROThe aircraft's model name is Inspire 1 Pro.
INSPIRE_1_RAWThe aircraft's model name is Inspire 1 Raw.
INSPIRE_2The aircraft's model name is Inspire 2.
PHANTOM_3_PROFESSIONALThe aircraft's model name is Phantom 3 Professional.
PHANTOM_3_ADVANCEDThe aircraft's model name is Phantom 3 Advanced.
PHANTOM_3_STANDARDThe aircraft's model name is Phantom 3 Standard.
Phantom_3_4KThe aircraft's model name is Phantom 3 4K.
PHANTOM_4The aircraft's model name is Phantom 4.
PHANTOM_4_PROThe aircraft's model name is Phantom 4 Pro.
PHANTOM_4_PRO_V2The aircraft's model name is Phantom 4 Pro V2.
P_4_MULTISPECTRALThe aircraft's model name is P4 Multispectral.
MAVIC_AIR_2The aircraft's model name is Mavic Air 2.
MAVIC_2_ENTERPRISE_ADVANCEDThe aircraft's model name is Mavic 2 Enterprise Advanced.
MATRICE_100The aircraft's model name is Matrice 100.
MATRICE_600The aircraft's model name is Matrice 600.
MATRICE_600_PROThe aircraft's model name is Matrice 600 Pro.
A3The aircraft flight controller's model name is A3.
MAVIC_PROThe aircraft's model name is Mavic Pro.
SparkThe aircraft's model name is Spark.
MATRICE_210The aircraft's model name is Matrice 210.
MATRICE_210_RTKThe aircraft's model name is Matrice 210 RTK.
MATRICE_200_V2The aircraft's model name is Matrice 200 V2.
MATRICE_210_V2The aircraft's model name is Matrice 210 V2.
MATRICE_210_RTK_V2The aircraft's model name is Matrice 210 RTK V2.
MATRICE_300_RTKThe aircraft's model name is Matrice 300 RTK.
MAVIC_AIRThe aircraft's model name is Mavic Air.
MAVIC_2_PROThe aircraft's model name is Mavic 2 Pro.
MAVIC_2_ZOOMThe aircraft's model name is Mavic 2 Zoom.
MAVIC_2The aircraft's model name is either Mavic 2 Pro or Mavic 2 Zoom. The camera is not recognized yet.
MAVIC_2_ENTERPRISEThe aircraft's model name is Mavic 2 Enterprise.
MAVIC_2_ENTERPRISE_DUALThe aircraft's model name is Mavic 2 Enterprise Dual.
MAVIC_MINIThe aircraft's model name is Mavic Mini.
DJI_MINI_SEThe aircraft's model name is DJI Mini SE.
DJI_MINI_2The aircraft's model name is DJI Mini 2.
DJI_AIR_2SThe aircraft's model name is DJI Air 2S.
N3The aircraft flight controller's model name is N3.
UNKNOWN_HANDHELDHandheld device model name unknown.
OSMOHandheld device model name Osmo.
OSMO_PROHandheld device model name Osmo Pro.
OSMO_RAWHandheld device model name Osmo RAW.
OSMO_MOBILEHandheld device model name Osmo Mobile.
OSMO_PLUSHandheld device model name Osmo+.
OSMO_MOBILE_2Handheld device model name Osmo Mobile 2.
+
UNKNOWN_AIRCRAFTThe Aircraft's model name is unknown.
INSPIRE_1The aircraft's model name is Inspire 1.
INSPIRE_1_PROThe aircraft's model name is Inspire 1 Pro.
INSPIRE_1_RAWThe aircraft's model name is Inspire 1 Raw.
INSPIRE_2The aircraft's model name is Inspire 2.
PHANTOM_3_PROFESSIONALThe aircraft's model name is Phantom 3 Professional.
PHANTOM_3_ADVANCEDThe aircraft's model name is Phantom 3 Advanced.
PHANTOM_3_STANDARDThe aircraft's model name is Phantom 3 Standard.
Phantom_3_4KThe aircraft's model name is Phantom 3 4K.
PHANTOM_4The aircraft's model name is Phantom 4.
PHANTOM_4_PROThe aircraft's model name is Phantom 4 Pro.
PHANTOM_4_PRO_V2The aircraft's model name is Phantom 4 Pro V2.
P_4_MULTISPECTRALThe aircraft's model name is P4 Multispectral.
MAVIC_AIR_2The aircraft's model name is Mavic Air 2.
DJI_MINI_SEThe aircraft's model name is DJI Mini SE.
DJI_MINI_2The aircraft's model name is DJI Mini 2.
MAVIC_2_ENTERPRISE_ADVANCEDThe aircraft's model name is Mavic 2 Enterprise Advanced.
MATRICE_100The aircraft's model name is Matrice 100.
MATRICE_600The aircraft's model name is Matrice 600.
MATRICE_600_PROThe aircraft's model name is Matrice 600 Pro.
A3The aircraft flight controller's model name is A3.
MAVIC_PROThe aircraft's model name is Mavic Pro.
SparkThe aircraft's model name is Spark.
MATRICE_210The aircraft's model name is Matrice 210.
MATRICE_210_RTKThe aircraft's model name is Matrice 210 RTK.
MATRICE_200_V2The aircraft's model name is Matrice 200 V2.
MATRICE_210_V2The aircraft's model name is Matrice 210 V2.
MATRICE_210_RTK_V2The aircraft's model name is Matrice 210 RTK V2.
MATRICE_300_RTKThe aircraft's model name is Matrice 300 RTK.
MAVIC_AIRThe aircraft's model name is Mavic Air.
MAVIC_2_PROThe aircraft's model name is Mavic 2 Pro.
MAVIC_2_ZOOMThe aircraft's model name is Mavic 2 Zoom.
MAVIC_2The aircraft's model name is either Mavic 2 Pro or Mavic 2 Zoom. The camera is not recognized yet.
MAVIC_2_ENTERPRISEThe aircraft's model name is Mavic 2 Enterprise.
MAVIC_2_ENTERPRISE_DUALThe aircraft's model name is Mavic 2 Enterprise Dual.
MAVIC_MINIThe aircraft's model name is Mavic Mini.
DJI_AIR_2SThe aircraft's model name is DJI Air 2S.
N3The aircraft flight controller's model name is N3.
UNKNOWN_HANDHELDHandheld device model name unknown.
OSMOHandheld device model name Osmo.
OSMO_PROHandheld device model name Osmo Pro.
OSMO_RAWHandheld device model name Osmo RAW.
OSMO_MOBILEHandheld device model name Osmo Mobile.
OSMO_PLUSHandheld device model name Osmo+.
OSMO_MOBILE_2Handheld device model name Osmo Mobile 2.
Class Members:
diff --git a/docs/API Reference/Components/Camera/DJICamera.html b/docs/API Reference/Components/Camera/DJICamera.html index d84f34cf..562a994e 100644 --- a/docs/API Reference/Components/Camera/DJICamera.html +++ b/docs/API Reference/Components/Camera/DJICamera.html @@ -1797,78 +1797,67 @@
Enum Members:
SLOW_MOTIONSets the camera to slow motion video recording mode. Only supported by Mavic Air 2, DJI Air 2S.
VIDEO_NORMALSets the camera to record normal videos.
PHOTO_TIME_LAPSESets 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.
PHOTO_AEBAutomatic 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.
PHOTO_SINGLESets the camera to take a single photo.
PHOTO_BURSTSet the camera to take multiple photos at once.
PHOTO_HDRSets the camera to take photos in HDR mode.
VIDEO_HDRSets the camera to HDR video recording mode. Only supported by Mavic Air 2.
PHOTO_INTERVALSets 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.
PHOTO_HYPER_LIGHTSets 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.
PHOTO_PANORAMASets the camera to take photos 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.
PHOTO_EHDRSets the camera to take an enhanced-HDR photo. It blends a sequence of photos for ghost-free high dynamic range photos.
PHOTO_HIGH_RESOLUTIONSets the camera to the high resolution mode. In this mode, the camera will take photos with a resolution of 48MP. Only supported by Mavic Air 2.
PHOTO_SUPER_RESOLUTIONSets the camera to the super resolution mode. In this mode, drag to select an area in the wide camera view, the gimbal will move automatically and take a series of 20MP photos of the selected area at the current zoom ratio by the zoom camera. All photos will be saved in the same sub-folder in the microSD card, and an HTML file will be created. To view the wide and close-up images, open the HTML file using a browser on a PC. If you want to view the close-up images in app, please refer to the sample implementation. Using setSuperResolutionCaptureArea to set the super resolution capture area. Using setSuperResolutionInfoCallback to listen the super resolution state. Only supported by Matrice 300 RTK.
PHOTO_SMARTSets the camera to the smart mode. In this mode, when shooting photo, the camera can automatically recognize the scene, and use the built-in algorithm to optimize the scene. Only supported by Mavic Air 2, DJI Air 2S.
INTERNAL_AI_SPOT_CHECKINGInternal work mode during smart inspection and it cannot be set manually. This mode might last for less than 10 seconds, during when the user cannot take photo, record a video, enter media playback mode, set spot metering target of ZOOM lens type, and set zoom focus length with any lens type. Only AUTO can be set with ZOOM lens type. In this mode, remote controller also cannot be used to take photo, record video and adjust focus. It's only supported by Matrice 300 RTK.
UNKNOWNThe camera work mode is unknown.
Class Members:
-
-
enum SDCardOperationState
- -
enum SDCardOperationState
-
Package:dji.common.camera
-
Description:
-

Operation states of the camera's SD card.

-
Enum Members:
-
NORMALThe SD card is in the normal state.
NOT_INSERTEDThe SD card is not inserted.
INVALIDThe SD card is in invalid state.
READ_ONLYThe SD card is in read-only state and write operation is not allowed.
FORMAT_NEEDEDIt is required to format the SD card before using it.
FORMATTINGThe SD card is being formatted.
INVALID_FILE_SYSTEMThe SD card is using an invalid file system. Format the SD card before using it.
BUSYThe SD card is busy.
FULLThe SD card is full.
SLOWThe SD card is too slow.
UNKNOWN_ERRORThe SD card encounters an unknown error.
NO_REMAIN_FILE_INDICESNo remaining file indices for any new photos or videos.
INITIALIZINGThe SD card is in initializing state.
FORMAT_RECOMMENDEDIt is recommended to format the SD card before using it.
RECOVERING_FILESThe camera is recovering the damaged files on the SD card.
WRITING_SLOWLYThe SD card is being written in a slow speed.
-
Class Members:
-
-
+
enum PhotoAEBCount
enum PhotoAEBCount
Package:dji.common.camera
SDK Key:CameraKey.PHOTO_AEB_COUNT
-
Description:
+
Description:

The number of pictures to continuously take at one time in AEB mode. Use with DJICameraPhotoAEBParam.

-
Enum Members:
+
Enum Members:
AEB_COUNT_3The number of pictures to continuously take at one time in AEB mode is 3.
AEB_COUNT_5The number of pictures to continuously take at one time in AEB mode is 5.
AEB_COUNT_7The number of pictures to continuously take at one time in AEB mode is 7.
UNKNOWNThe number of pictures to continuously take at one time in AEB mode is unknown.
-
Class Members:
+
Class Members:
enum PhotoPanoramaMode
enum PhotoPanoramaMode
Package:dji.common.camera
SDK Key:CameraKey.PHOTO_PANORAMA_MODE
-
Description:
+
Description:

Panorama photo modes.

-
Enum Members:
+
Enum Members:
PANORAMA_MODE_3X3Camera will shoot 3 rows of 3 photos. Each photo in a row will be taken with a different aircraft heading. Each row of photos is taken with a different gimbal pitch.
PANORAMA_MODE_3X1Camera will shoot 3 photos with the same aircraft heading and different gimbal pitch.
PANORAMA_MODE_SPHERECamera will shoot 8 rows of 3 photos and 1 extra photo (facing downward). Each photo in a row will be taken with a different aircraft heading. Each row of photos is taken with a different gimbal pitch.
PANORAMA_MODE_180Camera will shoot 3 photos with the same gimbal pitch (facing forward) and different aircraft headings.
PANORAMA_MODE_SUPER_RESOLUTIONThe camera will capture and patch nine photos resulting in a 48-megapixel super resolution photo. It is supported by Spark, Mavic Air, Mavic 2, Mavic 2 Pro, Mavic 2 Zoom, Mavic 2 Eneterprise, Mavic 2 Enterprise Dual.
UNKNOWNUnknown.
-
Class Members:
+
Class Members:
enum CameraVideoStreamSource
enum CameraVideoStreamSource
Package:dji.common.camera
-
Description:
+
Description:

The enumeration represents which lens the camera stream comes from. The camera video stream will been used to transfer to image transmission to display and determine which lens were taken photo or recording. It is only supported by Zenmuse H20 and Zenmuse H20T Camera.

-
Enum Members:
+
Enum Members:
DEFAULTThe default video stream channel.
WIDEWide stream. Only supported by Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced.
ZOOMZoom stream. Only supported by Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced.
INFRARED_THERMALInfrared thermal stream. Only supported by Zenmuse H20T and Mavic 2 Enterprise Advanced.
UNKNOWNUnknown.
-
Class Members:
+
Class Members:
Callback
class
Callback
enum SuperResolutionStatus
enum SuperResolutionStatus
Package:dji.common.camera
-
Description:
+
Description:

The states of Super resolution.

-
Enum Members:
+
Enum Members:
SELECTINGSelecting. You could adjust super resolution area with setSuperResolutionCaptureArea.
IN_PROGRESSSuper resolution shooting in progress.
FINISHSuper resolution shooting completed.
EXIT_OUT_OF_STORAGEStop shooting because there is no storage.
EXIT_SHOOT_FAILStop shooting because the shooting failed.
EXIT_GIMBAL_BLOCKStop shooting because the gimbal is blocked.
EXIT_GIMBAL_ABNORMAL_MOVEStop shooting because the gimbal did not move or move abnormally.
TIP_GIMBAL_OUT_OF_RANGEStop shooting because the angle of gimbal exceeds the maximum range.
TIP_OUT_OF_ZOOMThe zoom of camera out of the maximum range.
UNKNOWNUnknown error.
-
Class Members:
+
Class Members:
enum
Result
enum Result
enum Result
Package:dji.sdk.camera.view
-
Description:
+
Description:

Defines the result of pin point callback.

-
Enum Members:
+
Enum Members:
SUCCESS_BUT_OUT_OF_SCREENSuccess to get the pin point location, but point is out of liveview, should show as side indicator, please reference to DJI pilot.
SUCCESSSuccess to get the pin point location, the point is insde the liveview.
FAILEDFailed to get the pin point location.
INVALID_DRONE_POSITIONFailed to get the pin point location, because the drone position is invalid.
INVALID_POINT_POSITIONFailed to get the pin point location, because the input GPS location is invalid.
GIMBAL_ATTI_ERRORFailed to get the pin point location, because of gimbal attitude error.
CAMEAR_ERRORFailed to get the pin point location, because of camera error.
-
Class Members:
+
Class Members:
State Updates
class
TimeLapsePreviewCallback
Managers
class
MediaManager
SSD Clip File Name
class
SSDClipFileName
Original Photo Settings
class
OriginalPhotoSettings
Multispectral Storage Settings
class
MultispectralStoragePhotoSettings
Multispectral Exposure State
class
MultispectralExposureState
Watermark Settings
class
WatermarkSettings
Laser Measure Info
class
LaserMeasureInformation
final DisplayNamePhantom3StandardCamera
static final String DisplayNamePhantom3StandardCamera =
       DJICameraAbstraction.DisplayNamePhantom3StandardCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 3 Standard camera.

@@ -1876,7 +1865,7 @@
Description:
static final String DisplayNamePhantom3AdvancedCamera =
       DJICameraAbstraction.DisplayNamePhantom3AdvancedCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 3 Advanced camera.

@@ -1884,7 +1873,7 @@
Description:
static final String DisplayNamePhantom3ProfessionalCamera =
       DJICameraAbstraction.DisplayNamePhantom3ProfessionalCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 3 Professional camera.

@@ -1892,7 +1881,7 @@
Description:
static final String DisplayNamePhantom34KCamera = DJICameraAbstraction.DisplayNamePhantom34KCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 3 4K camera.

@@ -1900,7 +1889,7 @@
Description:
static final String DisplayNameX3 = DJICameraAbstraction.DisplayNameX3
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for X3 camera.

@@ -1908,7 +1897,7 @@
Description:
static final String DisplayNameX5 = DJICameraAbstraction.DisplayNameX5
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for X5 camera.

@@ -1916,7 +1905,7 @@
Description:
static final String DisplayNameX5R = DJICameraAbstraction.DisplayNameX5R
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for X5R camera.

@@ -1924,7 +1913,7 @@
Description:
static final String DisplayNamePhantom4Camera = DJICameraAbstraction.DisplayNamePhantom4Camera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 4 camera.

@@ -1932,7 +1921,7 @@
Description:
static final String DisplaynamePhantom4ProCamera = DJICameraAbstraction.DisplaynamePhantom4ProCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 4 Pro camera.

@@ -1940,7 +1929,7 @@
Description:
static final String DisplayNameXT = DJICameraAbstraction.DisplayNameXT336
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Zenmuse XT camera.

@@ -1948,7 +1937,7 @@
Description:
static final String DisplayNameXTS = DJICameraAbstraction.DisplayNameXTS
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Zenmuse XT S camera.

@@ -1956,7 +1945,7 @@
Description:
static final String DisplayNameZ3 = DJICameraAbstraction.DisplayNameZ3
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Z3 camera.

@@ -1964,7 +1953,7 @@
Description:
static final String DisplayNameMavicProCamera = DJICameraAbstraction.DisplayNameMavicProCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic Pro camera.

@@ -1972,7 +1961,7 @@
Description:
static final String DisplayNameSparkCamera = DJICameraAbstraction.DisplayNameSparkCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Spark camera.

@@ -1980,7 +1969,7 @@
Description:
static final String DisplaynamePhantom4PV2Camera = DJICameraAbstraction.DisplaynamePhantom4PSDRCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 4 Pro V2 camera.

@@ -1988,7 +1977,7 @@
Description:
static final String DisplaynamePhantom4RTKCamera = DJICameraAbstraction.DisplaynamePhantom4RTKCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 4 RTK camera.

@@ -1996,7 +1985,7 @@
Description:
static final String DisplayNameX7 = DJICameraAbstraction.DisplayNameX7
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for X7 camera.

@@ -2004,7 +1993,7 @@
Description:
static final String DisplayNameXT2_IR = DJICameraAbstraction.DisplayNameXT2_IR
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for XT2 thermal camera.

@@ -2012,7 +2001,7 @@
Description:
static final String DisplayNameXT2_VL = DJICameraAbstraction.DisplayNameXT2_VL
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for XT2 visual camera.

@@ -2020,7 +2009,7 @@
Description:
static final String DisplayNameMavicAirCamera = DJICameraAbstraction.DisplayNameMavicAirCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic Air camera.

@@ -2028,7 +2017,7 @@
Description:
static final String DisplayNameMavic2ZoomCamera = DJICameraAbstraction.DisplayNameMavic2ZoomCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic 2 Zoom camera.

@@ -2036,7 +2025,7 @@
Description:
static final String DisplayNameMavic2ProCamera = DJICameraAbstraction.DisplayNameMavic2ProCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic 2 Pro camera.

@@ -2044,7 +2033,7 @@
Description:
static final String DisplayNameMavic2EnterpriseCamera = DJICameraAbstraction.DisplayNameMavic2EnterpriseCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic 2 Enterprise.

@@ -2052,7 +2041,7 @@
Description:
static final String DisplayNameMavic2EnterpriseDual_IR = DJICameraAbstraction.DisplayNameMavic2EnterpriseDual_IR
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic 2 Enterprise Dual thermal camera.

@@ -2060,7 +2049,7 @@
Description:
static final String DisplayNameMavic2EnterpriseDual_VL = DJICameraAbstraction.DisplayNameMavic2EnterpriseDual_VL
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic 2 Enterprise Dual visual camera.

@@ -2068,7 +2057,7 @@
Description:
static final String DisplayNameP4MCamera = DJICameraAbstraction.DisplayNameP4MCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for P4 Multispectral camera.

@@ -2076,7 +2065,7 @@
Description:
static final String DisplayNameMavicMiniCamera = DJICameraAbstraction.DisplayNameMavicMiniCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic Mini camera.

@@ -2084,7 +2073,7 @@
Description:
static final String DisplayNameMavicAir2Camera = DJICameraAbstraction.DisplayNameMavicAir2Camera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic Air 2 camera.

@@ -2092,7 +2081,7 @@
Description:
static final String DisplayNameZenmuseH20 = DJIMultiLensCameraAbstraction.DisplayNameZenmuseH20
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Zenmuse H20.

@@ -2100,7 +2089,7 @@
Description:
static final String DisplayNameZenmuseH20T = DJIMultiLensCameraAbstraction.DisplayNameZenmuseH20T
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Zenmuse H20T.

@@ -2108,7 +2097,7 @@
Description:
static final String DisplayNameMavic2EnterpriseAdvancedCamera = DJIMultiLensCameraAbstraction.DisplayNameMavic2EnterpriseAdvancedCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Mavic 2 Enterprise Advanced Camera.

@@ -2116,7 +2105,7 @@
Description:
static final int XT2_IR_CAMERA_INDEX = DJISDKCacheHWAbstractionLayer.XT2_IR_CAMERA_INDEX
Package:dji.sdk.camera
-
Description:
+
Description:

Index for the XT2 camera.

@@ -2124,7 +2113,7 @@
Description:
static final String DisplayNameZ30 = DJICameraAbstraction.DisplayNameZ30
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Z30 camera.

@@ -2132,7 +2121,7 @@
Description:
static final String DisplayNameX4S = DJICameraAbstraction.DisplayNameX4S
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for X4S camera.

@@ -2140,7 +2129,7 @@
Description:
static final String DisplayNameX5S = DJICameraAbstraction.DisplayNameX5S
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for X5S camera.

@@ -2148,7 +2137,7 @@
Description:
static final String DisplaynamePhantom4AdvancedCamera = DJICameraAbstraction.DisplaynamePhantom4AdvancedCamera
Package:dji.sdk.camera
-
Description:
+
Description:

The display name for Phantom 4 Advanced camera.

Camera peak Threshold
class
CameraPeakThreshold
DJILens
class
Lens


@@ -2158,7 +2147,7 @@

Playback and Download

boolean isMediaDownloadModeSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_MEDIA_DOWNLOAD_MODE_SUPPORTED
-
Description:
+
Description:

Check if the current device supports Media Download Mode.

Return:
booleantrue if the current device supports Media Download Mode, false otherwise.
@@ -2167,7 +2156,7 @@
Return:
@Nullable
 MediaManager getMediaManager()
Package:dji.sdk.camera
-
Description:
+
Description:

Media Manager is used for interaction when camera is in MEDIA_DOWNLOAD. The user can only access the manager when isMediaDownloadModeSupported returns true. @return The MediaManager object if the aircraft supports media list feature. Otherwise, returns null.

Return:
MediaManagerAn instance of MediaManager.
@@ -2176,7 +2165,7 @@
Return:
boolean isPlaybackSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_PLAYBACK_SUPPORTED
-
Description:
+
Description:

Check if the current device supports Playback Mode.

Return:
booleanA boolean value.
@@ -2185,7 +2174,7 @@
Return:
@Nullable
 PlaybackManager getPlaybackManager()
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the playback manager object. Playback Manager is used for interaction when camera is in PLAYBACK. User can only access to the manager when isPlaybackSupported returns true.

Return:
PlaybackManagerAn instance of PlaybackManager.
@@ -2196,7 +2185,7 @@

Exposure & White Balance

void setExposureMode(@NonNull ExposureMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.EXPOSURE_MODE
-
Description:
+
Description:

Sets the camera's exposure mode. Check ExposureMode to view all possible camera exposure modes. Please note that in different exposure mode, it will have different values for the same setting. For Mavic 2 Enterprise Dual, the exposure mode is always PROGRAM. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull ExposureMode modeCamera exposure mode to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2205,7 +2194,7 @@
Input Parameters:
void getExposureMode(@NonNull final CompletionCallbackWith<ExposureMode> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.EXPOSURE_MODE
-
Description:
+
Description:

Gets the camera's exposure mode. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ExposureMode> callbackThe execution callback with the returned value(s).
@@ -2214,7 +2203,7 @@
Input Parameters:
void setISO(@NonNull ISO iso, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.ISO
-
Description:
+
Description:

Sets the camera's ISO value. See ISO to view all possible ISO settings for the camera. For the X5, X5R, Phantom 4 Pro camera, X4S and X5S, the ISO value can be set for all modes. For the other cameras, the ISO value can only be set when the camera exposure mode is in Manual mode. See the setExposureMode method for how to set exposure mode. For Mavic 2 Enterprise Dual, the ISO value is always AUTO. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull ISO isoThe ISO value to set the camera to use. Please check the enum CameraISOe in DJICameraSettingsDef to find all possible ISO values that the camera can be set to.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2223,7 +2212,7 @@
Input Parameters:
void getISO(@NonNull final CompletionCallbackWith<ISO> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.ISO
-
Description:
+
Description:

Gets the camera's ISO value. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ISO> callbackThe execution callback with the returned value(s).
@@ -2232,7 +2221,7 @@
Input Parameters:
void setShutterSpeed(@NonNull ShutterSpeed shutterSpeed, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SHUTTER_SPEED
-
Description:
+
Description:

Sets the camera shutter speed. To see all available shutterSpeed value settings, see ShutterSpeed. The shutter speed should not be set slower than the video frame rate when the camera's mode is RECORD_VIDEO. For example, if the video frame rate is 30fps, the shutterSpeed must be <= 1/30. Precondition: The shutter speed can be set only when the camera exposure mode is Shutter mode or Manual mode. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull ShutterSpeed shutterSpeedThe ISO value to set the camera to use. Please check the enum CameraISOe in DJICameraSettingsDef to find all possible ISO values that the camera can be set to.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2241,7 +2230,7 @@
Input Parameters:
void getShutterSpeed(@NonNull final CompletionCallbackWith<ShutterSpeed> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SHUTTER_SPEED
-
Description:
+
Description:

Gets the camera's shutter speed. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ShutterSpeed> callbackThe execution callback with the returned value(s).
@@ -2250,7 +2239,7 @@
Input Parameters:
boolean isAdjustableApertureSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_ADJUSTABLE_APERTURE_SUPPORTED
-
Description:
+
Description:

Gets whether the camera supports an adjustable aperture. Currently adjustable aperture is supported only by the X5, X5R, X4S, X5S cameras and Mavic 2 Pro. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Return:
booleanA boolean value.
@@ -2259,7 +2248,7 @@
Return:
void setAperture(@NonNull Aperture aperture, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.APERTURE
-
Description:
+
Description:

Sets the aperture value. This feature is available only when isAdjustableApertureSupported returns true.
Precondition:
The exposure mode ExposureMode must be in MANUAL or APERTURE_PRIORITY.
Supported only by the X5, X5R, X4S, X5S camera and Mavic 2 Pro. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull Aperture apertureThe aperture to set. Check enum CameraLensFocusMode in DJICameraSettingsDef.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2268,7 +2257,7 @@
Input Parameters:
void getAperture(@NonNull final CompletionCallbackWith<Aperture> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.APERTURE
-
Description:
+
Description:

Gets the lens aperture. This feature is available only when isAdjustableApertureSupported returns true. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Aperture> callbackThe execution callback with the returned value(s).
@@ -2277,7 +2266,7 @@
Input Parameters:
void setMeteringMode(@NonNull MeteringMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.METERING_MODE
-
Description:
+
Description:

Sets the camera's exposure metering. See MeteringMode to view all possible exposure metering settings for the camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull MeteringMode modeExposure metering to be set. Check the enum MeteringMode to find all possible exposure metering the camera can be set to.
@Nullable final CompletionCallback callbackThe execution callback with the execution result
@@ -2286,7 +2275,7 @@
Input Parameters:
void getMeteringMode(@NonNull final CompletionCallbackWith<MeteringMode> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.METERING_MODE
-
Description:
+
Description:

Gets the camera's exposure metering. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<MeteringMode> callbackThe execution callback with the returned value(s).
@@ -2295,7 +2284,7 @@
Input Parameters:
void setSpotMeteringTarget(@NonNull Point spotIndex, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SPOT_METERING_TARGET
-
Description:
+
Description:

Sets the spot metering area index. The camera image is divided into 96 spots defined by 12 columns and 8 rows. The row index range is [0,7], where the values increase top to bottom across the image. The column index range is [0, 11], where the values increase left to right. In order to make the method work, The camera exposure mode should be Program, Shutter or Aperture, the exposure metering mode must be SPOT, and setAELock must be false. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull Point spotIndexSpot metering point coordinate (x, y). x is column index to be set. The value should falls in [0, 11], where the values increase left to right. y is row index to be set. The value should falls in [0, 7], where the values increase top to bottom across the image.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2304,7 +2293,7 @@
Input Parameters:
void getSpotMeteringTarget(@NonNull final CompletionCallbackWith<Point> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SPOT_METERING_TARGET
-
Description:
+
Description:

Gets the spot metering area row index and column index. In order to make the method work, The camera exposure mode should be PROGRAM, SHUTTER_PRIORITY or APERTURE_PRIORITY, the exposure metering mode must be SPOT, and getAELock must be false. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Point> callbackThe execution callback with the returned value(s).
@@ -2313,7 +2302,7 @@
Input Parameters:
void setExposureCompensation(@NonNull ExposureCompensation compensation,
                                       @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.EXPOSURE_COMPENSATION
-
Description:
+
Description:

Sets the camera's exposure compensation. See ExposureCompensation to view all possible exposure compensations to which the camera can be set. In order to use this function, set the camera exposure mode to shutter, program or aperture. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull ExposureCompensation compensationExposure compensation value to be set for the camera.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2322,7 +2311,7 @@
Input Parameters:
void getExposureCompensation(@NonNull final CompletionCallbackWith<ExposureCompensation> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.EXPOSURE_COMPENSATION
-
Description:
+
Description:

Gets the camera's exposure compensation. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ExposureCompensation> callbackThe execution callback with the returned value(s).
@@ -2331,7 +2320,7 @@
Input Parameters:
void setAELock(boolean isLocked, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.AE_LOCK
-
Description:
+
Description:

Locks or unlocks the camera's AE (auto exposure).
Post condition:
If the AE lock is enabled, the spot metering area cannot be set. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
boolean isLockedtrue if the camera AE is locked, false if it is unlocked.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2340,7 +2329,7 @@
Input Parameters:
void getAELock(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.AE_LOCK
-
Description:
+
Description:

Determines if the camera's AE (auto exposure) is locked. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -2349,7 +2338,7 @@
Input Parameters:
void setAutoAEUnlockEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.AUTO_AE_UNLOCK_ENABLED
-
Description:
+
Description:

Enables/disables auto-unlocking of AE lock after shooting a photo. If it is enabled, the Auto Exposure will unlock after each shot. If disabled, Auto Exposure will change when calling setAELock. It is only supported X4S, X5S and Phantom 4 Pro cameras. For the other products, auto-unlocking is always enabled. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
boolean enabledtrue if the camera AE will automatically unlock.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2358,7 +2347,7 @@
Input Parameters:
void getAutoAEUnlockEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.AUTO_AE_UNLOCK_ENABLED
-
Description:
+
Description:

Determines whether auto-unlocking of AE lock is enabled. It is only supported by X4S, X5S and Phantom 4 Pro cameras. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -2367,7 +2356,7 @@
Input Parameters:
void setPhotoAEBCount(@NonNull PhotoAEBCount count, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_AEB_COUNT
-
Description:
+
Description:

Sets the camera's auto exposure bracketing (AEB) capture parameters.

Input Parameters:
@NonNull PhotoAEBCount countAEB capture count to be set for the camera.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2376,7 +2365,7 @@
Input Parameters:
void getPhotoAEBCount(@NonNull final CompletionCallbackWith<PhotoAEBCount> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_AEB_COUNT
-
Description:
+
Description:

Gets the camera's AEB capture parameters.

Input Parameters:
@NonNull final CompletionCallbackWith<PhotoAEBCount> callbackThe execution callback with the returned value(s).
@@ -2385,7 +2374,7 @@
Input Parameters:
void setWhiteBalance(@NonNull WhiteBalance whiteBalance, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.WHITE_BALANCE
-
Description:
+
Description:

Sets the camera's white balance (color temperature). When white balance is CUSTOM, the colorTemperature argument is used. For all other values, the colorTemperature argument is ignored. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull WhiteBalance whiteBalanceWhite balance value to be set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2398,7 +2387,7 @@
See Also:
void getWhiteBalance(@NonNull final CompletionCallbackWith<WhiteBalance> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.WHITE_BALANCE
-
Description:
+
Description:

Gets the camera's white balance and color temperature. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<WhiteBalance> callbackThe execution callback with the returned value(s).
@@ -2409,7 +2398,7 @@

Lens, Zoom & Focus

boolean isInterchangeableLensSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_INTERCHANGEABLE_LENS_SUPPORTED
-
Description:
+
Description:

true if the changeable lens is supported by the camera. Currently a changeable lens is supported only by the X5, X5R and X5S cameras. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Return:
booleanA boolean value.
@@ -2418,7 +2407,7 @@
Return:
void getLensInformation(@NonNull final CompletionCallbackWith<String> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.LENS_INFORMATION
-
Description:
+
Description:

Gets details of the installed lens. Supported only by the X5, X5R, X5S and X7 cameras. This is available only when isInterchangeableLensSupported returns true. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<String> callbackThe execution callback with the returned value(s).
@@ -2427,7 +2416,7 @@
Input Parameters:
boolean isDigitalZoomSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_DIGITAL_ZOOM_SUPPORTED
-
Description:
+
Description:

Check if the current device supports digital zoom scale. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Return:
booleanA boolean value.
@@ -2436,16 +2425,16 @@
Return:
void setDigitalZoomFactor(@FloatRange(from = 1.0, to = 2.0) float factor,
                                    @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.DIGITAL_ZOOM_FACTOR
-
Description:
-

Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

+
Description:
+

Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera, DJI Mini 2. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
-
@FloatRange(from = 1.0, to = 2.0) float factorThe valid range is from 1.0 to 2.0.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
+
@FloatRange(from = 1.0, to = 2.0) float factorThe valid range is from 1.0 to 4.0.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
method getDigitalZoomFactor
void getDigitalZoomFactor(@NonNull final CompletionCallbackWith<Float> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.DIGITAL_ZOOM_FACTOR
-
Description:
+
Description:

Gets current digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and Z30 camera. Note Z30 cannot set the digital zoom scale, but will use digital zoom when using startContinuousOpticalZoom and the optical zoom has reached its limit. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Float> callbackThe execution callback with the returned value(s).
@@ -2454,7 +2443,7 @@
Input Parameters:
boolean isOpticalZoomSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_OPTICAL_ZOOM_SUPPORTED
-
Description:
+
Description:

Check if camera supports optical zoom. It is only supported by X5, X5R and X5S camera with the Olympus M.Zuiko ED 14-42mm f/3.5-5.6 EZ lens, Z3 camera, Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Return:
booleantrue if camera supports optical zoom.
@@ -2463,7 +2452,7 @@
Return:
void getOpticalZoomSpec(@NonNull final CompletionCallbackWith<OpticalZoomSpec> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.OPTICAL_ZOOM_SPEC
-
Description:
+
Description:

Gets the specification of the zoom lens. It is only supported by X5, X5R and X5S camera with lens Olympus M.Zuiko ED 14-42mm f/3.5-5.6 EZ, Z3 camera, Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<OpticalZoomSpec> callbackThe execution callback with the returned value(s).
@@ -2472,7 +2461,7 @@
Input Parameters:
void setOpticalZoomFocalLength(int focalLength, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.OPTICAL_ZOOM_FOCAL_LENGTH
-
Description:
+
Description:

Sets focal length of the zoom lens. It is only supported by X5, X5R and X5S camera with lens Olympus M.Zuiko ED 14-42mm f/3.5-5.6 EZ, X5S camera with Panasonic Lumix 14-42mm/3.5-5.6 HD or Olympus M.Zuiko 9-18mm/4.0-5.6, Z3 camera, Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
int focalLengthFocal length of zoom lens. Valid range is [getMinFocalLength, getMaxFocalLength] and must be a multiple of getFocalLengthStep.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2481,7 +2470,7 @@
Input Parameters:
void getOpticalZoomFocalLength(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.OPTICAL_ZOOM_FOCAL_LENGTH
-
Description:
+
Description:

Gets zoom lens focal length in units of 0.1mm. It is only supported by X5, X5R and X5S camera with lens Olympus M.Zuiko ED 14-42mm f/3.5-5.6 EZ, Z3 camera, Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -2490,7 +2479,7 @@
Input Parameters:
void getOpticalZoomFactor(@NonNull final CompletionCallbackWith<Float> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.OPTICAL_ZOOM_SCALE
-
Description:
+
Description:

Gets current optical zoom factor with range [1, 30]. It is only supported Z30 camera. The Z30 zoom factor can be changed with setOpticalZoomFocalLength and startContinuousOpticalZoom. The zoom factor is then calculated and given through this method. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Float> callbackThe execution callback with the returned value(s).
@@ -2499,7 +2488,7 @@
Input Parameters:
void startContinuousOpticalZoom(@NonNull ZoomDirection direction,
                                          @NonNull final ZoomSpeed speed,
                                          @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.START_CONTINUOUS_OPTICAL_ZOOM
-
Description:
+
Description:

Start changing the focal length of the lens in specified direction with specified speed. Focal length change (zooming) will halt when maximum or minimum focal lengths are reached, or stopContinuousOpticalZoom is called. It is only supported by X5, X5R and X5S camera on Osmo with lens Olympus M.Zuiko ED 14-42mm f/3.5-5.6 EZ, Z3 camera, Z30 camera. For Zenmuse H20 and Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ZoomDirection directionDirection to zoom.
@NonNull final ZoomSpeed speedZoom speed.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2508,7 +2497,7 @@
Input Parameters:
void stopContinuousOpticalZoom(@Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.STOP_CONTINUOUS_OPTICAL_ZOOM
-
Description:
+
Description:

Called to stop focal length changing, when it currently is from calling startContinuousOpticalZoom. It is only supported by X5, X5R and X5S camera on Osmo with lens Olympus M.Zuiko ED 14-42mm f/3.5-5.6 EZ, Z3 camera, Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2517,7 +2506,7 @@
Input Parameters:
boolean isTapZoomSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_TAP_ZOOM_SUPPORTED
-
Description:
+
Description:

Determines whether the current camera supports TapZoom feature. TapZoom is only supported by Z30 camera. @return true if the camera supports TapZoom. In multiple lenses camera, if one of its lenses supports this feature, the camera and the lens that can supports both return true. User can only access the parameters through the lens object. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Return:
booleanA boolean value.
@@ -2526,7 +2515,7 @@
Return:
void setTapZoomEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.TAP_ZOOM_ENABLED
-
Description:
+
Description:

Enable/disable TapZoom. tapZoomAtTarget can only be called when TapZoom is enabled. It is only supported Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
boolean enabledThe execution callback with the returned execution result.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2535,7 +2524,7 @@
Input Parameters:
void getTapZoomEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.TAP_ZOOM_ENABLED
-
Description:
+
Description:

Determines whether TapZoom is enabled. It is only supported by Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -2544,7 +2533,7 @@
Input Parameters:
void setTapZoomMultiplier(@IntRange(from = 1, to = 5) int multiplier,
                                    @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.TAP_ZOOM_MULTIPLIER
-
Description:
+
Description:

TapZoom uses a multiplier to change the zoom scale when called. The final zoom scale for a TapZoom will be: Current Zoom Scale x Multiplier. The multiplier range is [1,5]. A multiplier of 1 will not change the zoom. When the multiplier is 1, the zoom scale will not change during TapZoom. It is only supported by Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@IntRange(from = 1, to = 5) int multiplierMultiplier of TapZoom.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2553,7 +2542,7 @@
Input Parameters:
void getTapZoomMultiplier(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.TAP_ZOOM_MULTIPLIER
-
Description:
+
Description:

Gets the multiplier for TapZoom. It is only supported by Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -2562,7 +2551,7 @@
Input Parameters:
void tapZoomAtTarget(@NonNull PointF target, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.TAP_ZOOM_AT_TARGET
-
Description:
+
Description:

TapZoom at the target. It can be called only when TapZoom is enabled. When a new target is set, the gimbal will rotate and locate the target in the center of the screen. At the same time, the camera will zoom by multiplying the TapZoom multiplier. It is only supported Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull PointF targetThe CameraTapZoomTargetPoint to zoom. The range for x and y is from 0.0 to 1.0. The point [0.0, 0.0] represents the top-left corner of the screen.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2571,7 +2560,7 @@
Input Parameters:
boolean isHybridZoomSupported()
Package:dji.sdk.camera
-
Description:
+
Description:

Hybrid zoom is combining optical and digital zoom. Camera will automatically switch over to digital zoom when optical zoom range is exceeded. Check if camera supports hybrid zoom. It is only supported by Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Return:
booleantrue if camera supports hybrid zoom.
@@ -2580,7 +2569,7 @@
Return:
void getHybridZoomSpec(@NonNull final CompletionCallbackWith<HybridZoomSpec> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Hybrid zoom is combining optical and digital zoom. Camera will automatically switch over to digital zoom when optical zoom range is exceeded. Gets the specification of the zoom lens. It is only supported by Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<HybridZoomSpec> callbackThe execution callback with the returned value(s).
@@ -2589,7 +2578,7 @@
Input Parameters:
void setHybridZoomFocalLength(int focalLength, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Hybrid zoom is combining optical and digital zoom. Camera will automatically switch over to digital zoom when optical zoom range is exceeded. Sets focal length of the zoom lens. It is only supported by Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
int focalLengthFocal length of zoom lens. Valid range is [getMinHybridFocalLength, getMaxHybridFocalLength] and must be a multiple of getFocalLengthStep.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2598,7 +2587,7 @@
Input Parameters:
void getHybridZoomFocalLength(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Hybrid zoom is combining optical and digital zoom. Camera will automatically switch over to digital zoom when optical zoom range is exceeded. Gets zoom lens focal length in units of 0.1mm. It is only supported by Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -2607,7 +2596,7 @@
Input Parameters:
void setTapZoomStateCallback(@Nullable final TapZoomStateCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the tap zoom state callback. The callback's onUpdate method will be called when the camera's zoom state is updated. It is only supported by Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@Nullable final TapZoomStateCallback callbackCompletion callback that receives the execution result.
@@ -2616,7 +2605,7 @@
Input Parameters:
boolean isAdjustableFocalPointSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_ADJUSTABLE_FOCAL_POINT_SUPPORTED
-
Description:
+
Description:

Determines whether the camera supports an adjustable focal point. Currently, the adjustable focal point is supported by the X5, X5R, Z3, Mavic Pro camera, Z30, Phantom 4 Pro camera, X4S, X5S, Mavic 2 Pro, Mavic 2 Zoom Camera and and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Return:
booleanA boolean value.
@@ -2625,7 +2614,7 @@
Return:
void setFocusMode(@NonNull SettingsDefinitions.FocusMode focusMode,
                            @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_MODE
-
Description:
+
Description:

Sets the lens focus mode. See FocusMode. It is available only when isAdjustableFocalPointSupported returns true. Supported by the X5, X5R, Z3 cameras (Z3 camera can only support AUTO), the Mavic Pro camera, Z30, Phantom 4 Pro camera, X4S, X5S, Mavic 2 Pro, Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull SettingsDefinitions.FocusMode focusModeFocus mode to set. Check FocusMode for more detail.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2634,7 +2623,7 @@
Input Parameters:
void getFocusMode(@NonNull final CompletionCallbackWith<FocusMode> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_MODE
-
Description:
+
Description:

Gets the lens focus mode. Please check FocusMode. It is available only when isAdjustableFocalPointSupported returns true. Supported only by the X5, X5R, Z3 cameras, Mavic Pro camera, Z30, Phantom 4 Pro camera, X4S, X5S, Mavic 2 Pro, Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<FocusMode> callbackThe execution callback with the returned value(s).
@@ -2643,7 +2632,7 @@
Input Parameters:
void setFocusTarget(@NonNull PointF focusTarget, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_TARGET
-
Description:
+
Description:

Sets the lens focus target point. When the focus mode is auto, the target point is the focal point. When the focus mode is manual, the target point is the zoom out area if the focus assistant is enabled for the manual mode. It is available only when isAdjustableFocalPointSupported returns true. Supported only by the X5, X5R, Z3 cameras, Mavic Pro camera, Phantom 4 Pro camera, Mavic 2 Pro, Mavic 2 Zoom Camera, Mavic 2 Enterprise Camera, X4S and X5S. camera, X4S and X5S. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull PointF focusTargetThe focus target to set. The range for x and y is from 0.0 to 1.0. The point [0.0, 0.0] represents the top-left angle of the screen.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2652,7 +2641,7 @@
Input Parameters:
void getFocusTarget(@NonNull final CompletionCallbackWith<PointF> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_TARGET
-
Description:
+
Description:

Gets the lens focus target point. It is available only when isAdjustableFocalPointSupported returns true. Supported only by the X5, X5R, Z3 cameras, Mavic Pro camera and Phantom 4 Pro camera, X4S, X5S, Mavic 2 Pro, Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<PointF> callbackThe execution callback with the returned value(s).
@@ -2661,7 +2650,7 @@
Input Parameters:
void setFocusAssistantSettings(FocusAssistantSettings settings,
                                         @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_ASSISTANT_SETTINGS
-
Description:
+
Description:

Used to enable/disable the lens focus assistant. When the focus assistant is enabled, the camera live view will digitally zoom into the focus target area so the user can see the quality of focus. Focus assistant can be used for both manual focus (MF) and auto focus (AF). It is available only when isAdjustableFocalPointSupported returns true. Supported only by the X5, X5R, Z3, Phantom 4 Pro camera, X4S and X5S. Because Z3 only supports AF mode, isEnabledMF will be ignored.

Input Parameters:
FocusAssistantSettings settingsSets whether the lens focus assistant for AF and MF mode is enabled.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2670,7 +2659,7 @@
Input Parameters:
void getFocusAssistantSettings(@NonNull final CompletionCallbackWithTwoParam<Boolean, Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_ASSISTANT_SETTINGS
-
Description:
+
Description:

Determines whether the lens focus assistant is enabled. When the focus assistant is enabled, the camera live view will digitally zoom into the focus target area so the user can see the quality of focus. Focus assistant can be used for both manual focus (MF) and auto focus (AF). It is available only when isAdjustableFocalPointSupported returns true. Supported only by the X5, X5R, Z3 cameras, Phantom 4 Pro, X4s and X5S. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWithTwoParam<Boolean, Boolean> callbackThe execution callback with the returned value(s).
@@ -2679,7 +2668,7 @@
Input Parameters:
void getFocusRingValueUpperBound(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_RING_VALUE_UPPER_BOUND
-
Description:
+
Description:

Gets the lens focusing ring value's max value. It is available only when isAdjustableFocalPointSupported returns true. Supported only by the X5, X5R, Z3 cameras, Phantom 4 Pro camera, X4S, X5S, Mavic 2 Pro, Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -2688,7 +2677,7 @@
Input Parameters:
void setFocusRingValue(@IntRange(from = 0) int value, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_RING_VALUE
-
Description:
+
Description:

Set the focal distance by simulating the focus ring adjustment. Value can have a range of 0, getFocusRingValueUpperBound], which represents infinity and the closest possible focal distance. It is available only when isAdjustableFocalPointSupported returns true. For some lenses, the minimum focus ring value is larger than 0. For example the minimum of DJI MFT 15mm f/1.7 ASPH is 270. To retrieve the minimum value, perform the following steps: - Call setFocusMode with AUTO. - Call setFocusTarget with the furthest target (>30m). - Call getFocusRingValue to get the current focus ring value. This is the minimum value. The maximum value can be retrieved using getFocusRingValueUpperBound. Supported only by X5, X5R, Z3 cameras, Phantom 4 Pro, X4S, X5S, Mavic 2 Pro, Mavic 2 Zoom Camera and Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@IntRange(from = 0) int valueValue to adjust focus ring to. The minimum value is 0, the maximum value depends on the installed lens. Please use method getFocusRingValueUpperBound to ensure the input argument is valid.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2697,7 +2686,7 @@
Input Parameters:
void getFocusRingValue(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FOCUS_RING_VALUE
-
Description:
+
Description:

Gets the lens focus ring value. It is available only when isAdjustableFocalPointSupported returns true. Supported only by the X5, X5R, Z3 cameras, Phantom 4 Pro, X4S, X5S, Mavic 2 Pro, Mavic 2 Zoom Camera, Mavic 2 Enterprise Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -2708,7 +2697,7 @@

Liveview Location

void getLiveviewLocationWithGPS(@NonNull LocationCoordinate3D pointPos, @NonNull PhysicalSource physicalSource, @NonNull CommonCallbacks.CompletionCallbackWith<PinPointInfo> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the PinPoint information with GPS which is used to show PinPoint in the liveview. Supported by Zenmuse H20 Series.

Input Parameters:
@NonNull LocationCoordinate3D pointPosThe GPS location, you could get the location from getTargetLocation or get the location with map.
@NonNull PhysicalSource physicalSourceThe physical source of a video feed.
@NonNull CommonCallbacks.CompletionCallbackWith<PinPointInfo> callbackThe execution callback with the returned value(s).
@@ -2719,7 +2708,7 @@

Settings

void restoreFactorySettings(@Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.RESTORE_FACTORY_SETTINGS
-
Description:
+
Description:

Load the camera's factory settings.
Post condition: The camera will reboot itself.

Input Parameters:
@Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
@@ -2728,7 +2717,7 @@
Input Parameters:
void saveSettingsToProfile(@NonNull CustomSettingsProfile profile,
                                     @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SAVE_SETTINGS_TO_PROFILE
-
Description:
+
Description:

Saves the current camera settings permanently to the specified profile. See CustomSettingsProfile to view all possible camera users.

Input Parameters:
@NonNull CustomSettingsProfile profileCamera profile for which to store camera settings.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2737,7 +2726,7 @@
Input Parameters:
void loadSettingsFromProfile(@NonNull CustomSettingsProfile profile, final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.LOAD_SETTINGS_FROM_PROFILE
-
Description:
+
Description:

Load camera settings from the specified user.
Post condition:
The camera will reboot itself.

Input Parameters:
@NonNull CustomSettingsProfile profileCamera profile to load camera settings from.
final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2748,7 +2737,7 @@

Photo Settings

void setPhotoAspectRatio(@NonNull PhotoAspectRatio aspectRatio,
                                   @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_ASPECT_RATIO
-
Description:
+
Description:

Sets the camera's aspect ratio for photos. See PhotoAspectRatio to view all possible ratios. Not supported by Z30 camera as the aspect ratio of Z30 is always RATIO_16_9. Not supported by XTS camera as the aspect ratio of XTS is always RATIO_4_3. For Zenmuse H20 and Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull PhotoAspectRatio aspectRatioAspect ratio for photos to be taken by camera.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2757,7 +2746,7 @@
Input Parameters:
void getPhotoAspectRatio(@NonNull final CompletionCallbackWith<PhotoAspectRatio> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_ASPECT_RATIO
-
Description:
+
Description:

Gets the camera's aspect ratio for photos. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<PhotoAspectRatio> callbackThe execution callback with the returned value(s).
@@ -2766,7 +2755,7 @@
Input Parameters:
void setPhotoFileFormat(@NonNull PhotoFileFormat format, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_FILE_FORMAT
-
Description:
+
Description:

Sets the camera's photo file format. See PhotoFileFormat to view all possible photo formats to which the camera can be set. Also supported by thermal imaging camera. Not supported by Z30 camera and Mavic 2 Enterprise Dual as the photo file format for Z30 is always JPEG. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull PhotoFileFormat formatPhoto file format used when the camera takes a photo. Check the enum PhotoFileFormat to find all possible photo formats the camera can be set to.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2775,7 +2764,7 @@
Input Parameters:
void getPhotoFileFormat(@NonNull final CompletionCallbackWith<PhotoFileFormat> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_FILE_FORMAT
-
Description:
+
Description:

Gets the camera's photo file format. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<PhotoFileFormat> callbackThe execution callback with the returned value(s).
@@ -2784,7 +2773,7 @@
Input Parameters:
void setPhotoBurstCount(@NonNull PhotoBurstCount count, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_BURST_COUNT
-
Description:
+
Description:

Sets the burst shoot count for the camera when the user wants to use that feature. Check PhotoBurstCount to view all possible burst count values to which the camera can be set.

Input Parameters:
@NonNull PhotoBurstCount countThe number of photos to take in one Burst shot. Please check the enum PhotoBurstCount to find all possible burst count values the camera can be set to.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2793,7 +2782,7 @@
Input Parameters:
void getPhotoBurstCount(@NonNull final CompletionCallbackWith<PhotoBurstCount> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_BURST_COUNT
-
Description:
+
Description:

Gets the burst count type.

Input Parameters:
@NonNull final CompletionCallbackWith<PhotoBurstCount> callbackThe execution callback with the returned value(s).
@@ -2802,7 +2791,7 @@
Input Parameters:
void setPhotoRAWBurstCount(@NonNull PhotoBurstCount count, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_RAW_BURST_COUNT
-
Description:
+
Description:

Sets the RAW image burst shoot count for the camera when the user wants to use that feature. See PhotoBurstCount to view all possible burst count values to which the camera can be set. It is only supported Inspire 2.

Input Parameters:
@NonNull PhotoBurstCount countThe number of photos to take in one RAW burst shoot.
@Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
@@ -2811,7 +2800,7 @@
Input Parameters:
void getPhotoRAWBurstCount(@NonNull final CompletionCallbackWith<PhotoBurstCount> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_RAW_BURST_COUNT
-
Description:
+
Description:

Gets the RAW image burst count. It is only supported Inspire 2.

Input Parameters:
@NonNull final CompletionCallbackWith<PhotoBurstCount> callbackThe execution callback with the returned value(s).
@@ -2820,7 +2809,7 @@
Input Parameters:
void setPhotoTimeIntervalSettings(@NonNull PhotoTimeIntervalSettings settings,
                                            @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_TIME_INTERVAL_SETTINGS
-
Description:
+
Description:

Sets the interval shoot parameters. The camera will capture a photo, wait a specified interval of time, take another photo, and continue in this manner until it has taken the required number of photos. Also supported by thermal imaging camera.

Input Parameters:
@NonNull PhotoTimeIntervalSettings settingsAn instance of PhotoTimeIntervalSettings.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2829,7 +2818,7 @@
Input Parameters:
void getPhotoTimeIntervalSettings(
       @NonNull final CompletionCallbackWith<PhotoTimeIntervalSettings> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_TIME_INTERVAL_SETTINGS
-
Description:
+
Description:

Gets the camera's interval shoot parameters.

Also supported by thermal imaging camera.

Input Parameters:
@NonNull final CompletionCallbackWith<PhotoTimeIntervalSettings> callbackThe execution callback with the returned value(s).
@@ -2838,7 +2827,7 @@
Input Parameters:
void setPhotoTimeLapseSettings(@NonNull PhotoTimeLapseSettings settings,
                                         @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_TIME_LAPSE_SETTINGS
-
Description:
+
Description:

Sets the TimeLapse parameters, including interval, duration and file format when saving. Precondition: Camera should be in TIME_LAPSE mode of ShootPhotoMode.

Input Parameters:
@NonNull PhotoTimeLapseSettings settingsThe time between image captures. An integer falls in the range, [10, 1000]. <br>The unit is 100ms. Please note that when the format is JPEG+Video,<br> the minimum interval is 20(2 seconds).
@Nullable final CompletionCallback callbackThe execution block with the returned execution result.
@@ -2847,7 +2836,7 @@
Input Parameters:
void getPhotoTimeLapseSettings(@NonNull final CompletionCallbackWith<PhotoTimeLapseSettings> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_TIME_LAPSE_SETTINGS
-
Description:
+
Description:

Gets the TimeLapse parameters including interval, duration and file format when saving. Precondition: The camera must be in TIME_LAPSE mode of ShootPhotoMode.

Input Parameters:
@NonNull final CompletionCallbackWith<PhotoTimeLapseSettings> callbackThe execution callback with the returned value(s).
@@ -2856,7 +2845,7 @@
Input Parameters:
void setPhotoPanoramaMode(@NonNull PhotoPanoramaMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_PANORAMA_MODE
-
Description:
+
Description:

Sets the panorama mode. It is used when setShootPhotoMode is called with PANORAMA. It is supported by Spark, Mavic Air, Mavic 2, Mavic 2 Pro, Mavic 2 Zoom, Mavic 2 Eneterprise, Mavic 2 Enterprise Dual.

Input Parameters:
@NonNull PhotoPanoramaMode modeThe panorama mode to set.
@Nullable final CompletionCallback callbackcompletion callback to receive the result.
@@ -2865,7 +2854,7 @@
Input Parameters:
void getPhotoPanoramaMode(@NonNull final CompletionCallbackWith<PhotoPanoramaMode> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_PANORAMA_MODE
-
Description:
+
Description:

Gets the panorama mode. It is supported by Spark, Mavic Air, Mavic 2, Mavic 2 Pro, Mavic 2 Zoom, Mavic 2 Eneterprise, Mavic 2 Enterprise Dual.

Input Parameters:
@NonNull final CompletionCallbackWith<PhotoPanoramaMode> callbackcompletion callback to receive the result.
@@ -2874,7 +2863,7 @@
Input Parameters:
void setPanoOriginalPhotoSettings(@NonNull OriginalPhotoSettings settings,
                                            @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Change the original image configuration when shooting panorama photos. CAUTION: enabling this may consume 500 MB in the SD card or the internal storage for each panorama. It is supported by Spark, Mavic Air, Mavic 2, Mavic 2 Pro, Mavic 2 Zoom, Mavic 2 Eneterprise, Mavic 2 Enterprise Dual. For Mavic Air, getFormat is not used and it will ignore the value.

Input Parameters:
@NonNull OriginalPhotoSettings settingsAn object of OriginalPhotoSettings.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2883,7 +2872,7 @@
Input Parameters:
void getPanoOriginalPhotoSettings(
       @NonNull final CompletionCallbackWith<OriginalPhotoSettings> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the configuration, which determines the behavior for the original images when shooting panorama photos. CAUTION: If this is enabled, it may consume 500 MB in the SD card or the internal storage for each panorama. It is supported by Mavic Air and Mavic 2. However, Mavic Air cannot change the format to save the original images. getFormat will be ignored by Mavic Air.

Input Parameters:
@NonNull final CompletionCallbackWith<OriginalPhotoSettings> callbackThe execution callback with the returned execution result.
@@ -2892,7 +2881,7 @@
Input Parameters:
void setHighQualityPreviewEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Enables this before photo capture to download high quality preview image. Only supported by Phantom 4 RTK.

Input Parameters:
boolean enabledtrue to enable the feature.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2901,7 +2890,7 @@
Input Parameters:
void getHighQualityPreviewEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets if high quality preview image downloading is enabled. Only supported by Phantom 4 RTK.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -2912,7 +2901,7 @@

Video Settings

void setVideoResolutionAndFrameRate(@NonNull ResolutionAndFrameRate resolutionAndFrameRate,
                                              @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.RESOLUTION_FRAME_RATE
-
Description:
+
Description:

Sets the camera's video resolution and frame rate. @warning The supported resolutions and frame rates for the two different analog television standards PAL and NTSC are below:

NTSC:
Resolution_4096x2160, FrameRate_24fps
Resolution_3840x2160, FrameRate_30fps
Resolution_3840x2160, FrameRate_24fps
Resolution_2704X1520, FrameRate_30fps
Resolution_2704X1520, FrameRate_24fps
Resolution_1920x1080, FrameRate_120fps (Slow Motion)
Resolution_1920x1080, FrameRate_60fps
Resolution_1920x1080, FrameRate_48fps
Resolution_1920x1080, FrameRate_30fps
Resolution_1920x1080, FrameRate_24fps
Resolution_1280x720, FrameRate_60fps
Resolution_1280x720, FrameRate_48fps
Resolution_1280x720, FrameRate_30fps
Resolution_1280x720, FrameRate_24fps

PAL:
Resolution_4096x2160, FrameRate_25fps
Resolution_4096x2160, FrameRate_24fps
Resolution_3840x2160, FrameRate_25fps
Resolution_3840x2160, FrameRate_24fps
Resolution_2704X1520, FrameRate_25fps
Resolution_2704X1520, FrameRate_24fps
Resolution_1920x1080, FrameRate_120fps (Slow Motion)
Resolution_1920x1080, FrameRate_50fps
Resolution_1920x1080, FrameRate_48fps
Resolution_1920x1080, FrameRate_25fps
Resolution_1920x1080, FrameRate_24fps
Resolution_1280x720, FrameRate_50fps
Resolution_1280x720, FrameRate_48fps
Resolution_1280x720, FrameRate_25fps
Resolution_1280x720, FrameRate_24fps For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull ResolutionAndFrameRate resolutionAndFrameRateResolution to be set for the video.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2921,7 +2910,7 @@
Input Parameters:
void getVideoResolutionAndFrameRate(
       @NonNull final CompletionCallbackWith<ResolutionAndFrameRate> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.RESOLUTION_FRAME_RATE
-
Description:
+
Description:

Gets the camera's video resolution and frame rate values. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ResolutionAndFrameRate> callbackThe execution callback with the returned value(s).
@@ -2930,7 +2919,7 @@
Input Parameters:
void setVideoFileFormat(@NonNull VideoFileFormat format, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VIDEO_FILE_FORMAT
-
Description:
+
Description:

Sets the camera's video file format. The default value is MOV. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull VideoFileFormat formatVideo file format to be set for videos.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2939,7 +2928,7 @@
Input Parameters:
void getVideoFileFormat(@NonNull final CompletionCallbackWith<VideoFileFormat> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VIDEO_FILE_FORMAT
-
Description:
+
Description:

Gets the camera's video file format. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<VideoFileFormat> callbackThe execution callback with the returned value(s).
@@ -2948,7 +2937,7 @@
Input Parameters:
void setVideoStandard(@NonNull VideoStandard videoStandard, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VIDEO_STANDARD
-
Description:
+
Description:

Sets the camera's analog video standard. Setting the video standard to PAL or NTSC will limit the available resolutions and frame rates to those compatible with the chosen video standard.

Input Parameters:
@NonNull VideoStandard videoStandardVideo standard value to be set for the camera.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2957,7 +2946,7 @@
Input Parameters:
void getVideoStandard(@NonNull final CompletionCallbackWith<VideoStandard> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VIDEO_STANDARD
-
Description:
+
Description:

Gets the camera's video standard value.

Input Parameters:
@NonNull final CompletionCallbackWith<VideoStandard> callbackThe execution callback with the returned value(s).
@@ -2966,7 +2955,7 @@
Input Parameters:
void setVideoCaptionEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VIDEO_CAPTION_ENABLED
-
Description:
+
Description:

Enables recording position, time and camera information into a video caption file (.srt) saved on the SD card. The information is updated at 1Hz. Currently the .srt file can only be downloaded directly from the SD card.

Input Parameters:
boolean enabledtrue to enable video caption.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2975,7 +2964,7 @@
Input Parameters:
void getVideoCaptionEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VIDEO_CAPTION_ENABLED
-
Description:
+
Description:

Gets whether the video caption is enabled.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -2984,7 +2973,7 @@
Input Parameters:
void setHistogramEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.HISTOGRAM_ENABLED
-
Description:
+
Description:

Enables the histogram.

Input Parameters:
boolean enabledTrue to enable histogram.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -2993,7 +2982,7 @@
Input Parameters:
void getHistogramEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.HISTOGRAM_ENABLED
-
Description:
+
Description:

Gets whether the histogram is enabled.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3002,7 +2991,7 @@
Input Parameters:
void setVideoFileCompressionStandard(@NonNull VideoFileCompressionStandard standard,
                                               @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VIDEO_FILE_COMPRESSION_STANDARD
-
Description:
+
Description:

Sets the video file compression standard. It is only supported X4S camera, X5S camera and Phantom 4 Pro. For all other products, H.264 is used.

Input Parameters:
@NonNull VideoFileCompressionStandard standardThe compression standard to use.
@Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
@@ -3011,7 +3000,7 @@
Input Parameters:
void getVideoFileCompressionStandard(
       @NonNull final CompletionCallbackWith<VideoFileCompressionStandard> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VIDEO_FILE_COMPRESSION_STANDARD
-
Description:
+
Description:

Gets the video file compression standard. It is only supported X4S camera, X5S camera and Phantom 4 Pro.

Input Parameters:
@NonNull final CompletionCallbackWith<VideoFileCompressionStandard> callbackThe execution callback with the returned value(s).
@@ -3020,7 +3009,7 @@
Input Parameters:
void setSSDVideoRecordingEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SSD_VIDEO_RECORDING_ENABLED
-
Description:
+
Description:

Enables/disables the recording of RAW video. It is supported by X5S. User can use the other SSD interfaces only when it is enabled. For X5R, RAW recording is always enabled if there is SSD inserted.

Input Parameters:
boolean enabledtrue to enable the RAW video recording.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3029,7 +3018,7 @@
Input Parameters:
void getSSDVideoRecordingEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SSD_VIDEO_RECORDING_ENABLED
-
Description:
+
Description:

Determines whether the recording of RAW video is enabled. It is supported by X5S.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3038,7 +3027,7 @@
Input Parameters:
void setSSDVideoResolutionAndFrameRate(@NonNull ResolutionAndFrameRate resolutionAndFrameRate,
                                                 @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SSD_VIDEO_RESOLUTION_AND_FRAME_RATE
-
Description:
+
Description:

Set Raw Video Resolution and Frame Rate of the SSD. Note, only raw video is saved to the SSD. Compressed video, compressed pictures and raw pictures are all saved to the SD Card. During video capture, Raw video and compressed video are saved simultaneously to the SSD and SD Card respectively. @warning The supported resolutions and frame rates for SSD Raw Videos are shown below:

NTSC:
Resolution_4096x2160, FrameRate_24fps
Resolution_3840x2160, FrameRate_24fps
Resolution_3840x2160, FrameRate_30fps
Resolution_2704X1520, FrameRate_24fps
Resolution_2704X1520, FrameRate_30fps
Resolution_1920x1080, FrameRate_60fps
Resolution_1920x1080, FrameRate_48fps
Resolution_1920x1080, FrameRate_30fps
Resolution_1920x1080, FrameRate_24fps



PAL:
Resolution_4096x2160, FrameRate_25fps
Resolution_4096x2160, FrameRate_24fps
Resolution_3840x2160, FrameRate_25fps
Resolution_3840x2160, FrameRate_24fps
Resolution_2704X1520, FrameRate_25fps
Resolution_2704X1520, FrameRate_24fps
Resolution_1920x1080, FrameRate_50fps
Resolution_1920x1080, FrameRate_48fps
Resolution_1920x1080, FrameRate_25fps
Resolution_1920x1080, FrameRate_24fps

For X5S, the frame rate of SSD has to be the same as the video to be stored in SD card, so frameRate is ignored. The possible resolutions are determined by SD card video's frame rate and the SSD video license (CameraSSDVideoLicense) being used. The supported resolutions in the current configuration can be queried by using SSDVideoResolutionRange in Capabilities.

Input Parameters:
@NonNull ResolutionAndFrameRate resolutionAndFrameRateResolution and frame rate to be set for the video.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3047,7 +3036,7 @@
Input Parameters:
void getSSDVideoResolutionAndFrameRate(
       @NonNull final CompletionCallbackWith<ResolutionAndFrameRate> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SSD_VIDEO_RESOLUTION_AND_FRAME_RATE
-
Description:
+
Description:

Get Raw Video Format and Frame Rate of the SSD.

Input Parameters:
@NonNull final CompletionCallbackWith<ResolutionAndFrameRate> callbackThe execution callback with the returned value(s).
@@ -3056,7 +3045,7 @@
Input Parameters:
void setSSDLegacyColor(@NonNull SettingsDefinitions.SSDLegacyColor color,
                                 @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SSD_LEGACY_COLOR
-
Description:
+
Description:

Sets the camera color for video that will be stored in SSD. It is only applied when the selected license key is either LicenseKeyTypeProRes422HQ or LicenseKeyTypeProRes4444XQ. This is the legacy version of SSD Color and it is only supported by Inspire 2 with firmware package versions (getFirmwarePackageVersion) lower than 01.0.0240. For newer firmware package versions, use setSSDColor instead.

Input Parameters:
@NonNull SettingsDefinitions.SSDLegacyColor colorSSD legacy color to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
@@ -3065,7 +3054,7 @@
Input Parameters:
void getSSDLegacyColor(@NonNull final CompletionCallbackWith<SSDLegacyColor> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SSD_LEGACY_COLOR
-
Description:
+
Description:

Gets the camera color for video that will store in SSD. This is the legacy version of SSD Color and it is only supported by Inspire 2 with firmware package versions (getFirmwarePackageVersion) lower than 01.0.0240. For newer firmware package versions, use getSSDColor instead.

Input Parameters:
@NonNull final CompletionCallbackWith<SSDLegacyColor> callbackThe execution callback with the returned value(s).
@@ -3074,7 +3063,7 @@
Input Parameters:
void setSSDColor(final SettingsDefinitions.SSDColor color, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the color for videos that will be stored in SSD. It is only applied when the selected license key is either LicenseKeyTypeProRes422HQ or LicenseKeyTypeProRes4444XQ. For LicenseKeyTypeCinemaDNG, the color is always RAW_COLOR. It is only supported Inspire 2 with the firmware package version (getFirmwarePackageVersion) 01.0.0240 or later. For older firmware package versions, use setSSDLegacyColor instead.

Input Parameters:
final SettingsDefinitions.SSDColor colorVideo color to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3083,7 +3072,7 @@
Input Parameters:
void getSSDColor(@NonNull final CompletionCallbackWith<SettingsDefinitions.SSDColor> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the color for videos that will be stored in SSD. It is only supported Inspire 2 with the firmware package version (getFirmwarePackageVersion) 01.0.0240 or later. For older firmware package versions, use getSSDLegacyColor instead.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.SSDColor> callbackThe execution callback with the returned SSDColor enum value.
@@ -3092,7 +3081,7 @@
Input Parameters:
void getSSDVideoLicenses(@NonNull final CompletionCallbackWith<CameraSSDVideoLicense[]> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SSD_VIDEO_LICENSES
-
Description:
+
Description:

Gets purchased license key(s). An Inspire 2 License Key activates the usage permission of CinemaDNG or Apple ProRes inside CineCore 2.0. User can purchase a license key on DJI's website. It is supported by Inspire 2. the digital filter for video that will store in SSD. It is only supported Inspire 2.

Input Parameters:
@NonNull final CompletionCallbackWith<CameraSSDVideoLicense[]> callbackThe execution callback with the returned value(s).
@@ -3101,7 +3090,7 @@
Input Parameters:
void activateSSDVideoLicense(@NonNull CameraSSDVideoLicense license,
                                       @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.ACTIVATE_SSD_VIDEO_LICENSE
-
Description:
+
Description:

Sets the SSD video license to be used. If an unpurchased license is selected then only SD video will be recorded.

Input Parameters:
@NonNull CameraSSDVideoLicense licenseLicense to used.
@Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
@@ -3110,7 +3099,7 @@
Input Parameters:
void getSSDVideoLicense(@NonNull final CompletionCallbackWith<CameraSSDVideoLicense> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.ACTIVATE_SSD_VIDEO_LICENSE
-
Description:
+
Description:

Gets the license key being used. It is supported by Inspire 2.

Input Parameters:
@NonNull final CompletionCallbackWith<CameraSSDVideoLicense> callbackThe execution callback with the returned value(s).
@@ -3121,7 +3110,7 @@

Auto Lock Gimbal

void setAutoLockGimbalEnabled(final boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Enables this to lock the gimbal when the camera is shooting a photo. The gimbal will keep the attitude when starting to shoot the photo.

Input Parameters:
final boolean enabledtrue to enable the feature.
@Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
@@ -3130,7 +3119,7 @@
Input Parameters:
void getAutoLockGimbalEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether the gimbal will be locked automatically during shooting photos.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3141,7 +3130,7 @@

Watermark Settings

void setWatermarkSettings(WatermarkSettings config, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the watermark configuration. Enables this to add timestamp and location stamp to the newly generated photos or videos. It is only supported by Mavic 2 Enterprise series. For Mavic 2 Enterprise Dual, the watermark is only applied to photos and videos generated by the visual camera.

Input Parameters:
WatermarkSettings configThe watermark configuration to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3150,7 +3139,7 @@
Input Parameters:
void getWatermarkSettings(@NonNull final CompletionCallbackWith<WatermarkSettings> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the watermark settings. If it is enabled, timestamp and location stamp will be added to the newly generated photos or videos. It is only supported by Mavic 2 Enterprise series. For Mavic 2 Enterprise Dual, the watermark is only applied to photos and videos generated by the visual camera.

Input Parameters:
@NonNull final CompletionCallbackWith<WatermarkSettings> callbackThe execution callback with the returned value(s).
@@ -3161,7 +3150,7 @@

Storage Settings

void setCustomExpandDirectoryName(@NonNull String name, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Custom expand directory name settings. After calling this interface, the newly generated media files (videos or photos) will be stored in the new folder, this new folder's name will be appended by your custom directory name. For example, the default folder name is "DJI_202001012359_01", you could append "Mission1" after it, so the new folder's name will be "DJI_202001012359_01_Mission1". In one flight, you can set multiple expand directory names to create multiple custom folders. Only Supported by Zenmuse P1, Zenmuse L1, Zenmuse H20 and Zenmuse H20T.

Input Parameters:
@NonNull String nameCustom directory name to set.
@Nullable final CompletionCallback callbackThe completion callback that receives the execution result.
@@ -3170,7 +3159,7 @@
Input Parameters:
void getCustomExpandDirectoryName(@NonNull final CompletionCallbackWith<String> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets custom expand directory name. Only Supported by Zenmuse P1, Zenmuse L1, Zenmuse H20 and Zenmuse H20T.

Input Parameters:
@NonNull final CompletionCallbackWith<String> callbackThe completion callback that receives the execution result.
@@ -3179,7 +3168,7 @@
Input Parameters:
void setCustomExpandFileName(@NonNull String name, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Custom expand file name settings. By calling this interface, the name of next media file (video or photo) which would be stored in camera will be appended by the custom file name you set. For example, the default photo name is "DJI_2020012091415_999_WIDE.JPG", you could append "Waypoint1" after the default photo name, so the new photo's name will be "DJI_2020012091415_999_WIDE_Waypoint1.JPG", This action will only take effect once. If you want to have the same name for all media files in one flight, you need to set this action before taking each photo. Only Supported by Zenmmuse P1, Zenmuse H20 and Zenmuse H20T.

Input Parameters:
@NonNull String nameCustom file name to set.
@Nullable final CompletionCallback callbackThe completion callback that receives the execution result.
@@ -3188,7 +3177,7 @@
Input Parameters:
void getCustomExpandFileName(@NonNull final CompletionCallbackWith<String> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets custom expand file name. Only Supported by Zenmuse P1, Zenmuse H20 and Zenmuse H20T.

Input Parameters:
@NonNull final CompletionCallbackWith<String> callbackThe completion callback that receives the execution result.
@@ -3197,7 +3186,7 @@
Input Parameters:
void setFileIndexMode(@NonNull FileIndexMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FILE_INDEX_MODE
-
Description:
+
Description:

Sets the camera's file index mode for the SD card. The default value of FileIndexMode is set to RESET.

Input Parameters:
@NonNull FileIndexMode modeFile index mode to be set for the camera's SD card. The default value of CameraFileIndexMode is set to Reset.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3206,7 +3195,7 @@
Input Parameters:
void getFileIndexMode(@NonNull final CompletionCallbackWith<FileIndexMode> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the camera's file index mode.

Input Parameters:
@NonNull final CompletionCallbackWith<FileIndexMode> callbackThe execution callback with the returned value(s).
@@ -3215,7 +3204,7 @@
Input Parameters:
void formatSDCard(@Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FORMAT_SD_CARD
-
Description:
+
Description:

Formats the SD card by deleting all the data on the SD card. This does not change any settings the user may have set on the SD card.

Input Parameters:
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3224,7 +3213,7 @@
Input Parameters:
void formatStorage(@NonNull SettingsDefinitions.StorageLocation storage, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Formats the storage by deleting all the data on it. It is supported by Mavic 2 series, Mavic 2 enterprise series, Mavic air and Matrice 200 V2 series.

Input Parameters:
@NonNull SettingsDefinitions.StorageLocation storageThe storage (either SD card or the internal storage) to format. When it is SDCARD, this interface has the same effect as formatSDCard.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3233,7 +3222,7 @@
Input Parameters:
boolean isSSDSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_SSD_SUPPORTED
-
Description:
+
Description:

Determines whether the SSD is supported by the camera. Currently, the SSD is supported only by X5R, X4S and X5S camera. @return true if SSD is supported, otherwise false.

Return:
booleanA boolean value.
@@ -3242,7 +3231,7 @@
Return:
void formatSSD(@Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.FORMAT_SSD
-
Description:
+
Description:

Formats the SSD by deleting all the data on the SSD. This does not change any settings the user may have set on the SSD.

Input Parameters:
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3253,7 +3242,7 @@

Laser Sensor

void setLaserEnabled(boolean enabled, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the laser enabled. Laser sensor turns on ranging function. Set true to enable the laser distance sensor with measuring ranges to natural object. The laser sensor must be at least 3m from the target point. It is only supported for Zenmuse H20 series.

Input Parameters:
boolean enabledtrue to enable video caption.
@Nullable final CommonCallbacks.CompletionCallback callbackThe execution callback with the returned value(s).
@@ -3262,7 +3251,7 @@
Input Parameters:
void getLaserEnabled(@NonNull final CommonCallbacks.CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets whether the laser is enabled. The laser sensor must be at least 3m from the target point. It is only supported for Zenmuse H20 series.

Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3273,7 +3262,7 @@

Misc Settings

void setAntiFlickerFrequency(@NonNull AntiFlickerFrequency antiFlickerFrequency,
                                       @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.ANTI_FLICKER_FREQUENCY
-
Description:
+
Description:

Sets the camera's anti-flicker frequency for video recording. Precondition: The exposure mode must be Program. Note: for the Z30 camera, changing anti-flicker will reboot the camera before the setting takes effect. It is not supported by Zenmuse H20 and Zenmuse H20T.

Input Parameters:
@NonNull AntiFlickerFrequency antiFlickerFrequencyAnti-flicker value to set for the camera. See AntiFlickerFrequency to view all the possible anti-flicker type settings for the camera.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3282,7 +3271,7 @@
Input Parameters:
void getAntiFlickerFrequency(@NonNull final CompletionCallbackWith<AntiFlickerFrequency> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.ANTI_FLICKER_FREQUENCY
-
Description:
+
Description:

Gets the camera's anti-flicker. It is not supported by Zenmuse H20 and Zenmuse H20T.

Input Parameters:
@NonNull final CompletionCallbackWith<AntiFlickerFrequency> callbackThe execution callback with the returned value(s).
@@ -3291,7 +3280,7 @@
Input Parameters:
void setSharpness(@IntRange(from = -3, to = 3) int sharpness, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SHARPNESS
-
Description:
+
Description:

Sets the camera's sharpness. The default value is 0. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@IntRange(from = -3, to = 3) int sharpnessSharpness value to be set in the range of [-3, 3].
@Nullable final CompletionCallback callbackAsynchronous execution result.
@@ -3300,7 +3289,7 @@
Input Parameters:
void getSharpness(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SHARPNESS
-
Description:
+
Description:

Gets the camera's sharpness. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value of sharpness with range [-3, 3].
@@ -3309,7 +3298,7 @@
Input Parameters:
void setContrast(@IntRange(from = -3, to = 3) int contrast, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.CONTRAST
-
Description:
+
Description:

Sets the camera's contrast. The default saturation value is 0. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@IntRange(from = -3, to = 3) int contrastContrast value to be set in the range of [-3, 3].
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3318,7 +3307,7 @@
Input Parameters:
void getContrast(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.CONTRAST
-
Description:
+
Description:

Gets the camera's contrast. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value of contrast with range [-3, 3].
@@ -3327,7 +3316,7 @@
Input Parameters:
void setDefogEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.DEFOG_ENABLED
-
Description:
+
Description:

Enable/disable defog feature. When defog feature is enabled, the contrast will be enhanced extraordinarily. It is only supported Z30.

Input Parameters:
boolean enabledtrue to enable defog feature.
@Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
@@ -3336,7 +3325,7 @@
Input Parameters:
void getDefogEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.DEFOG_ENABLED
-
Description:
+
Description:

Determines whether defog feature is enabled. It is only supported by Z30 camera.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3345,7 +3334,7 @@
Input Parameters:
void setIRFilterEnabled(final boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Enables/disables the IR filter (infared filter). Disabling the IR filter can enhance the image in low light environments. Enabling the IR filter can reduce the color distortion caused by the infared light. It is only supported by Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
final boolean enabledtrue to enable IR-Cut filter.
@Nullable final CompletionCallback callbackThe execution callback that receives the setter result.
@@ -3354,7 +3343,7 @@
Input Parameters:
void getIRFilterEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether IR filter (infared filter) is enabled. Disabling the IR filter can enhance the image in low light environments. Enabling the IR filter can reduce the color distortion caused by the infared light. It is only supported by Z30 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3363,7 +3352,7 @@
Input Parameters:
void setSaturation(@IntRange(from = -3, to = 3) int saturation,
                             @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SATURATION
-
Description:
+
Description:

Sets the camera's saturation. The default saturation value is 0. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@IntRange(from = -3, to = 3) int saturationSaturation value to be set in the range of [-3, 3]. The default value of the saturation value is 0.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3372,7 +3361,7 @@
Input Parameters:
void getSaturation(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.SATURATION
-
Description:
+
Description:

Gets the camera's saturation. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -3381,7 +3370,7 @@
Input Parameters:
void setColor(@NonNull CameraColor color, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.CAMERA_COLOR
-
Description:
+
Description:

Sets the camera's color. The default value is NONE. For a list of all possible camera colors, see CameraColor. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull CameraColor colorCamera color to be applied to the camera.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3390,7 +3379,7 @@
Input Parameters:
void getColor(@NonNull final CompletionCallbackWith<SettingsDefinitions.CameraColor> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.CAMERA_COLOR
-
Description:
+
Description:

Gets the camera's color. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.CameraColor> callbackThe execution callback with the returned value(s).
@@ -3399,7 +3388,7 @@
Input Parameters:
void setOrientation(@NonNull Orientation orientation, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.ORIENTATION
-
Description:
+
Description:

Sets the camera's orientation. The gimbal will rotate the roll axis based on the orientation. Supported only by Mavic Pro.

Input Parameters:
@NonNull Orientation orientationCamera's orientation.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3408,7 +3397,7 @@
Input Parameters:
void getOrientation(@NonNull final CompletionCallbackWith<Orientation> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.ORIENTATION
-
Description:
+
Description:

Gets the camera's orientation. Supported only by Mavic Pro.

Input Parameters:
@NonNull final CompletionCallbackWith<Orientation> callbackThe execution callback with the returned value(s).
@@ -3417,7 +3406,7 @@
Input Parameters:
void setVisionStabilizationEnabled(final boolean enable, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VISION_STABILIZATION_ENABLED
-
Description:
+
Description:

Enables vision stabilization for Z30 camera on M200 series. The vision system in the M200 series of aircraft can be used to compensate for any drift in the gimbal by analyzing the live view when there is no gimbal movement. Drift in the gimbal will be most noticeable at higher zoom factors. It is only supported Z30 on M200 series.

Input Parameters:
final boolean enabletrue to enable the vision stabilization.
@Nullable final CompletionCallback callbackcompletion callback to receive the result.
@@ -3426,7 +3415,7 @@
Input Parameters:
void getVisionStabilizationEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.VISION_STABILIZATION_ENABLED
-
Description:
+
Description:

Determines whether vision stabilization is enabled. It is only supported Z30 on M200 series.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackcompletion callback to receive the result.
@@ -3435,7 +3424,7 @@
Input Parameters:
void setMediaFileCustomInformation(@NonNull String information, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.CUSTOM_INFORMATION
-
Description:
+
Description:

Custom information can be stored in media file's XMP meta data. The custom information is written to the media file automatically after the media file is created. This method defines the information to write. The same information will be written to all media files until the information is changed again by this method. Custom information written to each file can be retrieved through fetchCustomInformation or from the image itself when processed on a separate system. It is supported by Phantom 4 Pro, Phantom 4 Advanced, Phantom 4 Pro V2.0, Zenmuse P1, Zenmuse L1, Zenmuse X4S, Zenmuse X5S, Zenmuse X7, Mavic 2 Enterprise camera and Mavic 2 Enterprise Dual camera.

Input Parameters:
@NonNull String informationCustom information to set. Use UTF-8 encoding with a length equal to or less than 31 characters.
@Nullable final CompletionCallback callbackThe execution callback to receive the result.
@@ -3444,7 +3433,7 @@
Input Parameters:
void getMediaFileCustomInformation(@NonNull final CompletionCallbackWith<String> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.CUSTOM_INFORMATION
-
Description:
+
Description:

Custom information can be stored in media file's XMP meta data. This method retrieves the information that will be written to future media files. The information written to individual files can be retrieved through fetchCustomInformation. It is only supported Phantom 4 Pro, Phantom 4 Advanced, Phantom 4 Pro V2.0, Zenmuse P1, Zenmse L1, Zenmuse X4S, Zenmuse X5S, Zenmuse X7, Mavic 2 Enterprise camera and Mavic 2 Enterprise Dual camera.

Input Parameters:
@NonNull final CompletionCallbackWith<String> callbackThe execution callback to receive the result.
@@ -3453,7 +3442,7 @@
Input Parameters:
void setDewarpingEnabled(final boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Enables/disables dewarping (lens distortion correction) for video recorded to SD card. Supported by Phantom 4 Pro camera, X4S, X5S and X7.

Input Parameters:
final boolean enabledtrue to enable video dewarping.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3462,7 +3451,7 @@
Input Parameters:
void getDewarpingEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether dewarping (lens distortion correction) is enabled. Supported by Phantom 4 Pro camera, X4S, X5S and X7.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned Boolean value(s).
@@ -3471,7 +3460,7 @@
Input Parameters:
void initSensorCleaningMode(@Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Initiates the sensor cleaning mode. Calling this will change getSensorCleaningState from IDLE to INITIATING. To start the sensor dedusting operation, the workflow should be:
1. Call initSensorCleaningMode.
2. Remove the lens from the camera.
3. Call startSensorCleaning.
4. When getSensorCleaningState becomes WAITING_FOR_LENS_REMOUNT, mount the lens back to the camera.

It is only supported Zenmuse X7.

Input Parameters:
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3480,7 +3469,7 @@
Input Parameters:
void startSensorCleaning(@Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Starts cleaning the sensor. The sensor cleaning should only be started when the lens is removed from the camera. It is only supported Zenmuse X7.

Input Parameters:
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3489,7 +3478,7 @@
Input Parameters:
void exitSensorCleaningMode(@Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Exits sensor cleaning mode. Calling this will stop the current executing operation and change getSensorCleaningState to IDLE.

Input Parameters:
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3498,7 +3487,7 @@
Input Parameters:
boolean isEIModeSupported()
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether the EI (exposure index) mode is supported by the camera. 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. The EI mode is supported by X4S, X5S and X7. In multiple lenses camera, if one of its lenses supports this feature, the camera and the lens that can supports both return true. User can only access the parameters through the lens object.

Return:
booleantrue if the EI mode is supported, otherwise false.
@@ -3507,7 +3496,7 @@
Return:
void setExposureSensitivityMode(final SettingsDefinitions.ExposureSensitivityMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the exposure sensitivity mode. It is only supported when isEIModeSupported returns true. It is supported by X4S, X5S and X7. For other cameras, only ISO mode is supported.

Input Parameters:
final SettingsDefinitions.ExposureSensitivityMode modeThe exposure sensitivity mode to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3516,7 +3505,7 @@
Input Parameters:
void getExposureSensitivityMode(@NonNull final CompletionCallbackWith<SettingsDefinitions.ExposureSensitivityMode> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the exposure sensitivity mode. It is only supported when isEIModeSupported returns true. It is supported by X4S, X5S and X7. For other cameras, only ISO mode is supported.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.ExposureSensitivityMode> callbackThe execution callback with the returned ExposureSensitivityMode enum value.
@@ -3525,7 +3514,7 @@
Input Parameters:
void setEI(final int ei, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets EI value. The valid range can be fetched from getEIRange. It is only valid when exposure sensitivity mode is EI. It is only supported by X4S, X5S and X7.

Input Parameters:
final int eiThe EI value to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3534,7 +3523,7 @@
Input Parameters:
void getEI(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets EI value. It is only valid when exposure sensitivity mode is EI. It is only supported by X4S, X5S and X7.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned integer value.
@@ -3543,7 +3532,7 @@
Input Parameters:
void getRecommendedEI(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the EI value recommended by the camera. It is only valid when exposure sensitivity mode is EI. It is only supported by X4S, X5S and X7.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned Integer value.
@@ -3552,7 +3541,7 @@
Input Parameters:
void getEIRange(@NonNull final CompletionCallbackWith<int[]> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the valid range of EI values. It is only valid when exposure sensitivity mode is EI. It is only supported by X4S, X5S and X7.

Input Parameters:
@NonNull final CompletionCallbackWith<int[]> callbackThe execution callback with the returned int value.
@@ -3561,7 +3550,7 @@
Input Parameters:
void setEIColor(final SettingsDefinitions.EIColor color, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the camera color for EI mode. It is only valid when exposure sensitivity mode is EI. It is only supported by X4S, X5S and X7.

Input Parameters:
final SettingsDefinitions.EIColor colorThe camera color to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3570,7 +3559,7 @@
Input Parameters:
void getEIColor(@NonNull final CompletionCallbackWith<SettingsDefinitions.EIColor> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the camera color for EI mode. It is only valid when exposure sensitivity mode is EI. It is only supported by X4S, X5S and X7.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.EIColor> callbackThe execution callback with the returned EIColor enum value.
@@ -3579,7 +3568,7 @@
Input Parameters:
boolean isMechanicalShutterSupported()
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether the mechanical shutter speed is supported by the camera or the lens (for X7). The mechanical shutter is supported by Zenmuse P1, Phantom 4 Pro camera, X4S and X7 with DL lenses. In multiple lenses camera, if one of its lenses supports this feature, the camera and the lens that can supports both return true. User can only access the parameters through the lens object.

Return:
booleantrue if the mechanical shutter is supported, otherwise false.
@@ -3588,7 +3577,7 @@
Return:
void setMechanicalShutterEnabled(final boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Enables the mechanical shutter. It is only valid when isMechanicalShutterSupported returns true. For Zenmuse L1, this interface can not enabled in video mode.

Input Parameters:
final boolean enabledtrue to enable the mechanical shutter.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3597,7 +3586,7 @@
Input Parameters:
void getMechanicalShutterEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether the mechanical shutter is enabled. It is only valid when isMechanicalShutterSupported returns true.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned boolean value.
@@ -3606,7 +3595,7 @@
Input Parameters:
boolean isNDFilterModeSupported()
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether the ND filter mode is supported by the camera and the lens. Only the DL-S 16mm F2.8 ND ASPH lens for X7 has a built-in ND4 filter and supports changing the modes through an application. In multiple lenses camera, if one of its lenses supports this feature, the camera and the lens that can supports both return true. User can only access the parameters through the lens object.

Return:
booleantrue if the ND filter mode is supported, otherwise false.
@@ -3615,7 +3604,7 @@
Return:
void setNDFilterMode(final SettingsDefinitions.NDFilterMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the mode of ND filter. It is only valid when isNDFilterModeSupported returns true.

Input Parameters:
final SettingsDefinitions.NDFilterMode modeThe ND filter mode to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3624,7 +3613,7 @@
Input Parameters:
void getNDFilterMode(@NonNull final CompletionCallbackWith<SettingsDefinitions.NDFilterMode> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the ND filter mode. It is only valid when isNDFilterModeSupported returns true.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.NDFilterMode> callbackThe execution callback with the returned NDFilterMode enum value.
@@ -3633,7 +3622,7 @@
Input Parameters:
void setSSDClipFileName(final SettingsDefinitions.SSDClipFileName name, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the clip name for the video to be stored in SSD. The clip name will be applied to the next video file stored in SSD. After saving a video file, getClipID will increase by 1 automatically. It is only supported by Inspire 2.

Input Parameters:
final SettingsDefinitions.SSDClipFileName nameThe clip name to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3642,7 +3631,7 @@
Input Parameters:
void getSSDClipFileName(@NonNull final CompletionCallbackWith<SettingsDefinitions.SSDClipFileName> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the clip name for video to be stored in SSD. It is only supported by Inspire 2.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.SSDClipFileName> callbackThe execution callback with the returned SSDClipFileName class.
@@ -3651,7 +3640,7 @@
Input Parameters:
boolean isPhotoQuickViewSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_PHOTO_QUICK_VIEW_SUPPORTED
-
Description:
+
Description:

Determines whether the device supports the quick view. Quick view is the period of time a photo is shown as a preview after it is taken and before the camera returns to the live camera view. In multiple lenses camera, if one of its lenses supports this feature, the camera and the lens that can supports both return true. User can only access the parameters through the lens object.

Return:
booleanA boolean value.
@@ -3660,7 +3649,7 @@
Return:
void setPhotoQuickViewDuration(@IntRange(from = 0, to = 10) int duration,
                                         @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_QUICK_VIEW_DURATION
-
Description:
+
Description:

Sets the camera's quick view duration. The valid range is [0, 10] seconds. When duration is 0, it means that the quick view is disabled. The default value is 0 second. Call isPhotoQuickViewSupported before using this method.

Input Parameters:
@IntRange(from = 0, to = 10) int durationQuick view duration to be set for the camera. This value defines the amount of time a photo is shown as a preview after it is taken before the camera returns back to the live camera view. This value must be set in the range of [0, 10] seconds. When the value is 0, quick view is disabled. The default value is 0 second.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3669,7 +3658,7 @@
Input Parameters:
void getPhotoQuickViewDuration(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.PHOTO_QUICK_VIEW_DURATION
-
Description:
+
Description:

Gets the camera's quick view duration.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -3678,7 +3667,7 @@
Input Parameters:
void setHDLiveViewEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.HD_LIVE_VIEW_ENABLED
-
Description:
+
Description:

Enables HD (high-definition) live view. When it is enabled, the live view resolution is 1080p with frame rate 30 fps. The settings will only take effect when the camera is in record-video mode and the video resolution is either 1080p or 2.7k without slow-motion enabled. If recording video in 4k, then the live stream will be limited to 720p. Supported by Mavic Air 2, DJI Air 2S, Mavic Pro, Mavic 2 Pro, Mavic 2 Zoom and Phantom 4 Pro v2.0.

Input Parameters:
boolean enabledEnable or disable HD live view.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3687,7 +3676,7 @@
Input Parameters:
void getHDLiveViewEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.HD_LIVE_VIEW_ENABLED
-
Description:
+
Description:

true if 1080p live view is enabled. This will return the value of the setter, and not necessarily the actual live view resolution. For example, if recording in 4K and HD live view has previously been set, then this will return true but the actual live view resolution will be 720p. Supported only by , DJI Air 2S, Mavic Pro, Mavic 2 Pro, Mavic 2 Zoom and Phantom 4 Pro V2.0.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3696,7 +3685,7 @@
Input Parameters:
void setLEDAutoTurnOffEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.LED_AUTO_TURN_OFF_ENABLED
-
Description:
+
Description:

Enables the automatic control of the front-arm LEDs. The camera can turn off the front-arm LEDs automatically when it shoots photos or records videos. The LEDs will be turned on after the shooting or recording is finished. Supported only by Mavic Pro, Mavic Air, and Mavic 2 series.

Input Parameters:
boolean enabledEnable the automatic control of the front-arm LEDs.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3705,7 +3694,7 @@
Input Parameters:
void getLEDAutoTurnOffEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.LED_AUTO_TURN_OFF_ENABLED
-
Description:
+
Description:

Determines whether the automatic control of the front-arm LEDs is Enabled. Supported only by Mavic Pro, Mavic Air, and Mavic 2 series.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3714,7 +3703,7 @@
Input Parameters:
void setBeaconAutoTurnOffEnabled(boolean enabled, @NonNull final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Enables the automatic control of the beacon. The camera can turn off the beacon automatically when it shoots photos or records videos. The LEDs will be turned on after the shooting or recording is finished. Only Supported by Matrice 200 series V2 and Zenmuse H20/H20T mounted on Matrice 300 RTK.

Input Parameters:
boolean enabledEnable the automatic control of the beacon.
@NonNull final CompletionCallback callbackThe execution callback with the returned value(s).
@@ -3723,7 +3712,7 @@
Input Parameters:
void getBeaconAutoTurnOffEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether the automatic control of the beacon is Enabled. Only Supported by M200 series v2 and Zenmuse H20/H20T mounted on Matrice 300 RTK.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3734,7 +3723,7 @@

Storage Location

boolean isInternalStorageSupported()
Package:dji.sdk.camera
-
Description:
+
Description:

Determines if the camera supports the internal storage or not. When it is supported, the camera shoot photos or record videos without SD card. The newly generated photos or videos will be stored in the internal storage.

Return:
booleantrue if internal storage is supported.
@@ -3743,7 +3732,7 @@
Return:
void setStorageLocation(@NonNull SettingsDefinitions.StorageLocation location,
                                  @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the storage location for the newly generated photos or videos. It is only supported when isInternalStorageSupported returns true. Not supported by Mavic Mini, DJI Mini 2, DJI Mini SE.

Input Parameters:
@NonNull SettingsDefinitions.StorageLocation locationThe storage location to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3752,7 +3741,7 @@
Input Parameters:
void getStorageLocation(@NonNull final CompletionCallbackWith<SettingsDefinitions.StorageLocation> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the storage location for the newly generated photos or videos. When isInternalStorageSupported returns false, this setting is always SDCARD.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.StorageLocation> callbackThe execution callback with the returned execution result.
@@ -3763,7 +3752,7 @@

Audio Settings

boolean isAudioRecordingSupported()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_AUDIO_RECORDING_SUPPORTED
-
Description:
+
Description:

Determines whether the current device supports audio recording. Currently audio recording is supported only by the Osmo camera.

Return:
booleanThe boolean value.
@@ -3772,7 +3761,7 @@
Return:
void setAudioRecordingEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.AUDIO_RECORDING_ENABLED
-
Description:
+
Description:

Enables audio recording when capturing video. Supported only by Osmo camera.

Input Parameters:
boolean enabledEnable or disable audio recording.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3781,7 +3770,7 @@
Input Parameters:
void getAudioRecordingEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.AUDIO_RECORDING_ENABLED
-
Description:
+
Description:

Determines whether the audio record is enabled.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3790,7 +3779,7 @@
Input Parameters:
void setAudioGain(@IntRange(from = 0, to = 100) int value, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.AUDIO_GAIN
-
Description:
+
Description:

Sets the microphone recording gain.

Input Parameters:
@IntRange(from = 0, to = 100) int valueRecording gain with range [0, 100].
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3799,7 +3788,7 @@
Input Parameters:
void getAudioGain(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.AUDIO_GAIN
-
Description:
+
Description:

Gets the microphone recording gain.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -3808,7 +3797,7 @@
Input Parameters:
void setTurnOffFanWhenPossible(boolean turnOffWhenPossible, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.TURN_OFF_FAN_WHEN_POSSIBLE
-
Description:
+
Description:

This method will turn off the camera's cooling fan whenever the camera is cool enough to do so. This allows better audio recording from the internal microphone in the camera.

Input Parameters:
boolean turnOffWhenPossibletrue to turn fan off whenever possible.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3817,7 +3806,7 @@
Input Parameters:
void getTurnOffFanWhenPossible(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.TURN_OFF_FAN_WHEN_POSSIBLE
-
Description:
+
Description:

Determines whether the fan will turn off whenever it is cool enough to do so to enable better audio recordings from the camera's internal microphone.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3828,7 +3817,7 @@

Thermal

boolean isThermalCamera()
Package:dji.sdk.camera
SDK Key:CameraKey.IS_THERMAL_CAMERA
-
Description:
+
Description:

true if the current connected device is a thermal imaging camera. @return BOOL true if current connected device is thermal imaging camera. For Zenmuse H20T, please use class Lens.

Return:
booleanA boolean value.
@@ -3837,7 +3826,7 @@
Return:
void setThermalROI(@NonNull ThermalROI roi, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ROI
-
Description:
+
Description:

Sets the Region of Interest (ROI). Used to manage color range distribution across the screen to maximize contrast for regions of highest interest. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalROI roiAn enum type of the Region of Interest to be used. Please refer to ThermalROI.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3846,7 +3835,7 @@
Input Parameters:
void getThermalROI(@NonNull final CompletionCallbackWith<ThermalROI> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ROI
-
Description:
+
Description:

Gets the Region of Interest. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ThermalROI> callbackThe execution callback with the returned value(s).
@@ -3855,7 +3844,7 @@
Input Parameters:
void setThermalPalette(@NonNull ThermalPalette palette, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_PALETTE
-
Description:
+
Description:

Sets the Palette. Each palette is a unique look-up table that maps 8-bit temperature values to different colors. Different palettes can be used to help the user better visualize temperature contrast or specific temperature bands. The valid range can be fetched from thermalPaletteRange. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalPalette paletteAn enum type of the ThermalPalette to be used.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3864,7 +3853,7 @@
Input Parameters:
void getThermalPalette(@NonNull final CompletionCallbackWith<ThermalPalette> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_PALETTE
-
Description:
+
Description:

Gets the Palette. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ThermalPalette> callbackThe execution callback with the returned value(s).
@@ -3873,7 +3862,7 @@
Input Parameters:
void setThermalScene(@NonNull ThermalScene scene, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_SCENE
-
Description:
+
Description:

Sets the scene to instantly enhance your image. In all modes except Manual and User modes, the DDE, ACE, SSO, brightness and contrast are set automatically to obtain the best result. In User modes, the contrast and brightness are set automatically to obtain the best results. Any settings that are made in these modes are retained if the scene is changed. In Manual mode, DDE, contrast and brightness are set manually. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalScene sceneAn enum type for the ThermalScene to be used.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3882,7 +3871,7 @@
Input Parameters:
void getThermalScene(@NonNull final CompletionCallbackWith<ThermalScene> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_SCENE
-
Description:
+
Description:

Gets current scene. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ThermalScene> callbackThe execution callback with the returned value(s).
@@ -3891,7 +3880,7 @@
Input Parameters:
void setThermalDDE(@IntRange(from = -20, to = 100) int value, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_DDE
-
Description:
+
Description:

Sets the Digital Data Enhancement index (for DDE dynamic mode). DDE can be used to enhance image details (sharpen, higher index) and/or suppress fixed pattern noise (soften, lower index). It can be set manually only when the Scene mode is Manual, User1, User2 or User3. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@IntRange(from = -20, to = 100) int valueInteger in range [-20, 100]. Values less than 0 soften the image and filter fixed pattern noise. Values greater than 0 sharpen the details in the image. Value of 0 results in no enhancement.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3900,7 +3889,7 @@
Input Parameters:
void getThermalDDE(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_DDE
-
Description:
+
Description:

Gets the value of Digital Data Enhancement. The value is available only when the Scene mode is Manual, User1, User2 or User3. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -3909,7 +3898,7 @@
Input Parameters:
void setThermalACE(@IntRange(from = -8, to = 8) int value, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ACE
-
Description:
+
Description:

Set the value of Active Contrast Enhancement. Active contrast enhancement allows for a contrast trade-off between hotter and colder scenes when using 8-bit pixel data. It can be set manually only when the Scene mode is User1, User2 or User3. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@IntRange(from = -8, to = 8) int valueInteger in range [-8, 8]. <br> value > 0: more contrast in hotter scene content and less contrast in colder scene content (sky, ocean etc.). <br> value < 0: more contrast in colder scene content and less contrast in hotter scene content. <br> value = 0: neutral <br> value = 3: recommended for generic use
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3918,7 +3907,7 @@
Input Parameters:
void getThermalACE(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ACE
-
Description:
+
Description:

Gets the value of Active Contrast Enhancement. The value is available only when the Scene mode is Manual, User1, User2 or User3. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -3927,7 +3916,7 @@
Input Parameters:
void setThermalSSO(@IntRange(from = 0, to = 100) int value, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_SSO
-
Description:
+
Description:

Sets the value of Smart Scene Optimization. When using non-linear histogram equalization to map the 14-bit sensor pixel values to 8-bit pixel values, it can become difficult to determine the difference in temperature of two objects from their different shades of gray. SSO allows a percentage of the 14-bit histogram to be mapped linearly to the 8-bit histogram, which will compromise local contrast, but allow for more accurate visual radiometric measurements. This is particularly useful for bi-modal scenes. It can be set manually only when the Scene mode is User1, User2 or User3. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@IntRange(from = 0, to = 100) int valuePercentage of histogram to map linearly [0, 100].
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3936,7 +3925,7 @@
Input Parameters:
void getThermalSSO(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_SSO
-
Description:
+
Description:

Gets the value of Smart Scene Optimization. The value is available only when the Scene mode is Manual, User1, User2 or User3. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -3945,7 +3934,7 @@
Input Parameters:
void setThermalBrightness(@IntRange(from = 0, to = 16383) int brightness,
                                    @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_BRIGHTNESS
-
Description:
+
Description:

Sets the brightness of the image. It can be set manually only when the Scene mode is Manual. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@IntRange(from = 0, to = 16383) int brightnessThe integer value falls in [0, 16383].
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3954,7 +3943,7 @@
Input Parameters:
void getThermalBrightness(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_BRIGHTNESS
-
Description:
+
Description:

Gets the value of brightness. The value is available only when the Scene mode is Manual, User1, User2 or User3. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -3963,7 +3952,7 @@
Input Parameters:
void setThermalContrast(@IntRange(from = 0, to = 255) int contrast,
                                  @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_CONTRAST
-
Description:
+
Description:

Sets the value of contrast, with larger values having higher contrast. It can be set manually only when the Scene mode is Manual. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@IntRange(from = 0, to = 255) int contrastContrast value as an integer with range [0, 255].
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3972,7 +3961,7 @@
Input Parameters:
void getThermalContrast(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_CONTRAST
-
Description:
+
Description:

Gets contrast value. The value is available only when the Scene mode is Manual, User1, User2 or User3. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -3981,7 +3970,7 @@
Input Parameters:
void setThermalIsothermEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_ENABLED
-
Description:
+
Description:

Enable or disable Isotherms. Isotherms can be used to highlight specific temperature ranges: 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. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
boolean enabledtrue if isotherms are enabled.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -3990,7 +3979,7 @@
Input Parameters:
void getThermalIsothermEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_ENABLED
-
Description:
+
Description:

Determines whether Isotherms are enabled. true if Isotherms are enabled. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
@@ -3999,7 +3988,7 @@
Input Parameters:
void setThermalIsothermUnit(@NonNull ThermalIsothermUnit unit, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_UNIT
-
Description:
+
Description:

Sets the unit of the Isotherm ranges to either Celsius or percent. Different units results in different value ranges for Isotherms. Supported only by thermal imaging cameras except Mavic 2 Enterprise Dual thermal camera. For Mavic 2 Enterprise Dual, the Isotherm unit is always CELSIUS. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalIsothermUnit unitAn enum type of the CameraThermalIsothermUnit to be used. Please refer to DJICameraThermalIsothermUnit.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4008,7 +3997,7 @@
Input Parameters:
void getThermalIsothermUnit(@NonNull final CompletionCallbackWith<ThermalIsothermUnit> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_UNIT
-
Description:
+
Description:

Gets the units for Isotherm ranges. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Mavic 2 Enterprise Dual, the Isotherm unit is always CELSIUS. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ThermalIsothermUnit> callbackThe execution callback with the returned value(s).
@@ -4017,7 +4006,7 @@
Input Parameters:
void setThermalIsothermUpperValue(@IntRange(from = 0, to = 100) int value,
                                            @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_UPPER_VALUE
-
Description:
+
Description:

Sets the upper threshold value for Isotherm. All temperature values above this will use colors 224-255 from the palette. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@IntRange(from = 0, to = 100) int valueIf the unit is percentage, the allowed range is [0,100]. If the unit is Celsius, for Mavic 2 Enterprise Dual thermal camera, the value range is [-10, 400]. For other thermal imaging cameras, the value range is [-40, 500]. The value can only be equal or larger than middle Isotherm threshold.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4026,7 +4015,7 @@
Input Parameters:
void getThermalIsothermUpperValue(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_UPPER_VALUE
-
Description:
+
Description:

Gets the upper threshold value for Isotherm. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -4035,7 +4024,7 @@
Input Parameters:
void setThermalIsothermMiddleValue(@IntRange(from = 0, to = 100) int value,
                                             @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_MIDDLE_VALUE
-
Description:
+
Description:

Sets the middle threshold value for Isotherm. Temperature values between the middle and upper Isotherm threshold will be displayed with colors 176-223 from the palette. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@IntRange(from = 0, to = 100) int valueIf the unit is percentage, the value falls in [0,100]. If the unit is Celsius, the value range is [-40, 550]. The value can only be equal or larger than lower threshold and equal or smaller than upper threshold.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4044,7 +4033,7 @@
Input Parameters:
void getThermalIsothermMiddleValue(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_MIDDLE_VALUE
-
Description:
+
Description:

Gets the middle threshold value for Isotherm. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -4053,7 +4042,7 @@
Input Parameters:
void setThermalIsothermLowerValue(@IntRange(from = 0, to = 100) int value,
                                            @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_LOWER_VALUE
-
Description:
+
Description:

Sets the lower threshold value for Isotherm. Temperature values between the lower and middle Isotherm threshold will be displayed with colors 128-175 from the palette. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@IntRange(from = 0, to = 100) int valueIf the unit is percentage, the value falls in [0,100]. If the unit is Celsius, for Mavic 2 Enterprise Dual thermal camera, the value range is [-10, 400], for other thermal imaging cameras, the value range is [-40, 500]. The value can only be equal or smaller than upper threshold.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4062,7 +4051,7 @@
Input Parameters:
void getThermalIsothermLowerValue(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ISOTHERM_LOWER_VALUE
-
Description:
+
Description:

Gets the lower threshold value for Isotherm. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
@@ -4071,7 +4060,7 @@
Input Parameters:
void setThermalGainMode(@NonNull ThermalGainMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_GAIN_MODE
-
Description:
+
Description:

Sets the gain mode. Low gain mode can be used for scenes with temperatures ranging from -40 to 550 degrees Celsius. For higher contrast, the high gain mode can be used by for temperatures between -25 to 135 degrees Celsius for the 640x512 camera and -25 to 100 degrees Celsius for 324 x 256 camera. Mavic 2 Enterprise Dual has different temperature range from other thermal imaging cameras. Therefore, for Mavic 2 Enterprise Dual, the low gain mode can be used from -10 to 140 degrees Celsius. The high gain mode can be used from -10 to 400 degree Celsius. Supported by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalGainMode modeAn enum type of the ThermalGainMode to be used.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4080,7 +4069,7 @@
Input Parameters:
void getThermalGainMode(@NonNull final CompletionCallbackWith<ThermalGainMode> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_GAIN_MODE
-
Description:
+
Description:

Gets the gain mode. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ThermalGainMode> callbackThe execution callback with the returned value(s).
@@ -4089,7 +4078,7 @@
Input Parameters:
void setThermalMeasurementMode(@NonNull ThermalMeasurementMode mode, @Nullable CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_MEASUREMENT_MODE
-
Description:
+
Description:

Sets the mode for thermal measurement. Use callback method onUpdate to receive the measurement result. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalMeasurementMode modeThe desired measurement mode.
@Nullable CompletionCallback callbackExecution callback that receives the getter execution result.
@@ -4098,7 +4087,7 @@
Input Parameters:
void getThermalMeasurementMode(@NonNull CompletionCallbackWith<ThermalMeasurementMode> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_MEASUREMENT_MODE
-
Description:
+
Description:

Gets the mode for thermal measurement. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull CompletionCallbackWith<ThermalMeasurementMode> callbackThe execution callback with the returned value(s).
@@ -4107,7 +4096,7 @@
Input Parameters:
void setThermalDigitalZoomFactor(@NonNull ThermalDigitalZoomFactor factor,
                                           @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_DIGITAL_ZOOM_FACTOR
-
Description:
+
Description:

Adjusts the digital zoom. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalDigitalZoomFactor factorFor resolution 640 x 512, x1,x2,x4,x8 can be set. For resolution 336 x 256, only x1,x2,x4 can be set. Please refer to CameraThermalDigitalZoomScale in DJICameraSettingsDef.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4116,7 +4105,7 @@
Input Parameters:
void getThermalDigitalZoomFactor(@NonNull final CompletionCallbackWith<ThermalDigitalZoomFactor> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_DIGITAL_ZOOM_FACTOR
-
Description:
+
Description:

Gets current digital zoom. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ThermalDigitalZoomFactor> callbackThe execution callback with the returned value(s).
@@ -4125,7 +4114,7 @@
Input Parameters:
void getThermalProfile(@NonNull final CompletionCallbackWith<SettingsDefinitions.ThermalProfile> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_PROFILE
-
Description:
+
Description:

Gets the thermal imaging camera profile. The profile includes information about resolution, frame rate and focal length. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.ThermalProfile> callbackThe execution callback with the returned value(s).
@@ -4134,7 +4123,7 @@
Input Parameters:
void setThermalSpotMeteringTargetPoint(@NonNull PointF targetPoint,
                                                 @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_SPOT_METERING_TARGET_POINT
-
Description:
+
Description:

Sets the spot metering target point which then invoke the callback from setThermalTemperatureCallback with the temperature at a specific coordinate in the scene. This method requires a relative point that is proportional to the dimension of the camera video dimension, the x, and y values must all be between 0 and 1.0. Supported only by XT2, Mavic 2 Enterprise Dual and Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull PointF targetPointThe desired target point.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4143,7 +4132,7 @@
Input Parameters:
void getThermalSpotMeteringTargetPoint(
       @NonNull final CompletionCallbackWith<PointF> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_SPOT_METERING_TARGET_POINT
-
Description:
+
Description:

Gets the spot metering target point if one is set, if not then returns CGPointZero. Supported only by XT2, Mavic 2 Enterprise Dual and Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<PointF> callbackThe execution callback with the returned value(s).
@@ -4152,7 +4141,7 @@
Input Parameters:
void setThermalMeteringArea(@NonNull RectF area, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_METERING_AREA
-
Description:
+
Description:

Set the metering area for a rectangle inside the thermal image scene, which allows the camera to transmit aggregate temperature computations via the onUpdate callback method. See ThermalAreaTemperatureAggregations for the statistical values that are available. This method requires a relative rect that is proportional to the rect of the thermal scene, the x, y, width, and height values must all be between 0 and 1.0. Supported only by XT2, Mavic 2 Enterprise Dual and Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull RectF areaThe desired thermal metering area.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4161,7 +4150,7 @@
Input Parameters:
void getThermalMeteringArea(@NonNull final CompletionCallbackWith<RectF> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_METERING_AREA
-
Description:
+
Description:

Get a rect representing the currently set metering area for the thermal scene. Supported only by XT2, Mavic 2 Enterprise Dual and Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<RectF> callbackThe execution callback with the returned value(s).
@@ -4170,7 +4159,7 @@
Input Parameters:
void setThermalFFCMode(@NonNull ThermalFFCMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_FFC_MODE
-
Description:
+
Description:

Set the flat-field correction (FFC) mode. Supported only by thermal imaging cameras. For Mavic 2 Enterprise Dual thermal camera, the ThermalFFCMode is always AUTO. For Mavic 2 Enterprise Advanced camera, support AUTO and MANUAL. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalFFCMode modeThe desired FFC mode.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4179,7 +4168,7 @@
Input Parameters:
void getThermalFFCMode(@NonNull final CompletionCallbackWith<ThermalFFCMode> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_FFC_MODE
-
Description:
+
Description:

Get the currently set flat-field correction (FFC) mode. Supported only by thermal imaging cameras with installed firmware version of 1.15.1.60 or higher. For Mavic 2 Enterprise Dual thermal camera, the DJICamera_DJICameraThermalFFCMode is always DJICamera_DJICameraThermalFFCMode_Auto. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ThermalFFCMode> callbackThe execution callback with the returned value(s).
@@ -4188,7 +4177,7 @@
Input Parameters:
void triggerThermalFFC(@Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.TRIGGER_THERMAL_FFC
-
Description:
+
Description:

Trigger flat-field correction. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@Nullable final CompletionCallback callbackThe execution callback with result of the trigger action.
@@ -4197,7 +4186,7 @@
Input Parameters:
void setThermalCustomExternalSceneSettingsProfile(@NonNull ThermalCustomExternalSceneSettingsProfile profile,
                                                            @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_CUSTOM_EXTERNAL_SCENE_SETTINGS_PROFILE
-
Description:
+
Description:

Set the custom user profile. This profile represents user-set external scene parameters for the thermal scene. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull ThermalCustomExternalSceneSettingsProfile profileThe desired user profile setting.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4206,7 +4195,7 @@
Input Parameters:
void getThermalCustomExternalSceneSettingsProfile(
       @NonNull final CompletionCallbackWith<ThermalCustomExternalSceneSettingsProfile> callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_CUSTOM_EXTERNAL_SCENE_SETTINGS_PROFILE
-
Description:
+
Description:

Get the currently set custom user profile. This profile represents user-set external scene parameters for the thermal scene. Supported only by thermal imaging cameras. For Zenmuse H20T, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<ThermalCustomExternalSceneSettingsProfile> callbackThe execution callback with the returned value(s).
@@ -4215,7 +4204,7 @@
Input Parameters:
void setThermalAtmosphericTemperature(float temperature, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ATMOSPHERIC_TEMPERATURE
-
Description:
+
Description:

Set the temperature of the atmosphere between the scene and the camera. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
float temperatureThe assumed temperature of the atmosphere between the camera and the scene, can be between -50 and 327.67 degrees Celsius.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4224,7 +4213,7 @@
Input Parameters:
void setThermalAtmosphericTransmissionCoefficient(final float coefficient,
                                                            @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_ATMOSPHERIC_TEMPERATURE
-
Description:
+
Description:

Set the transmission coefficient of the atmosphere between the scene and the camera. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
final float coefficientThe desired atmospheric temperature, can be between 50 and 100.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4233,7 +4222,7 @@
Input Parameters:
void setThermalBackgroundTemperature(final float temperature, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_BACKGROUND_TEMPERATURE
-
Description:
+
Description:

Set the assumed temperature reflected by the background of the scene, can be between -50 and 327.67 degrees Celsius. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
final float temperatureThe desired background reflected temperature.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4242,7 +4231,7 @@
Input Parameters:
void setThermalSceneEmissivity(final float emissivity, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_SCENE_EMISSIVITY
-
Description:
+
Description:

Set the emissivity of the thermal scene, can be between 50 and 100. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
final float emissivityThe desired scene emissivity.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4251,7 +4240,7 @@
Input Parameters:
void setThermalWindowReflection(final float reflection, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_WINDOW_REFLECTION
-
Description:
+
Description:

Set assumed window reflection coefficient, can be between 0 and X where X is the window transmission coefficient parameter. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
final float reflectionThe desired window reflection coefficient.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4260,7 +4249,7 @@
Input Parameters:
void setThermalWindowReflectedTemperature(final float temperature,
                                                    @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_WINDOW_REFLECTED_TEMPERATURE
-
Description:
+
Description:

Set the temperature reflected in the window, can be between -50 and 327.67 degrees Celsius. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
final float temperatureThe desired window reflected temperature.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4269,7 +4258,7 @@
Input Parameters:
void setThermalWindowTemperature(final float temperature, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_WINDOW_TEMPERATURE
-
Description:
+
Description:

Set the window temperature, can be between -50 and 327.67 degrees Celsius. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
final float temperatureThe desired window temperature.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4278,7 +4267,7 @@
Input Parameters:
void setThermalWindowTransmissionCoefficient(final float coefficient,
                                                       @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
SDK Key:CameraKey.THERMAL_WINDOW_TRANSMISSION_COEFFICIENT
-
Description:
+
Description:

Set the window transmission coefficient, can be between 50 and 100-X where X is the window reflection. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T, please use class Lens.

Input Parameters:
final float coefficientThe desired window transmission coefficient.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4287,7 +4276,7 @@
Input Parameters:
void setThermalTemperatureUnit(final SettingsDefinitions.TemperatureUnit temperatureUnit, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the temperature unit. Only supported by XT2 and Mavic 2 Enterprise Dual. For Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
final SettingsDefinitions.TemperatureUnit temperatureUnitAn enum value of TemperatureUnit.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4296,7 +4285,7 @@
Input Parameters:
void getThermalTemperatureUnit(final CompletionCallbackWith<SettingsDefinitions.TemperatureUnit> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the temperature unit. Only supported by XT2 and Mavic 2 Enterprise Dual Thermal camera. For Zenmuse H20T, please use class Lens.

Input Parameters:
final CompletionCallbackWith<SettingsDefinitions.TemperatureUnit> callbackThe execution callback with the returned execution result.
@@ -4305,7 +4294,7 @@
Input Parameters:
void setDisplayMode(final SettingsDefinitions.DisplayMode mode, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the display mode to coordinate the video feeds from both the visual camera and the thermal camera. Only supported by XT2 camera and Mavic 2 Enterprise Dual Thermal Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
final SettingsDefinitions.DisplayMode modeThe display mode to set.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4314,7 +4303,7 @@
Input Parameters:
void getDisplayMode(@NonNull final CompletionCallbackWith<SettingsDefinitions.DisplayMode> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the display mode. The display mode determine the way to coordinate the video feeds from both the visual camera and the thermal camera. Only supported by XT2 camera and Mavic 2 Enterprise Dual Thermal Camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.DisplayMode> callbackThe execution callback with the returned execution result.
@@ -4323,7 +4312,7 @@
Input Parameters:
void setPIPPosition(final SettingsDefinitions.PIPPosition position, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Set the Picture in picture mode of XT2 camera.For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
final SettingsDefinitions.PIPPosition positionCould be one of the Enum "SettingsDefinitions.PIPPosition"
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4332,7 +4321,7 @@
Input Parameters:
void getPIPPosition(@NonNull final CompletionCallbackWith<SettingsDefinitions.PIPPosition> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Get picture in picture mode of XT2 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<SettingsDefinitions.PIPPosition> callbackThe execution callback with the returned execution result.
@@ -4341,7 +4330,7 @@
Input Parameters:
void setMSXLevel(@IntRange(from = 0, to = 100) int level, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the level for MSX display mode. The range for level is [0, 100]. When it is 0, the visible spectrum definition is invisible. When it is 100, the visual spectrum definition is the most obvious. Only supported by XT2 camera and Mavic 2 Enterprise Dual. Mavic 2 Enterprise Dual does not support with firmware version lower than 01.01.0520. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@IntRange(from = 0, to = 100) int levelThe MSX level to set with range [0, 100].
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4350,7 +4339,7 @@
Input Parameters:
void getMSXLevel(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the level for MSX display mode. The range for level is [0, 100]. When it is 0, the visible spectrum definition is invisible. When it is 100, the visual spectrum definition is the most obvious. Only supported by XT2 camera and Mavic 2 Enterprise Dual. Mavic 2 Enterprise Dual does not support with firmware version lower than 01.01.0520. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class Lens.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned execution result.
@@ -4359,7 +4348,7 @@
Input Parameters:
void setDualFeedVerticalAlignmentOffset(@IntRange(from = -40, to = 40) int offset, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the vertical alignment offset between the video feeds from both the visual camera and the thermal camera. The alignment is applied to the MSX display mode. Different camera results in different value ranges. For XT2 camera, the valid range is [-8, 8]. For Mavic 2 Enterprise Dual, the valid range is [-40, 40]. Positive value will move the thermal window up. Use this setting to fine-tune the performance of MSX display mode and the align PIP mode. Only supported by XT2 camera and Mavic 2 Enterprise Dual.

Input Parameters:
@IntRange(from = -40, to = 40) int offsetRange from -8 to 8 for XT2, from -40 to 40 for Mavic 2 Enterprise Dual.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4368,7 +4357,7 @@
Input Parameters:
void getDualFeedVerticalAlignmentOffset(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the vertical alignment offset between the video feeds from both the visual camera and the thermal camera. The alignment is applied to the MSX display mode. Different camera results in different value ranges. For XT2 camera, the valid range is [-8, 8]. For Mavic 2 Enterprise Dual, the valid range is [-40, 40]. Positive value will move the thermal window up. Only supported by XT2 camera and Mavic 2 Enterprise Dual camera.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned execution result.
@@ -4377,7 +4366,7 @@
Input Parameters:
void setDualFeedHorizontalAlignmentOffset(@IntRange(from = -100, to = 100) int offset, @Nullable final CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the horizontal alignment offset between the video feeds from both the visual camera and the thermal camera. The alignment is applied to the MSX display mode. Different camera results in different value ranges. For XT2 camera, the valid range is [-100, 100]. For Mavic 2 Enterprise Dual, the valid range is [-40, 40]. Positive value will move the thermal window to the right. Use this setting to fine-tune the performance of MSX display mode and the align PIP mode. Only supported by XT2 camera and Mavic 2 Enterprise Dual.

Input Parameters:
@IntRange(from = -100, to = 100) int offsetRange from -100 to 100 for XT2, from -40 to 40 for Mavic 2 Enterprise Dual.
@Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4386,7 +4375,7 @@
Input Parameters:
void getDualFeedHorizontalAlignmentOffset(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the horizontal alignment offset between the video feeds from both the visual camera and the thermal camera. The alignment is applied to the MSX display mode. Different camera results in different value ranges. For XT2 camera, the valid range is [-100, 100]. For Mavic 2 Enterprise Dual, the valid range is [-40, 40]. Positive value will move the thermal window to the right. Only supported by XT2 camera and Mavic 2 Enterprise Dual.

Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned execution result.
@@ -4397,7 +4386,7 @@

Multi Lenses

boolean isMultiLensCameraSupported()
Package:dji.sdk.camera
-
Description:
+
Description:

Determines if the camera supports the multiple lens.

Return:
booleantrue if the multiple lens is supported.
@@ -4406,7 +4395,7 @@
Return:
boolean isMultiVideoStreamSourceSupported()
Package:dji.sdk.camera
-
Description:
+
Description:

Determines whether the camera supports multi video stream source or not.

Return:
booleanA boolean value.
@@ -4415,7 +4404,7 @@
Return:
void setCameraVideoStreamSource(@NonNull CameraVideoStreamSource cameraVideoStreamSource, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the camera video stream source. For multi-lens cameras, the camera stream has different sources. CameraVideoStreamSource is used to represents the camera video stream source. When the source of the camera video stream is set, the current live view stream will also been changed to corresponding source. It is only supported by Zenmuse H20/H20T.

Input Parameters:
@NonNull CameraVideoStreamSource cameraVideoStreamSourceThe camera video stream source.
@Nullable final CommonCallbacks.CompletionCallback callbackThe execution callback with the returned value(s).
@@ -4424,7 +4413,7 @@
Input Parameters:
void getCameraVideoStreamSource(@NonNull final CommonCallbacks.CompletionCallbackWith<CameraVideoStreamSource> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the camera video stream source. For multi-lens cameras, the camera stream has different sources. CameraVideoStreamSource is used to represents the camera video stream source. When the source of the camera video stream is set, the image transmission will also been changed to corresponding source. It is only supported by Zenmuse H20 series.

Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<CameraVideoStreamSource> callbackThe execution callback with the returned value(s).
@@ -4433,7 +4422,7 @@
Input Parameters:
void setCaptureCameraStreamSettings(@NonNull CameraStreamSettings streamSettings, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

By default, all lenses of this camera will take photos. by using this interface, you can select your interested lens to take photos. Before calling this interface, you should set the camera mode to photo mode. Only supported by Zenmuse H20 series.

Input Parameters:
@NonNull CameraStreamSettings streamSettingsAn object of CameraStreamSettings.
@Nullable final CommonCallbacks.CompletionCallback callbackCallback that receives the setter execution result.
@@ -4442,7 +4431,7 @@
Input Parameters:
void getCaptureCameraStreamSettings(@NonNull final CommonCallbacks.CompletionCallbackWith<CameraStreamSettings> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the capture camera stream settings for taking photo. Only supported by Zenmuse H20 series.

Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<CameraStreamSettings> callbackCallback to receive the result.
@@ -4451,7 +4440,7 @@
Input Parameters:
void setRecordCameraStreamSettings(@NonNull CameraStreamSettings streamSettings, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the camera stream settings for recording video. When recording video, it will been determined whether if current screen is recorded and which camera stream sources are recorded according the camera settings. The class of CameraStreamSettings is used to set the camera stream settings. Before calling this interface, you should set the camera mode to video mode. Only supported by Zenmuse H20 series.

Input Parameters:
@NonNull CameraStreamSettings streamSettingsAn object of CameraStreamSettings.
@Nullable final CommonCallbacks.CompletionCallback callbackCallback that receives the setter execution result.
@@ -4460,7 +4449,7 @@
Input Parameters:
void getRecordCameraStreamSettings(@NonNull final CommonCallbacks.CompletionCallbackWith<CameraStreamSettings> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the capture camera stream settings for recording video. Only supported by Zenmuse H20 series.

Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<CameraStreamSettings> callbackCallback to receive the result.
@@ -4471,7 +4460,7 @@

Multispectral Camera

void setMultispectralDisplayMode(SettingsDefinitions.MultispectralDisplayMode displayMode, @Nullable CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

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

Input Parameters:
SettingsDefinitions.MultispectralDisplayMode displayModeThe display mode to set.
@Nullable CommonCallbacks.CompletionCallback callbackCallback that receives the setter execution result.
@@ -4480,7 +4469,7 @@
Input Parameters:
void getMultispectralDisplayMode(@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.MultispectralDisplayMode> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the display mode. The display mode determines the way to coordinate the video feeds from both the RGB sensor and single-band sensors. Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.MultispectralDisplayMode> callbackCallback to receive the result.
@@ -4489,7 +4478,7 @@
Input Parameters:
void setMultispectralStoragePhotoSettings(MultispectralStoragePhotoSettings settings, @Nullable CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the storage settings for the multispectral camera. The settings control if the photos created by different sensors will be saved or not. Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
MultispectralStoragePhotoSettings settingsAn object of MultispectralStoragePhotoSettings.
@Nullable CommonCallbacks.CompletionCallback callbackCallback to receive the setter result.
@@ -4498,7 +4487,7 @@
Input Parameters:
void getMultispectralStoragePhotoSettings(@NonNull CommonCallbacks.CompletionCallbackWith<MultispectralStoragePhotoSettings> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the storage settings for the multispectral camera. Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallbackWith<MultispectralStoragePhotoSettings> callbackCallback to receive the getter result.
@@ -4507,7 +4496,7 @@
Input Parameters:
void setMultispectralMeteringMode(SettingsDefinitions.MeteringMode mode, @Nullable CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the metering mode for the single-band sensors on the multispectral camera. The same metering mode will be applied to all single-band sensors (sensors except the RGB one). Only CENTER and AVERAGE mode to be set. Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
SettingsDefinitions.MeteringMode modeExposure metering to set.
@Nullable CommonCallbacks.CompletionCallback callbackCallback to receive the result.
@@ -4516,7 +4505,7 @@
Input Parameters:
void getMultispectralMeteringMode(@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.MeteringMode> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the metering mode for all single-band sensors (sensors except the RGB one). Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.MeteringMode> callbackCallback to receive the result.
@@ -4525,7 +4514,7 @@
Input Parameters:
void setMultispectralExposureMode(SettingsDefinitions.ExposureMode mode, @Nullable CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the exposure mode for the single-band sensors on the multispectral camera. The same exposure mode will be applied to all single-band sensors (sensors except the RGB one). Exposure mode must be PROGRAM or SHUTTER_PRIORITY. Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
SettingsDefinitions.ExposureMode modeCamera exposure mode to set.
@Nullable CommonCallbacks.CompletionCallback callbackRemote execution result error block.
@@ -4534,7 +4523,7 @@
Input Parameters:
void getMultispectralExposureMode(@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.ExposureMode> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the exposure mode for all single-band sensors (sensors except the RGB one). Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.ExposureMode> callbackCallback to receive the result.
@@ -4543,7 +4532,7 @@
Input Parameters:
void setMultispectralExposureCompensation(SettingsDefinitions.ExposureCompensation compensation, @Nullable CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the exposure compensation for the single-band sensors on the multispectral camera. The same exposure compensation will be applied to all single-band sensors (sensors except the RGB one). See ExposureCompensation to view all possible exposure compensations to which the single-band sensors can be set. In order to use this function, set the camera exposure mode to PROGRAM or SHUTTER_PRIORITY Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
SettingsDefinitions.ExposureCompensation compensationExposure compensation value to be set for the single-band sensors's.
@Nullable CommonCallbacks.CompletionCallback callbackCallback to receive the result.
@@ -4552,7 +4541,7 @@
Input Parameters:
void getMultispectralExposureCompensation(@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.ExposureCompensation> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the exposure compensation for all single-band sensors (sensors except the RGB one). Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.ExposureCompensation> callbackCallback to receive the result.
@@ -4561,7 +4550,7 @@
Input Parameters:
void setMultispectralShutterSpeed(SettingsDefinitions.ShutterSpeed shutterSpeed, @Nullable CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Sets the shutter speed for the single-band sensors on the multispectral camera. The same shutter speed will be applied to all single-band sensors (sensors except the RGB one). To see all available shutter speed value settings, see ShutterSpeed. The shutter speed should not be set slower than the video frame rate when the camera's mode is RECORD_VIDEO. For example, if the video frame rate is 30fps, the shutter speed must be <= 1/30. Precondition: The shutter speed can be set only when the camera exposure mode is SHUTTER_PRIORITY mode. Only supported by multispectral camera of P4 Multispectral.

Input Parameters:
SettingsDefinitions.ShutterSpeed shutterSpeedShutter speed value to be set for the single-band sensors. For all available values shutterSpeed can be set to, please check ShutterSpeed. <br> The shutter speed should not be set slower than the video frame rate when the camera's mode is RECORD_VIDEO. For example, if the video frame rate = 30fps, then the shutterSpeed must be <= 1/30.
@Nullable CommonCallbacks.CompletionCallback callbackRemote execution result error block.
@@ -4570,7 +4559,7 @@
Input Parameters:
void getMultispectralShutterSpeed(@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.ShutterSpeed> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Gets the shutter speed for all single-band sensors (sensors except the RGB one). The shutter speed is only available when the camera exposure mode is SHUTTER_PRIORITY mode.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.ShutterSpeed> callbackCallback to receive the result.
@@ -4579,7 +4568,7 @@
Input Parameters:
void setMultispectralAELock(boolean isLocked, @Nullable CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Locks or unlocks the single-band sensors on the multispectral camera AELock AE (auto exposure). The same lock state will be applied to all single-band sensors (sensors except the RGB one).

Input Parameters:
boolean isLockedtrue if the the single-band sensors AE is locked, false if it is unlocked.
@Nullable CommonCallbacks.CompletionCallback callbackThe execution callback with the returned execution result.
@@ -4588,7 +4577,7 @@
Input Parameters:
void getMultispectralAELock(@NonNull CommonCallbacks.CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Determines if all the single-band (sensors except the RGB one) sensors on the multispectral camera AE (auto exposure) is locked.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallbackWith<Boolean> callbackCallback to receive the result.
@@ -4599,29 +4588,29 @@

Camera Calibration

enum DJICameraCalibrateState
Package:dji.common.camera
-
Description:
+
Description:

The calibration status of the camera's lens.

-
Enum Members:
+
Enum Members:
NOT_CALIBRATEIf the camera lenses are not calibrated. Focusing action will be influenced. Please use calibration interface if you need.
CALIBRATEDCamera lens calibrated. Do not need to calibrate.
CALIBRATINGCalibration is in progress.
WAITING_FOR_CALIBRATEWaiting for the calibration.
OTHERThe camera lens's state is unknown.
-
Class Members:
+
Class Members:
Camera Calibrate Result
enum
DJICameraCalibrateResult
enum DJICameraCalibrateResult
enum DJICameraCalibrateResult
Package:dji.common.camera
-
Description:
+
Description:

The calibration result of the camera's lens.

-
Enum Members:
+
Enum Members:
IDLENo calibration.
COMPLETEDThe calibration is successful.
FAIL_NORMALThe calibration is failed. Please retry.
DATA_ERRORThe calibration is failed because of the data error. Please retry.
OTHERThe calibration is failed with the unknown error.
-
Class Members:
+
Class Members:
Calibration callback
class
CalibrationCallback
Start Calibaration
method
startCalibration
method startCalibration
void startCalibration(@NonNull CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

If you encounter the following situation, please call this interface for camera calibration. Only supported by Zemmuse P1.
1. Zemmuse P1 supports the replacement of a variety of fixed focus lenses, so when the lens is replaced, it is recommended that you recalibrate.
2. Please listen the OnStateUpdate, if the status is NOT_CALIBRATE, please recalibrate.
3. Please listen the hms error code, If you listen to the following error code, please recalibrate.
       hms_0x1C000D02: The camera calibration file failed to load, please perform infinity calibration.
       hms_0x1C000D03: Infinity focus calibration data expired. Recalibrate.
       hms_0x1C000D04: Infinity focus calibration data expired. Recalibrate.

The following are the calibration steps:
1. Take off and ascend to 102 meters (335ft) or higher to start calibration. Fly with caution.
2. Call startCalibration interface. The state will change to WAITING_FOR_CALIBRATE.
3. Set gimbal angle as -90 degrees(perpendicular to the ground). Call setFocusTarget interface to set the object with multiple distinct visual patterns at the center of the camera view as focus. Then the state will change to CALIBRATING.
4. After finish the calibration, the state will change to CALIBRATED. You can use DJICameraCalibrateResult to listen the calibration result.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallback callbackThe execution callback with the returned value(s).
@@ -4630,7 +4619,7 @@
Input Parameters:
void stopCalibration(@NonNull CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Stop camera calibraion.

Input Parameters:
@NonNull CommonCallbacks.CompletionCallback callbackThe execution callback with the returned value(s).
@@ -4639,7 +4628,7 @@
Input Parameters:
void calibratedInfinityFocus(@NonNull CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.camera
-
Description:
+
Description:

Make sure you have calibrated the lens' infinity focusing with startCalibration. 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).

Input Parameters:
@NonNull CommonCallbacks.CompletionCallback callbackThe execution callback with the returned value(s).
@@ -4649,7 +4638,7 @@
Inherited Methods:
void setComponentListener(ComponentListener listener)
Package:dji.sdk.base
-
Description:
+
Description:

Sets the listener for the DJI component.

Input Parameters:
ComponentListener listenerThe callback of ComponentListener.
@@ -4658,7 +4647,7 @@
Input Parameters:
int getIndex()
Package:dji.sdk.base
-
Description:
+
Description:

Returns the component index. Index is zero based. A component will have an index greater than zero when there are multiple components of the same type on the DJI product, and one of the components already has the index 0. For instance, M210 can have two gimbal mounted cameras, and will therefore have two gimbal components with indices 0 and 1, and two camera components with indices 0 and 1. For Matrice 600, there are printed numbers on the battery boxes. The Battery component instance with index 0 corresponds to battery compartment number 1. For Inspire 2 and M200 series, Battery with index 0 corresponds to the battery on the port (left hand) side of the aircraft. For M210, M210 RTK and M300 RTK, Camera and Gimbal with index 0 corresponds to the camera and gimbal on the port (left hand) side of the aircraft. Lidar with index 0 corresponds to the lidar(Zenmuse L1) on the port (left hand) side of the aircraft.

Return:
intAn int value of index.
@@ -4667,7 +4656,7 @@
Return:
boolean isConnected()
Package:dji.sdk.base
-
Description:
+
Description:

true if the component is connected.

Return:
booleantrue if the component is connected.
@@ -4676,7 +4665,7 @@
Return:
void getSerialNumber(@NonNull CompletionCallbackWith<String> callback)
Package:dji.sdk.base
-
Description:
+
Description:

Gets the serial number of the component. Depending on the component, this serial number might not match the serial number found on the physical component.

Input Parameters:
@NonNull CompletionCallbackWith<String> callbackThe execution callback with the value returned.
@@ -4685,7 +4674,7 @@
Input Parameters:
void getFirmwareVersion(@NonNull CompletionCallbackWith<String> callback)
Package:dji.sdk.base
-
Description:
+
Description:

Returns the firmware version of the component. Each component will have a different firmware version, the combination of which will form the package firmware version getFirmwarePackageVersion found in BaseProduct.

Input Parameters:
@NonNull CompletionCallbackWith<String> callbackThe execution callback with the value(s) returned.
diff --git a/docs/API Reference/Components/Camera/DJICamera_DJILens.html b/docs/API Reference/Components/Camera/DJICamera_DJILens.html index 2fc2c2d0..e9d334ee 100644 --- a/docs/API Reference/Components/Camera/DJICamera_DJILens.html +++ b/docs/API Reference/Components/Camera/DJICamera_DJILens.html @@ -1662,7 +1662,7 @@
Input Parameters:
Description:

Sets the spot metering area index of the current lens. The lens image is divided into 225 spots defined by 15 columns and 15 rows. The row index range is [0,14], where the values increase top to bottom across the image. The column index range is [0, 14], where the values increase left to right. In order to make the method work, The camera exposure mode should be Program, Shutter or Aperture, the exposure metering mode must be SPOT, and setAELock must be NO.

Input Parameters:
-
@NonNull Point spotIndexSpot metering point coordinate (x, y). x is column index to be set. The value should falls in [0, 11], where the values increase left to right. y is row index to be set. The value should falls in [0, 7], where the values increase top to bottom across the image.
@Nullable final CommonCallbacks.CompletionCallback callbackThe execution callback with the returned execution result.
+
@NonNull Point spotIndexSpot metering point coordinate (x, y). x is column index to be set. The value should falls in [0, 14], where the values increase left to right. y is row index to be set. The value should falls in [0, 14], where the values increase top to bottom across the image.
@Nullable final CommonCallbacks.CompletionCallback callbackThe execution callback with the returned execution result.
Spot Metering Target
method
getSpotMeteringTarget
method getSpotMeteringTarget
diff --git a/docs/API Reference/Components/Diagnostics/DJIDiagnostics.html b/docs/API Reference/Components/Diagnostics/DJIDiagnostics.html index 81e10830..8af6471b 100644 --- a/docs/API Reference/Components/Diagnostics/DJIDiagnostics.html +++ b/docs/API Reference/Components/Diagnostics/DJIDiagnostics.html @@ -1507,7 +1507,7 @@
Class Members:
Description:

Diagnostics components type.

Enum Members:
-
BATTERYBattery component.
CAMERACamera component.
CENTER_BOARDCenter board component.
ON_SCREEN_DISPLAYComponents' error often shown on the main screen.
FLIGHT_CONTROLLERFlight controller component.
GIMBALGimbal component.
LIGHTBRIDGELightbridge component.
REMOTE_CONTROLLERRemote controller component.
VISIONVision component.
RTKRTK component.
DEVICE_HEALTH_INFORMATIONDevice health information. Only supported by some components of Matrice 300 RTK and Zenmuse H20 series. It is recommended to use device health information to replace old diagnostics for flight controller and RTK. There will be a few duplicated component error for gimbal, battery, perception module on Matrice 300 RTK. Find error code and detailed description information in the Readme file on Github (https://github.com/dji-sdk/Mobile-SDK-Android/blob/master/README.md)
PRODUCTProduct component. It is used to listen the remote controller and aircraft disconnect status.
OTHEROther.
+
BATTERYBattery component.
CAMERACamera component.
CENTER_BOARDCenter board component.
ON_SCREEN_DISPLAYComponents' error often shown on the main screen.
FLIGHT_CONTROLLERFlight controller component.
GIMBALGimbal component.
LIGHTBRIDGELightbridge component.
REMOTE_CONTROLLERRemote controller component.
VISIONVision component.
RTKRTK component.
DEVICE_HEALTH_INFORMATIONDevice health information. Only supported by some components of Matrice 300 RTK and Zenmuse H20 series. It is recommended to use device health information to replace old diagnostics for flight controller and RTK. There will be a few duplicated component error for gimbal, battery, perception module on Matrice 300 RTK. Find error code and detailed description information in the Readme file on Github (https://github.com/dji-sdk/Mobile-SDK-Android/blob/master/README.md)
OTHEROther.
Class Members:
diff --git a/docs/API Reference/Components/FlightController/DJIFlightController.html b/docs/API Reference/Components/FlightController/DJIFlightController.html index 840f8a52..3f8dc2da 100644 --- a/docs/API Reference/Components/FlightController/DJIFlightController.html +++ b/docs/API Reference/Components/FlightController/DJIFlightController.html @@ -2181,59 +2181,95 @@
Description:

Return false if unlock takeoff without GPS.

Input Parameters:
@NonNull CompletionCallbackWith<Boolean> callbackCallback that receives the execution result.
+
Coordinated Turn
method
setCoordinatedTurnEnabled
+
method setCoordinatedTurnEnabled
+ +
void setCoordinatedTurnEnabled(@NonNull boolean enabled, @Nullable CompletionCallback<DJIError> callback)
+
Package:dji.sdk.flightcontroller
+
Description:
+

Enables the coordinated turn. Improves aerodynamic efficiency. The aircraft is flying in the direction of the turn, without sideslipping. Only supported by M300 RTK.

+
Input Parameters:
+
@NonNull boolean enabledtrue to enable the coordinated turn.
@Nullable CompletionCallback<DJIError> callbackCallback that receives the execution result.
+
+
method getCoordinatedTurnEnabled
+ +
void getCoordinatedTurnEnabled(@Nullable CompletionCallbackWith<Boolean> callback)
+
Package:dji.sdk.flightcontroller
+
Description:
+

Get whether the coordinated turn switch is on. Only supported by M300 RTK.

+
Input Parameters:
+
@Nullable CompletionCallbackWith<Boolean> callbackCallback that receives the execution result.
+
Navigation Satellite System
method
setNavigationSatelliteSystem
+
method setNavigationSatelliteSystem
+ +
void setNavigationSatelliteSystem(@NonNull NavigationSatelliteSystem system, @Nullable CompletionCallback<DJIError> callback)
+
Package:dji.sdk.flightcontroller
+
Description:
+

The selection of satellite positioning system is only supported when the RTK positioning function is turned off, and cannot be modified in the air. If RTK positioning function is turned on, aircraft uses GPS, GLONASS, Galileo, and BDS data to determine location. Only supported by M300 RTK.

+
Input Parameters:
+
@NonNull NavigationSatelliteSystem systemNavigation satellite system.
@Nullable CompletionCallback<DJIError> callbackCallback that receives the execution result.
+
+
method getNavigationSatelliteSystem
+ +
void getNavigationSatelliteSystem(@Nullable CompletionCallbackWith<NavigationSatelliteSystem> callback)
+
Package:dji.sdk.flightcontroller
+
Description:
+

Get the navigation satellite system. Only supported by M300 RTK.

+
Input Parameters:
+
@Nullable CompletionCallbackWith<NavigationSatelliteSystem> callbackCallback that receives the execution result.
Flight Limitation
method
setMaxFlightHeight
method setMaxFlightHeight
void setMaxFlightHeight(@IntRange(from = 20, to = 500) int maxHeight,
                                  @Nullable final CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.MAX_FLIGHT_HEIGHT
-
Description:
+
Description:

Sets the maximum flight height limitation of the aircraft. The maxHeight value must be in the range [20, 500] m.

-
Input Parameters:
+
Input Parameters:
@IntRange(from = 20, to = 500) int maxHeightMaximum height of the aircraft.
@Nullable final CompletionCallback callbackThe execution callback with the execution result returned.
method getMaxFlightHeight
void getMaxFlightHeight(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.MAX_FLIGHT_HEIGHT
-
Description:
+
Description:

Gets the maximum flight height limitation of the aircraft.

-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
method setMaxFlightRadius
void setMaxFlightRadius(@IntRange(from = 15, to = 8000) int maxRadius,
                                  @Nullable final CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.MAX_FLIGHT_RADIUS
-
Description:
+
Description:

Sets the maximum flight radius limitation of the aircraft. The radius is calculated from the home point. The maxRadius value must be in the range [15, 8000] m.

-
Input Parameters:
+
Input Parameters:
@IntRange(from = 15, to = 8000) int maxRadiusMaximum flight radius of the aircraft.
@Nullable final CompletionCallback callbackThe execution callback with the execution result returned.
method getMaxFlightRadius
void getMaxFlightRadius(@NonNull final CompletionCallbackWith<Integer> callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.MAX_FLIGHT_RADIUS
-
Description:
+
Description:

Gets the maximum flight radius limitation of the aircraft.

-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
method setMaxFlightRadiusLimitationEnabled
void setMaxFlightRadiusLimitationEnabled(boolean enabled, @Nullable final CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.MAX_FLIGHT_RADIUS_ENABLED
-
Description:
+
Description:

Sets whether the maximum flight radius limitation is enabled. If enabled is false, there is no maximum flight radius limitation.

-
Input Parameters:
+
Input Parameters:
boolean enabledMaximum flight radius limitation is enabled.
@Nullable final CompletionCallback callbackThe execution callback with the execution result returned.
method getMaxFlightRadiusLimitationEnabled
void getMaxFlightRadiusLimitationEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.MAX_FLIGHT_RADIUS_ENABLED
-
Description:
+
Description:

Gets the maximum flight radius limitation status (enabled/disabled).

-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).


Home

@@ -2242,63 +2278,63 @@

Home

void startGoHome(@Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.START_GO_HOME
-
Description:
+
Description:

The aircraft will start to go home. The completion callback will return execution result once this method is invoked.

-
Input Parameters:
+
Input Parameters:
@Nullable CompletionCallback callbackThe execution callback with the returned execution result.
method cancelGoHome
void cancelGoHome(@Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.CANCEL_GO_HOME
-
Description:
+
Description:

The aircraft will stop going home and will hover in place.

-
Input Parameters:
+
Input Parameters:
@Nullable CompletionCallback callbackThe execution callback with the returned execution result.
Location
method
setHomeLocation
method setHomeLocation
void setHomeLocation(@NonNull LocationCoordinate2D homeLocation,
                                        @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.HOME_LOCATION
-
Description:
+
Description:

Sets the home location of the aircraft. The home location is where the aircraft returns when commanded by startGoHome, when its signal is lost or when the battery is below the lowBatteryWarning threshold. The user should be careful setting a new home point location, as sometimes the product will not be under user control when returning home. A home location is valid if it is within 30m of one of the following:

  • initial take-off location
  • aircraft's current location
  • current mobile location with at least kCLLocationAccuracyNearestTenMeters accuracy level
  • current remote controller's location as shown by RC GPS.

-
Input Parameters:
+
Input Parameters:
@NonNull LocationCoordinate2D homeLocationHome location latitude and longitude in degrees.
@Nullable CompletionCallback callbackThe execution callback with the returned execution result.
method setHomeLocationUsingAircraftCurrentLocation
void setHomeLocationUsingAircraftCurrentLocation(@Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.HOME_LOCATION_USING_CURRENT_AIRCRAFT_LOCATION
-
Description:
+
Description:

Sets the home location of the aircraft to the current location of the aircraft. See setHomeLocation for details on home point use.

-
Input Parameters:
+
Input Parameters:
@Nullable CompletionCallback callbackThe execution callback with the returned execution result.
method getHomeLocation
void getHomeLocation(@NonNull CompletionCallbackWith<LocationCoordinate2D> callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.HOME_LOCATION
-
Description:
+
Description:

Gets the home point of the aircraft.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<LocationCoordinate2D> callbackThe execution callback with the returned value(s).
method setGoHomeHeightInMeters
void setGoHomeHeightInMeters(@IntRange(from = 20, to = 500) int height,
                                                @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.GO_HOME_HEIGHT_IN_METERS
-
Description:
+
Description:

Sets the minimum altitude, relative to where the aircraft took off, at which the aircraft must be before going home. This can be useful when the user foresees obstacles in the aircraft's flight path. If the aircraft's current altitude is higher than the minimum go home altitude, it will go home at its current altitude. The valid range for the altitude is from 20m to 500m. But if the aircraft is M300 RTK, the limit can beyond 500m.

-
Input Parameters:
+
Input Parameters:
@IntRange(from = 20, to = 500) int heightThe aircraft's default go home altitude.
@Nullable CompletionCallback callbackThe execution callback with the returned execution result.
method getGoHomeHeightInMeters
void getGoHomeHeightInMeters(@NonNull CompletionCallbackWith<Integer> callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.GO_HOME_HEIGHT_IN_METERS
-
Description:
+
Description:

Gets the minimum altitude (relative to the take-off location in meters) at which the aircraft must be before going home.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).


Fail Safes

@@ -2307,81 +2343,81 @@

Fail Safes

void setConnectionFailSafeBehavior(@NonNull ConnectionFailSafeBehavior behavior,
                                                      @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.CONNECTION_FAIL_SAFE_BEHAVIOR
-
Description:
+
Description:

Sets the FailSafe action for when the connection between remote controller and aircraft is lost. It is supported by Mavic Mini, DJI Mini 2, DJI Mini SE and Maivic Air 2.

-
Input Parameters:
+
Input Parameters:
@NonNull ConnectionFailSafeBehavior behaviorThe ConnectionFailSafeBehavior object.
@Nullable CompletionCallback callbackThe execution callback with the returned value(s).
method getConnectionFailSafeBehavior
void getConnectionFailSafeBehavior(
       @NonNull CompletionCallbackWith<ConnectionFailSafeBehavior> callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.CONNECTION_FAIL_SAFE_BEHAVIOR
-
Description:
+
Description:

Gets the FailSafe action for when the connection between remote controller and aircraft is lost.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<ConnectionFailSafeBehavior> callbackThe execution callback with the returned value(s).
method setLowBatteryWarningThreshold
void setLowBatteryWarningThreshold(@IntRange(from = 15, to = 50) int percent,
                                                      @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.LOW_BATTERY_WARNING_THRESHOLD
-
Description:
+
Description:

Sets the low battery warning threshold as a percentage. The percentage must be in the range of [15, 50]. It is not supported by Mavic Mini, DJI Mini 2, DJI Mini SE, Mavic Air 2 and DJI Air 2S.

-
Input Parameters:
+
Input Parameters:
@IntRange(from = 15, to = 50) int percentLow battery warning percentage.
@Nullable CompletionCallback callbackThe execution callback with the returned execution result.
method getLowBatteryWarningThreshold
void getLowBatteryWarningThreshold(@NonNull CompletionCallbackWith<Integer> callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.LOW_BATTERY_WARNING_THRESHOLD
-
Description:
+
Description:

Gets the low battery warning threshold as a percentage.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
method setSeriousLowBatteryWarningThreshold
void setSeriousLowBatteryWarningThreshold(@IntRange(from = 10, to = 45) int percent,
                                                             @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.SERIOUS_LOW_BATTERY_WARNING_THRESHOLD
-
Description:
+
Description:

Sets the serious low battery warning threshold as a percentage. The minimum value is 10. The maximum value is value from getLowBatteryWarningThreshold minus 5. It is supported by Mavic Mini, DJI Mini 2, DJI Mini SE, Mavic Air 2 and DJI Air 2S.

-
Input Parameters:
+
Input Parameters:
@IntRange(from = 10, to = 45) int percentSerious low battery warning percentage.
@Nullable CompletionCallback callbackThe execution callback with the returned execution result.
method getSeriousLowBatteryWarningThreshold
void getSeriousLowBatteryWarningThreshold(@NonNull CompletionCallbackWith<Integer> callback)
Package:dji.sdk.flightcontroller
SDK Key:FlightControllerKey.SERIOUS_LOW_BATTERY_WARNING_THRESHOLD
-
Description:
+
Description:

Gets the serious low battery warning threshold in percentage.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<Integer> callbackThe execution callback with the value(s) returned.
method setSmartReturnToHomeEnabled
void setSmartReturnToHomeEnabled(boolean enabled, @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Enables/disables Smart Return-To-Home (RTH) feature. When it is enabled, aircraft will request to go home when remaining battery is only enough for completing the go-home action. For Mavic Mini, DJI Mini 2, DJI Mini SE, the aircraft will return to home point when the remaning battery is low.

-
Input Parameters:
+
Input Parameters:
boolean enabledtrue to enable smart RTH.
@Nullable CompletionCallback callbackCompletion block that receives the setter execution result.
method getSmartReturnToHomeEnabled
void getSmartReturnToHomeEnabled(
       @NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Determines whether Smart Return-To-Home (RTH) feature is enabled or not. When it is enabled, aircraft will request to go home when remaining battery is only enough for completing the go-home action.

-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackCompletion callback that receives the execution result.
method confirmSmartReturnToHomeRequest
void confirmSmartReturnToHomeRequest(boolean confirmed, @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Confirms or cancels the Smart Return-To-Home (RTH) request. When Smart RTH is enabled, the aircraft will request to go home when the battery is only enough for going home. Before executing the go-home action, the aircraft will wait for the confirmation from users with 10 seconds count-down. If the "confirmed" parameter is false, the request is canceled and the aircraft will not execute go-home action. Otherwise, go-home action will start. Smart RTH will be triggered only once during the same flight. Flight controller with firmware version lower than 3.0.0.0 does not support confirming the Smart RTH request. User can either cancel the request or wait for the countdown to start go-home action. It is supported by Mavic Mini, DJI Mini 2, DJI Mini SE, DJI Air 2S and Mavic Air 2.

-
Input Parameters:
+
Input Parameters:
boolean confirmedtrue to confirm the request and the aircraft will start go-home immediately.
@Nullable CompletionCallback callbackCompletion block to receive the result.


Flight Mode

@@ -2390,70 +2426,70 @@

Flight Mode

void getRCSwitchFlightModeMapping(
       @NonNull CompletionCallbackWith<RemoteControllerFlightMode[]> callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Gets the mapping between the flight modes and the flight mode switch positions on the remote controller. Elements 0, 1, and 2 of the returned array map to POSITION_ONE, POSITION_TWO, and POSITION_THREE of the getFlightModeSwitch. The value of each Enum item represents the corresponding value of the RemoteControllerFlightMode Enum representing the flight mode.
The mapping is fixed for the Phantom series, Inspire series, Mavic Pro, and M100. For N3, A3, Matrice 600, and Matrice 600 Pro the mapping is firmware dependent. With firmware version 3.2.11.0 or above, the mapping can be customized in DJI Assistant 2.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<RemoteControllerFlightMode[]> callbackCompletion callback that receives the getter result. Each element of array is an instance with a value of RemoteControllerFlightMode.
Multiple Flight Mode
method
setMultipleFlightModeEnabled
method setMultipleFlightModeEnabled
void setMultipleFlightModeEnabled (boolean enabled, @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Enables/disables multiple-flight mode. When multiple-flight mode is enabled, user can change the aircraft's mode to P/F/A/S mode by toggling the switch on the remote controller. If it is disabled, the aircraft will be in P mode.

-
Input Parameters:
+
Input Parameters:
boolean enabledtrue to enable multiple-flight mode.
@Nullable CompletionCallback callbackCompletion callback that receives the execution result.
method getMultipleFlightModeEnabled
void getMultipleFlightModeEnabled (@NonNull CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Determines whether multiple-flight mode is enabled. When multiple-flight mode is enabled, user can change the aircraft's mode to P/F/A/S mode by toggling the switch on the remote controller. If it is disabled, the aircraft will be in P mode.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<Boolean> callbackCompletion callback that receives the execution result.
Novice Mode Enabled
method
setNoviceModeEnabled
method setNoviceModeEnabled
void setNoviceModeEnabled(boolean enabled, @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Enables novice mode. When novice mode is enabled, the flight speed will become slower and less responsive handling. For Phantom 4 Pro, enabling novice mode will enable the infrared time-of-flight (TOF) sensors on the left and right.

-
Input Parameters:
+
Input Parameters:
boolean enabledtrue to enable novice mode.
@Nullable CompletionCallback callbackCompletion block that receives the execution result.
method getNoviceModeEnabled
void getNoviceModeEnabled(@NonNull CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Determines whether novice mode is enabled or not. If novice mode is enabled, the flight speed is slower and less responsive handling. For Phantom 4 Pro, enabling novice mode will enable the infrared time-of-flight (TOF) sensors on the left and right.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<Boolean> callbackCompletion callback that receives the execution result.
Power Supply Port Enabled
method
setPowerSupplyPortEnabled
method setPowerSupplyPortEnabled
void setPowerSupplyPortEnabled(boolean enabled, @Nullable CompletionCallback callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Enables the power supply port. It is only supported by M200 series and M200 series v2.

-
Input Parameters:
+
Input Parameters:
boolean enabledtrue if power supply port is enabled.
@Nullable CompletionCallback callbackCallback that receives the execution result.
method getPowerSupplyPortEnabled
void getPowerSupplyPortEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:dji.sdk.flightcontroller
-
Description:
+
Description:

Determines whether the power supply port is enabled or not. It is only supported by M200 series and M200 series v2.

-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callbackCompletion block that receives the execution result.
Max Flight Height
method
hasReachedMaxFlightHeight
method hasReachedMaxFlightHeight
boolean hasReachedMaxFlightHeight()
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.HAS_REACHED_MAX_FLIGHT_HEIGHT
-
Description:
+
Description:

true if the aircraft has reached the maximum flight height.

Return:
booleanA boolean value.
@@ -2462,176 +2498,187 @@
Return:
boolean hasReachedMaxFlightRadius()
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.HAS_REACHED_MAX_FLIGHT_RADIUS
-
Description:
+
Description:

true if the aircraft has reached the maximum flight radius.

Return:
booleantrue if the aircraft has reached the maximum flight radius.


+
+
enum NavigationSatelliteSystem
+ +
enum NavigationSatelliteSystem
+
Package:dji.common.flightcontroller
+
Description:
+

This enum defines the navigation satellite system currently being used.

+
Enum Members:
+
GPS_GLONASSUsing GSP and GLONSS satellite data.
BEIDOUOnly use Beidou satellite navigation system.
+
Class Members:
+
enum VisionDrawHeadingMode
@EXClassNullAway
 enum VisionDrawHeadingMode
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.DRAW_HEADING_MODE
-
Description:
+
Description:

The heading mode of the camera used in the vision drawing the 3D orbit data.

-
Enum Members:
+
Enum Members:
FREEFree mode - Camera direction can be freely adjusted in flight.
FORWARDRegular mode - camera direction consistent with course direction.
UNKNOWNUnknown.
-
Class Members:
+
Class Members:
enum VisionDrawStatus
@EXClassNullAway
 enum VisionDrawStatus
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.DRAW_STATUS
-
Description:
+
Description:

State of the vision drawing the 3D orbit data.

-
Enum Members:
+
Enum Members:
INITInitializing.
PREPAREVision got the orbit data, and preparing to calculate the 3D orbit.
READY_TO_GOVision has generated the 3D orbit data, and start to download.
START_AUTOStarting State (Auto mode).
START_MANUALStaring State (Manual mode).
PAUSEPause state.
OTHEROther unknown state.
-
Class Members:
+
Class Members:
enum UrgentStopMotorMode
@EXClassNullAway
 enum UrgentStopMotorMode
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.URGENT_STOP_MOTOR_MODE
-
Description:
+
Description:

The Mode enum to urgent stop motor.

-
Enum Members:
+
Enum Members:
CSCCommand only for Inspire 2, Phantom 4, Phantom 4 Professional, Phantom 4 Advanced and M200 series.
NEVERCommand only for Inspire 2, Phantom 4, Phantom 4 Professional, Phantom 4 Advanced and M200 series.
IN_OUT_ALWAYSCommand only for DJI Mavic Pro and Mavic Air.
IN_OUT_WHEN_BREAKDOWNCommand only for DJI Mavic Pro and Mavic Air.
UNKNOWNUnknown.
-
Class Members:
+
Class Members:
Current State
class
FlightControllerState
Gravity Center State
class
GravityCenterState
Sensors
class
Compass
class
RTK
class
Radar
Access Locker
class
AccessLocker
Virtual Sticks
class
FlightControlData
enum VerticalControlMode
@EXClassNullAway
 enum VerticalControlMode
Package:dji.common.flightcontroller.virtualstick
-
Description:
+
Description:

Defines how vertical control values are interpreted by the aircraft.

-
Enum Members:
+
Enum Members:
VELOCITYSets the virtual stick vertical control values to be a vertical velocity. Positive and negative vertical velocity is for the aircraft ascending and descending respectively. Maximum vertical velocity is defined as 4 m/s. Minimum vertical velocity is defined as -4 m/s.
POSITIONSets the virtual stick vertical control values to be an altitude. Maximum position is defined as 500 m. Minimum position is defined as 0 m.
-
Class Members:
+
Class Members:
enum RollPitchControlMode
@EXClassNullAway
 enum RollPitchControlMode
Package:dji.common.flightcontroller.virtualstick
-
Description:
+
Description:

Defines how manual roll and pitch values are interpreted by the aircraft.

-
Enum Members:
+
Enum Members:
ANGLESets the roll and pitch values to be an angle relative to a level aircraft. In the body coordinate system, positive and negative pitch angle is for the aircraft rotating about the y-axis in the positive direction or negative direction, respectively. Positive and negative roll angle is the positive direction or negative direction rotation angle about the x-axis, respectively. However in the ground coordinate system, positive and negative pitch angle is the angle value for the aircraft moving south and north, respectively. Positive and negative roll angle is the angle when the aircraft is moving east and west, respectively. Maximum angle is defined as 30 degrees. Minimum angle is defined as -30 degrees.
VELOCITYSets the roll and pitch values to be a velocity. In the body coordinate system, positive and negative pitch velocity is for the aircraft moving towards the positive direction or negative direction along the pitch axis and y-axis, respectively. Positive and negative roll velocity is when the aircraft is moving towards the positive direction or negative direction along the roll axis and x-axis, respectively. However, in the ground coordinate system, positive and negative pitch velocity is for the aircraft moving east and west, respectively. Positive and negative roll velocity is when the aircraft is moving north and south, respectively. Maximum velocity is defined as 15 meters/s. Minimum velocity is defined as -15 meters/s.
-
Class Members:
+
Class Members:
enum YawControlMode
@EXClassNullAway
 enum YawControlMode
Package:dji.common.flightcontroller.virtualstick
-
Description:
+
Description:

Defines how manual yaw values are interpreted by the aircraft.

-
Enum Members:
+
Enum Members:
ANGLESets the yaw values to be an angle relative to the north. Positive and negative yaw angle is for the aircraft rotating clockwise and counterclockwise, respectively. Maximum yaw angle is defined as 180 degrees. Minimum yaw angle is defined as -180 degrees.
ANGULAR_VELOCITYSets the yaw values to be an angular velocity. Positive and negative angular velocity is for the aircraft rotating clockwise and counterclockwise, respectively. Maximum yaw angular velocity is defined as 100 degrees/s. Minimum yaw angular velocity is defined as -100 degrees/s.
-
Class Members:
+
Class Members:
enum FlightCoordinateSystem
@EXClassNullAway
 enum FlightCoordinateSystem
Package:dji.common.flightcontroller.virtualstick
-
Description:
+
Description:

Flight control coordinate system.

-
Enum Members:
+
Enum Members:
GROUNDGround coordinate system.
BODYBody coordinate system.
-
Class Members:
+
Class Members:
Flight Assistance
enum
ControlMode
enum ControlMode
@EXClassNullAway
 enum ControlMode
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.CONTROL_MODE
-
Description:
+
Description:

Control mode of the flight controller. It determines how the pilot can control the aircraft. By default, it is in smart control mode.

-
Enum Members:
+
Enum Members:
SMARTSmart control mode. The aircraft can stabilize its altitude and attitude in smart mode.
MANUALManual control mode. The aircraft will not stabilize its altitude and attitude in manual mode. This mode is for advanced pilots only, and should only be used when the pilot understands the risk of operating in this mode. Any damage to the product when operating in this mode will not be covered under warranty.
UNKNOWNUnknown control mode.
-
Class Members:
+
Class Members:
enum FlightOrientationMode
@EXClassNullAway
 enum FlightOrientationMode
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.ORIENTATION_MODE
-
Description:
+
Description:

Tells the aircraft how to interpret flight commands for forward, backward, left and right. See the Flight Controller User Guide for more information.

-
Enum Members:
+
Enum Members:
COURSE_LOCKThe aircraft should move relative to a locked course heading.
HOME_LOCKThe aircraft should move relative radially to the Home Point.
AIRCRAFT_HEADINGThe aircraft should move relative to the front of the aircraft.
-
Class Members:
+
Class Members:
Flight Wind Warning
enum
FlightWindWarning
enum FlightWindWarning
@EXClassNullAway
 enum FlightWindWarning
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.FLIGHT_WIND_WARNING
-
Description:
+
Description:

Warning caused by the strong wind.

-
Enum Members:
+
Enum Members:
LEVEL_0No wind warning.
LEVEL_1The wind speed is high. Fly with caution and ensure the aircraft remains within the line of sight.
LEVEL_2Strong Wind. Fly with caution and ensure the aircraft remains within line of sight. It is more serious than LEVEL_1.
UNKNOWNUnknown.
-
Class Members:
+
Class Members:
Obstacle Sensing Direction
enum
DJIFlightAssistantObstacleSensingDirection
enum DJIFlightAssistantObstacleSensingDirection
enum DJIFlightAssistantObstacleSensingDirection
Package:dji.common.flightcontroller.flightassistant
-
Description:
+
Description:

Obstacle sensing direction. It is only supported by Matrice 300 RTK.

-
Enum Members:
+
Enum Members:
UpwardUpward sensing. The upward distance range is 1.1m~30m
DownwardDownward sensing. The downward distance range is 0.6m~30m
HorizontalHorizontal Field. The horizontal distance range is 1.1m~40m
-
Class Members:
+
Class Members:
enum ConnectionFailSafeBehavior
@EXClassNullAway
 enum ConnectionFailSafeBehavior
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.CONNECTION_FAIL_SAFE_BEHAVIOR
-
Description:
+
Description:

Defines aircraft failsafe action when signal between the remote controller and the aircraft is lost.

-
Enum Members:
+
Enum Members:
HOVERHover.
LANDINGLanding.
GO_HOMEReturn-to-Home.
UNKNOWNUnknown.
-
Class Members:
+
Class Members:
enum RemoteControllerFlightMode
@EXClassNullAway
 enum RemoteControllerFlightMode
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.CURRENT_MODE
-
Description:
+
Description:

Flight modes that map to the flight mode switch on the remote controller.

-
Enum Members:
+
Enum Members:
PPositioning mode. GNSS and Vision Positioning Systems are used for positioning if they are available. For products without F mode, intelligent functions such as missions and intelligent orientation control can be performed in P-mode.
SSport mode. The maximum flight speed and responsiveness of the aircraft is increased in this mode.
AAttitude mode. The GNSS and Vision Positioning Systems are not used for positioning. The aircraft only uses the barometer to maintain altitude. If receiving a GNSS signal, the aircraft can automatically return home if the Remote Controller signal is lost and if the Home Point has been recorded successfully.
GGentle mode. The sensitivity and speed of aircraft will be substantially decreased in gentle mode.
MManual mode. The aircraft will not stabilize its altitude nor attitude in manual mode. This mode is for advanced pilots only, and should only be used when the pilot understands the risk of operating in this mode. Any damage to the product when operating in this mode will not be covered under warranty. It is supported by stand-alone A3 and N3 and can be enabled in Assistant 2.
FFunction mode. Performs the same as Positioning mode with intelligent functions such as missions and intelligent orientation control enabled.
TTripod Mode. This mode drops the aircraft's maximum speed and significantly reduces the control stick sensitivity of the remote controller to give the user the precision needed for accurate framing. It is only supported by Mavic 2.
UNKNOWNUnknown mode.
-
Class Members:
+
Class Members:
enum SmartRTHState
@EXClassNullAway
 enum SmartRTHState
Package:dji.common.flightcontroller
-
Description:
+
Description:

State of Smart Return-To-Home (RTH). It is only used when Smart RTH is enabled.

-
Enum Members:
+
Enum Members:
IDLESmart RTH is not triggered yet in the current flight. The Smart RTH state will be reset to this value when the aircraft lands.
COUNTING_DOWNSmart RTH is triggered and the aircraft is counting down. If no response is received within 10 seconds or the user confirms the request, the aircraft will start to go home and the state will change to EXECUTED. If user cancels the request, the state will change to CANCELLED.
EXECUTEDSmart RTH is already executed in the current flight. The state will not be reset until the aircraft lands.
CANCELLEDSmart RTH request is cancelled by the user. The state will not be reset until the aircraft lands.
UNKNOWNUnknown.
-
Class Members:
+
Class Members:
Air Sense System Info
class
AirSenseSystemInformation
LED Settings
class
LEDsSettings
Limits
class
Limits
Fixed Wing Control
enum
FixedWingControl
enum FixedWingControl
enum FixedWingControl
Package:dji.common.flightcontroller
SDK Key:FlightControllerKey.FIXED_WING_CONTROL
-
Description:
+
Description:

The aircraft will fly forward automatically at a certain speed after entering Fixed-Wing Mode. Push the left stick up to ascend and down to descend. Push either stick left or right to rotate the aircraft. Push the right stick up to accelerate and pushing down will exit Fixed-Wing Mode. See the Flight Controller User Guide for more information.

-
Enum Members:
+
Enum Members:
READYPrepare fixed-wing mode.
ENTEREnter fixed-wing mode.
EXITExit fixed-wing mode.
OTHEROther reservations.
-
Class Members:
+
Class Members:
Inherited Methods:
dji.sdk.base.BaseComponent
method
setComponentListener
@@ -2639,16 +2686,16 @@
Inherited Methods:
void setComponentListener(ComponentListener listener)
Package:dji.sdk.base
-
Description:
+
Description:

Sets the listener for the DJI component.

-
Input Parameters:
+
Input Parameters:
ComponentListener listenerThe callback of ComponentListener.
method
getIndex
method getIndex
int getIndex()
Package:dji.sdk.base
-
Description:
+
Description:

Returns the component index. Index is zero based. A component will have an index greater than zero when there are multiple components of the same type on the DJI product, and one of the components already has the index 0. For instance, M210 can have two gimbal mounted cameras, and will therefore have two gimbal components with indices 0 and 1, and two camera components with indices 0 and 1. For Matrice 600, there are printed numbers on the battery boxes. The Battery component instance with index 0 corresponds to battery compartment number 1. For Inspire 2 and M200 series, Battery with index 0 corresponds to the battery on the port (left hand) side of the aircraft. For M210, M210 RTK and M300 RTK, Camera and Gimbal with index 0 corresponds to the camera and gimbal on the port (left hand) side of the aircraft. Lidar with index 0 corresponds to the lidar(Zenmuse L1) on the port (left hand) side of the aircraft.

Return:
intAn int value of index.
@@ -2657,7 +2704,7 @@
Return:
boolean isConnected()
Package:dji.sdk.base
-
Description:
+
Description:

true if the component is connected.

Return:
booleantrue if the component is connected.
@@ -2666,18 +2713,18 @@
Return:
void getSerialNumber(@NonNull CompletionCallbackWith<String> callback)
Package:dji.sdk.base
-
Description:
+
Description:

Gets the serial number of the component. Depending on the component, this serial number might not match the serial number found on the physical component.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<String> callbackThe execution callback with the value returned.
method getFirmwareVersion
void getFirmwareVersion(@NonNull CompletionCallbackWith<String> callback)
Package:dji.sdk.base
-
Description:
+
Description:

Returns the firmware version of the component. Each component will have a different firmware version, the combination of which will form the package firmware version getFirmwarePackageVersion found in BaseProduct.

-
Input Parameters:
+
Input Parameters:
@NonNull CompletionCallbackWith<String> callbackThe execution callback with the value(s) returned.
diff --git a/docs/API Reference/Components/IntelligentFlightAssistant/DJIFlightAssistantPerceptionState.html b/docs/API Reference/Components/IntelligentFlightAssistant/DJIFlightAssistantPerceptionState.html index 659faf60..522cc4e0 100644 --- a/docs/API Reference/Components/IntelligentFlightAssistant/DJIFlightAssistantPerceptionState.html +++ b/docs/API Reference/Components/IntelligentFlightAssistant/DJIFlightAssistantPerceptionState.html @@ -1484,7 +1484,7 @@
Return:
int getDownwardObstacleDistance()
Package:dji.common.flightcontroller.flightassistant
Description:
-

The downward obstacle distance.

+

The downward obstacle distance. Not supported by Mavic Air 2 and DJI Air 2S

Return:
intAn int value of downward obstacle distance.
diff --git a/docs/API Reference/Components/KeyManager/DJICameraKey.html b/docs/API Reference/Components/KeyManager/DJICameraKey.html index d25eedcd..3713466e 100644 --- a/docs/API Reference/Components/KeyManager/DJICameraKey.html +++ b/docs/API Reference/Components/KeyManager/DJICameraKey.html @@ -1665,7 +1665,7 @@
Class Keys:

getMediaFileCustomInformation

ANTI_FLICKER_RANGE

Access:

PUSH

Type:

AntiFlickerFrequency[]

API:

AntiFlickerFrequency

-

STORAGE_STATE

Access:

PUSH

Type:

SettingsDefinitions.SDCardOperationState

API:

-

COLOR_WAVEFORM_DISPLAY_STATE

Access:

PUSH, SET

Type:

ColorWaveformSettings.ColorWaveformDisplayState

API:

+

STORAGE_STATE

Access:

PUSH

Type:

SettingsDefinitions.SDCardOperationState

API:

-

COLOR_WAVEFORM_DISPLAY_STATE

Access:

PUSH, SET

Type:

ColorWaveformSettings.ColorWaveformDisplayState

API:

ColorWaveformDisplayState

OPTICAL_ZOOM_SPEC

Access:

PUSH

Type:

OpticalZoomSpec

API:

getOpticalZoomSpec

@@ -1777,7 +1777,7 @@
Class Keys:

getPhotoRAWBurstCount

PhotoBurstCount

-

INNERSTORAGE_STATE

Access:

PUSH

Type:

SettingsDefinitions.SDCardOperationState

API:

-

SDCARD_AVAILABLE_RECORDING_TIME_IN_SECONDS

Access:

PUSH

Type:

Integer

API:

+

INNERSTORAGE_STATE

Access:

PUSH

Type:

SettingsDefinitions.SDCardOperationState

API:

-

SDCARD_AVAILABLE_RECORDING_TIME_IN_SECONDS

Access:

PUSH

Type:

Integer

API:

getAvailableRecordingTimeInSeconds

IS_SHOOTING_SINGLE_PHOTO

Access:

PUSH

Type:

Boolean

API:

isShootingSinglePhoto

@@ -1887,7 +1887,7 @@
Class Keys:

ThermalProfile

STOP_RECORD_VIDEO_IN_CACHE

Access:

ACTION

Type:

-

API:

-

EI_COLOR

Access:

PUSH, SET

Type:

SettingsDefinitions.EIColor

API:

EIColor

-

ZOOM_BOX_RELATIVE_FOV

Access:

PUSH

Type:

ZoomRelativeFov

API:

-

IS_INTERNAL_STORAGE_SUPPORTED

Access:

PUSH

Type:

Boolean

API:

-

SDCARD_STATE

Access:

PUSH

Type:

SettingsDefinitions.SDCardOperationState

API:

-

IS_SHOOTING_PHOTO_ENABLED

Access:

PUSH

Type:

Boolean

API:

-

ISO_RANGE

Access:

PUSH

Type:

ISO[]

API:

+

ZOOM_BOX_RELATIVE_FOV

Access:

PUSH

Type:

ZoomRelativeFov

API:

-

IS_INTERNAL_STORAGE_SUPPORTED

Access:

PUSH

Type:

Boolean

API:

-

SDCARD_STATE

Access:

PUSH

Type:

SettingsDefinitions.SDCardOperationState

API:

-

IS_SHOOTING_PHOTO_ENABLED

Access:

PUSH

Type:

Boolean

API:

-

ISO_RANGE

Access:

PUSH

Type:

ISO[]

API:

ISO

ISORange

diff --git a/docs/API Reference/Components/LiveStreamManager/DJILiveStreamManager.html b/docs/API Reference/Components/LiveStreamManager/DJILiveStreamManager.html index 684360fc..d25ff0af 100644 --- a/docs/API Reference/Components/LiveStreamManager/DJILiveStreamManager.html +++ b/docs/API Reference/Components/LiveStreamManager/DJILiveStreamManager.html @@ -1493,12 +1493,12 @@
Return:
method startStream
-
int startStream()
+
synchronized int startStream()
Package:dji.sdk.sdkmanager
Description:

Starts the live streaming. If the manager starts successfully, isStreaming will return true. The encoder will start to encoding the video frame if it is needed. The video will be streamed to the RTMP server if the server is available. The audio can be streamed along with the video if the audio setting is enabled.

Return:
-
intAn int value of the error code. 0 means success. 254 means initialization error. -2，means livestream feature is disabled by LDM. -3 means failure to obtain sps/pps.
+
synchronized intAn int value of the error code. 0 means success. 254 means initialization error. -2，means livestream feature is disabled by LDM. -3 means failure to obtain sps/pps.
method stopStream
diff --git a/docs/API Reference/Components/Missions/DJIActiveTrackMissionOperator.html b/docs/API Reference/Components/Missions/DJIActiveTrackMissionOperator.html index 23e5a07c..e7087d05 100644 --- a/docs/API Reference/Components/Missions/DJIActiveTrackMissionOperator.html +++ b/docs/API Reference/Components/Missions/DJIActiveTrackMissionOperator.html @@ -1659,9 +1659,9 @@
Input Parameters:
void switchSpotlightMode(@NonNull SpotlightMode spotlightMode, @NonNull CommonCallbacks.CompletionCallback callback)
Package:dji.sdk.mission.activetrack
Description:
-

Changes the Spotlight submode on the currently executing mission, It is only supported by Matrice 300 RTK.

+

Changes the spotlight submode on the currently executing mission, It is only supported by Matrice 300 RTK.

Input Parameters:
-
SOURCE_DIFFERENT modeSpotlight submode to change.
@NonNull CommonCallbacks.CompletionCallback callbackThe execution callback with the returned execution result.
+
@NonNull SpotlightMode spotlightModeSpotlight submode to change.
@NonNull CommonCallbacks.CompletionCallback callbackThe execution callback with the returned execution result.
Recommended Configuration
method
setRecommendedConfiguration
method setRecommendedConfiguration
diff --git a/docs/API Reference/Components/Missions/WaypointV2MissionOperatorListenerInterface.html b/docs/API Reference/Components/Missions/WaypointV2MissionOperatorListenerInterface.html index dd4bd87a..82606c86 100644 --- a/docs/API Reference/Components/Missions/WaypointV2MissionOperatorListenerInterface.html +++ b/docs/API Reference/Components/Missions/WaypointV2MissionOperatorListenerInterface.html @@ -1493,8 +1493,7 @@
Input Parameters:
Package:dji.sdk.mission.waypoint
Description:

Called when the waypoint mission is stopped by the user.

-
Input Parameters:
-
SOURCE_DIFFERENT errorError if the waypoint mission didn't end as expected.
+ diff --git a/docs/API Reference/Components/RemoteController/DJIRemoteController.html b/docs/API Reference/Components/RemoteController/DJIRemoteController.html index a63ee283..3990ed90 100644 --- a/docs/API Reference/Components/RemoteController/DJIRemoteController.html +++ b/docs/API Reference/Components/RemoteController/DJIRemoteController.html @@ -1800,7 +1800,7 @@
Description:
static final String DisplayNameMavicMini = DJIRCAbstraction.DisplayNameWM160
Package:dji.sdk.remotecontroller
Description:
-

The display name of Mavic Mini's remote controller.

+

The display name of Mavic Mini/DJI Mini SE's remote controller.

final DisplayNameMavicAir2
diff --git a/docs/API Reference/Components/SDKError/DJIError_DJIFlightControllerError.html b/docs/API Reference/Components/SDKError/DJIError_DJIFlightControllerError.html index 83730392..b9adcd16 100644 --- a/docs/API Reference/Components/SDKError/DJIError_DJIFlightControllerError.html +++ b/docs/API Reference/Components/SDKError/DJIError_DJIFlightControllerError.html @@ -1600,12 +1600,20 @@
Description:
Description:

The base station fell. Land the aircraft to re-establish the connection to the base station.

+
+
final NAVIGATION_SATELLITE_SYSTEM_CAN_NOT_SET
+ +
static final DJIFlightControllerError NAVIGATION_SATELLITE_SYSTEM_CAN_NOT_SET = new DJIFlightControllerError("The selection of navigation satellite system is only supported when the RTK function is turned off, and cannot be modified in the air")
+
Package:dji.common.error
+
Description:
+

The selection of navigation satellite system is only supported when the RTK function is turned off, and cannot be modified in the air.

+
final BASE_STATION_PARAMETER_NUMBER_NOT_MATCH
static final DJIFlightControllerError BASE_STATION_PARAMETER_NUMBER_NOT_MATCH = new DJIFlightControllerError("Base station internal error. Parameter numbers do not match. Please contact <dev@dji.com>.")
Package:dji.common.error
-
Description:
+
Description:

Base station internal error. Parameter numbers do not match. Please contact https://djisdksupport.zendesk.com/hc/requests/new.

@@ -1613,7 +1621,7 @@
Description:
static final DJIFlightControllerError BASE_STATION_PARAMETER_LENGTH_NOT_MATCH = new DJIFlightControllerError("Base station internal error. Parameters' length do not match. Please contact <dev@dji.com>.")
Package:dji.common.error
-
Description:
+
Description:

Base station internal error. Parameters' length do not match. Please contact https://djisdksupport.zendesk.com/hc/requests/new.

@@ -1621,7 +1629,7 @@
Description:
static final DJIFlightControllerError BASE_STATION_PARAMETER_READ_ONLY = new DJIFlightControllerError("Base station internal error. Parameters read only. Please contact <dev@dji.com>.")
Package:dji.common.error
-
Description:
+
Description:

Base station internal error. Parameters read only. Please contact https://djisdksupport.zendesk.com/hc/requests/new.

@@ -1629,7 +1637,7 @@
Description:
static final DJIFlightControllerError GRAVITY_CENTER_CALIBRATION_NOT_FLYING= new DJIFlightControllerError("The aircraft cannot start the gravity center calibration because it is not flying.")
Package:dji.common.error
-
Description:
+
Description:

The aircraft cannot start the gravity center calibration because it is not flying.

@@ -1637,7 +1645,7 @@
Description:
static final DJIFlightControllerError GRAVITY_CENTER_CALIBRATION_NOT_FLYING_NOT_WORK_IN_SIMULATOR = new DJIFlightControllerError("The aircraft cannot start the gravity center calibration because the simulator starts.")
Package:dji.common.error
-
Description:
+
Description:

The aircraft cannot start the gravity center calibration because the simulator starts.

@@ -1645,7 +1653,7 @@
Description:
static final DJIFlightControllerError GRAVITY_CENTER_CALIBRATION_IS_RUNNING = new DJIFlightControllerError("The aircraft cannot start the gravity center calibration before the previous calibration finishes.")
Package:dji.common.error
-
Description:
+
Description:

The aircraft cannot start the gravity center calibration before the previous calibration finishes.

@@ -1653,7 +1661,7 @@
Description:
static final DJIFlightControllerError GRAVITY_CENTER_CALIBRATION_NOT_HOVERING = new DJIFlightControllerError("The aircraft cannot start the gravity center calibration because it is not hovering.")
Package:dji.common.error
-
Description:
+
Description:

The aircraft cannot start the gravity center calibration because it is not hovering.

@@ -1661,7 +1669,7 @@
Description:
static final DJIFlightControllerError GRAVITY_CENTER_CALIBRATION_STOPPED_BY_USER = new DJIFlightControllerError("The gravity center calibration is stopped by the user.")
Package:dji.common.error
-
Description:
+
Description:

The gravity center calibration is stopped by the user.

@@ -1669,7 +1677,7 @@
Description:
static final DJIFlightControllerError GRAVITY_CENTER_CALIBRATION_FAILED_IN_BIG_WIND = new DJIFlightControllerError("The gravity center calibration is interrupted because the wind is too strong.")
Package:dji.common.error
-
Description:
+
Description:

The gravity center calibration is interrupted because the wind is too strong.

@@ -1677,7 +1685,7 @@
Description:
static final DJIFlightControllerError OWNER_OFFLINE_ERROR= new DJIFlightControllerError("The current rc is offline")
Package:dji.common.error
-
Description:
+
Description:

Owner offline error.

@@ -1685,7 +1693,7 @@
Description:
static final DJIFlightControllerError DEVICE_LOCKED_ERROR= new DJIFlightControllerError("The device to lock is locked")
Package:dji.common.error
-
Description:
+
Description:

Device locked error.

@@ -1693,7 +1701,7 @@
Description:
static final DJIFlightControllerError OWNER_OUT_CONTROL_ERROR= new DJIFlightControllerError("The current rc does not have this device control permission.")
Package:dji.common.error
-
Description:
+
Description:

Owner out control error.

@@ -1701,7 +1709,7 @@
Description:
static final DJIFlightControllerError COMMAND_NOT_SUPPORTED_BY_CURRENT_ATTITUDE = new DJIFlightControllerError("The command cannot be executed with the current attitude.")
Package:dji.common.error
-
Description:
+
Description:

The command cannot be executed with the current attitude.

@@ -1709,7 +1717,7 @@
Description:
static final DJIFlightControllerError BASE_STATION_NEED_LOGIN = new DJIFlightControllerError("For Matrice 300 RTK, you must login before set name, or set referencingLocation etc.")
Package:dji.common.error
-
Description:
+
Description:

For Matrice 300 RTK, you must login before you can set name, or use setBaseStationReferencingLocation etc.

@@ -1717,7 +1725,7 @@
Description:
static final DJIFlightControllerError CANNOT_BASE_STATION_SCAN_IN_FLYING = new DJIFlightControllerError("For Matrice 300 RTK, you could not trigger scan base station when flying")
Package:dji.common.error
-
Description:
+
Description:

For Matrice 300 RTK, you cannot scan fro a base station while flying.

@@ -1725,7 +1733,7 @@
Description:
static final DJIFlightControllerError BASE_STATION_PASSWORD_INVALID =
truetruenew DJIFlightControllerError("Base station administrator account's password is invalid. Please login again. If you reset your password, please use the default password.")
Package:dji.common.error
-
Description:
+
Description:

Base station administrator account password is invalid. Please login again. If you reset your password, please use the default password.

Inherited Methods:
@@ -1734,7 +1742,7 @@
Inherited Methods:
static DJIError getDJIError(int errorCode)
Package:dji.common.error
-
Description:
+
Description:

Returns the specific error in the DJIFlightHubError according to the error code.

Input Parameters:
int errorCodeerrorCode for DJIFlightHubError.
@@ -1745,7 +1753,7 @@
Return:
static DJIError getDJIError(int errorCode)
Package:dji.sdk.utmiss
-
Description:
+
Description:

Get DJIUTMISSError.

Input Parameters:
int errorCodeAn int value of error code.
@@ -1756,7 +1764,7 @@
Return:
String getDescription()
Package:dji.common.error
-
Description:
+
Description:

Returns the description of the error code.

Return:
StringThe description of the error code.
@@ -1765,7 +1773,7 @@
Return:
void setDescription(String desc)
Package:dji.common.error
-
Description:
+
Description:

Sets the description for the error code.

Input Parameters:
String descDescription string.
diff --git a/docs/API Reference/Components/SDKError/DJIError_DJIWaypointV2Error.html b/docs/API Reference/Components/SDKError/DJIError_DJIWaypointV2Error.html index 0d789bd0..9b743e6a 100644 --- a/docs/API Reference/Components/SDKError/DJIError_DJIWaypointV2Error.html +++ b/docs/API Reference/Components/SDKError/DJIError_DJIWaypointV2Error.html @@ -1846,12 +1846,44 @@
Description:
Description:

The action associate trigger getType is invalid.

+
+
method DJIWaypointV2Error
+ +
static DJIWaypointV2Error ACTION_INTERVAL_TRIGGER_WAYPOINT_INDEX_INVALID
           = new DJIWaypointV2Error("The action trigger waypoint index is invalid.", -8007)
+
Package:dji.common.error
+
Description:
+

The action associate trigger waypoint index invalid.

+
+
+
method DJIWaypointV2Error
+ +
static DJIWaypointV2Error ACTION_ACTUATOR_STATUS_NOT_MATCH_ACTION
           = new DJIWaypointV2Error("The actuator state does not match action.", -9004)
+
Package:dji.common.error
+
Description:
+

The actuator state does not match action.

+
+
+
method DJIWaypointV2Error
+ +
static DJIWaypointV2Error ACTION_ACTUATOR_OPERATION_INDEX_INVALID
           = new DJIWaypointV2Error("The action actuator operation index is invalid.", -9005)
+
Package:dji.common.error
+
Description:
+

The action actuator operation index is invalid.

+
+
+
method DJIWaypointV2Error
+ +
static DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_EXEC_FAIL
           = new DJIWaypointV2Error("Camera fail to exec coressponding command.", -15008)
+
Package:dji.common.error
+
Description:
+

Camera failed to execute coressponding command.

+
method DJIWaypointV2Error
static DJIWaypointV2Error ACTION_ACTUATOR_NOT_SUPPORT
           = new DJIWaypointV2Error("The action actuator is not supported.", -9001)
Package:dji.common.error
-
Description:
+
Description:

The action actuator is not supported.

@@ -1859,7 +1891,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_TYPE_INVALID
           = new DJIWaypointV2Error("The action actuator type is invalid.", -9002)
Package:dji.common.error
-
Description:
+
Description:

The action actuator getActuatorType is invalid.

@@ -1867,7 +1899,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_OPERATION_TYPE_INVALID
           = new DJIWaypointV2Error("The action actuator operation type is invalid.", -9003)
Package:dji.common.error
-
Description:
+
Description:

The action actuator operation type is invalid. See getCameraOperationType or getAircraftControlType or getOperationType.

@@ -1875,7 +1907,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_GIMBAL_PARAM_INVALID
           = new DJIWaypointV2Error("The action gimbal actuator parameters invalid.", -11001)
Package:dji.common.error
-
Description:
+
Description:

The action gimbal actuator parameters are invalid.

@@ -1883,7 +1915,7 @@
Description:
static DJIWaypointV2Error ACTION_ROTATE_GIMBAL_FAILED
           = new DJIWaypointV2Error("The action actuator rotate gimbal failed.", -11004)
Package:dji.common.error
-
Description:
+
Description:

The action actuator rotate gimbal failed.

@@ -1891,7 +1923,7 @@
Description:
static DJIWaypointV2Error ACTION_STOP_GIMBAL_UNIFORM_CONTROL_FAILED
           = new DJIWaypointV2Error("Gimbal is not mounted or unable to execute stop rotation command.", -11005)
Package:dji.common.error
-
Description:
+
Description:

Gimbal is not mounted or unable to execute stop rotation command.

@@ -1899,7 +1931,7 @@
Description:
static DJIWaypointV2Error ACTION_FLIGHT_TYPE_NOT_SUPPORT_HOVER
           = new DJIWaypointV2Error("The current waypoint type(Coordinated turn or Curved route Aircraft continues) does not support setting the action when the waypoint is reached.", -12007)
Package:dji.common.error
-
Description:
+
Description:

The current waypoint type(Coordinated turn or Curved route Aircraft continues) does not support setting the action when the waypoint is reached.

@@ -1907,7 +1939,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_NAVIGATION_FAIL_TO_PRECISE_SHOOTPOHTO
           = new DJIWaypointV2Error("Take precise photo failed.", -14001)
Package:dji.common.error
-
Description:
+
Description:

Failed to take precise photos.

@@ -1915,7 +1947,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_NAVIGATION_PRECISE_SHOOTPOHTO_TIMEOUT
           = new DJIWaypointV2Error("Take precise photo timeout.", -14002)
Package:dji.common.error
-
Description:
+
Description:

Timeout for taking precise photos.

@@ -1923,7 +1955,7 @@
Description:
static DJIWaypointV2Error ACTION_ROTATE_AIRCRAFT_YAW_PARAM_INVALID
           = new DJIWaypointV2Error("The action of rotate aircraft yaw parameters are invalid.", -12001)
Package:dji.common.error
-
Description:
+
Description:

The action WaypointAircraftControlParam parameters are invalid.

@@ -1931,7 +1963,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_NAVIGATION_EXEC_FAILED
           = new DJIWaypointV2Error("Navigation command execute failed", -14003)
Package:dji.common.error
-
Description:
+
Description:

Failed to execute navigation command.

@@ -1939,7 +1971,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_SEND_SINGLE_SHOT_CMD_TO_CAMERA_FAILED
           = new DJIWaypointV2Error("Fail to send shoot photo command to camera cause of no camera or camera is busy", -15001)
Package:dji.common.error
-
Description:
+
Description:

Failed to send shoot photo command to camera cause of no camera or camera is busy.

@@ -1947,7 +1979,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_SEND_VIDEO_START_CMD_TO_CAMERA_FAILED
           = new DJIWaypointV2Error("Fail to send start record command to camera cause of no camera or camera is busy. ", -15002)
Package:dji.common.error
-
Description:
+
Description:

Failed to send start record command to camera cause of no camera or camera is busy.

@@ -1955,7 +1987,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_SEND_VIDEO_STOP_CMD_TO_CAMERA_FAILED
           = new DJIWaypointV2Error("Fail to send video stop command to camera cause of no camera or camera is not busy", -15003)
Package:dji.common.error
-
Description:
+
Description:

Failed to send video stop command to camera cause of no camera or camera is not busy.

@@ -1963,7 +1995,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_FOCUS_PARAM_XY_INVALID
           = new DJIWaypointV2Error("Camera focus param xy exceed valid range [0, 1].", -15004)
Package:dji.common.error
-
Description:
+
Description:

Camera focus param xy exceed valid range [0, 1].

@@ -1971,7 +2003,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_SEND_FOCUS_CMD_TO_CAMERA_FAILED
           = new DJIWaypointV2Error("Fail to send camera focus command cause of no camera or camera is busy.", -15005)
Package:dji.common.error
-
Description:
+
Description:

Failed to send camera focus command cause of no camera or camera is busy.

@@ -1979,7 +2011,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_SEND_FOCALIZE_CMD_TO_CAMERA_FAILED
           = new DJIWaypointV2Error("Fail to send camera zoom command cause of no camera or camera is busy. ", -15006)
Package:dji.common.error
-
Description:
+
Description:

Failed to send camera zoom command cause of no camera or camera is busy.

@@ -1987,7 +2019,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_FOCAL_DISTANCE_INVALID
           = new DJIWaypointV2Error("Illegal zoom focal length.", -15007)
Package:dji.common.error
-
Description:
+
Description:

Illegal zoom focal length.

@@ -1995,7 +2027,7 @@
Description:
static DJIWaypointV2Error ACTION_ROTATE_AIRCRAFT_YAW_FAILED
           = new DJIWaypointV2Error("The action actuator rotate aircraft yaw execute failed.", -12002)
Package:dji.common.error
-
Description:
+
Description:

The action actuator rotate aircraft yaw execute failed.

@@ -2003,7 +2035,7 @@
Description:
static DJIWaypointV2Error ACTION_AIRCRAFT_START_STOP_FLY_FAILED
           = new DJIWaypointV2Error("The action actuator aircraft start stop fly execute failed.", -12004)
Package:dji.common.error
-
Description:
+
Description:

The action actuator aircraft start or stop fly execute failed. For example: when the aircraft is flying, an error will occur when the isStartFly(TRUE) action is executed. You should execute isStartFly(FALSE) first.

@@ -2011,7 +2043,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INTERRUPT_REASON_AVOID
           = new DJIWaypointV2Error("Waypoint mission was interrupted due to obstacle avoidance.", -13)
Package:dji.common.error
-
Description:
+
Description:

The waypoint mission is interrupted by by obstacle avoidance system.

@@ -2019,7 +2051,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INTERRUPT_REASON_AVOID_RADIUS_LIMIT
           = new DJIWaypointV2Error("Waypoint mission was interrupted due to reaching radius limit.", -14)
Package:dji.common.error
-
Description:
+
Description:

The waypoint mission is interrupted because of radius limit.

@@ -2027,7 +2059,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INTERRUPT_REASON_AVOID_HEIGHT_LIMIT
           = new DJIWaypointV2Error("Waypoint mission was interrupted due to height limit.", -15)
Package:dji.common.error
-
Description:
+
Description:

The waypoint mission is interrupted because of height limit.

@@ -2035,7 +2067,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INTERRUPT_REASON_AVOID_RTK_UNHEALTHY
           = new DJIWaypointV2Error("Waypoint mission was interrupted due to weak RTK signal.", -16)
Package:dji.common.error
-
Description:
+
Description:

The waypoint mission is interrupted because of RTK week signal.

@@ -2043,7 +2075,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INTERRUPT_REASON_AVOID_USER_REQ_BREAK
           = new DJIWaypointV2Error("Waypoint mission was interrupted due to interrupted by user.", -17)
Package:dji.common.error
-
Description:
+
Description:

The waypoint mission is interrupted because of user request.

@@ -2051,7 +2083,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_COMMAND_CANNOT_EXECUTE
           = new DJIWaypointV2Error("Command cannot execute.", -1)
Package:dji.common.error
-
Description:
+
Description:

Command cannot execute.

@@ -2059,7 +2091,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_COMMAND_EXECUTION_FAILED
           = new DJIWaypointV2Error("Command execution failed.", -2)
Package:dji.common.error
-
Description:
+
Description:

Command execution failed.

@@ -2067,7 +2099,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INVALID_PARAMETERS
           = new DJIWaypointV2Error("Invalid parameters.", -3)
Package:dji.common.error
-
Description:
+
Description:

Invalid parameters.

@@ -2075,7 +2107,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_COMMON_TIMEOUT
           = new DJIWaypointV2Error("Common timeout.", -4)
Package:dji.common.error
-
Description:
+
Description:

Common timeout.

@@ -2083,7 +2115,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_PRODUCT_CONNECT_FAILED
           = new DJIWaypointV2Error("Product connection failed.", -5)
Package:dji.common.error
-
Description:
+
Description:

Product connection failed.

@@ -2091,7 +2123,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_SYSTEM_BUSY
           = new DJIWaypointV2Error("System busy.", -6)
Package:dji.common.error
-
Description:
+
Description:

System busy.

@@ -2099,7 +2131,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_OPERATION_CANCEL_BY_USER
           = new DJIWaypointV2Error("Operation cancel by user.", -7)
Package:dji.common.error
-
Description:
+
Description:

Operation cancel by user.

@@ -2107,7 +2139,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_UPLOAD_MEDIA_FILE_FAILED
           = new DJIWaypointV2Error("Upload media file failed.", -8)
Package:dji.common.error
-
Description:
+
Description:

Upload media file failed.

@@ -2115,7 +2147,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_SDR_RESERVE_FAILED
           = new DJIWaypointV2Error("SDR reserve failed.", -9)
Package:dji.common.error
-
Description:
+
Description:

SDR reserve failed.

@@ -2123,7 +2155,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_CHECK_PHOTO_STORAGE_PACK_ERROR
           = new DJIWaypointV2Error("Check photo storage pack error.", -10)
Package:dji.common.error
-
Description:
+
Description:

Check photo storage pack error.

@@ -2131,7 +2163,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_SDR_LINK_RESERVE_FAILED_CAUSE_MOTOR_ON
           = new DJIWaypointV2Error("SDR link reserve failed because motor is on.", -11)
Package:dji.common.error
-
Description:
+
Description:

SDR link reserve failed because motor is on.

@@ -2139,7 +2171,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_ACTION_TRIGGER_NOT_MATCH_ACTUATOR
           = new DJIWaypointV2Error("The action actuator and the trigger type do not match.", -12)
Package:dji.common.error
-
Description:
+
Description:

The action actuator and the trigger type do not match.

@@ -2147,7 +2179,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_TRAJECTORY_REPLAY_INVALID_LOCATION
           = new DJIWaypointV2Error("The trajectory replay's location is invalid.", -100)
Package:dji.common.error
-
Description:
+
Description:

The trajectory replay's location is invalid.

@@ -2155,7 +2187,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_TRAJECTORY_REPLAY_NO_WAYPOINT_TO_REMOVE
           = new DJIWaypointV2Error("The trajectory replay has no waypoint to remove.", -101)
Package:dji.common.error
-
Description:
+
Description:

The trajectory replay has no waypoint to remove.

@@ -2163,7 +2195,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_TRAJECTORY_REPLAY_GIMBAL_ATTI_ERROR
           = new DJIWaypointV2Error(" The trajectory replay's gimbal attitude has error.", -102)
Package:dji.common.error
-
Description:
+
Description:

The trajectory replay's gimbal attitude has error.

@@ -2171,7 +2203,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INVALID_INPUT_DATA_FC_LENGTH
           = new DJIWaypointV2Error("Data transmission does not match protocols.", -1001)
Package:dji.common.error
-
Description:
+
Description:

Data transmission does not match protocols.

@@ -2179,7 +2211,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INVALID_INPUT_DATA_FLOAT_NUMBER
           = new DJIWaypointV2Error(" Invalid floating number.", -1002)
Package:dji.common.error
-
Description:
+
Description:

Invalid floating number.

@@ -2187,7 +2219,7 @@
Description:
static DJIWaypointV2Error MISSION_END_INDEX_INVALID
           = new DJIWaypointV2Error("Last waypoint index is invalid.", -2003)
Package:dji.common.error
-
Description:
+
Description:

Last waypoint index is invalid.

@@ -2195,7 +2227,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_INDEX_INVALID
           = new DJIWaypointV2Error("Invalid waypoint index, please check your waypoint index with waypoint count.", -2011)
Package:dji.common.error
-
Description:
+
Description:

Invalid waypoint index, please check your waypoint index with waypoint count.

@@ -2203,7 +2235,7 @@
Description:
static DJIWaypointV2Error MISSION_WAYPOINT_START_INDEX_NOT_IN_END_OF_LAST_UPLOAD
           = new DJIWaypointV2Error("The upload waypoint start index isn't in the given range.", -2013)
Package:dji.common.error
-
Description:
+
Description:

The upload waypoint start index isn't in the given range.

@@ -2211,7 +2243,7 @@
Description:
static DJIWaypointV2Error MISSION_CONTROL_START_STOP_INVALID
           = new DJIWaypointV2Error("The aircraft start waypoint is too far away from the stop waypoint.", -4002)
Package:dji.common.error
-
Description:
+
Description:

The aircraft start waypoint is too far away from the stop waypoint.

@@ -2219,7 +2251,7 @@
Description:
static DJIWaypointV2Error MISSION_CONTROL_PAUSE_RESUME_INVALID
           = new DJIWaypointV2Error("Invalid pause resume operation.", -4003)
Package:dji.common.error
-
Description:
+
Description:

Invalid pause resume operation.

@@ -2227,7 +2259,7 @@
Description:
static DJIWaypointV2Error MISSION_CONTROL_INTERRUPT_RECOVER_INVALID
           = new DJIWaypointV2Error("Invalid  interrupt recover operation.", -4004)
Package:dji.common.error
-
Description:
+
Description:

Invalid interrupt recover operation.

@@ -2235,7 +2267,7 @@
Description:
static DJIWaypointV2Error MISSION_CONTROL_MISSION_ALREADY_PAUSED
           = new DJIWaypointV2Error("The mission is already paused.", -4009)
Package:dji.common.error
-
Description:
+
Description:

The mission is already paused.

@@ -2243,7 +2275,7 @@
Description:
static DJIWaypointV2Error MISSION_CONTROL_NO_RUNNING_MISSION_FOR_RESUME
           = new DJIWaypointV2Error("The mission cannot resume because it is not running.", -4010)
Package:dji.common.error
-
Description:
+
Description:

The mission cannot resume because it is not running.

@@ -2251,7 +2283,7 @@
Description:
static DJIWaypointV2Error MISSION_CONTROL_NOT_SUPPORT_PAUSE_RESUME
           = new DJIWaypointV2Error("The mission cannot be paused or resumed now.", -4013)
Package:dji.common.error
-
Description:
+
Description:

The mission cannot be paused or resumed now.

@@ -2259,7 +2291,7 @@
Description:
static DJIWaypointV2Error MISSION_CONTROL_NOT_SUPPORT_INTERRUPT_RESUME
           = new DJIWaypointV2Error("The mission cannot be interrupted or recovered now.", -4014)
Package:dji.common.error
-
Description:
+
Description:

The mission cannot be interrupted or recovered now.

@@ -2267,7 +2299,7 @@
Description:
static DJIWaypointV2Error RECOVER_NO_CURRENT_PROJECTION_POINT
           = new DJIWaypointV2Error("No recorded waypoint for recovery currently.", -4016)
Package:dji.common.error
-
Description:
+
Description:

No recorded waypoint for recovery currently.

@@ -2275,7 +2307,7 @@
Description:
static DJIWaypointV2Error RECOVER_NO_NEXT_PROJECTION_POINT
           = new DJIWaypointV2Error("No recorded waypoint for next waypoint recovery.", -4017)
Package:dji.common.error
-
Description:
+
Description:

No recorded waypoint for next waypoint recovery.

@@ -2283,7 +2315,7 @@
Description:
static DJIWaypointV2Error UPLOAD_ACTION_TRIGGER_REACH_END_INDEX_LESS_START_INDEX
           = new DJIWaypointV2Error("Uploaded reach trigger invalid.", -8002)
Package:dji.common.error
-
Description:
+
Description:

Uploaded reach trigger invalid.

@@ -2291,7 +2323,7 @@
Description:
static DJIWaypointV2Error UPLOAD_ACTION_TRIGGER_REACH_INTERVAL_COUNT_INVALID
           = new DJIWaypointV2Error("Uploaded reach trigger invalid.", -8003)
Package:dji.common.error
-
Description:
+
Description:

Uploaded reach trigger invalid.

@@ -2299,7 +2331,7 @@
Description:
static DJIWaypointV2Error UPLOAD_ACTION_TRIGGER_REACH_AUTO_TERMINATE_INVALID
           = new DJIWaypointV2Error("Uploaded reach trigger invalid.", -8004)
Package:dji.common.error
-
Description:
+
Description:

Uploaded reach trigger invalid.

@@ -2307,7 +2339,7 @@
Description:
static DJIWaypointV2Error UPLOAD_ACTION_ACTUATOR_SPRAY_EXTERNAL_SPRAY_MODE_INVALID
           = new DJIWaypointV2Error("Uploaded spray actuator is invalid.", -10001)
Package:dji.common.error
-
Description:
+
Description:

Uploaded spray actuator is invalid.

@@ -2315,7 +2347,7 @@
Description:
static DJIWaypointV2Error UPLOAD_ACTION_ACTUATOR_SPRAY_FLOW_SPEED_INVALID
           = new DJIWaypointV2Error("Uploaded spray actuator is invalid.", -10002)
Package:dji.common.error
-
Description:
+
Description:

Uploaded spray actuator is invalid.

@@ -2323,7 +2355,7 @@
Description:
static DJIWaypointV2Error UPLOAD_ACTION_ACTUATOR_SPRAY_FLOW_SPEED_PRE_MU_INVALID
           = new DJIWaypointV2Error("Uploaded spray actuator is invalid.", -10003)
Package:dji.common.error
-
Description:
+
Description:

Uploaded spray actuator is invalid.

@@ -2331,7 +2363,7 @@
Description:
static DJIWaypointV2Error ACTION_ACTUATOR_PAYLOAD_FAIL_TO_SEND_CMD_TO_PAYLOAD
           = new DJIWaypointV2Error("Uploaded payload actuator is invalid.", -13001)
Package:dji.common.error
-
Description:
+
Description:

Uploaded payload actuator is invalid.

Inherited Methods:
@@ -2340,7 +2372,7 @@
Inherited Methods:
static DJIError getDJIError(int errorCode)
Package:dji.common.error
-
Description:
+
Description:

Returns the specific error in the DJIFlightHubError according to the error code.

Input Parameters:
int errorCodeerrorCode for DJIFlightHubError.
@@ -2351,7 +2383,7 @@
Return:
static DJIError getDJIError(int errorCode)
Package:dji.sdk.utmiss
-
Description:
+
Description:

Get DJIUTMISSError.

Input Parameters:
int errorCodeAn int value of error code.
@@ -2362,7 +2394,7 @@
Return:
String getDescription()
Package:dji.common.error
-
Description:
+
Description:

Returns the description of the error code.

Return:
StringThe description of the error code.
@@ -2371,7 +2403,7 @@
Return:
void setDescription(String desc)
Package:dji.common.error
-
Description:
+
Description:

Sets the description for the error code.

Input Parameters:
String descDescription string.
diff --git a/docs/API Reference/index.html b/docs/API Reference/index.html index 0bd5e7fc..aa2dd1b2 100644 --- a/docs/API Reference/index.html +++ b/docs/API Reference/index.html @@ -1,4 +1,4 @@ - + diff --git a/docs/API Reference/javascripts/search_index.js b/docs/API Reference/javascripts/search_index.js index 549c71be..51d17498 100644 --- a/docs/API Reference/javascripts/search_index.js +++ b/docs/API Reference/javascripts/search_index.js @@ -1855,6 +1855,8 @@ var search_data = { "the base station is moved. land the aircraft to re-establish the connection to the ground station.", "base_station_fell", "the base station fell. land the aircraft to re-establish the connection to the base station.", + "navigation_satellite_system_can_not_set", + "the selection of navigation satellite system is only supported when the rtk function is turned off, and cannot be modified in the air.", "base_station_parameter_number_not_match", "base station internal error. parameter numbers do not match. please contact .", "base_station_parameter_length_not_match", @@ -2326,6 +2328,14 @@ var search_data = { "djiwaypointv2error", "the action associate trigger `gettype` is invalid.", "djiwaypointv2error", + "the action associate trigger waypoint index invalid.", + "djiwaypointv2error", + "the actuator state does not match action.", + "djiwaypointv2error", + "the action actuator operation index is invalid.", + "djiwaypointv2error", + "camera failed to execute coressponding command.", + "djiwaypointv2error", "the action actuator is not supported.", "djiwaypointv2error", "the action actuator `getactuatortype` is invalid.", @@ -2919,8 +2929,6 @@ var search_data = { "rtk component.", "device_health_information", "device health information. only supported by some components of matrice 300 rtk and zenmuse h20 series. it is recommended to use device health information to replace old diagnostics for flight controller and rtk. there will be a few duplicated component error for gimbal, battery, perception module on matrice 300 rtk. find error code and detailed description information in the readme file on github (https://github.com/dji-sdk/mobile-sdk-android/blob/master/readme.md)", - "product", - "product component. it is used to listen the remote controller and aircraft disconnect status.", "other", "other.", "warninglevel", @@ -3445,6 +3453,10 @@ var search_data = { "the aircraft's model name is p4 multispectral.", "mavic_air_2", "the aircraft's model name is mavic air 2.", + "dji_mini_se", + "the aircraft's model name is dji mini se.", + "dji_mini_2", + "the aircraft's model name is dji mini 2.", "mavic_2_enterprise_advanced", "the aircraft's model name is mavic 2 enterprise advanced.", "matrice_100", @@ -3489,10 +3501,6 @@ var search_data = { "the aircraft's model name is mavic 2 enterprise dual.", "mavic_mini", "the aircraft's model name is mavic mini.", - "dji_mini_se", - "the aircraft's model name is dji mini se.", - "dji_mini_2", - "the aircraft's model name is dji mini 2.", "dji_air_2s", "the aircraft's model name is dji air 2s.", "n3", @@ -4468,7 +4476,7 @@ var search_data = { "onexecutionfinish", "called when the waypoint mission ends. @param error error if the waypoint mission didn't end as expected.", "onexecutionstopped", - "called when the waypoint mission is stopped by the user. @param error error if the waypoint mission didn't end as expected.", + "called when the waypoint mission is stopped by the user.", "waypointv2actionlistener", "listener that is interested on action event.", "ondownloadupdate", @@ -6130,7 +6138,7 @@ var search_data = { "switchquickshotmode", "changes the quickshot sbmode on the currently executing mission. it is only supported by spark. @param mode quickshot submode to change. @param callback the execution callback with the returned execution result.", "switchspotlightmode", - "changes the spotlight submode on the currently executing mission, it is only supported by matrice 300 rtk. @param mode spotlight submode to change. @param callback the execution callback with the returned execution result.", + "changes the spotlight submode on the currently executing mission, it is only supported by matrice 300 rtk. @param spotlightmode spotlight submode to change. @param callback the execution callback with the returned execution result.", "setrecommendedconfiguration", "sets the recommended camera and gimbal configuration that optimizes performance for the activetrack mission in most environments. @param callback the execution callback with the returned execution result.", "setretreatenabled", @@ -7587,38 +7595,6 @@ var search_data = { "`true` if the lens focus assistant is enabled for manual focusing. @return `true` if mf is enabled.", "isenabledaf", "`true` if the lens focus assistant is enabled for auto focusing. @return true if af is enabled.", - "normal", - "the sd card is in the normal state.", - "not_inserted", - "the sd card is not inserted.", - "invalid", - "the sd card is in invalid state.", - "read_only", - "the sd card is in read-only state and write operation is not allowed.", - "format_needed", - "it is required to format the sd card before using it.", - "formatting", - "the sd card is being formatted.", - "invalid_file_system", - "the sd card is using an invalid file system. format the sd card before using it.", - "busy", - "the sd card is busy.", - "full", - "the sd card is full.", - "slow", - "the sd card is too slow.", - "unknown_error", - "the sd card encounters an unknown error.", - "no_remain_file_indices", - "no remaining file indices for any new photos or videos.", - "initializing", - "the sd card is in initializing state.", - "format_recommended", - "it is recommended to format the sd card before using it.", - "recovering_files", - "the camera is recovering the damaged files on the sd card.", - "writing_slowly", - "the sd card is being written in a slow speed.", "not_found", "ssd is not found.", "idle", @@ -8400,9 +8376,9 @@ var search_data = { "is_digital_zoom_supported", "sdk key for isdigitalzoomsupported: check if the current device supports digital zoom scale. it is supported by osmo with x3 camera, phantom 4 camera, z3 camera, mavic pro camera and z30 camera. for zenmuse h20, zenmuse h20t and mavic 2 enterprise advanced, please use class `lens`. @return a boolean value.", "setdigitalzoomfactor", - "adjusts the digital zoom. it is supported by osmo with x3 camera, phantom 4 camera, z3 camera, mavic pro camera and xt 2 camera. for zenmuse h20, zenmuse h20t and mavic 2 enterprise advanced, please use class `lens`. @param factor the valid range is from 1.0 to 2.0. @param callback the execution callback with the returned execution result.", + "adjusts the digital zoom. it is supported by osmo with x3 camera, phantom 4 camera, z3 camera, mavic pro camera and xt 2 camera, dji mini 2. for zenmuse h20, zenmuse h20t and mavic 2 enterprise advanced, please use class `lens`. @param factor the valid range is from 1.0 to 4.0. @param callback the execution callback with the returned execution result.", "digital_zoom_factor", - "sdk key for setdigitalzoomfactor: adjusts the digital zoom. it is supported by osmo with x3 camera, phantom 4 camera, z3 camera, mavic pro camera and xt 2 camera. for zenmuse h20, zenmuse h20t and mavic 2 enterprise advanced, please use class `lens`. @param factor the valid range is from 1.0 to 2.0. @param callback the execution callback with the returned execution result.", + "sdk key for setdigitalzoomfactor: adjusts the digital zoom. it is supported by osmo with x3 camera, phantom 4 camera, z3 camera, mavic pro camera and xt 2 camera, dji mini 2. for zenmuse h20, zenmuse h20t and mavic 2 enterprise advanced, please use class `lens`. @param factor the valid range is from 1.0 to 4.0. @param callback the execution callback with the returned execution result.", "getdigitalzoomfactor", "gets current digital zoom. it is supported by osmo with x3 camera, phantom 4 camera, z3 camera, mavic pro camera and z30 camera. note z30 cannot set the digital zoom scale, but will use digital zoom when using `startcontinuousopticalzoom` and the optical zoom has reached its limit. for zenmuse h20, zenmuse h20t and mavic 2 enterprise advanced, please use class `lens`. @param callback the execution callback with the returned value(s).", "digital_zoom_factor", @@ -9387,8 +9363,6 @@ var search_data = { "stores the focus settings", "focus_assistant_settings", "sdk key for focusassistantsettings: stores the focus settings", - "sdcardoperationstate", - "operation states of the camera's sd card.", "photofileformat", "camera photo file formats. the default value is jpeg.", "photo_file_format", @@ -9808,7 +9782,7 @@ var search_data = { "getmeteringmode", "gets the exposure metering of the current lens. @param callback the execution callback with the returned value(s).", "setspotmeteringtarget", - "sets the spot metering area index of the current lens. the lens image is divided into 225 spots defined by 15 columns and 15 rows. the row index range is [0,14], where the values increase top to bottom across the image. the column index range is [0, 14], where the values increase left to right. in order to make the method work, the camera exposure mode should be `program`, `shutter` or `aperture`, the exposure metering mode must be `spot`, and `setaelock` must be `no`. @param spotindex spot metering point coordinate (x, y). x is column index to be set. the value should falls in [0, 11], where the values increase left to right. y is row index to be set. the value should falls in [0, 7], where the values increase top to bottom across the image. @param callback the execution callback with the returned execution result.", + "sets the spot metering area index of the current lens. the lens image is divided into 225 spots defined by 15 columns and 15 rows. the row index range is [0,14], where the values increase top to bottom across the image. the column index range is [0, 14], where the values increase left to right. in order to make the method work, the camera exposure mode should be `program`, `shutter` or `aperture`, the exposure metering mode must be `spot`, and `setaelock` must be `no`. @param spotindex spot metering point coordinate (x, y). x is column index to be set. the value should falls in [0, 14], where the values increase left to right. y is row index to be set. the value should falls in [0, 14], where the values increase top to bottom across the image. @param callback the execution callback with the returned execution result.", "getspotmeteringtarget", "gets the spot metering area row index and column index of the current lens. in order to make the method work, the lens exposure mode should be `program`, `shutter_priority` or `aperture_priority`, the exposure metering mode must be `spot`, and `getaelock` must be `false`. @param callback the execution callback with the returned value(s).", "setexposurecompensation", @@ -10768,7 +10742,7 @@ var search_data = { "getupwardobstacledistance", "the upward obstacle distance. @return an int value of the upward obstacle distance.", "getdownwardobstacledistance", - "the downward obstacle distance. @return an int value of downward obstacle distance.", + "the downward obstacle distance. not supported by mavic air 2 and dji air 2s @return an int value of downward obstacle distance.", "obstacleavoidancesensorstate", "current state of obstacle avoidance sensor.", "isupwardvisualobstacleavoidancesensorworking", @@ -11323,6 +11297,20 @@ var search_data = { "when gps signal low, aircraft unable to auto hover and takeoff restricted. if you want to unlock takeoff without gps , ensure there no people or obstacles within 2 m around the aircraft, and pay close attention to operating the remote controller at all times to avoid collisions. @param lock `false` to unlock takeoff without gps. @param callback callback that receives the execution result.", "islocktakeoffwithoutgps", "return `false` if unlock takeoff without gps. @param callback callback that receives the execution result.", + "setcoordinatedturnenabled", + "enables the coordinated turn. improves aerodynamic efficiency. the aircraft is flying in the direction of the turn, without sideslipping. only supported by m300 rtk. @param enabled `true` to enable the coordinated turn. @param callback callback that receives the execution result.", + "getcoordinatedturnenabled", + "get whether the coordinated turn switch is on. only supported by m300 rtk. @param callback callback that receives the execution result.", + "setnavigationsatellitesystem", + "the selection of satellite positioning system is only supported when the rtk positioning function is turned off, and cannot be modified in the air. if rtk positioning function is turned on, aircraft uses gps, glonass, galileo, and bds data to determine location. only supported by m300 rtk. @param system navigation satellite system. @param callback callback that receives the execution result.", + "getnavigationsatellitesystem", + "get the navigation satellite system. only supported by m300 rtk. @param callback callback that receives the execution result.", + "navigationsatellitesystem", + "this enum defines the navigation satellite system currently being used.", + "gps_glonass", + "using gsp and glonss satellite data.", + "beidou", + "only use beidou satellite navigation system.", "onboardsdkdevicedatacallback", "callback function that updates the data received from an external device (e.g.the onboard device).", "flightcontrollerstate", @@ -13914,7 +13902,7 @@ var search_data = { "displaynamedjismartcontrollerenterprisecontroller", "the display name of dji smart controller enterprise.", "displaynamemavicmini", - "the display name of mavic mini's remote controller.", + "the display name of mavic mini/dji mini se's remote controller.", "displaynamemavicair2", "the display name of mavic air 2's remote controller.", "displaynamedjimini2", @@ -30193,6 +30181,20 @@ var search_data = { "#DJIError_DJISDKFlightControllerError_GroundSystemFell_inline", "", ], + [ + "NAVIGATION_SATELLITE_SYSTEM_CAN_NOT_SET", + 2, + "/Components/SDKError/DJIError_DJIFlightControllerError.html", + "#DJIError_DJISDKFlightControllerError_NavigationSatelliteSystemCanNotSet_inline", + "The selection of navigation satellite system is only supported when the RTK function is turned off, and cannot be modified in the air.", + ], + [ + "The selection of navigation satellite system is only supported when the RTK function is turned off, and cannot be modified in the air.", + 1, + "/Components/SDKError/DJIError_DJIFlightControllerError.html", + "#DJIError_DJISDKFlightControllerError_NavigationSatelliteSystemCanNotSet_inline", + "", + ], [ "BASE_STATION_PARAMETER_NUMBER_NOT_MATCH", 2, @@ -33483,6 +33485,62 @@ var search_data = { "#DJIError_DJIWaypointV2Error_ActionIntervalTriggerTypeInvalid_inline", "", ], + [ + "DJIWaypointV2Error", + 2, + "/Components/SDKError/DJIError_DJIWaypointV2Error.html", + "#DJIError_DJIWaypointV2Error_ActionTriggerWayPointIndexInvalid_inline", + "The action associate trigger waypoint index invalid.", + ], + [ + "The action associate trigger waypoint index invalid.", + 1, + "/Components/SDKError/DJIError_DJIWaypointV2Error.html", + "#DJIError_DJIWaypointV2Error_ActionTriggerWayPointIndexInvalid_inline", + "", + ], + [ + "DJIWaypointV2Error", + 2, + "/Components/SDKError/DJIError_DJIWaypointV2Error.html", + "#DJIError_DJIWaypointV2Error_ActionActuatorStatusNotMatchAction_inline", + "The actuator state does not match action.", + ], + [ + "The actuator state does not match action.", + 1, + "/Components/SDKError/DJIError_DJIWaypointV2Error.html", + "#DJIError_DJIWaypointV2Error_ActionActuatorStatusNotMatchAction_inline", + "", + ], + [ + "DJIWaypointV2Error", + 2, + "/Components/SDKError/DJIError_DJIWaypointV2Error.html", + "#DJIError_DJIWaypointV2Error_ActionActuatorOperationIndexInvalid_inline", + "The action actuator operation index is invalid.", + ], + [ + "The action actuator operation index is invalid.", + 1, + "/Components/SDKError/DJIError_DJIWaypointV2Error.html", + "#DJIError_DJIWaypointV2Error_ActionActuatorOperationIndexInvalid_inline", + "", + ], + [ + "DJIWaypointV2Error", + 2, + "/Components/SDKError/DJIError_DJIWaypointV2Error.html", + "#DJIError_DJIWaypointV2Error_ActionActuatorCameraExcuteFailed_inline", + "Camera failed to execute coressponding command.", + ], + [ + "Camera failed to execute coressponding command.", + 1, + "/Components/SDKError/DJIError_DJIWaypointV2Error.html", + "#DJIError_DJIWaypointV2Error_ActionActuatorCameraExcuteFailed_inline", + "", + ], [ "DJIWaypointV2Error", 2, @@ -37641,20 +37699,6 @@ var search_data = { "#DJIDiagnostics_DJIDiagnosticsType_DEVICE_HEALTH_INFORMATION_inline", "", ], - [ - "PRODUCT", - 2, - "/Components/Diagnostics/DJIDiagnostics.html", - "#DJIDiagnostics_DJIDiagnosticsType_Product_inline", - "Product component. It is used to listen the remote controller and aircraft disconnect status.", - ], - [ - "Product component. It is used to listen the remote controller and aircraft disconnect status.", - 1, - "/Components/Diagnostics/DJIDiagnostics.html", - "#DJIDiagnostics_DJIDiagnosticsType_Product_inline", - "", - ], [ "OTHER", 2, @@ -41323,6 +41367,34 @@ var search_data = { "#DJIAircraft_DJIAircraftModelNameMavicAir2_inline", "", ], + [ + "DJI_MINI_SE", + 2, + "/BaseClasses/DJIBaseProduct.html", + "#DJIAircraft_DJIAircraftModelNameDJIMiniSE_inline", + "The aircraft's model name is DJI Mini SE.", + ], + [ + "The aircraft's model name is DJI Mini SE.", + 1, + "/BaseClasses/DJIBaseProduct.html", + "#DJIAircraft_DJIAircraftModelNameDJIMiniSE_inline", + "", + ], + [ + "DJI_MINI_2", + 2, + "/BaseClasses/DJIBaseProduct.html", + "#DJIAircraft_DJIAircraftModelNameDJIMini2_inline", + "The aircraft's model name is DJI Mini 2.", + ], + [ + "The aircraft's model name is DJI Mini 2.", + 1, + "/BaseClasses/DJIBaseProduct.html", + "#DJIAircraft_DJIAircraftModelNameDJIMini2_inline", + "", + ], [ "MAVIC_2_ENTERPRISE_ADVANCED", 2, @@ -41631,34 +41703,6 @@ var search_data = { "#DJIAircraft_DJIAircraftModelNameMavicMini_inline", "", ], - [ - "DJI_MINI_SE", - 2, - "/BaseClasses/DJIBaseProduct.html", - "#DJIAircraft_DJIAircraftModelNameDJIMiniSE_inline", - "The aircraft's model name is DJI Mini SE.", - ], - [ - "The aircraft's model name is DJI Mini SE.", - 1, - "/BaseClasses/DJIBaseProduct.html", - "#DJIAircraft_DJIAircraftModelNameDJIMiniSE_inline", - "", - ], - [ - "DJI_MINI_2", - 2, - "/BaseClasses/DJIBaseProduct.html", - "#DJIAircraft_DJIAircraftModelNameDJIMini2_inline", - "The aircraft's model name is DJI Mini 2.", - ], - [ - "The aircraft's model name is DJI Mini 2.", - 1, - "/BaseClasses/DJIBaseProduct.html", - "#DJIAircraft_DJIAircraftModelNameDJIMini2_inline", - "", - ], [ "DJI_AIR_2S", 2, @@ -48482,10 +48526,10 @@ var search_data = { 2, "/Components/Missions/WaypointV2MissionOperatorListenerInterface.html", "#WaypointV2MissionOperatorListenerInterface_onExecutionStop_inline", - "Called when the waypoint mission is stopped by the user. @param error Error if the waypoint mission didn't end as expected.", + "Called when the waypoint mission is stopped by the user.", ], [ - "Called when the waypoint mission is stopped by the user. @param error Error if the waypoint mission didn't end as expected.", + "Called when the waypoint mission is stopped by the user.", 1, "/Components/Missions/WaypointV2MissionOperatorListenerInterface.html", "#WaypointV2MissionOperatorListenerInterface_onExecutionStop_inline", @@ -60116,10 +60160,10 @@ var search_data = { 2, "/Components/Missions/DJIActiveTrackMissionOperator.html", "#DJIActiveTrackMissionOperator_switchSpotlightMode_inline", - "Changes the Spotlight submode on the currently executing mission, It is only supported by Matrice 300 RTK. @param mode Spotlight submode to change. @param callback The execution callback with the returned execution result.", + "Changes the spotlight submode on the currently executing mission, It is only supported by Matrice 300 RTK. @param spotlightMode Spotlight submode to change. @param callback The execution callback with the returned execution result.", ], [ - "Changes the Spotlight submode on the currently executing mission, It is only supported by Matrice 300 RTK. @param mode Spotlight submode to change. @param callback The execution callback with the returned execution result.", + "Changes the spotlight submode on the currently executing mission, It is only supported by Matrice 300 RTK. @param spotlightMode Spotlight submode to change. @param callback The execution callback with the returned execution result.", 1, "/Components/Missions/DJIActiveTrackMissionOperator.html", "#DJIActiveTrackMissionOperator_switchSpotlightMode_inline", @@ -70317,230 +70361,6 @@ var search_data = { "#DJICamera_DJICameraFocusAssistantSettings_enabledForAF_inline", "", ], - [ - "NORMAL", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Normal_inline", - "The SD card is in the normal state.", - ], - [ - "The SD card is in the normal state.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Normal_inline", - "", - ], - [ - "NOT_INSERTED", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_NotInserted_inline", - "The SD card is not inserted.", - ], - [ - "The SD card is not inserted.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_NotInserted_inline", - "", - ], - [ - "INVALID", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Invalid_inline", - "The SD card is in invalid state.", - ], - [ - "The SD card is in invalid state.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Invalid_inline", - "", - ], - [ - "READ_ONLY", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_ReadOnly_inline", - "The SD card is in read-only state and write operation is not allowed.", - ], - [ - "The SD card is in read-only state and write operation is not allowed.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_ReadOnly_inline", - "", - ], - [ - "FORMAT_NEEDED", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_FormatNeeded_inline", - "It is required to format the SD card before using it.", - ], - [ - "It is required to format the SD card before using it.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_FormatNeeded_inline", - "", - ], - [ - "FORMATTING", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Formatting_inline", - "The SD card is being formatted.", - ], - [ - "The SD card is being formatted.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Formatting_inline", - "", - ], - [ - "INVALID_FILE_SYSTEM", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_InvalidFileSystem_inline", - "The SD card is using an invalid file system. Format the SD card before using it.", - ], - [ - "The SD card is using an invalid file system. Format the SD card before using it.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_InvalidFileSystem_inline", - "", - ], - [ - "BUSY", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Busy_inline", - "The SD card is busy.", - ], - [ - "The SD card is busy.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Busy_inline", - "", - ], - [ - "FULL", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Full_inline", - "The SD card is full.", - ], - [ - "The SD card is full.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Full_inline", - "", - ], - [ - "SLOW", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Slow_inline", - "The SD card is too slow.", - ], - [ - "The SD card is too slow.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Slow_inline", - "", - ], - [ - "UNKNOWN_ERROR", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_UnknownError_inline", - "The SD card encounters an unknown error.", - ], - [ - "The SD card encounters an unknown error.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_UnknownError_inline", - "", - ], - [ - "NO_REMAIN_FILE_INDICES", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_NoRemainFileIndices_inline", - "No remaining file indices for any new photos or videos.", - ], - [ - "No remaining file indices for any new photos or videos.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_NoRemainFileIndices_inline", - "", - ], - [ - "INITIALIZING", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Initializing_inline", - "The SD card is in initializing state.", - ], - [ - "The SD card is in initializing state.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_Initializing_inline", - "", - ], - [ - "FORMAT_RECOMMENDED", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_FormatRecommended_inline", - "It is recommended to format the SD card before using it.", - ], - [ - "It is recommended to format the SD card before using it.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_FormatRecommended_inline", - "", - ], - [ - "RECOVERING_FILES", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_RecoveringFiles_inline", - "The camera is recovering the damaged files on the SD card.", - ], - [ - "The camera is recovering the damaged files on the SD card.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_RecoveringFiles_inline", - "", - ], - [ - "WRITING_SLOWLY", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_WritingSlowly_inline", - "The SD card is being written in a slow speed.", - ], - [ - "The SD card is being written in a slow speed.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_WritingSlowly_inline", - "", - ], [ "NOT_FOUND", 2, @@ -76006,10 +75826,10 @@ var search_data = { 2, "/Components/Camera/DJICamera.html", "#DJICamera_CameraSettings_setDigitalZoomScale_inline", - "Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class `Lens`. @param factor The valid range is from 1.0 to 2.0. @param callback The execution callback with the returned execution result.", + "Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera, DJI Mini 2. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class `Lens`. @param factor The valid range is from 1.0 to 4.0. @param callback The execution callback with the returned execution result.", ], [ - "Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class `Lens`. @param factor The valid range is from 1.0 to 2.0. @param callback The execution callback with the returned execution result.", + "Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera, DJI Mini 2. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class `Lens`. @param factor The valid range is from 1.0 to 4.0. @param callback The execution callback with the returned execution result.", 1, "/Components/Camera/DJICamera.html", "#DJICamera_CameraSettings_setDigitalZoomScale_inline", @@ -76020,10 +75840,10 @@ var search_data = { 2, "/Components/Camera/DJICamera.html", "#DJICamera_CameraSettings_setDigitalZoomScale_inline", - "SDK Key for setDigitalZoomFactor: Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class `Lens`. @param factor The valid range is from 1.0 to 2.0. @param callback The execution callback with the returned execution result.", + "SDK Key for setDigitalZoomFactor: Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera, DJI Mini 2. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class `Lens`. @param factor The valid range is from 1.0 to 4.0. @param callback The execution callback with the returned execution result.", ], [ - "SDK Key for setDigitalZoomFactor: Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class `Lens`. @param factor The valid range is from 1.0 to 2.0. @param callback The execution callback with the returned execution result.", + "SDK Key for setDigitalZoomFactor: Adjusts the digital zoom. It is supported by Osmo with X3 camera, Phantom 4 camera, Z3 camera, Mavic Pro camera and XT 2 camera, DJI Mini 2. For Zenmuse H20, Zenmuse H20T and Mavic 2 Enterprise Advanced, please use class `Lens`. @param factor The valid range is from 1.0 to 4.0. @param callback The execution callback with the returned execution result.", 1, "/Components/Camera/DJICamera.html", "#DJICamera_CameraSettings_setDigitalZoomScale_inline", @@ -82917,20 +82737,6 @@ var search_data = { "", "", ], - [ - "SDCardOperationState", - 2, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_inline", - "Operation states of the camera's SD card.", - ], - [ - "Operation states of the camera's SD card.", - 1, - "/Components/Camera/DJICamera.html", - "#DJICamera_DJICameraSDCardOperationState_inline", - "", - ], [ "PhotoFileFormat", 2, @@ -85862,10 +85668,10 @@ var search_data = { 2, "/Components/Camera/DJICamera_DJILens.html", "#DJICamera_DJILens_setSpotMeteringTargetRowIndex_inline", - "Sets the spot metering area index of the current lens. The lens image is divided into 225 spots defined by 15 columns and 15 rows. The row index range is [0,14], where the values increase top to bottom across the image. The column index range is [0, 14], where the values increase left to right. In order to make the method work, The camera exposure mode should be `Program`, `Shutter` or `Aperture`, the exposure metering mode must be `SPOT`, and `setAELock` must be `NO`. @param spotIndex Spot metering point coordinate (x, y). x is column index to be set. The value should falls in [0, 11], where the values increase left to right. y is row index to be set. The value should falls in [0, 7], where the values increase top to bottom across the image. @param callback The execution callback with the returned execution result.", + "Sets the spot metering area index of the current lens. The lens image is divided into 225 spots defined by 15 columns and 15 rows. The row index range is [0,14], where the values increase top to bottom across the image. The column index range is [0, 14], where the values increase left to right. In order to make the method work, The camera exposure mode should be `Program`, `Shutter` or `Aperture`, the exposure metering mode must be `SPOT`, and `setAELock` must be `NO`. @param spotIndex Spot metering point coordinate (x, y). x is column index to be set. The value should falls in [0, 14], where the values increase left to right. y is row index to be set. The value should falls in [0, 14], where the values increase top to bottom across the image. @param callback The execution callback with the returned execution result.", ], [ - "Sets the spot metering area index of the current lens. The lens image is divided into 225 spots defined by 15 columns and 15 rows. The row index range is [0,14], where the values increase top to bottom across the image. The column index range is [0, 14], where the values increase left to right. In order to make the method work, The camera exposure mode should be `Program`, `Shutter` or `Aperture`, the exposure metering mode must be `SPOT`, and `setAELock` must be `NO`. @param spotIndex Spot metering point coordinate (x, y). x is column index to be set. The value should falls in [0, 11], where the values increase left to right. y is row index to be set. The value should falls in [0, 7], where the values increase top to bottom across the image. @param callback The execution callback with the returned execution result.", + "Sets the spot metering area index of the current lens. The lens image is divided into 225 spots defined by 15 columns and 15 rows. The row index range is [0,14], where the values increase top to bottom across the image. The column index range is [0, 14], where the values increase left to right. In order to make the method work, The camera exposure mode should be `Program`, `Shutter` or `Aperture`, the exposure metering mode must be `SPOT`, and `setAELock` must be `NO`. @param spotIndex Spot metering point coordinate (x, y). x is column index to be set. The value should falls in [0, 14], where the values increase left to right. y is row index to be set. The value should falls in [0, 14], where the values increase top to bottom across the image. @param callback The execution callback with the returned execution result.", 1, "/Components/Camera/DJICamera_DJILens.html", "#DJICamera_DJILens_setSpotMeteringTargetRowIndex_inline", @@ -92582,10 +92388,10 @@ var search_data = { 2, "/Components/IntelligentFlightAssistant/DJIFlightAssistantPerceptionState.html", "#DJIFlightAssistantPerceptionState_downwardObstacleDistance_inline", - "The downward obstacle distance. @return An int value of downward obstacle distance.", + "The downward obstacle distance. Not supported by Mavic Air 2 and DJI Air 2S @return An int value of downward obstacle distance.", ], [ - "The downward obstacle distance. @return An int value of downward obstacle distance.", + "The downward obstacle distance. Not supported by Mavic Air 2 and DJI Air 2S @return An int value of downward obstacle distance.", 1, "/Components/IntelligentFlightAssistant/DJIFlightAssistantPerceptionState.html", "#DJIFlightAssistantPerceptionState_downwardObstacleDistance_inline", @@ -96469,6 +96275,104 @@ var search_data = { "#DJIFlightController_isLockTakeoffWithoutGPS_inline", "", ], + [ + "setCoordinatedTurnEnabled", + 2, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_setCoordinatedTurnEnabled_inline", + "Enables the coordinated turn. Improves aerodynamic efficiency. The aircraft is flying in the direction of the turn, without sideslipping. Only supported by M300 RTK. @param enabled `true` to enable the coordinated turn. @param callback Callback that receives the execution result.", + ], + [ + "Enables the coordinated turn. Improves aerodynamic efficiency. The aircraft is flying in the direction of the turn, without sideslipping. Only supported by M300 RTK. @param enabled `true` to enable the coordinated turn. @param callback Callback that receives the execution result.", + 1, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_setCoordinatedTurnEnabled_inline", + "", + ], + [ + "getCoordinatedTurnEnabled", + 2, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_getCoordinatedTurnEnabled_inline", + "Get whether the coordinated turn switch is on. Only supported by M300 RTK. @param callback Callback that receives the execution result.", + ], + [ + "Get whether the coordinated turn switch is on. Only supported by M300 RTK. @param callback Callback that receives the execution result.", + 1, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_getCoordinatedTurnEnabled_inline", + "", + ], + [ + "setNavigationSatelliteSystem", + 2, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_setNavigationSatelliteSystem_inline", + "The selection of satellite positioning system is only supported when the RTK positioning function is turned off, and cannot be modified in the air. If RTK positioning function is turned on, aircraft uses GPS, GLONASS, Galileo, and BDS data to determine location. Only supported by M300 RTK. @param system Navigation satellite system. @param callback Callback that receives the execution result.", + ], + [ + "The selection of satellite positioning system is only supported when the RTK positioning function is turned off, and cannot be modified in the air. If RTK positioning function is turned on, aircraft uses GPS, GLONASS, Galileo, and BDS data to determine location. Only supported by M300 RTK. @param system Navigation satellite system. @param callback Callback that receives the execution result.", + 1, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_setNavigationSatelliteSystem_inline", + "", + ], + [ + "getNavigationSatelliteSystem", + 2, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_getNavigationSatelliteSystem_inline", + "Get the navigation satellite system. Only supported by M300 RTK. @param callback Callback that receives the execution result.", + ], + [ + "Get the navigation satellite system. Only supported by M300 RTK. @param callback Callback that receives the execution result.", + 1, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_getNavigationSatelliteSystem_inline", + "", + ], + [ + "NavigationSatelliteSystem", + 2, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_NavigationSatelliteSystem_inline", + "This enum defines the navigation satellite system currently being used.", + ], + [ + "This enum defines the navigation satellite system currently being used.", + 1, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_NavigationSatelliteSystem_inline", + "", + ], + [ + "GPS_GLONASS", + 2, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_NavigationSatelliteSystem_GPS_GLONASS_inline", + "Using GSP and GLONSS satellite data.", + ], + [ + "Using GSP and GLONSS satellite data.", + 1, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_NavigationSatelliteSystem_GPS_GLONASS_inline", + "", + ], + [ + "BEIDOU", + 2, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_NavigationSatelliteSystem_BEIDOU_inline", + "Only use Beidou satellite navigation system.", + ], + [ + "Only use Beidou satellite navigation system.", + 1, + "/Components/FlightController/DJIFlightController.html", + "#DJIFlightController_NavigationSatelliteSystem_BEIDOU_inline", + "", + ], [ "OnboardSDKDeviceDataCallback", 2, @@ -114604,10 +114508,10 @@ var search_data = { 2, "/Components/RemoteController/DJIRemoteController.html", "#DJIRemoteController_DJIRemoteControllerDisplayNameMavicMini_inline", - "The display name of Mavic Mini's remote controller.", + "The display name of Mavic Mini/DJI Mini SE's remote controller.", ], [ - "The display name of Mavic Mini's remote controller.", + "The display name of Mavic Mini/DJI Mini SE's remote controller.", 1, "/Components/RemoteController/DJIRemoteController.html", "#DJIRemoteController_DJIRemoteControllerDisplayNameMavicMini_inline", diff --git a/docs/API Reference/stylesheets/doc-app.css b/docs/API Reference/stylesheets/doc-app.css index 825418a5..4d693a16 100644 --- a/docs/API Reference/stylesheets/doc-app.css +++ b/docs/API Reference/stylesheets/doc-app.css @@ -1,4 +1,4 @@ -/* mixin */ +/* mixin */ /* color */ /* $light-text-color: #a6acaa; */ /* b4b4b4 */ diff --git a/docs/API Reference/stylesheets/doc-vendor.css b/docs/API Reference/stylesheets/doc-vendor.css index 1a0f0e10..f9aefb48 100644 --- a/docs/API Reference/stylesheets/doc-vendor.css +++ b/docs/API Reference/stylesheets/doc-vendor.css @@ -1,4 +1,4 @@ -@charset "UTF-8"; +@charset "UTF-8"; /*! * Bootstrap v3.3.5 (http://getbootstrap.com) * Copyright 2011-2015 Twitter, Inc. diff --git a/docs/SDK APIs Diff/4.16_4.16.1_android_diff.html b/docs/SDK APIs Diff/4.16_4.16.1_android_diff.html new file mode 100644 index 00000000..672b569e --- /dev/null +++ b/docs/SDK APIs Diff/4.16_4.16.1_android_diff.html @@ -0,0 +1,54 @@ + + + +
+ +

DJI Mobile SDK 4.16 to 4.16.1 Differences

+ +
+ +

API changes

+ +
4.16 Parent and Name4.16 Code4.16.1 Parent and Name4.16.1 CodeParentNameTypeParamReturn
dji.sdk.sdkmanager.LiveStreamManager.startStreamint startStream() dji.sdk.sdkmanager.LiveStreamManager.startStreamsynchronized int startStream()
X

+ +

APIs added to 4.16.1

+ +
Parent and NameCode
dji.common.error.DJIFlightControllerError.NAVIGATION_SATELLITE_SYSTEM_CAN_NOT_SETstatic final DJIFlightControllerError NAVIGATION_SATELLITE_SYSTEM_CAN_NOT_SET = new DJIFlightControllerError("The selection of navigation satellite system is only supported when the RTK function is turned off, and cannot be modified in the air")
dji.common.error.DJIWaypointV2Error.DJIWaypointV2Errorstatic DJIWaypointV2Error ACTION_ACTUATOR_CAMERA_EXEC_FAIL + = new DJIWaypointV2Error("Camera fail to exec coressponding command.", -15008)
dji.common.error.DJIWaypointV2Error.DJIWaypointV2Errorstatic DJIWaypointV2Error ACTION_ACTUATOR_OPERATION_INDEX_INVALID + = new DJIWaypointV2Error("The action actuator operation index is invalid.", -9005)
dji.common.error.DJIWaypointV2Error.DJIWaypointV2Errorstatic DJIWaypointV2Error ACTION_ACTUATOR_STATUS_NOT_MATCH_ACTION + = new DJIWaypointV2Error("The actuator state does not match action.", -9004)
dji.common.error.DJIWaypointV2Error.DJIWaypointV2Errorstatic DJIWaypointV2Error ACTION_INTERVAL_TRIGGER_WAYPOINT_INDEX_INVALID + = new DJIWaypointV2Error("The action trigger waypoint index is invalid.", -8007)
dji.common.flightcontroller.NavigationSatelliteSystemenum NavigationSatelliteSystem
dji.common.flightcontroller.NavigationSatelliteSystem.BEIDOU BEIDOU(1)
dji.common.flightcontroller.NavigationSatelliteSystem.GPS_GLONASS GPS_GLONASS(0)
dji.common.flightcontroller.NavigationSatelliteSystem.UNKNOWN UNKNOWN(0xFFFF)
dji.sdk.flightcontroller.FlightController.getCoordinatedTurnEnabledvoid getCoordinatedTurnEnabled(@Nullable CompletionCallbackWith<Boolean> callback)
dji.sdk.flightcontroller.FlightController.getNavigationSatelliteSystemvoid getNavigationSatelliteSystem(@Nullable CompletionCallbackWith<NavigationSatelliteSystem> callback)
dji.sdk.flightcontroller.FlightController.setCoordinatedTurnEnabledvoid setCoordinatedTurnEnabled(@NonNull boolean enabled, @Nullable CompletionCallback<DJIError> callback)
dji.sdk.flightcontroller.FlightController.setNavigationSatelliteSystemvoid setNavigationSatelliteSystem(@NonNull NavigationSatelliteSystem system, @Nullable CompletionCallback<DJIError> callback)

581f068 511e425 a618c40 76a6472 15bf140 a618c40 f168c7d 61b21e1 7ae0bce 581f068 7ae0bce a1da5c9

+ +