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.
+
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, M300 RTK and M350 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.
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.
+
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, M300 RTK and M350 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.
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.
+
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, M300 RTK and M350 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.
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.
+
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, M300 RTK and M350 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.
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.
+
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, M300 RTK and M350 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.
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.
+
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, M300 RTK and M350 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.
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.
+
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, M300 RTK and M350 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.
Enable or disable the link zoom function. After enabling the link zoom function, call setThermalDigitalZoomFactor to achieve synchronous zooming of the infrared lens and the zoom lens. In the split-screen mode PIP, the user can compare the images of the infrared lens and the zoom lens more efficiently.
+Supported by Zenmuse H20 Series.
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.
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 Series and Mavic 2 Enterprise Advanced, please use class Lens.
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.
The 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 callback
The execution callback with the returned execution result.
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.
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.
Sets the TimeLapse parameters, including interval, duration and file format when saving. Precondition: Camera should be in TIME_LAPSE mode of ShootPhotoMode.
The 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 callback
The execution block with the returned execution result.
Gets the TimeLapse parameters including interval, duration and file format when saving. Precondition: The camera must be in TIME_LAPSE mode of ShootPhotoMode.
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.
voidsetPanoOriginalPhotoSettings(@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.
voidgetPanoOriginalPhotoSettings( @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.
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:
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.
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:
+
Input Parameters:
boolean enabled
true to enable video caption.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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:
+
Input Parameters:
boolean enabled
true to enable the RAW video recording.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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:
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.
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.
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:
+
Input Parameters:
@NonNull final CompletionCallbackWith<SSDLegacyColor> callback
The execution callback with the returned value(s).
voidgetSSDColor(@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.
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.
voidgetAutoLockGimbalEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Determines whether the gimbal will be locked automatically during shooting photos.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callback
The execution callback with the returned value(s).
Watermark Settings
@@ -3146,18 +3157,18 @@
Watermark Settings
voidsetWatermarkSettings(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.
voidgetWatermarkSettings(@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.
The execution callback with the returned value(s).
Storage Settings
@@ -3166,79 +3177,79 @@
Storage Settings
voidsetCustomExpandDirectoryName(@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 Series.
-
Input Parameters:
+
Input Parameters:
@NonNull String name
Custom directory name to set.
@Nullable final CompletionCallback callback
The completion callback that receives the execution result.
voidsetCustomExpandFileName(@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 Series.
-
Input Parameters:
+
Input Parameters:
@NonNull String name
Custom file name to set.
@Nullable final CompletionCallback callback
The completion callback that receives the execution result.
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:
boolean
A boolean value.
@@ -3247,9 +3258,9 @@
Return:
voidformatSSD(@Nullable final CompletionCallback callback)
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:
+
Input Parameters:
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
Laser Sensor
@@ -3258,18 +3269,18 @@
Laser Sensor
voidsetLaserEnabled(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.
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 Series.
voidsetIRFilterEnabled(finalboolean 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 Series and Mavic 2 Enterprise Advanced, please use class Lens.
-
Input Parameters:
+
Input Parameters:
final boolean enabled
true to enable IR-Cut filter.
@Nullable final CompletionCallback callback
The execution callback that receives the setter result.
voidgetIRFilterEnabled(@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 Series and Mavic 2 Enterprise Advanced, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callback
The execution callback with the returned value(s).
Sets the camera's color. The default value is NONE. For a list of all possible camera colors, see CameraColor. For Zenmuse H20 Series and Mavic 2 Enterprise Advanced, please use class Lens.
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.
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:
+
Input Parameters:
@NonNull String information
Custom information to set. Use UTF-8 encoding with a length equal to or less than 31 characters.
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:
+
Input Parameters:
@NonNull final CompletionCallbackWith<String> callback
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:
boolean
true if the EI mode is supported, otherwise false.
@@ -3512,79 +3523,79 @@
Return:
voidsetExposureSensitivityMode(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.
voidgetExposureSensitivityMode(@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.
voidsetEI(finalint 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:
+
Input Parameters:
final int ei
The EI value to set.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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:
boolean
true if the mechanical shutter is supported, otherwise false.
@@ -3593,25 +3604,25 @@
Return:
voidsetMechanicalShutterEnabled(finalboolean 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:
+
Input Parameters:
final boolean enabled
true to enable the mechanical shutter.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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:
boolean
true if the ND filter mode is supported, otherwise false.
@@ -3620,43 +3631,43 @@
Return:
voidsetNDFilterMode(final SettingsDefinitions.NDFilterMode mode, @Nullable final CompletionCallback callback)
voidsetSSDClipFileName(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.
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:
boolean
A boolean value.
@@ -3665,72 +3676,72 @@
Return:
voidsetPhotoQuickViewDuration(@IntRange(from = 0, to = 10)int duration, @Nullable final CompletionCallback callback)
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:
+
Input Parameters:
@IntRange(from = 0, to = 10) int duration
Quick 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 callback
The execution callback with the returned execution result.
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:
+
Input Parameters:
boolean enabled
Enable or disable HD live view.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callback
The execution callback with the returned value(s).
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:
+
Input Parameters:
boolean enabled
Enable the automatic control of the front-arm LEDs.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
voidsetBeaconAutoTurnOffEnabled(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 Series mounted on Matrice 300 RTK.
-
Input Parameters:
+
Input Parameters:
boolean enabled
Enable the automatic control of the beacon.
@NonNull final CompletionCallback callback
The execution callback with the returned value(s).
voidgetBeaconAutoTurnOffEnabled(@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 Series mounted on Matrice 300 RTK.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callback
The execution callback with the returned value(s).
Storage Location
@@ -3739,7 +3750,7 @@
Storage Location
booleanisInternalStorageSupported()
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:
boolean
true if internal storage is supported.
@@ -3748,18 +3759,18 @@
Return:
voidsetStorageLocation(@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.
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:
+
Input Parameters:
boolean turnOffWhenPossible
true to turn fan off whenever possible.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
Return:
boolean
A boolean value.
@@ -3842,558 +3853,558 @@
Return:
voidsetThermalROI(@NonNull ThermalROI roi, @Nullable final CompletionCallback callback)
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 and H20N, please use class Lens.
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 and H20N, please use class Lens.
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 and H20N, please use class Lens.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = -20, to = 100) int value
Integer 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 callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = -8, to = 8) int value
Integer 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 callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 100) int value
Percentage of histogram to map linearly [0, 100].
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 16383) int brightness
The integer value falls in [0, 16383].
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 255) int contrast
Contrast value as an integer with range [0, 255].
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
boolean enabled
true if isotherms are enabled.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
Determines whether Isotherms are enabled. true if Isotherms are enabled. Supported only by thermal imaging cameras. For Zenmuse H20T and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Boolean> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
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 and H20N, please use class Lens.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 100) int value
If 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 callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 100) int value
If 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 callback
The execution callback with the returned execution result.
Gets the middle threshold value for Isotherm. Supported only by thermal imaging cameras, except Mavic 2 Enterprise Dual thermal camera. For Zenmuse H20T and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 100) int value
If 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 callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
Sets the mode for thermal measurement. Use callback method onUpdate to receive the measurement result. Supported only by thermal imaging cameras. For Zenmuse H20T and H20N, please use class Lens.
For 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 callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull PointF targetPoint
The desired target point.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<PointF> callback
The execution callback with the returned value(s).
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:
+
Input Parameters:
@NonNull RectF area
The desired thermal metering area.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<RectF> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<ThermalFFCMode> callback
The execution callback with the returned value(s).
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 and H20N, please use class Lens.
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 and H20N, please use class Lens.
Set the temperature of the atmosphere between the scene and the camera. Supported only by Zenmuse XT containing Advanced Radiometry capabilities. For Zenmuse H20T and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
float temperature
The assumed temperature of the atmosphere between the camera and the scene, can be between -50 and 327.67 degrees Celsius.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
final float coefficient
The desired atmospheric temperature, can be between 50 and 100.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
final float temperature
The desired background reflected temperature.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
final float emissivity
The desired scene emissivity.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
final float reflection
The desired window reflection coefficient.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
final float temperature
The desired window reflected temperature.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
final float temperature
The desired window temperature.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 and H20N, please use class Lens.
-
Input Parameters:
+
Input Parameters:
final float coefficient
The desired window transmission coefficient.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
voidsetThermalTemperatureUnit(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 H20 Series and Mavic 2 Enterprise Advanced, please use class Lens.
voidsetDisplayMode(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 Series and Mavic 2 Enterprise Advanced, please use class Lens.
voidgetDisplayMode(@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 Series and Mavic 2 Enterprise Advanced, please use class Lens.
voidsetMSXLevel(@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 Series and Mavic 2 Enterprise Advanced, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 100) int level
The MSX level to set with range [0, 100].
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
voidgetMSXLevel(@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 Series and Mavic 2 Enterprise Advanced, please use class Lens.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned execution result.
voidsetDualFeedVerticalAlignmentOffset(@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:
+
Input Parameters:
@IntRange(from = -40, to = 40) int offset
Range from -8 to 8 for XT2, from -40 to 40 for Mavic 2 Enterprise Dual.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
voidgetDualFeedVerticalAlignmentOffset(@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:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned execution result.
voidsetDualFeedHorizontalAlignmentOffset(@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:
+
Input Parameters:
@IntRange(from = -100, to = 100) int offset
Range from -100 to 100 for XT2, from -40 to 40 for Mavic 2 Enterprise Dual.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
voidgetDualFeedHorizontalAlignmentOffset(@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:
+
Input Parameters:
@NonNull final CompletionCallbackWith<Integer> callback
The execution callback with the returned execution result.
Multi Lenses
@@ -4402,7 +4413,7 @@
Multi Lenses
booleanisMultiLensCameraSupported()
Package:
dji.sdk.camera
-
Description:
+
Description:
Determines if the camera supports the multiple lens.
Return:
boolean
true if the multiple lens is supported.
@@ -4411,7 +4422,7 @@
Return:
booleanisMultiVideoStreamSourceSupported()
Package:
dji.sdk.camera
-
Description:
+
Description:
Determines whether the camera supports multi video stream source or not.
Return:
boolean
A boolean value.
@@ -4420,54 +4431,54 @@
Return:
voidsetCameraVideoStreamSource(@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 Series.
voidgetCameraVideoStreamSource(@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.
voidsetCaptureCameraStreamSettings(@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.
voidsetRecordCameraStreamSettings(@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.
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.
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.
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.
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.
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.
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.
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.
Shutter 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.
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.
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:
+
Input Parameters:
boolean isLocked
true if the the single-band sensors AE is locked, false if it is unlocked.
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.
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).
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.
+
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, M300 RTK and M350 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.
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.
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> callback
The execution callback with the value(s) returned.
The internal storage embedded in the aircraft. When it is available, the camera can shoot photos or record videos without SD card. It is only supported by Mavic Air.
The different colors are used to show various temperatures in the thermal imagery image. The colors are not actually related to wavelengths of light, but rather the grayscale intensity.
-
Enum Members:
+
Enum Members:
WHITE_HOT
Without Isotherm enabled, the Palette type is WhiteHot. With Isotherm enabled, the Palette type is WhiteHotIso.
BLACK_HOT
Without Isotherm enabled, the Palette type is BlackHot. With Isotherm enabled, the Palette type is BlackHotIso.
RED_HOT
Without Isotherm enabled, the Palette type is RedHot. With Isotherm enabled, the Palette type is RedHotIso. Shown as Tint in DJI Pilot.
GREEN_HOT
Without Isotherm enabled, the Palette type is GreenHot. With Isotherm enabled, the Palette type is GreenHotIso. Shown as Medical in DJI Pilot.
FUSION
Without Isotherm enabled, the Palette type is Fusion. With Isotherm enabled, the Palette type is FusionIso.
RAINBOW
Without Isotherm enabled, the Palette type is Rainbow. With Isotherm enabled, the Palette type is RainbowIso. Shown as Rainbow1 in DJI Pilot.
IRONBOW_1
Without Isotherm enabled, the Palette type is Ironbow1. With Isotherm enabled, the Palette type is IronbowWHIso. Shown as IronRed in DJI Pilot.
IRONBOW_2
Without Isotherm enabled, the Palette type is Ironbow2. With Isotherm enabled, the Palette type is IronbowBHIso.
ICE_FIRE
Without Isotherm enabled, the Palette type is IceFire. With Isotherm enabled, the Palette type is IceFireIso. Shown as Arctic in DJI Pilot.
SEPIA
Without Isotherm enabled, the Palette type is Sepia. With Isotherm enabled, the Palette type is SepiaIso.
GLOWBOW
Without Isotherm enabled, the Palette type is Glowbow. With Isotherm enabled, the Palette type is GlowbowIso.
COLOR_1
Without Isotherm enabled, the Palette type is Color1. With Isotherm enabled, the Palette type is MidRangeWHIso. Shown as Fulgurite in DJI Pilot.
COLOR_2
Without Isotherm enabled, the Palette type is Color2. With Isotherm enabled, the Palette type is MidRangeBHIso. Shown as HotIron in DJI Pilot.
RAIN
Without Isotherm enabled, the Palette type is Rain. With Isotherm enabled, the Palette type is RainbowHCIso. Shown as Rainbow2 in DJI Pilot.
HOT_SPOT
Without Isotherm enabled, the Palette type is HotSpot. With Isotherm enabled, the Palette type is HotSpotIso. Only supported by Mavic 2 Enterprise Dual.
RAINBOW2
Without Isotherm enabled, the Palette type is Rainbow2. With Isotherm enabled, the Palette type is Rainbow2Iso. Only supported by Mavic 2 Enterprise Dual.
GRAY
Without Isotherm enabled, the Palette type is Gray. With Isotherm enabled, the Palette type is GrayIso. Only supported by Mavic 2 Enterprise Dual.
HOT_METAL
Without Isotherm enabled, the Palette type is HotMetal. With Isotherm enabled, the Palette type is HotMetalIso. Only supported by Mavic 2 Enterprise Dual.
COLD_SPOT
Without Isotherm enabled, the Palette type is ColdSpot. With Isotherm enabled, the Palette type is ColdSpotIso. Only supported by Mavic 2 Enterprise Dual.
Thermal camera temperature measurement mode. The default value is Disabled.
-
Enum Members:
+
Enum Members:
DISABLED
Disable temperature measuring.
SPOT_METERING
Enable temperature measurement and set mode to spot metering. Use setThermalTemperatureCallback to receive the updated temperature data. In this mode, the advanced radiometry version XT camera can change the metering point using setThermalSpotMeteringTargetPoint.
AREA_METERING
Enable temperature measurement and set mode to area metering. Use onUpdate to receive the updated temperature data. Only supported by the advanced radiometry version XT camera.
UNKNOWN
Thermal camera's temperature measurement mode is unknown.
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. Supported by the zoom lens of Zenmuse H20 Series.
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Boolean> callback
The execution callback with the returned value(s).
voidsetIRFilterMode(@NonNull final SettingsDefinitions.IRFilterMode irFilterMode, @NonNull final CommonCallbacks.CompletionCallback callback)
+
Package:
dji.sdk.camera
+
Description:
+
Sets the IR filter mode of the current lens. ON to reduce the color distortion caused by the infared light, OFF to enhance the image in low light environments, or AUTO to up to the system to decide whether to switch. Supported by the zoom lens of Zenmuse H20 Series.
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 Series and Mavic 2 Enterprise Advanced, please use class Lens.
Return:
boolean
A boolean value.
@@ -1862,18 +1870,18 @@
Return:
voidsetDigitalZoomFactor(@FloatRange(from = 1.0, to = 2.0)float factor, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the digital zoom factor of the current lens. Not supported by Zenmuse H20 Series.
voidgetDigitalZoomFactor(@NonNull final CommonCallbacks.CompletionCallbackWith<Float> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets current digital zoom factor of the current lens. Note Z30 cannot set the digital zoom scale, but will use digital zoom when using startContinuousOpticalZoom and the optical zoom has reached its limit. Not supported by Zenmuse H20 Series.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Float> callback
The execution callback with the returned value(s).
Optical Zoom
@@ -1882,7 +1890,7 @@
Optical Zoom
booleanisOpticalZoomSupported()
Package:
dji.sdk.camera
-
Description:
+
Description:
Determine if the current lens supports optical zoom. Not supported by Zenmuse H20 Series.
Return:
boolean
true if lens supports optical zoom.
@@ -1891,45 +1899,45 @@
Return:
voidgetOpticalZoomSpec(@NonNull final CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.OpticalZoomSpec> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the specification of the current lens. Not supported by Zenmuse H20 Series.
voidstartContinuousOpticalZoom(@NonNull SettingsDefinitions.ZoomDirection direction, @NonNull final SettingsDefinitions.ZoomSpeed speed, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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. Supported by the zoom lens of Zenmuse H20 Series and Mavic 2 Enterprise Advanced.
voidstopContinuousOpticalZoom(@Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Called to stop focal length changing, when it currently is from calling startContinuousOpticalZoom. Supported by the zoom lens of Zenmuse H20 Series and Mavic 2 Enterprise Advanced.
The execution callback with the returned execution result.
Hybrid Zoom
@@ -1938,7 +1946,7 @@
Hybrid Zoom
booleanisHybridZoomSupported()
Package:
dji.sdk.camera
-
Description:
+
Description:
Hybrid zoom is combining optical and digital zoom. Lens will automatically switch over to digital zoom when optical zoom range is exceeded. Check if lens supports hybrid zoom. Supported by the zoom lens of Zenmuse H20 Series.
Return:
boolean
true if camera supports hybrid zoom.
@@ -1947,27 +1955,27 @@
Return:
voidgetHybridZoomSpec(@NonNull final CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.HybridZoomSpec> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Hybrid zoom is combining optical and digital zoom. Lens will automatically switch over to digital zoom when optical zoom range is exceeded. Gets the specification of the zoom lens. Supported by the zoom lens of Zenmuse H20 Series.
voidsetHybridZoomFocalLength(int focalLength, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Hybrid zoom is combining optical and digital zoom. Lens will automatically switch over to digital zoom when optical zoom range is exceeded. Sets focal length of the zoom lens. Supported by the zoom lens of Zenmuse H20 Series.
voidgetHybridZoomFocalLength(@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Hybrid zoom is combining optical and digital zoom. Lens will automatically switch over to digital zoom when optical zoom range is exceeded. Gets zoom lens focal length in units of 0.1mm. Supported by the zoom lens of Zenmuse H20 Series.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
Tap Zoom
@@ -1976,7 +1984,7 @@
Tap Zoom
booleanisTapZoomSupported()
Package:
dji.sdk.camera
-
Description:
+
Description:
Determines if the current lens supports TapZoom feature.
Return:
boolean
true if camera supports tap zoom.
@@ -1985,45 +1993,45 @@
Return:
voidsetTapZoomEnabled(boolean enabled, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Enable/disable TapZoom. tapZoomAtTarget can only be called when TapZoom is enabled. Supported by Mavic 2 Enterprise Advanced, the zoom lens and the wide lens of Zenmuse H20 Series.
voidsetTapZoomMultiplier(@IntRange(from = 1, to = 5)int multiplier, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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. Supported by the zoom lens and the wide lens of Zenmuse H20 Series. The tap zoom multiplier of Zenmuse H20 Series must be 1.
voidgetTapZoomMultiplier(@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the multiplier for TapZoom. Supported by the zoom lens and the wide lens of Zenmuse H20 Series. The tap zoom multiplier of Zenmuse H20 Series must be 1.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
voidtapZoomAtTarget(@NonNull PointF target, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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. Supported by Mavic 2 Enterprise Advanced, the zoom lens and the wide lens of Zenmuse H20 Series. It will only work when the tap zoom multiplier of Zenmuse H20 Series is 1.
-
Input Parameters:
+
Input Parameters:
@NonNull PointF target
The target 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.
The execution callback with the returned execution result.
Advanced Camera Settings
@@ -2032,7 +2040,7 @@
Advanced Camera Settings
booleanisAdjustableApertureSupported()
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets whether the lens supports an adjustable aperture. Currently adjustable aperture is supported only by the zoom lens of Zenmuse H20 Series.
Return:
boolean
A boolean value.
@@ -2041,25 +2049,25 @@
Return:
voidsetAperture(@NonNull SettingsDefinitions.Aperture aperture, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the aperture value of the current lens. 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 zoom lens of Zenmuse H20 Series and Mavic 2 Enterprise Advanced.
Determines whether the lens supports an adjustable focal point. Currently, the adjustable focal point is supported by the zoom lens of Zenmuse H20 Series.
Return:
boolean
A boolean value.
@@ -2068,81 +2076,81 @@
Return:
voidsetFocusMode(@NonNull SettingsDefinitions.FocusMode focusMode, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the focus mode of the current lens. See FocusMode. It is available only when isAdjustableFocalPointSupported returns true. Supported by the zoom lens of Zenmuse H20 Series. Not supported by Mavic 2 Enterprise Advanced.
voidgetFocusMode(@NonNull final CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.FocusMode> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the focus mode of the current lens. Please check FocusMode. It is available only when isAdjustableFocalPointSupported returns true. Supported by the zoom lens of Zenmuse H20 Series. Not supported by Mavic 2 Enterprise Advanced.
voidsetFocusTarget(@NonNull PointF focusTarget, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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 by the zoom lens of Zenmuse H20 Series. Not supported by Mavic 2 Enterprise Advanced.
-
Input Parameters:
+
Input Parameters:
@NonNull PointF focusTarget
The 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.
voidgetFocusTarget(@NonNull final CommonCallbacks.CompletionCallbackWith<PointF> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the lens focus target point. It is available only when isAdjustableFocalPointSupported returns true. Supported by the zoom lens of Zenmuse H20 Series. Not supported by Mavic 2 Enterprise Advanced.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<PointF> callback
The execution callback with the returned value(s).
voidsetFocusAssistantSettings(FocusAssistantSettings settings, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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. Not supported by Mavic 2 Enterprise Advanced.
voidgetFocusAssistantSettings(@NonNull final CommonCallbacks.CompletionCallbackWithTwoParam<Boolean, Boolean> callback)
Package:
dji.sdk.camera
-
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 by the zoom lens of Zenmuse H20 Series. Not supported by Mavic 2 Enterprise Advanced.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWithTwoParam<Boolean, Boolean> callback
The execution callback with the returned value(s).
voidgetFocusRingValueUpperBound(@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the lens focusing ring value's max value. It is available only when isAdjustableFocalPointSupported returns true. Supported by the zoom lens of Zenmuse H20 Series. Not supported by Mavic 2 Enterprise Advanced.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
voidsetFocusRingValue(@IntRange(from = 0)int value, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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 by the zoom lens of Zenmuse H20 Series. Not supported by Mavic 2 Enterprise Advanced.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0) int value
Value 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.
voidgetFocusRingValue(@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the lens focus ring value. It is available only when isAdjustableFocalPointSupported returns true. Supported by the zoom lens of Zenmuse H20 Series. Not supported by Mavic 2 Enterprise Advanced.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
Mechanical Shutter Speed
@@ -2151,7 +2159,7 @@
Mechanical Shutter Speed
booleanisMechanicalShutterSupported()
Package:
dji.sdk.camera
-
Description:
+
Description:
Determines whether the mechanical shutter speed is supported by the camera or the lens.
Return:
boolean
true if the mechanical shutter is supported, otherwise false.
@@ -2160,18 +2168,18 @@
Return:
voidsetMechanicalShutterEnabled(finalboolean enabled, @Nullable final CommonCallbacks.CompletionCallback callback)
voidgetMechanicalShutterEnabled(@NonNull final CommonCallbacks.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:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Boolean> callback
The execution callback with the returned boolean value.
Video Recording
@@ -2180,18 +2188,18 @@
Video Recording
voidsetAntiFlickerFrequency(@NonNull SettingsDefinitions.AntiFlickerFrequency antiFlickerFrequency, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the lens 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 Series.
The execution callback with the returned value(s).
Thermal Imaging Camera
@@ -2200,7 +2208,7 @@
Thermal Imaging Camera
booleanisThermalLens()
Package:
dji.sdk.camera
-
Description:
+
Description:
Return true if the current connected device is a thermal imaging lens.
Return:
boolean
A boolean value.
@@ -2209,596 +2217,596 @@
Return:
voidsetThermalROI(@NonNull SettingsDefinitions.ThermalROI roi, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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 by the thermal lens of Zenmuse H20T and H20N.
voidsetThermalPalette(@NonNull SettingsDefinitions.ThermalPalette palette, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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.
voidsetThermalScene(@NonNull SettingsDefinitions.ThermalScene scene, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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.
voidsetThermalDDE(@IntRange(from = -20, to = 100)int value, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = -20, to = 100) int value
Integer 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.
voidsetThermalACE(@IntRange(from = -8, to = 8)int value, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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. Not supported by Zenmuse H20T and H20N.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = -8, to = 8) int value
Integer 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.
voidgetThermalACE(@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the value of Active Contrast Enhancement. The value is available only when the Scene mode is Manual, User1, User2 or User3. Not supported by Zenmuse H20T and H20N.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
voidsetThermalSSO(@IntRange(from = 0, to = 100)int value, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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. Not supported by Zenmuse H20T and H20N.
voidgetThermalSSO(@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the value of Smart Scene Optimization. The value is available only when the Scene mode is Manual, User1, User2 or User3. Not supported by Zenmuse H20T and H20N.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned value(s).
voidsetThermalIsothermEnabled(boolean enabled, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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. Not supported by Mavic 2 Enterprise Advanced.
voidsetThermalIsothermMiddleValue(@IntRange(from = 0, to = 100)int value, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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. Not supported by Zenmuse H20T and H20N.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 100) int value
If 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.
voidsetThermalIsothermLowerValue(@IntRange(from = 0, to = 100)int value, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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 by the thermal lens of Zenmuse H20T and H20N.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = 0, to = 100) int value
If the unit is percentage, the value falls in [0,100].
voidsetThermalGainMode(@NonNull SettingsDefinitions.ThermalGainMode mode, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
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, for Mavic 2 Enterprise Advanced, the low gain mode can be used from -20 to 450 degrees Celsius. The high gain mode can be used from -20 to 150 degree Celsius
Sets the mode for thermal measurement. Supported only by thermal imaging cameras. Supported by the thermal lens of Zenmuse H20T and H20N and Mavic 2 Enterprise Advanced.
For 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 ThermalDigitalZoomFactor in DJICameraSettingsDef.
voidgetThermalProfile(@NonNull final CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.ThermalProfile> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the thermal imaging camera profile. The profile includes information about resolution, frame rate and focal length. Supported by the thermal lens of Zenmuse H20T and H20N.
voidgetThermalSpotMeteringTargetPoint( @NonNull final CommonCallbacks.CompletionCallbackWith<PointF> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the spot metering target point if one is set, if not then returns CGPointZero.
Supported by the thermal lens of Zenmuse H20T and H20N and Mavic 2 Enterprise Advanced.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<PointF> callback
The execution callback with the returned value(s).
voidsetThermalSpotMeteringTargetPoint(@NonNull PointF targetPoint, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the spot metering target point which then invoke the callback from setThermalTemperatureCallback. 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. You should call setThermalMeasurementMode to set the measurement mode to SPOT_METERING first. Supported by the thermal lens of Zenmuse H20T and H20N and Mavic 2 Enterprise Advanced.
voidsetThermalMeteringArea(@NonNull RectF area, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Set the metering area for a rectangle inside the thermal ismage scene, which allows the camera to transmit aggregate temperature computations via the onUpdate delegate 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. You should call setThermalMeasurementMode to set the measurement mode to AREA_METERING first. Supported by the thermal lens of Zenmuse H20T and H20N and Mavic 2 Enterprise Advanced.
voidgetThermalCustomExternalSceneSettingsProfile( @NonNull final CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.ThermalCustomExternalSceneSettingsProfile> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the currently set custom user profile. This profile represents user-set external scene parameters for the thermal scene. Not supported by Zenmuse H20T and H20N.
voidsetThermalCustomExternalSceneSettingsProfile(@NonNull SettingsDefinitions.ThermalCustomExternalSceneSettingsProfile profile, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the custom user profile. This profile represents user-set external scene parameters for the thermal scene. Not supported by Zenmuse H20T and H20N.
voidsetDisplayMode(final SettingsDefinitions.DisplayMode mode, @Nullable final CommonCallbacks.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 applies to the thermal infrared video feed. For Zemmuse H20T and H20N, you should set setCameraVideoStreamSource with INFRARED_THERMAL first. Only supported by Zenmuse H20T and H20N.and Mavic 2 Enterprise Advanced.
voidsetPIPPosition(final SettingsDefinitions.PIPPosition position, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the thermal window's position relative to the visual window. Only applies to the thermal infrared video feed. The setting is valid when the display mode is PIP. Refer to setDisplayMode and getDisplayMode.
voidgetPIPPosition(@NonNull final CommonCallbacks.CompletionCallbackWith<SettingsDefinitions.PIPPosition> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the PIP position which determines the thermal window's position relative to the visual window. The setting is valid when the display mode is PIP. Refer to setDisplayMode and getDisplayMode.
voidsetMSXLevel(@IntRange(from = 0, to = 100)int level, @Nullable final CommonCallbacks.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 applies to the thermal infrared video feed.
voidgetMSXLevel(@NonNull final CommonCallbacks.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. Supported by the thermal lens of Zenmuse H20T and H20N.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned execution result.
voidsetDualFeedHorizontalAlignmentOffset(@IntRange(from = -100, to = 100)int offset, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the horizontal alignment offset between the video feeds from both the visual lens and the thermal lens. The alignment is applied to the MSX display mode. Different camera results in different value ranges.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = -100, to = 100) int offset
Range from -100 to 100 for XT2, from -40 to 40 for Mavic 2 Enterprise Dual.
voidgetDualFeedHorizontalAlignmentOffset(@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the horizontal alignment offset between the video feeds from both the visual lens and the thermal lens. The alignment is applied to the MSX display mode. Different camera results in different value ranges.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned execution result.
voidsetDualFeedVerticalAlignmentOffset(@IntRange(from = -40, to = 40)int offset, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the vertical alignment offset between the video feeds from both the visual lens and the thermal lens. The alignment is applied to the MSX display mode. Different camera results in different value ranges.
-
Input Parameters:
+
Input Parameters:
@IntRange(from = -40, to = 40) int offset
Range from -8 to 8 for XT2, from -40 to 40 for Mavic 2 Enterprise Dual.
voidgetDualFeedVerticalAlignmentOffset(@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Gets the vertical alignment offset between the video feeds from both the visual lens and the thermal Lens. The alignment is applied to the MSX display mode. Different camera results in different value ranges.
-
Input Parameters:
+
Input Parameters:
@NonNull final CommonCallbacks.CompletionCallbackWith<Integer> callback
The execution callback with the returned execution result.
voidsetThermalBackgroundTemperature(finalfloat temperature, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the assumed temperature reflected by the background of the scene, can be between -50 and 327.67 degrees Celsius. Not supported by Zenmuse H20T and H20N.
voidsetThermalWindowReflection(finalfloat reflection, @Nullable final CommonCallbacks.CompletionCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets assumed window reflection coefficient, can be between 0 and X where X is the window transmission coefficient parameter. Not supported by Zenmuse H20T and H20N.
Enables or disables the infrared sensor protection. If the sensor protection is enabled, the infrared thermal camera shutter might be closed. Only supported by Zenmuse H20T and H20N.
Enables the infrared thermal camera. Infrared thermal camera shutter may be closed, if the sensor protection is enabled. Only supported by Zenmuse H20T and H20N.
Sets the thermal lens temperature aggregation update callback. Callback will be called when there are new min, max, and average values available for the set spot metering area. Supported by the thermal lens of Zenmuse H20T and H20N.
Sets the thermal lens external scene settings update callback. Callback will get called when updated external scene settings are available. Only supported by XT2.
Sets the thermal lens temperature update callback. Callback is used when there is a new temperature value available for the set spot metering target point. Supported by the thermal lens of Zenmuse H20T and H20N.
The Callback object to set as the callback. <br> Callback implements an onUpdate method.</br> The Float object contains information about the updated temperature value.
Sets the callback for updated exposure parameters. The callback's onUpdate method will be called each time the exposure parameters (ISO, Exposure Compensation, Shutter Speed and Aperture) are updated.
voidsetTapZoomStateCallback(@Nullable final Lens.TapZoomStateCallback callback)
Package:
dji.sdk.camera
-
Description:
+
Description:
Sets the tap zoom state callback. The callback's DJICamera_DJILens_TapZoomStateCallbackInterface_onUpdate method will be called when the lens zoom state is updated. Supported by the zoom lens and the wide lens of Zenmuse H20 Series and Mavic 2 Enterprise Advanced.
-
Input Parameters:
+
Input Parameters:
@Nullable final Lens.TapZoomStateCallback callback
Completion block that receives the execution result.
Sets the laser measure information callback. When laser information would been updated, it call Callback to update the laser state information. The laser sensor must be at least 3m from the target point. It is only supported by Zenmuse H20 series.
Set the codec name. For some mobile phones that cannot display video stream normally. You can set the codec name through this interface so that MSDK can call the correct decoder for decoding and display. You can call android API:MediaCodecList to get available codec names for testing.
Gets YUV data from hardware decoder. The obtained data of format is MediaCodecInfo.CodecCapabilities.COLOR_FormatYUV420Planar and the width and height must be even.
-
Input Parameters:
+
Input Parameters:
int width
width of the video.
int height
height of the video.
Return:
byte[]
The YUV data from the hardware decoder.
@@ -1626,9 +1625,9 @@
Return:
byte[] getRgbaData(int width, int height)
Package:
dji.sdk.codec
-
Description:
+
Description:
Gets RGBA data from hardware decoder.
-
Input Parameters:
+
Input Parameters:
int width
width of the video.
int height
height of the video.
Return:
byte[]
The RGBA data from the hardware decoder.
@@ -1638,7 +1637,7 @@
Related:
enum VideoSource
Package:
dji.sdk.codec
-
Description:
+
Description:
The source of the video feed.
Enum Members:
CAMERA
The source of the video feed is the main camera.
FPV
The source of the video feed is the FPV camera.
SECONDARY_CAMERA
The source of the video feed is the secondary camera.
Data Protection Manager. DJI SDK will send data to DJI servers in the background in order to complete logics, including data related to user's information. Data Protection Manager can be used to authorize DJI server to access the user-related data. SDK will NOT send the data to DJI server in the background before the authorization. Internet requests triggered by the user manually are not managed by DataProtectionManager. Involved user-related data is listed in the documentation of the interfaces. The authorization is not persistent and each authorization setting will be reset to the default value for each APP's life cycle. This class is accessible before calling registerApp. The UTMISSManager class needs to report flight dynamic data to the UTMISS server in accordance with the policy requirements of the Civil Aviation Administration of China. It is not in this category of management. For details, please refer to the UTMISSManager interface document.
+
Data Protection Manager. DJI SDK will send data to DJI servers in the background in order to complete logics, including data related to user's information. Data Protection Manager can be used to authorize DJI server to access the user-related data. SDK will NOT send the data to DJI server in the background before the authorization. Internet requests triggered by the user manually are not managed by DataProtectionManager. Involved user-related data is listed in the documentation of the interfaces. This class is accessible before calling registerApp. The UTMISSManager class needs to report flight dynamic data to the UTMISS server in accordance with the policy requirements of the Civil Aviation Administration of China. It is not in this category of management. For details, please refer to the UTMISSManager interface document.
Agree or disagree with the product improvement project. Through this project, the DJI device information, mobile device information, and diagnostic and usage data collected through MSDK will be provided to DJI for analysis. This analysis helps DJI improve products and services. DJI will take necessary data protection measures before data analysis.
Sets true to save log for pipelines. In order to improve developer's experience on SDK interconnectivity, Pipeline is designed to save log files locally when files are transferred, during which the speed is 475KB per minute. Please be careful with the device storage.
+
Sets true to save log for pipelines. In order to improve developer's experience on SDK interconnectivity, DJIPipeline is designed to save log files locally when files are transferred, during which the speed is 475KB per minute. Please be careful with the device storage.
Enables the coordinated turn. Improves aerodynamic efficiency. The aircraft is flying in the direction of the turn, without sideslipping. Only supported by M300 RTK.
+
Enables the coordinated turn. Improves aerodynamic efficiency. The aircraft is flying in the direction of the turn, without sideslipping. Only supported by M300 RTK and M350 RTK.
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.
+
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 and M350 RTK.
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.
+
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 or M350 RTK, the limit can beyond 500m.
Input Parameters:
@IntRange(from = 20, to = 500) int height
The aircraft's default go home altitude.
@Nullable CompletionCallback callback
The execution callback with the returned execution result.
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.
+
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, M300 RTK and M350 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.
Unlocks the selected fly zones. This method can be used to unlock authorization zones. After unlocking the zones, flight will be unrestricted in those zones until the unlock expires. The unlocking record will be linked to the user's account and will be accessible to DJI Go and other DJI Mobile SDK based applications. Data Protection Notes - Calling this method will send the following protected data to DJI server: - User account information - The serial number of the connected aircraft.
voidunlockAuthorizationFlyZone(@Size(min = 1)finalint id, @Nullable final CompletionCallback<DJIError> callback)
+
Package:
dji.sdk.flightcontroller
+
Description:
+
Unlock the authorization fly zone. After unlocking the authorization fly zone, the aircraft will be able to take off normally in the authorization fly zone, and the authorization fly zone will continue to be banned after reboot the aircraft.
Reloads the unlocked zone groups unlocked by the current user's account from the server. For all products besides Phantom 3 and Inspire 1 series this includes both self unlocked and custom unlocked zones. Each unlocked zone group corresponds to one aircraft serial number. After launch, SDK will call this method once. It will call this method again when either the network connection or the current account state changes (e.g. when a new user successfully logs in). Call this method any other time to trigger the reloading manually. Calling this method will NOT synchronize the loaded zone groups onto the aircraft. To get a list of groups currently loaded from the server, call getLoadedUnlockedZoneGroups. User will need to manually call syncUnlockedZoneGroupToAircraft to synchronize the unlocked group to the connected aircraft after the unlocked zone groups are reloaded. This feature is not supported by Inspire 1 or Phantom 3 series. For the other products, it can be used when isCustomUnlockZoneSupported returns true.
Gets the unlocked zone groups loaded from the server. Each zone group corresponds to one aircraft. The loaded zone groups will NOT be synchronized to the aircraft automatically. User need to manually invoke syncUnlockedZoneGroupToAircraft to synchronize the unlocked zone group to the connected aircraft. Invoke reloadUnlockedZoneGroupsFromServer to trigger the reloading of unlocked zone groups manually. This feature is not supported by Inspire 1 or Phantom 3 series. For the other products, it can be used when isCustomUnlockZoneSupported returns true.
Synchronizes the unlocked zone group to the connected aircraft. SDK will select the unlocked zone group that matches the serial number of the connected aircraft. After the unlocked zone group is synchronized to the aircraft successfully, the latest unlocked fly zones and the custom unlock zones on the aircraft can be checked by the follow methods:
voidenableCustomUnlockZone(@Nullable CustomUnlockZone zone, @Nullable final CompletionCallback callback)
Package:
dji.sdk.flightcontroller
-
Description:
+
Description:
Enables an Custom Unlock Zones that is on the aircraft. All Custom Unlock Zones on the aircraft can be retrieved with getCustomUnlockZonesFromAircraft. At any time, only one Custom Unlock Zone can be enabled. Enabling an Custom Unlock Zone will disable the previously enabled zone. This method can only be used when isCustomUnlockZoneSupported is true.
true if an aircraft is connected with flight controller firmware that supports Custom Unlock Zones. Aircraft that support Custom Unlock zones are also able to disable unlocked fly zones temporarily.
Return:
boolean
A boolean value to check if Custom Unlock Zone supported.
@@ -1591,54 +1590,54 @@
Return:
voidgetPreciseDatabaseVersion(@NonNull final CompletionCallbackWith<String> callback)
Package:
dji.sdk.flightcontroller
-
Description:
+
Description:
The version of the precise fly zone database in the firmware of the aircraft. It is null if getPreciseDatabaseState is INITIALIZING. The precise database is supported by Phantom 4 series, Inspire 2, M200 series, Mavic and Spark.
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<String> callback
voidgetPreciseDatabaseState(@NonNull final CompletionCallbackWith<FlyZoneDatabaseState> callback)
Package:
dji.sdk.flightcontroller
-
Description:
+
Description:
The fly zone database state in the firmware of the aircraft. The SDK will compare the version of the database on the aircraft against the latest one online. When the aircraft database is out-of-date, the user should use DJI Go or Assistant 2 to update the firmware. This database is supported by Phantom 4 series, Inspire 2, M200 series, Mavic and Spark.
voidgetBasicDatabaseState(@NonNull final CompletionCallbackWith<FlyZoneDatabaseState> callback)
Package:
dji.sdk.flightcontroller
-
Description:
+
Description:
Get the state of the basic fly zone database on the mobile device. The SDK will compare the version of the local database against the latest one online. When the local database is out-of-date, call startBasicDatabaseUpgrade to start updating the database. If the update is compulsory (for safety reasons), SDK will start the update automatically. The basic database is used by DJI aircraft that do not support the precise database (e.g. Phantom 3 series, Inspire 1 series).
voidgetBasicDatabaseVersion(@NonNull final CompletionCallbackWith<String> callback)
Package:
dji.sdk.flightcontroller
-
Description:
+
Description:
The version of the basic fly zone database on the mobile device. It is null if the local file cannot be parsed by SDK. The basic database is used by DJI aircraft that do not support the precise database (e.g. Phantom 3 series, Inspire 1 series).
-
Input Parameters:
+
Input Parameters:
@NonNull final CompletionCallbackWith<String> callback
The execution callback with the returned String value.
The state of the fly zone database on the aircraft.
Enum Members:
INITIALIZING
SDK is fetching the information of the database.
NO_INTERNET_CONNECTION
SDK cannot access the Internet, so it cannot compare the database version with the latest one on the Internet.
OUT_OF_DATE
Aircraft's database version is older than the latest one. User should use DJI Go or Assistant 2 to upgrade the firmware in order to keep the database up to date.
UP_TO_DATE
The database in the aircraft is up to date.
UNKNOWN
Unknown state
@@ -1657,7 +1656,7 @@
Class Members:
@EXClassNullAway enum FlyZoneState
Package:
dji.common.flightcontroller.flyzone
-
Description:
+
Description:
This enum describes whether the aircraft is clear of, near, or actually in a fly zone.
Enum Members:
CLEAR
The aircraft is not within 200 meters of any warning, enhanced warning, authorization or restricted zone.
NEAR_RESTRICTED_ZONE
The aircraft is within 200 meters of an authorization or restricted zone.
IN_WARNING_ZONE_WITH_HEIGHT_LIMITATION
The aircraft is currently in a warning or enhanced warning zone and this place will limit max flight height to 120m.
IN_WARNING_ZONE
The aircraft is currently in a warning or enhanced warning zone.
IN_RESTRICTED_ZONE
The aircraft is currently in an authorization or restricted zone.
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.
+
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, M300 RTK and M350 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.
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.
+
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, M300 RTK and M350 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.
Turn on superimposed visible light pixels. In this mode camera will take a photo every 3 seconds. It is recommended to use when flying aircraft manually.
VISIBLE_LIGHT_PIXEL_ON_TIMED_SHOT_OFF
Turn on superimposed visible light pixels. In this mode camera will not take photo automatically. It is recommended to use in Waypoint Mission and set the photo interval to 3 seconds.
Enums represent the point cloud live view color mode of lidar.
-
Enum Members:
-
INTENSITY
Using intensity data to coloring the point cloud live view data.
HEIGHT
Using height(getZ) data to coloring the point cloud live view data. It will help you measure objects with a large height difference.
HYBIRD
Hybird the intensity and distance(getX, getY) data to coloring the point cloud live view data. It will help you to measure objects better when flying horizontally.
In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is not supported by Mavic Pro when using WiFi connection. It is not supported by Spark, Mavic Mini, DJI Mini 2, DJI Mini SE, Mavic Air 2, DJI Air 2S and Matrice 300 RTK.
+
In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is not supported by Mavic Pro when using WiFi connection. It is not supported by Spark, Mavic Mini, DJI Mini 2, DJI Mini SE, Mavic Air 2, DJI Air 2S and Matrice 300 RTK.
Aircraft has reached a waypoint, has rotated to the new heading and is now processing actions. This state will be called before the waypoint actions starts executing and will occur for each waypoint action.
DOING_ACTION
Aircraft is at a waypoint and is executing an action.
FINISHED_ACTION
Aircraft is at a waypoint and has finished executing the current waypoint action. This state occurs once for each waypoint action.
Aircraft has reached a waypoint, has rotated to the new heading and is now processing actions. This state will be called before the waypoint actions starts executing and will occur for each waypoint action.
DOING_ACTION
Aircraft is at a waypoint and is executing an action.
FINISHED_ACTION
Aircraft is at a waypoint and has finished executing the current waypoint action. This state occurs once for each waypoint action.
Gets the interruption of the last waypoint mission. If a waypoint mission is interrupted before the completion, the aircraft will record the interruption information. This information is only available when the last waypoint mission is incomplete and the first waypoint of the mission has been reached. The interruption will also be recorded if the mission is stopped by the user. The interruption information is recorded in the aircraft and the information persists even after the aircraft's reboot. Supported only by Phantom 4 RTK.
+
Gets the interruption of the last waypoint mission. If a waypoint mission is interrupted before the completion, the aircraft will record the interruption information. This information is only available when the last waypoint mission is incomplete and the first waypoint of the mission has been reached. The interruption will also be recorded if the mission is stopped by the user. The interruption information is recorded in the aircraft and the information persists even after the aircraft's reboot. Supported only by Phantom 4 RTK.
voidsetAutoFlightSpeed(@FloatRange(from = -15.0f, to = 15.0f)float speed, @Nullable CompletionCallback<DJIWaypointV2Error> callback)
Package:
dji.sdk.mission.waypoint
Description:
-
Set the flight speed while the mission is executing automatically (without manual joystick speed input). This is the only property or method in this class that can communicate with the aircraft during a mission. All other properties and methods are used offline to prepare the mission which is then uploaded to the aircraft.
+
Set the flight speed while the mission is executing automatically (without manual joystick speed input). This is the only property or method in this class that can communicate with the aircraft during a mission. All other properties and methods are used offline to prepare the mission which is then uploaded to the aircraft.
Input Parameters:
@FloatRange(from = -15.0f, to = 15.0f) float speed
YES when the aircraft reaches a waypoint. After the waypoint actions and heading change is complete, the targetWaypointIndex will increment and this property will become NO.
+
YES when the aircraft reaches a waypoint. After the waypoint actions and heading change is complete, the targetWaypointIndex will increment and this property will become NO.
In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is only supported by MATRICE_300_RTK.
+
In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is only supported by MATRICE_300_RTK.
The state of the operator is unknown. It is the initial action state when the operator is just created.
DISCONNECTED
The connection between the mobile device, remote controller and aircraft is broken.
RECOVERING
The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the action state from the aircraft.
NOT_SUPPORTED
The connected product does not support waypoint mission 2.0.
READY_TO_UPLOAD
The aircraft is ready to upload actions.
UPLOADING
The uploading is started successfully. Detail information for each action is being uploaded one by one.
READY_TO_EXECUTE
Waypoint mission is uploaded completely and the aircraft is ready to start the execution.
Executing
The execution is started successfully.
Interrupted
Waypoint mission is interrupted successfully. User can call interruptMission to continue the execution.
+
UNKNOWN
The state of the operator is unknown. It is the initial action state when the operator is just created.
DISCONNECTED
The connection between the mobile device, remote controller and aircraft is broken.
RECOVERING
The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the action state from the aircraft.
NOT_SUPPORTED
The connected product does not support waypoint mission 2.0.
READY_TO_UPLOAD
The aircraft is ready to upload actions.
UPLOADING
The uploading is started successfully. Detail information for each action is being uploaded one by one.
READY_TO_EXECUTE
Waypoint mission is uploaded completely and the aircraft is ready to start the execution.
Executing
The execution is started successfully.
Interrupted
Waypoint mission is interrupted successfully. User can call interruptMission to continue the execution.
Gets the currently loaded mission of the operator. There are two ways to load a mission. 1. A mission can be loaded by user through loadMission. 2. If the aircraft is already executing a waypoint mission when SDK is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. In that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. User can call downloadMission to get all the information for the loaded mission. The getLoadedMission will be reset to null when the execution of the loadedMission is stopped, finished.
+
Gets the currently loaded mission of the operator. There are two ways to load a mission. 1. A mission can be loaded by user through loadMission. 2. If the aircraft is already executing a waypoint mission when SDK is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. In that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. User can call downloadMission to get all the information for the loaded mission. The getLoadedMission will be reset to null when the execution of the loadedMission is stopped, finished.
Gets the currently loaded actions count of the operator. There are two ways to load a mission. 1. Actions can be loaded by user through loadMission. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count.
+
Gets the currently loaded actions count of the operator. There are two ways to load a mission. 1. Actions can be loaded by user through loadMission. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count.
Gets the count of loaded actions in current operator. There are two ways to load a mission. 1. Actions can be loaded by user through loadMission. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. load it automatically. In that case, the loaded actions will be null, if user want get summary of the executing actions user can call downloadMission to get all the information for the loaded actions. The getLoadedActions will be reset to null when the execution of the getLoadedMission is stopped, finished.
+
Gets the count of loaded actions in current operator. There are two ways to load a mission. 1. Actions can be loaded by user through loadMission. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. load it automatically. In that case, the loaded actions will be null, if user want get summary of the executing actions user can call downloadMission to get all the information for the loaded actions. The getLoadedActions will be reset to null when the execution of the getLoadedMission is stopped, finished.
Starts to upload the getLoadedMission to the aircraft. It can only be called when the getLoadedMission is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is READY_TO_UPLOAD. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the WaypointV2MissionState will become READY_TO_EXECUTE. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onUploadUpdate to receive the detailed progress.
+
Starts to upload the getLoadedMission to the aircraft. It can only be called when the getLoadedMission is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is READY_TO_UPLOAD. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the WaypointV2MissionState will become READY_TO_EXECUTE. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onUploadUpdate to receive the detailed progress.
Callback will be invoked with the result if the upload command has been received successfully by the aircraft. If the upload command is successfully sent, use addWaypointEventListener to check the detailed progress.
Callback will be invoked with the result if the upload command has been received successfully by the aircraft. If the upload command is successfully sent, use addWaypointEventListener to check the detailed progress.
Starts to upload the getLoadedActions to the aircraft. It can only be called when the getLoadedActions is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is READY_TO_EXECUTE. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the DJIWaypointV2MissionActionState will become READY_TO_EXECUTE.
+
Starts to upload the getLoadedActions to the aircraft. It can only be called when the getLoadedActions is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is READY_TO_EXECUTE. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the DJIWaypointV2MissionActionState will become READY_TO_EXECUTE.
Callback will be invoked with the result if the upload action command has been received successfully by the aircraft. If the upload command is successfully sent, use addActionListener to check the detailed progress.
Callback will be invoked with the result if the upload action command has been received successfully by the aircraft. If the upload command is successfully sent, use addActionListener to check the detailed progress.
Downloads information of Actions from startActionID to endActionID. The information of waypoints missing in getLoadedMission ascending order. If getLoadedMission is already complete (containing all the waypoints), this method will call completion immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - Executing - INTERRUPTED
+
Downloads information of each waypoint from aircraft and save it to getLoadedMission. If a download operation starts, the operator will download the information of waypoints missing in getLoadedMission one-by-one in ascending order. If getLoadedMission is already complete (containing all the waypoints), this method will call completion immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - Executing - INTERRUPTED.
Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onDownloadUpdate to receive the detailed progress.
Downloads information of each waypoint from aircraft and save it to getLoadedMission. If a download operation starts, the operator will download the information of waypoints missing in getLoadedMission one-by-one in ascending order. If getLoadedMission is already complete (containing all the waypoints), this method will call completion immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - Executing - INTERRUPTED.
+
Downloads information of Actions from startActionID to endActionID. The information of waypoints missing in getLoadedMission ascending order. If getLoadedMission is already complete (containing all the waypoints), this method will call completion immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - Executing - INTERRUPTED
Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_addListenerToDownloadEvent to receive the detailed progress.
Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them.
+
Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them.
Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them.
+
Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them.
Starts the execution of the uploaded mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is READY_TO_EXECUTE. After a mission is started successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become Executing.
+
Starts the execution of the uploaded mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is READY_TO_EXECUTE. After a mission is started successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become Executing.
Pauses the executing mission. It can only be called when the WaypointV2MissionState is Executing. After a mission is paused successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become INTERRUPTED.
+
Pauses the executing mission. It can only be called when the WaypointV2MissionState is Executing. After a mission is paused successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become INTERRUPTED.
Resumes the paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is INTERRUPTED. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become Executing.
+
Resumes the paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is INTERRUPTED. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become Executing.
Resumes the paused mission with recover type. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is INTERRUPTED. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become Executing.
+
Resumes the paused mission with recover type. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is INTERRUPTED. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become Executing.
Stops the executing or paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - Executing - INTERRUPTED After a mission finishes successfully, DJIWaypointV2MissionActionExecutionEvent_currentState will become READY_TO_UPLOAD.
+
Stops the executing or paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - Executing - INTERRUPTED After a mission finishes successfully, DJIWaypointV2MissionActionExecutionEvent_currentState will become READY_TO_UPLOAD.
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.
+
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, M300 RTK and M350 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.
Class used to interact with the payload device mounted on DJI aircraft.
+
Class used to interact with the payload device mounted on DJI aircraft. Note: In the MSDK V4 version, the PSDK payload device cannot be used with Zenmuse L1 and Zenmuse P1 at the same time. If you need to use them at the same time, please upgrade to MSDK V5.
The pipelines to transmit data between DJI Payload device and DJI mobile SDK. This function does not support dual controllers scenarios. It's only supported by Matrice 300 RTK.
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.
+
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, M300 RTK and M350 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.
Establishes a pipeline connected with Onboard device or Payload device to transmit data. Uses connect to create a pipeline. disconnect can be invoked to destroy the data transmission channel and disconnect from the Onboard device or Payload device.
Guarantees delivery of data and that packets will be delivered in the order they were sent.
PUSH
This transmission control type does not provide guaranteed delivery and a datagram packet may become corrupt or lost in transit. Suitable for time-sensitive transmission.
Establishes a pipeline connected with Onboard device or Payload device to transmit data. Uses DJIPipelines_connect to create a pipeline. DJIPipelines_disconnect can be invoked to destroy the data transmission channel and disconnect from the Onboard device or Payload device.
RTK is using the D-RTK 2 base station as the reference station. It is supported by Phantom 4 RTK, P4 Multispectral and Matrice 300 RTK.
CUSTOM_NETWORK_SERVICE
RTK is using third-party network service as the reference station. The network service should use NTRIP(Networked Transport of RTCM via Internet Protocol). It is supported by Phantom 4 RTK, P4 Multispectral, Matrice 210 RTK V2 and Matrice 300 RTK.
NETWORK_RTK
Default virtual reference station solution to provide cm level accurate position. The frame can be either WGS84 or CGCS 2000. Please note that this default solution can only be used in China. Please add the "djinetworkrtkhelper" to the project via gradle: implementation 'com.dji:library-networkrtk-helper:2.0.2'. It is only supported by Phantom 4 RTK, P4 Multispectral and Matrice 300 RTK.
UNKNOWN
Unknown reference station source.
+
NONE
Not using any reference station source.
BASE_STATION
RTK is using the D-RTK 2 base station as the reference station. It is supported by Phantom 4 RTK, P4 Multispectral and Matrice 300 RTK.
CUSTOM_NETWORK_SERVICE
RTK is using third-party network service as the reference station. The network service should use NTRIP(Networked Transport of RTCM via Internet Protocol). It is supported by Phantom 4 RTK, P4 Multispectral, Matrice 210 RTK V2 and Matrice 300 RTK.
NETWORK_RTK
Default virtual reference station solution to provide cm level accurate position. The frame can be either WGS84 or CGCS 2000. Please note that this default solution can only be used in China. Please add the "djinetworkrtkhelper" to the project via gradle: implementation 'com.dji:library-networkrtk-helper:2.0.2'. It is only supported by Matrice 300 RTK and Matrice 350 RTK.
NTRIP_NETWORK_SERVICE
Ntrip network service which is used for CMCC network RTK service. It is only supported Matrice 300 RTK and Matrice 350 RTK.
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.
+
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, M300 RTK and M350 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.
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.
+
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, M300 RTK and M350 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.
staticfinal DJIError COMMON_PARAM_ILLEGAL = new DJIError("Param Illegal")
Package:
dji.common.error
-
Description:
+
Description:
Illegal parameters. This error will be returned by the function for setting camera parameters in DJIPhantomCamera and DJIInspireCamera, when illegal parameters are used.
staticfinal DJIError UNABLE_TO_GET_FIRMWARE_VERSION = new DJIError( "Unable to get the firmware version. Note: The sdk will fetch the firmware version from the server so, please ensure you have Internet connectivity before you invoke getVersion().")
Package:
dji.common.error
-
Description:
+
Description:
Unable to get the firmware version. Note: The SDK gets the firmware version table from the server. Ensure Internet connectivity before you invoke getVersion().
staticfinal DJIError UNABLE_TO_GET_FLAGS = new DJIError( "Unable to get the analytics flags from server. Please ensure you have Internet connectivity before you invoke this method.")
Package:
dji.common.error
-
Description:
+
Description:
Unable to get the analytics flags from server. Note: Ensure Internet connectivity before you invoke this method.
staticfinal DJIError UNABLE_TO_GET_FLAG_BUT_RETRY = new DJIError( "Unable to get the analytics flags from server, but retrying. Please ensure you have Internet connectivity before invoking this method")
Package:
dji.common.error
-
Description:
+
Description:
Unable to get the analytics flags from server, but retrying.
staticfinal DJIError BATTERY_GET_SMART_BATTERY_INFO_FAILED = new DJIError("Get smart battery info failed")
Package:
dji.common.error
-
Description:
+
Description:
Get smart battery information failed. This error will be returned by the functions for getting information in DJIPhantomBattery and DJIAircraftBattery when the request to get information failed.
public void getSmartBatteryRestTimeForAll(DJISmartBatteryExecuteResultCallback mCallBack) public void getSmartBatteryNeedTimeForGoHome(DJISmartBatteryExecuteResultCallback mCallBack) public void getSmartBatteryNeedTimeForLand(DJISmartBatteryExecuteResultCallback mCallBack) public void getSmartBatteryGohomeBatteryLevel(DJISmartBatteryExecuteResultCallback mCallBack) public void getSmartBatteryLandBatteryLevel(DJISmartBatteryExecuteResultCallback mCallBack) public void getSmartBatteryRadiusForGohome(DJISmartBatteryExecuteResultCallback mCallBack) public void getSmartBatteryRequestGohomeFlag(DJISmartBatteryExecuteResultCallback mCallBack)
Determines whether asynchronous getter and setter method callbacks should be invoked in UIThread or BackgroundThread. This method is only for setters and getters, as push data callbacks (typically state data) always return in the BackgroundThread.
Input Parameters:
boolean enable
A boolean value.
@@ -1526,7 +1508,7 @@
Input Parameters:
voidcloseAOAConnection()
Package:
dji.sdk.sdkmanager
-
Description:
+
Description:
This method is used to close the AOA connection during development and should not be used in the final application. When using AS or Eclipse to build and run the application, the AOA connection is not properly closed if the application is terminated. As a result, the next time the application is run, the SDK will not be able to connect to the product without first disconnecting and reconnecting the USB cable. AS and Eclipse can be configured to invoke this method before compiling the application, closing the link before the application is run, and overcoming this problem.
Used to establish the Bluetooth connection between the mobile device and the DJI product. The Bluetooth connection needs to be established before a connection between the SDK and the DJI product can be made using startConnectionToProduct.
If only Bluetooth devices will be connected, then this should be set to true.
Input Parameters:
boolean isBluetoothDevice
true if only Bluetooth devices will be connected.
@@ -1599,7 +1581,7 @@
Input Parameters:
booleanstartConnectionToProduct()
Package:
dji.sdk.sdkmanager
-
Description:
+
Description:
Starts a connection between the SDK and the DJI product. This method should be called after successful registration of the app and once there is a data connection between the mobile device and DJI product. This data connection is either a USB cable connection, a WiFi connection (that needs to be established outside of the SDK) or a Bluetooth connection (that needs to be established with getBluetoothProductConnector). If the connection succeeds, onProductConnect will be called if the connection succeeded. Returns true if the connection is started successfully. For products which connect to the mobile device using Bluetooth, getBluetoothProductConnector should be used to get a BluetoothProductConnector object which can handle Bluetooth device connection.
Gets the path that flight logs are stored to. Flight logs are automatically defineed by MSDK and stored on the mobile device. The SDK does nothing with these logs, and they are provided only as a convenience for developers and users. Users can use these flight logs with DJI service centers if they are making a warranty claim. Only developers using the SDK, and users of the mobile device can access these logs. Older flight logs are overwritten by newer flight logs over time, so the flight log path is given in case an application needs to store all logs.
Return:
String
An NSString object of the flight log path.
@@ -1638,7 +1620,7 @@
Return:
String getFlycLogPath()
Package:
dji.sdk.sdkmanager
-
Description:
+
Description:
Gets the path that flight control compact logs are stored to. Flight control compact logs are defined by flight controller and stored on the mobile device. The SDK does nothing with these logs, and they are provided only as a convenience for developers and users. Users can use these flight logs with DJI service centers if they are making a warranty claim. Only developers using the SDK, and users of the mobile device can access these logs. Older flight logs are overwritten by newer flight logs over time, so the flight log path is given in case an application needs to store all logs. Supported by DJI Air 2S, DJI Mini 2, DJI Mini SE, Mavic Air 2, Mavic Mini, Mavic Pro, Phantom 4 Pro, Matrice 300 RTK.
Return:
String
An NSString object of the flight control compact log path.
@@ -1649,7 +1631,7 @@
Managers
FlyZoneManager getFlyZoneManager()
Package:
dji.sdk.sdkmanager
-
Description:
+
Description:
Provide access to FlyZoneManager used to manage DJI's GEO system for no fly zones.
Manages Local Data Mode (LDM) functionality. Local data mode gives the developer the option to put the SDK into airplane mode, restricting its access to the internet. See LDMManager for details on when and where this is possible, and what is restricted.
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.
+
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, M300 RTK and M350 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.
Retrieves instances of the product's lidars. This is used when the aircraft has multiple DJI lidars, e.g. M300 RTK. Note, when two Zenmuse L1 do exist, lidar order within the array will not always the same. For example: On the M300 RTK, the port side (left) Zenmuse L1 will have an index of 0 and the starboard side (right) Zenmuse will have an index of 1. However, the first object of getLidars will not necessarily always be the lidar with getIndex of 0.
+
Retrieves instances of the product's lidars. This is used when the aircraft has multiple DJI lidars, e.g. M300 RTK and M350 RTK. Note, when two Zenmuse L1 do exist, lidar order within the array will not always the same. For example: On the M300 RTK and M350 RTK, the port side (left) Zenmuse L1 will have an index of 0 and the starboard side (right) Zenmuse will have an index of 1. However, the first object of getLidars will not necessarily always be the lidar with getIndex of 0.
DJISDKCacheError
diff --git a/docs/API Reference/index.html b/docs/API Reference/index.html
index 9996e84e..c8f037f5 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 983c3f98..a1ba077d 100644
--- a/docs/API Reference/javascripts/search_index.js
+++ b/docs/API Reference/javascripts/search_index.js
@@ -80,7 +80,7 @@ var search_data = {
"onconnectivitychange",
"called when the connectivity status has changes for the component. this callback will be called when the component disconnects from the product. if the product itself gets disconnected, this callback method will be called by all of the product component. @param isconnected `true` if the component is connected.",
"getindex",
- "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 an int value of index.",
+ "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, m300 rtk and m350 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 an int value of index.",
"isconnected",
"`true` if the component is connected. @return `true` if the component is connected.",
"getserialnumber",
@@ -95,6 +95,10 @@ var search_data = {
"get the authorization of access to data of type dji hardware information. @return `true` if it is authorized.",
"isaccesstoobfuscatedlocationauthorized",
"get the authorization of access to data of type obfuscated location. @return `true` if it is authorized.",
+ "agreetoproductimprovement",
+ "agree or disagree with the product improvement project. through this project, the dji device information, mobile device information, and diagnostic and usage data collected through msdk will be provided to dji for analysis. this analysis helps dji improve products and services. dji will take necessary data protection measures before data analysis. @param isagree `true` to ageree product improvement project. @return the encountered error if there is any.",
+ "isagreetoproductimprovement",
+ "gets whether to agree to the product improvement project. @return `true` if it is agreed to product improvement project.",
"getinstance",
"get the singleton instance of the class. @return an object of `dataprotectionmanager`.",
"djisdkmanager",
@@ -108,7 +112,7 @@ var search_data = {
"useraccountmanager",
"class used to manage the dji account.",
"dataprotectionmanager",
- "data protection manager. dji sdk will send data to dji servers in the background in order to complete logics, including data related to user's information. data protection manager can be used to authorize dji server to access the user- related data. sdk will not send the data to dji server in the background before the authorization. internet requests triggered by the user manually are not managed by `dataprotectionmanager`. involved user-related data is listed in the documentation of the interfaces. the authorization is not persistent and each authorization setting will be reset to the default value for each app's life cycle. this class is accessible before calling `registerapp`. the utmissmanager class needs to report flight dynamic data to the utmiss server in accordance with the policy requirements of the civil aviation administration of china. it is not in this category of management. for details, please refer to the utmissmanager interface document.",
+ "data protection manager. dji sdk will send data to dji servers in the background in order to complete logics, including data related to user's information. data protection manager can be used to authorize dji server to access the user- related data. sdk will not send the data to dji server in the background before the authorization. internet requests triggered by the user manually are not managed by `dataprotectionmanager`. involved user-related data is listed in the documentation of the interfaces. this class is accessible before calling `registerapp`. the utmissmanager class needs to report flight dynamic data to the utmiss server in accordance with the policy requirements of the civil aviation administration of china. it is not in this category of management. for details, please refer to the utmissmanager interface document.",
"ldmmanager",
"local data mode (ldm) manager. when local data mode is enabled, the sdk's access to the internet is restricted. you should use `registerappforldm` to register the app. only application registration (confirming the app key is valid) will be unrestricted. all other sdk services will be restricted. when the sdk's internet access is restricted, all sdk services that require an internet connection will not be available or able to update. for instance, the fly zone manager will not be able to update the fly zone data base, retrieve the latest tfrs (temporary flight restrictions) or unlock fly zones. ldm is therefore most appropriate for users that have very stringent data requirements, and are able to accommodate this restricted functionality. when local data mode is enabled, the utmissmanager will not report flight dynamic data to the utmiss server.",
"utmissmanager",
@@ -146,9 +150,7 @@ var search_data = {
"mobileremotecontroller",
"a simulated remote controller on the mobile device to control the aircraft when the physical remote controller is absent. the mobile remote controller only supports mode 2 control style and flight mode p. it is supported by mavic pro using wifi. this object is available from the `aircraft` subclass off `baseproduct`.",
"payload",
- "class used to interact with the payload device mounted on dji aircraft.",
- "pipeline",
- "establishes a pipeline connected with onboard device or payload device to transmit data. uses `connect` to create a pipeline. `disconnect` can be invoked to destroy the data transmission channel and disconnect from the onboard device or payload device.",
+ "class used to interact with the payload device mounted on dji aircraft. note: in the msdk v4 version, the psdk payload device cannot be used with zenmuse l1 and zenmuse p1 at the same time. if you need to use them at the same time, please upgrade to msdk v5.",
"accessoryaggregation",
"this class contains all possible accessories (spotlight, beacon and speaker) supported by the aircraft. the accessory aggregation component is available when mavic 2 enterprise is connected. an accessory becomes available only when the accessory is connected to the aircraft.",
"basestation",
@@ -2193,46 +2195,6 @@ var search_data = {
"the command cannot be executed in current payload mode. see `payloadproductphase`.",
"in_wifi_link",
"cannot upgrade when using `wifilink`.",
- "unknown",
- "unknown.",
- "crc_check_failed",
- "crc check failed.",
- "invalid_parameters",
- "invalid parameters.",
- "not_enough_memory",
- "not enough memory.",
- "not_ready",
- "usually occurs when allocating the local pipeline id.",
- "send_failed",
- "send data exception.",
- "receive_failed",
- "receiving data exceptions.",
- "timeout",
- "timeout error.",
- "busy_operation",
- "busy now, please try again later.",
- "unacceptable_operations",
- "resource occupied, please select another id connection.",
- "closed",
- "connection closed, no need to call again.",
- "connecting",
- "connecting, no need to call again.",
- "resources_not_available",
- "local resources are ineffective and unavailable. please recreate.",
- "closing",
- "connection closing, no need to call again.",
- "not_connected",
- "connection has not established.",
- "link_break",
- "link broken, please check the connection with the aircraft.",
- "connection_refused",
- "the target device refuses to connect.",
- "id_occupied",
- "duplicated binding is not allowed. please try to bind with a new id.",
- "internal_status_error",
- "internal status error. please recreate the pipeline object.",
- "getdjierror",
- "get the object of `pipelineerror` error information by error code. @param code an int value of the error code. @return an object of `pipelineerror`.",
"getdjierror",
"get the mission waypoint error type. @param errorcode an int value of the error code. @return value of the `djiwaypointv2error` enum.",
"djiwaypointv2error",
@@ -2535,8 +2497,6 @@ var search_data = {
"errors related to the upgrade.",
"djiwaypointv2error",
"errors related to the payload.",
- "pipelineerror",
- "errors related to the `pipelines`.",
"djisdkerror",
"dji sdk error.",
"djisdkcacheerror",
@@ -2549,6 +2509,8 @@ var search_data = {
"catch all for various errors.",
"common_data_error",
"data error. shown as n/a in dji app.",
+ "common_invalid_authorization_id",
+ "invalid authorization id.",
"common_undefined",
"undefined error. this error will be returned when the error is undefined. public void setmulticontrolmode(boolean value,final djiexecuteresultcallback mcallback)",
"common_timeout",
@@ -3279,6 +3241,8 @@ var search_data = {
"set the peak focus threshold value. @param peakfocusthresholdvalue a float value representing peak focus threshold.",
"setoverexposurewarningenabled",
"enable or disable the over exposure warning. @param isenabled enable/disable the over exposure warning.",
+ "setcodecname",
+ "set the codec name. for some mobile phones that cannot display video stream normally. you can set the codec name through this interface so that msdk can call the correct decoder for decoding and display. you can call android api:mediacodeclist to get available codec names for testing. @param codecname ",
"setyuvdatacallback",
"sends yuv data from hardware decoder. @param callback the yuv data callback.",
"getyuvdatacallback",
@@ -3434,7 +3398,7 @@ var search_data = {
"getradar",
"retrieves an instance of the device's radar.",
"getlidars",
- "retrieves instances of the product's lidars. this is used when the aircraft has multiple dji lidars, e.g. m300 rtk. note, when two zenmuse l1 do exist, lidar order within the array will not always the same. for example: on the m300 rtk, the port side (left) zenmuse l1 will have an index of 0 and the starboard side (right) zenmuse will have an index of 1. however, the first object of `getlidars` will not necessarily always be the lidar with `getindex` of 0. @return a list of the aircraft's lidars.",
+ "retrieves instances of the product's lidars. this is used when the aircraft has multiple dji lidars, e.g. m300 rtk and m350 rtk. note, when two zenmuse l1 do exist, lidar order within the array will not always the same. for example: on the m300 rtk and m350 rtk, the port side (left) zenmuse l1 will have an index of 0 and the starboard side (right) zenmuse will have an index of 1. however, the first object of `getlidars` will not necessarily always be the lidar with `getindex` of 0. @return a list of the aircraft's lidars.",
"unknown_aircraft",
"the aircraft's model name is unknown.",
"inspire_1",
@@ -3561,8 +3525,6 @@ var search_data = {
"when this string is received in a broadcast, the sdk will attempt to connect to usb accessory.",
"getinstance",
"accessor for `djisdkmanager` object. @return an instance of `djisdkmanager` object.",
- "destroy",
- "releases the resources held by the djisdkmanager. this will unsubscribe the app from any updates sent by the sdk.",
"setcallbackruninuithread",
"determines whether asynchronous getter and setter method callbacks should be invoked in uithread or backgroundthread. this method is only for setters and getters, as push data callbacks (typically state data) always return in the backgroundthread. @param enable a boolean value.",
"closeaoaconnection",
@@ -3717,38 +3679,6 @@ var search_data = {
"handheld device model name osmo+.",
"osmo_mobile_2",
"handheld device model name osmo mobile 2.",
- "getid",
- "the identification number of the pipeline connected with the payload or the onboard device. @return an int value of pipeline id.",
- "gettype",
- "transmission processing type. @return an enum value of `transmissioncontroltype`.",
- "getdevicetype",
- "device type connected. @return an enum value of `pipelinedevicetype`.",
- "writedata",
- "data to be sent. 1 kb data size is recommended. @param data the data needs to be sent. @param offset the start offset in the data. @param length the number of bytes to write. @return if the return code greater than 0 it is the length of data written otherwise it is the error code.",
- "readdata",
- "read data from the pipeline. @param buff the buffer into which the data is read. @param offset the start offset in the array buff at which the data is written. @param length the maximum number of bytes to read. @return if the return code greater than 0 it is the length of data read otherwise it is the error code.",
- "transmissioncontroltype",
- "defines pipeline transmission control type.",
- "stable",
- "guarantees delivery of data and that packets will be delivered in the order they were sent.",
- "push",
- "this transmission control type does not provide guaranteed delivery and a datagram packet may become corrupt or lost in transit. suitable for time- sensitive transmission.",
- "pipelinedevicetype",
- "the enum is used to represent the pipeline device type.",
- "on_board",
- "onboard device. please check the developer website: https://developer.dji.com /onboard-sdk/.",
- "payload",
- "payload device. please check the developer website: https://developer.dji.com /payload-sdk/.",
- "unknown",
- "unknown.",
- "pipelines",
- "manage multiple pipelines. only supported by matrice 300 rtk with firmware version v01.00.01.01 and above.",
- "getpipelines",
- "retrieves instances of the products's pipelines. the key of the map table refers to the pipeline id that connected with the payload or the onboard device, and the value refers to the pipeline instance object. when the pipeline connection is established successfully, a pipeline object is created and placed in the map table. when `disconnect` is invoked, the expired pipeline will be removed from the pipelins map table. @return the pipeline map object.",
- "connect",
- "establishes the pipeline connection with the pipeline's id. returns an instance of the pipeline when it is connected successfully, otherwise, error information will be returned. @param id the pipeline id. @param transmissiontype an enum value of `transmissioncontroltype`. @param callback completion block to receive the result.",
- "disconnect",
- "disconnects from the payload or the onboard device by pipeline id, and clear the cached data in pipeline. if it is disconnected successfully, the pipeline instance will be removed from the pipeline map table, otherwise, error information will be returned. @param callback completion block to receive the result.",
"setareacode",
"set the area code of country or area. the following functions can not be used unless the corresponding area code is set. currently the supported country or area list and the supported function list is as follows: - usa: remote identification broadcast of drone @param areacode area code of country or area. @return return the setting execution result of area code.",
"getuasremoteidstatus",
@@ -4022,7 +3952,7 @@ var search_data = {
"videofeeder",
"class that manages live video feed from dji products to the mobile device.",
"getpipelines",
- "the pipelines to transmit data between dji payload device and dji mobile sdk. this function does not support dual controllers scenarios. it's only supported by matrice 300 rtk. @return the `pipelines` objects.",
+ "the pipelines to transmit data between dji payload device and dji mobile sdk. this function does not support dual controllers scenarios. it's only supported by matrice 300 rtk. @return the djipipelines objects.",
"getupstreambandwidth",
"gets the bandwidth of the upstream (from mobile sdk to payload). the unit is bytes/s. the bandwidth is determined by the firmware and currently it is not larger than 500 bytes/s. @param callback the execution callback with the returned value(s).",
"getpayloadproductname",
@@ -4366,7 +4296,7 @@ var search_data = {
"getloadedmission",
"gets the currently loaded mission of the operator. there are two ways to load a mission. 1. a mission can be loaded by user through `loadmission`. 2. if the aircraft is already executing a waypoint mission when sdk is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. in that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. user can call `downloadmission` to get all the information for the loaded mission. the `getloadedmission` will be reset to `null` when the execution of the loadedmission is stopped, finished or interrupted. @return a object of `waypointmission`.",
"getpreviousinterruption",
- "gets the interruption of the last waypoint mission. if a waypoint mission is interrupted before the completion, the aircraft will record the interruption information. this information is only available when the last waypoint mission is incomplete and the first waypoint of the mission has been reached. the interruption will also be recorded if the mission is stopped by the user. the interruption information is recorded in the aircraft and the information persists even after the aircraft's reboot. supported only by phantom 4 rtk. @param callback the execution callback with the returned execution result.",
+ "gets the interruption of the last waypoint mission. if a waypoint mission is interrupted before the completion, the aircraft will record the interruption information. this information is only available when the last waypoint mission is incomplete and the first waypoint of the mission has been reached. the interruption will also be recorded if the mission is stopped by the user. the interruption information is recorded in the aircraft and the information persists even after the aircraft's reboot. supported only by phantom 4 rtk. @param callback the execution callback with the returned execution result.",
"uploadmission",
"starts to upload the `getloadedmission` to the aircraft. it can only be called when the `getloadedmission` is complete and the `getcurrentstate` is `ready_to_upload`. if a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. after a mission is uploaded successfully, the `waypointmissionstate` will become `ready_to_execute`. @param callback completion block that will be called when the upload operation succeeds or fails to start. ",
"retryuploadmission",
@@ -4388,9 +4318,9 @@ var search_data = {
"removelistener",
"removes listener. if the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener listener to be removed.",
"waypointmission",
- "in the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. waypoints are physical locations to which the aircraft will fly. creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. the aircraft travels between waypoints automatically at a base speed. however, the user can change the speed by using the pitch joystick. if the stick is pushed up, the speed will increase. if the stick is pushed down, the speed will slow down. the stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. when the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. if the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). if the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. it is not supported by mavic pro when using wifi connection. it is not supported by spark, mavic mini, dji mini 2, dji mini se, mavic air 2, dji air 2s and matrice 300 rtk.",
+ "in the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. waypoints are physical locations to which the aircraft will fly. creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. the aircraft travels between waypoints automatically at a base speed. however, the user can change the speed by using the pitch joystick. if the stick is pushed up, the speed will increase. if the stick is pushed down, the speed will slow down. the stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. when the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. if the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). if the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. it is not supported by mavic pro when using wifi connection. it is not supported by spark, mavic mini, dji mini 2, dji mini se, mavic air 2, dji air 2s and matrice 300 rtk.",
"waypointv2mission",
- "in the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. waypoints are physical locations to which the aircraft will fly. creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. the aircraft travels between waypoints automatically at a base speed. however, the user can change the speed by using the pitch joystick. if the stick is pushed up, the speed will increase. if the stick is pushed down, the speed will slow down. the stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. when the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. if the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). if the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. it is only supported by `matrice_300_rtk`.",
+ "in the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. waypoints are physical locations to which the aircraft will fly. creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. the aircraft travels between waypoints automatically at a base speed. however, the user can change the speed by using the pitch joystick. if the stick is pushed up, the speed will increase. if the stick is pushed down, the speed will slow down. the stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. when the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. if the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). if the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. it is only supported by `matrice_300_rtk`.",
"waypointmissionevent",
"waypoint event base class.",
"waypointmissionuploadevent",
@@ -4470,35 +4400,35 @@ var search_data = {
"targetwaypointindex",
"index of the waypoint for the next mission to which the aircraft will proceed.",
"iswaypointreached",
- "yes when the aircraft reaches a waypoint. after the waypoint actions and heading change is complete, the `targetwaypointindex` will increment and this property will become no.",
+ "yes when the aircraft reaches a waypoint. after the waypoint actions and heading change is complete, the `targetwaypointindex` will increment and this property will become no.",
"executestate",
"current execution state of the aircraft.",
"initializing",
"waypoint mission is initializing, which means the mission has started and the aircraft is going to the first waypoint.",
"moving",
- "aircraft is currently moving toward the mission's next waypoint. this happens when the `waypointmissionflightpathmode` is set to `normal`.",
+ "aircraft is currently moving toward the mission's next waypoint. this happens when the `waypointmissionflightpathmode` is set to `normal`.",
"curve_mode_moving",
- "aircraft is currently moving. this happens when the `waypointmissionflightpathmode` is set to `curved`.",
+ "aircraft is currently moving. this happens when the `waypointmissionflightpathmode` is set to `curved`.",
"curve_mode_turning",
- "aircraft is currently turning. this happens when the `waypointmissionflightpathmode` is set to `curved`.",
+ "aircraft is currently turning. this happens when the `waypointmissionflightpathmode` is set to `curved`.",
"begin_action",
- "aircraft has reached a waypoint, has rotated to the new heading and is now processing actions. this state will be called before the waypoint actions starts executing and will occur for each waypoint action.",
+ "aircraft has reached a waypoint, has rotated to the new heading and is now processing actions. this state will be called before the waypoint actions starts executing and will occur for each waypoint action.",
"doing_action",
"aircraft is at a waypoint and is executing an action.",
"finished_action",
- "aircraft is at a waypoint and has finished executing the current waypoint action. this state occurs once for each waypoint action.",
+ "aircraft is at a waypoint and has finished executing the current waypoint action. this state occurs once for each waypoint action.",
"return_to_first_waypoint",
- "aircraft has returned to the first waypoint. this happens when the `getfinishedaction` is set to `return_to_first_waypoint`.",
+ "aircraft has returned to the first waypoint. this happens when the `getfinishedaction` is set to `return_to_first_waypoint`.",
"paused",
"the mission is currently paused by the user.",
"getloadedmission",
- "gets the currently loaded mission of the operator. there are two ways to load a mission. 1. a mission can be loaded by user through `loadmission`. 2. if the aircraft is already executing a waypoint mission when sdk is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. in that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. user can call `downloadmission` to get all the information for the loaded mission. the `getloadedmission` will be reset to `null` when the execution of the loadedmission is stopped, finished. @return an object of `waypointv2mission`.",
+ "gets the currently loaded mission of the operator. there are two ways to load a mission. 1. a mission can be loaded by user through `loadmission`. 2. if the aircraft is already executing a waypoint mission when sdk is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. in that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. user can call `downloadmission` to get all the information for the loaded mission. the `getloadedmission` will be reset to `null` when the execution of the loadedmission is stopped, finished. @return an object of `waypointv2mission`.",
"loadmission",
- "loads a waypoint mission into the operator. a mission can be loaded only when the `waypointv2missionstate` is one of the following : - `ready_to_upload` - `ready_to_execute` calling `loadmission` when the current state is `ready_to_execute` will change the state to `ready_to_upload`. after calling `getloadedmission`, @param mission waypoint mission to load. @param callback returns an error when mission data is invalid or the mission cannot be loaded in the current state.",
+ "loads a waypoint mission into the operator. a mission can be loaded only when the `waypointv2missionstate` is one of the following : - `ready_to_upload` - `ready_to_execute` calling `loadmission` when the current state is `ready_to_execute` will change the state to `ready_to_upload`. after calling `getloadedmission`, @param mission waypoint mission to load. @param callback returns an error when mission data is invalid or the mission cannot be loaded in the current state.",
"getloadedactioncount",
- "gets the currently loaded actions count of the operator. there are two ways to load a mission. 1. actions can be loaded by user through `loadmission`. 2. if the aircraft is already executing a waypoint mission and it has uploaded actions when sdk is re-connected, the operator will recover uploaded action count. @return an int value of loaded action count.",
+ "gets the currently loaded actions count of the operator. there are two ways to load a mission. 1. actions can be loaded by user through `loadmission`. 2. if the aircraft is already executing a waypoint mission and it has uploaded actions when sdk is re-connected, the operator will recover uploaded action count. @return an int value of loaded action count.",
"getloadedactions",
- "gets the count of loaded actions in current operator. there are two ways to load a mission. 1. actions can be loaded by user through `loadmission`. 2. if the aircraft is already executing a waypoint mission and it has uploaded actions when sdk is re-connected, the operator will recover uploaded action count. load it automatically. in that case, the loaded actions will be `null`, if user want get summary of the executing actions user can call `downloadmission` to get all the information for the loaded actions. the `getloadedactions` will be reset to `null` when the execution of the getloadedmission is stopped, finished. @return a list of `waypointv2action` objects.",
+ "gets the count of loaded actions in current operator. there are two ways to load a mission. 1. actions can be loaded by user through `loadmission`. 2. if the aircraft is already executing a waypoint mission and it has uploaded actions when sdk is re-connected, the operator will recover uploaded action count. load it automatically. in that case, the loaded actions will be `null`, if user want get summary of the executing actions user can call `downloadmission` to get all the information for the loaded actions. the `getloadedactions` will be reset to `null` when the execution of the getloadedmission is stopped, finished. @return a list of `waypointv2action` objects.",
"getcurrentstate",
"the current state of the operator. @return an object of `waypointv2missionstate`.",
"getcurrentactionstate",
@@ -4506,11 +4436,11 @@ var search_data = {
"addwaypointeventlistener",
"add listener to listen for waypoint events. @param listener an object of djiwaypointv2missionoperator_listener.",
"removewaypointlistener",
- "removes listener. if the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener listener to be removed.",
+ "removes listener. if the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener listener to be removed.",
"addactionlistener",
"add listener to listen the events. @param listener an object of djiwaypointv2missionoperator_actionlistener.",
"removeactionlistener",
- "removes listener. if the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener listener to be removed.",
+ "removes listener. if the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener listener to be removed.",
"waypointv2missionoperatorlistener",
"listen mission event.",
"ondownloadupdate",
@@ -4570,25 +4500,25 @@ var search_data = {
"gettotalactioncount",
"the total count of actions in the waypoint mission. @return an int value.",
"uploadmission",
- "starts to upload the `getloadedmission` to the aircraft. it can only be called when the `getloadedmission` is complete and the djiwaypointv2missionactionexecutionevent_currentstate is `ready_to_upload`. if a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. after a mission is uploaded successfully, the `waypointv2missionstate` will become `ready_to_execute`. if it is started successfully, use djiwaypointv2missionoperator_listener_onuploadupdate to receive the detailed progress. @param callback callback will be invoked with the result if the upload command has been received successfully by the aircraft. if the upload command is successfully sent, use `addwaypointeventlistener` to check the detailed progress.",
+ "starts to upload the `getloadedmission` to the aircraft. it can only be called when the `getloadedmission` is complete and the djiwaypointv2missionactionexecutionevent_currentstate is `ready_to_upload`. if a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. after a mission is uploaded successfully, the `waypointv2missionstate` will become `ready_to_execute`. if it is started successfully, use djiwaypointv2missionoperator_listener_onuploadupdate to receive the detailed progress. @param callback callback will be invoked with the result if the upload command has been received successfully by the aircraft. if the upload command is successfully sent, use `addwaypointeventlistener` to check the detailed progress.",
"uploadwaypointactions",
- "starts to upload the `getloadedactions` to the aircraft. it can only be called when the `getloadedactions` is complete and the djiwaypointv2missionactionexecutionevent_currentstate is `ready_to_execute`. if a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. after a mission is uploaded successfully, the djiwaypointv2missionactionstate will become `ready_to_execute`. @param actions a list of `waypointv2action` objects. @param callback callback will be invoked with the result if the upload action command has been received successfully by the aircraft. if the upload command is successfully sent, use `addactionlistener` to check the detailed progress.",
+ "starts to upload the `getloadedactions` to the aircraft. it can only be called when the `getloadedactions` is complete and the djiwaypointv2missionactionexecutionevent_currentstate is `ready_to_execute`. if a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. after a mission is uploaded successfully, the djiwaypointv2missionactionstate will become `ready_to_execute`. @param actions a list of `waypointv2action` objects. @param callback callback will be invoked with the result if the upload action command has been received successfully by the aircraft. if the upload command is successfully sent, use `addactionlistener` to check the detailed progress.",
"downloadmission",
- "downloads information of actions from startactionid to endactionid. the information of waypoints missing in `getloadedmission` ascending order. if `getloadedmission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is one of the following: - `executing` - `interrupted` @param callback callback that will be called when the download operation succeeds or fails to start. if it is started successfully, use djiwaypointv2missionoperator_listener_ondownloadupdate to receive the detailed progress.",
+ "downloads information of each waypoint from aircraft and save it to `getloadedmission`. if a download operation starts, the operator will download the information of waypoints missing in `getloadedmission` one-by-one in ascending order. if `getloadedmission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is one of the following: - `executing` - `interrupted`. @param callback callback that will be called when the download operation succeeds or fails to start. if it is started successfully, use djiwaypointv2missionoperator_listener_ondownloadupdate to receive the detailed progress.",
"downloadactions",
- "downloads information of each waypoint from aircraft and save it to `getloadedmission`. if a download operation starts, the operator will download the information of waypoints missing in `getloadedmission` one-by-one in ascending order. if `getloadedmission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is one of the following: - `executing` - `interrupted`. @param callback callback that will be called when the download operation succeeds or fails to start. if it is started successfully, use djiwaypointv2missionoperator_addlistenertodownloadevent to receive the detailed progress.",
+ "downloads information of actions from startactionid to endactionid. the information of waypoints missing in `getloadedmission` ascending order. if `getloadedmission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is one of the following: - `executing` - `interrupted` @param callback callback that will be called when the download operation succeeds or fails to start. if it is started successfully, use djiwaypointv2missionoperator_addlistenertodownloadevent to receive the detailed progress.",
"startmission",
- "starts the execution of the uploaded mission. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is `ready_to_execute`. after a mission is started successfully, the djiwaypointv2missionactionexecutionevent_currentstate will become `executing`. @param callback completion block that will be called when the operator succeeds or fails to start the execution. if it fails, an error will be returned.",
+ "starts the execution of the uploaded mission. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is `ready_to_execute`. after a mission is started successfully, the djiwaypointv2missionactionexecutionevent_currentstate will become `executing`. @param callback completion block that will be called when the operator succeeds or fails to start the execution. if it fails, an error will be returned.",
"interruptmission",
- "pauses the executing mission. it can only be called when the `waypointv2missionstate` is `executing`. after a mission is paused successfully, the djiwaypointv2missionactionexecutionevent_currentstate will become `interrupted`. @param callback callback that will be called when the operator succeeds or fails to pause the mission. if it fails, an error will be returned.",
+ "pauses the executing mission. it can only be called when the `waypointv2missionstate` is `executing`. after a mission is paused successfully, the djiwaypointv2missionactionexecutionevent_currentstate will become `interrupted`. @param callback callback that will be called when the operator succeeds or fails to pause the mission. if it fails, an error will be returned.",
"recovermission",
- "resumes the paused mission. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is `interrupted`. after a mission is resumed successfully, the djiwaypointv2missionactionexecutionevent_currentstate will become `executing`. @param callback callback that will be called when the operator succeeds or fails to resume the mission. if it fails, an error will be returned.",
+ "resumes the paused mission. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is `interrupted`. after a mission is resumed successfully, the djiwaypointv2missionactionexecutionevent_currentstate will become `executing`. @param callback callback that will be called when the operator succeeds or fails to resume the mission. if it fails, an error will be returned.",
"recovermission",
- "resumes the paused mission with recover type. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is `interrupted`. after a mission is resumed successfully, the djiwaypointv2missionactionexecutionevent_currentstate will become `executing`. @param type an enum value of `interruptrecoveractiontype` @param callback callback that will be called when the operator succeeds or fails to resume the mission. if it fails, an error will be returned.",
+ "resumes the paused mission with recover type. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is `interrupted`. after a mission is resumed successfully, the djiwaypointv2missionactionexecutionevent_currentstate will become `executing`. @param type an enum value of `interruptrecoveractiontype` @param callback callback that will be called when the operator succeeds or fails to resume the mission. if it fails, an error will be returned.",
"stopmission",
- "stops the executing or paused mission. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is one of the following: - `executing` - `interrupted` after a mission finishes successfully, djiwaypointv2missionactionexecutionevent_currentstate will become `ready_to_upload`. @param callback completion block that will be called when the operator succeeds or fails to resume the mission. if it fails, an error will be returned.",
+ "stops the executing or paused mission. it can only be called when the djiwaypointv2missionactionexecutionevent_currentstate is one of the following: - `executing` - `interrupted` after a mission finishes successfully, djiwaypointv2missionactionexecutionevent_currentstate will become `ready_to_upload`. @param callback completion block that will be called when the operator succeeds or fails to resume the mission. if it fails, an error will be returned.",
"setautoflightspeed",
- "set the flight speed while the mission is executing automatically (without manual joystick speed input). this is the only property or method in this class that can communicate with the aircraft during a mission. all other properties and methods are used offline to prepare the mission which is then uploaded to the aircraft. @param speed auto flight speed to be set. the absolute value of the auto flight speed should be less than or equal to the `getmaxflightspeed`. its range is [-`getmaxflightspeed`, `getmaxflightspeed`] m/s. @param callback callback.",
+ "set the flight speed while the mission is executing automatically (without manual joystick speed input). this is the only property or method in this class that can communicate with the aircraft during a mission. all other properties and methods are used offline to prepare the mission which is then uploaded to the aircraft. @param speed auto flight speed to be set. the absolute value of the auto flight speed should be less than or equal to the `getmaxflightspeed`. its range is [-`getmaxflightspeed`, `getmaxflightspeed`] m/s. @param callback callback.",
"getautoflightspeed",
"get the flight speed while the mission is executing. @param callback callback.",
"waypointv2missionexecutionevent",
@@ -4624,7 +4554,7 @@ var search_data = {
"disconnected",
"the connection between the mobile device, remote controller and aircraft is broken.",
"recovering",
- "the connection between the mobile device, remote controller and aircraft is built-up. the operator is synchronizing the state from the aircraft.",
+ "the connection between the mobile device, remote controller and aircraft is built-up. the operator is synchronizing the state from the aircraft.",
"not_supported",
"the connected product does not support waypoint mission 2.0.",
"ready_to_upload",
@@ -4644,7 +4574,7 @@ var search_data = {
"disconnected",
"the connection between the mobile device, remote controller and aircraft is broken.",
"recovering",
- "the connection between the mobile device, remote controller and aircraft is built-up. the operator is synchronizing the action state from the aircraft.",
+ "the connection between the mobile device, remote controller and aircraft is built-up. the operator is synchronizing the action state from the aircraft.",
"not_supported",
"the connected product does not support waypoint mission 2.0.",
"ready_to_upload",
@@ -8571,6 +8501,10 @@ var search_data = {
"pin point information, include the pin points location in the liveview and callback result. supported by zenmuse h20 series.",
"getliveviewlocationwithgps",
"gets the pinpoint information with gps which is used to show pinpoint in the liveview. supported by zenmuse h20 series. @param pointpos the gps location, you could get the location from `gettargetlocation` or get the location with map. @param physicalsource the physical source of a video feed. @param callback the execution callback with the returned value(s).",
+ "setlinkzoomenabled",
+ "enable or disable the link zoom function. after enabling the link zoom function, call `setthermaldigitalzoomfactor` to achieve synchronous zooming of the infrared lens and the zoom lens. in the split-screen mode pip, the user can compare the images of the infrared lens and the zoom lens more efficiently. supported by zenmuse h20 series. @param enabled true to enable link zoom. @param callback the execution callback with the returned value(s).",
+ "getlinkzoomenabled",
+ "gets the link zoom status. supported by zenmuse h20 series. @param callback the execution callback with the returned value(s).",
"restorefactorysettings",
"load the camera's factory settings. post condition: the camera will reboot itself. @param callback the execution callback with the returned value(s).",
"camerakey.restore_factory_settings",
@@ -9879,6 +9813,18 @@ var search_data = {
"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. supported by the zoom lens of zenmuse h20 series. @param enabled `true` to enable ir-cut filter. @param callback callback that receives the setter result.",
"getirfilterenabled",
"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. supported by the zoom lens of zenmuse h20 series. @param callback the execution callback with the returned value(s).",
+ "off",
+ "off.",
+ "on",
+ "on.",
+ "auto",
+ "auto.",
+ "irfiltermode",
+ "the ir filter mode.",
+ "setirfiltermode",
+ "sets the ir filter mode of the current lens. on to reduce the color distortion caused by the infared light, off to enhance the image in low light environments, or auto to up to the system to decide whether to switch. supported by the zoom lens of zenmuse h20 series. @param irfiltermode an enum type of the `irfiltermode` to be used. @param callback the execution callback with the returned execution result.",
+ "getirfiltermode",
+ "gets the ir filter mode of the current lens. supported by the zoom lens of zenmuse h20 series. @param callback the execution callback with the returned value(s).",
"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 series and mavic 2 enterprise advanced, please use class `lens`. @return a boolean value.",
"setdigitalzoomfactor",
@@ -10360,7 +10306,7 @@ var search_data = {
"getxmpfiledata",
"this property contains the xmp data which was written to this media file. if this property returns `null`, use `fetchxmpfiledata` to populate it. only supported phantom 4 rtk, zenmuse p1, zenmuse l1.",
"getresolution",
- "camera resolution. @return an enum value of `videoresolution`.",
+ "camera video resolution. only supported by video. @return an enum value of `videoresolution`.",
"getvideoorientation",
"the orientation of the camera when the video file was first recorded. if the camera orientation changes during a video capture, this will report the initial orientation. will be `landscape` if the media file is a photo. only mavic pro supports this property. will be `landscape` for other products. @return an enum value of `orientation`",
"getthumbnail",
@@ -10914,7 +10860,9 @@ var search_data = {
"custom_network_service",
"rtk is using third-party network service as the reference station. the network service should use ntrip(networked transport of rtcm via internet protocol). it is supported by phantom 4 rtk, p4 multispectral, matrice 210 rtk v2 and matrice 300 rtk.",
"network_rtk",
- "default virtual reference station solution to provide cm level accurate position. the frame can be either wgs84 or cgcs 2000. please note that this default solution can only be used in china. please add the djinetworkrtkhelper to the project via gradle: implementation 'com.dji:library-networkrtk-helper:2.0.2'. it is only supported by phantom 4 rtk, p4 multispectral and matrice 300 rtk.",
+ "default virtual reference station solution to provide cm level accurate position. the frame can be either wgs84 or cgcs 2000. please note that this default solution can only be used in china. please add the djinetworkrtkhelper to the project via gradle: implementation 'com.dji:library-networkrtk-helper:2.0.2'. it is only supported by matrice 300 rtk and matrice 350 rtk.",
+ "ntrip_network_service",
+ "ntrip network service which is used for cmcc network rtk service. it is only supported matrice 300 rtk and matrice 350 rtk.",
"unknown",
"unknown reference station source.",
"callback",
@@ -11088,9 +11036,9 @@ var search_data = {
"getrtk",
"rtk positioning object. @return an instance of `rtk`.",
"savepipelineslog",
- "sets true to save log for pipelines. in order to improve developer's experience on sdk interconnectivity, `pipeline` is designed to save log files locally when files are transferred, during which the speed is 475kb per minute. please be careful with the device storage. @param enabled `true` to save log files.",
+ "sets true to save log for pipelines. in order to improve developer's experience on sdk interconnectivity, djipipeline is designed to save log files locally when files are transferred, during which the speed is 475kb per minute. please be careful with the device storage. @param enabled `true` to save log files.",
"getpipelines",
- "the pipelines to transmit data between onboard device and dji mobile sdk. it's only supported by matrice 300 rtk. @return an instance of `pipelines`.",
+ "the pipelines to transmit data between onboard device and dji mobile sdk. it's only supported by matrice 300 rtk. @return an instance of djipipelines.",
"getimucount",
"number of imu modules in the flight controller. most products have one imu. exceptions: - phantom 4, phantom 4 pro, mavic pro, and inspire 2 each have two imus - a3, matrice 600, and matrice 600 pro each have one inner imu and can have at most two external imus. - n3 has two inner imus and can have one external imu. @return an int value.",
"imu_count",
@@ -11290,9 +11238,9 @@ var search_data = {
"home_location",
"sdk key for gethomelocation: gets the home point of the aircraft. @param callback the execution callback with the returned value(s).",
"setgohomeheightinmeters",
- "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. @param height the aircraft's default go home altitude. @param callback the execution callback with the returned execution result.",
+ "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 or m350 rtk, the limit can beyond 500m. @param height the aircraft's default go home altitude. @param callback the execution callback with the returned execution result.",
"go_home_height_in_meters",
- "sdk key for setgohomeheightinmeters: 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. @param height the aircraft's default go home altitude. @param callback the execution callback with the returned execution result.",
+ "sdk key for setgohomeheightinmeters: 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 or m350 rtk, the limit can beyond 500m. @param height the aircraft's default go home altitude. @param callback the execution callback with the returned execution result.",
"getgohomeheightinmeters",
"gets the minimum altitude (relative to the take-off location in meters) at which the aircraft must be before going home. @param callback the execution callback with the returned value(s).",
"go_home_height_in_meters",
@@ -11360,13 +11308,13 @@ var search_data = {
"setpropellercoverlimitenabled",
"this mode should only be enabled when using accessories like propeller guards and the aircraft is flying in wind-free environments. shown as payload mode in dji fly. only supported by dji mini 2. @param enabled `true` to enable the propeller cover limit. @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.",
+ "enables the coordinated turn. improves aerodynamic efficiency. the aircraft is flying in the direction of the turn, without sideslipping. only supported by m300 rtk and m350 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 completion block that receives the execution result.",
+ "get whether the coordinated turn switch is on. only supported by m300 rtk and m350 rtk. @param callback completion block 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.",
+ "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 and m350 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.",
+ "get the navigation satellite system. only supported by m300 rtk and m350 rtk. @param callback callback that receives the execution result.",
"navigationsatellitesystem",
"this enum defines the navigation satellite system currently being used.",
"gps_glonass",
@@ -12369,6 +12317,8 @@ var search_data = {
"gets a list of authorization fly zones unlocked by the account for the connected aircraft. it includes fly zones unlocked by the flight planner (http://www.dji.com/flysafe/geo-system#planner), and the ones unlocked during flight using dji go or any dji mobile sdk based application. this list does not include fly zones unlocked by custom unlocking. for inspire 1 and phantom 3 series, the list is fetched from the server. if the internet is not accessible, the cached local data will be used. for the other products, the list is fetched from the aircraft. @param callback the execution callback with the returned value(s).",
"unlockflyzones",
"unlocks the selected fly zones. this method can be used to unlock authorization zones. after unlocking the zones, flight will be unrestricted in those zones until the unlock expires. the unlocking record will be linked to the user's account and will be accessible to dji go and other dji mobile sdk based applications. data protection notes - calling this method will send the following protected data to dji server: - user account information - the serial number of the connected aircraft. @param ids the ids of `authorization` zones. @param callback the execution callback with the returned execution result.",
+ "unlockauthorizationflyzone",
+ "unlock the authorization fly zone. after unlocking the authorization fly zone, the aircraft will be able to take off normally in the authorization fly zone, and the authorization fly zone will continue to be banned after reboot the aircraft. @param id the id of `authorization` zone. @param callback the execution callback with the returned execution result.",
"reloadunlockedzonegroupsfromserver",
"reloads the unlocked zone groups unlocked by the current user's account from the server. for all products besides phantom 3 and inspire 1 series this includes both self unlocked and custom unlocked zones. each unlocked zone group corresponds to one aircraft serial number. after launch, sdk will call this method once. it will call this method again when either the network connection or the current account state changes (e.g. when a new user successfully logs in). call this method any other time to trigger the reloading manually. calling this method will not synchronize the loaded zone groups onto the aircraft. to get a list of groups currently loaded from the server, call `getloadedunlockedzonegroups`. user will need to manually call `syncunlockedzonegrouptoaircraft` to synchronize the unlocked group to the connected aircraft after the unlocked zone groups are reloaded. this feature is not supported by inspire 1 or phantom 3 series. for the other products, it can be used when `iscustomunlockzonesupported` returns `true`. @param callback `completion callback` to receive the result.",
"getloadedunlockedzonegroups",
@@ -13028,7 +12978,7 @@ var search_data = {
"stopreadpointcloudliveviewdata",
"stop to receive the point cloud live view data. @param callback the execution callback with the returned value(s).",
"idjilidarliveviewdataprocessor",
- "this processor is provided by dji. we receive the `pointcloudliveviewdata` through `startreadpointcloudliveviewdata` interface, and then use `idjilidarliveviewdataprocessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through `pointcloudview`. if you want to display with your own algorithm. you can use `pointcloudliveviewdata` to draw the point cloud live view data by yourself.",
+ "this processor is provided by dji. we receive the `pointcloudliveviewdata` through `startreadpointcloudliveviewdata` interface, and then use `idjilidarliveviewdataprocessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through djilidarpointcloudview. if you want to display with your own algorithm. you can use `pointcloudliveviewdata` to draw the point cloud live view data by yourself.",
"bindview",
"bind the view which is provided by dji. @param view the view to draw the point cloud live view data. provided by dji.",
"addpointcloudliveviewdata",
@@ -13161,24 +13111,12 @@ var search_data = {
"rgb data of the object measured by the lidar. if you set visible light pixel mode to `visible_light_pixel_off`, the data will be (0, 0, 0).",
"getblue",
"rgb data of the object measured by the lidar. if you set visible light pixel mode to `visible_light_pixel_off`, the data will be (0, 0, 0).",
- "pointcloudview",
- "this view is provided by dji. we recevie the `pointcloudliveviewdata` through `startreadpointcloudliveviewdata` interface, and then use `idjilidarliveviewdataprocessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through this view. if you don't want to use this view, you can use `pointcloudliveviewdata` to draw the point cloud live view data by yourself.",
"pointclouddisplaymode",
"enums represent the point cloud live view display mode of lidar.",
"fpv",
"display the point cloud live view data by fpv mode. only the point cloud live view data in the current fpv screen will be displayed.",
"overall",
"display the point cloud live view data by overall mode. all point cloud live view data added to `idjilidarliveviewdataprocessor` through `addpointcloudliveviewdata` will be displayed.",
- "pointcloudcolormode",
- "enums represent the point cloud live view color mode of lidar.",
- "intensity",
- "using intensity data to coloring the point cloud live view data.",
- "height",
- "using height(`getz`) data to coloring the point cloud live view data. it will help you measure objects with a large height difference.",
- "hybird",
- "hybird the intensity and distance(`getx`, `gety`) data to coloring the point cloud live view data. it will help you to measure objects better when flying horizontally.",
- "visible_light",
- "using visible light(`getred`, `getgreen`, `getblue`) data to coloring the point cloud live view data. if you want to use this mode, please set `djilidarpointcloudvisiblelightpixelmode` on.",
"responseforgimbalcontrol",
"constructor of the class. @param requesterid slave remote controller's identifier. @param isagree true if the master remote controller agrees to give the slave remote controller the right to control the gimbal.",
"getrequesterid",
@@ -17822,10 +17760,10 @@ var search_data = {
2,
"/Components/BaseComponent/DJIBaseComponent.html",
"#DJIBaseComponent_index_inline",
- "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 An int value of index.",
+ "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, M300 RTK and M350 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 An int value of index.",
],
[
- "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 An int value of index.",
+ "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, M300 RTK and M350 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 An int value of index.",
1,
"/Components/BaseComponent/DJIBaseComponent.html",
"#DJIBaseComponent_index_inline",
@@ -17929,6 +17867,34 @@ var search_data = {
"#DJIDataProtectionManager_isAccessToObfuscatedLocationAuthorized_inline",
"",
],
+ [
+ "agreeToProductImprovement",
+ 2,
+ "/Components/DataProtectionManager/DJIDataProtectionManager.html",
+ "#DJIDataProtectionManager_agreeToProductImprovement_inline",
+ "Agree or disagree with the product improvement project. Through this project, the DJI device information, mobile device information, and diagnostic and usage data collected through MSDK will be provided to DJI for analysis. This analysis helps DJI improve products and services. DJI will take necessary data protection measures before data analysis. @param isAgree `true` to ageree product improvement project. @return The encountered error if there is any.",
+ ],
+ [
+ "Agree or disagree with the product improvement project. Through this project, the DJI device information, mobile device information, and diagnostic and usage data collected through MSDK will be provided to DJI for analysis. This analysis helps DJI improve products and services. DJI will take necessary data protection measures before data analysis. @param isAgree `true` to ageree product improvement project. @return The encountered error if there is any.",
+ 1,
+ "/Components/DataProtectionManager/DJIDataProtectionManager.html",
+ "#DJIDataProtectionManager_agreeToProductImprovement_inline",
+ "",
+ ],
+ [
+ "isAgreeToProductImprovement",
+ 2,
+ "/Components/DataProtectionManager/DJIDataProtectionManager.html",
+ "#DJIDataProtectionManager_isAgreeToProductImprovement_inline",
+ "Gets whether to agree to the product improvement project. @return `true` if it is agreed to product improvement project.",
+ ],
+ [
+ "Gets whether to agree to the product improvement project. @return `true` if it is agreed to product improvement project.",
+ 1,
+ "/Components/DataProtectionManager/DJIDataProtectionManager.html",
+ "#DJIDataProtectionManager_isAgreeToProductImprovement_inline",
+ "",
+ ],
[
"getInstance",
2,
@@ -18018,10 +17984,10 @@ var search_data = {
2,
"/Components/DataProtectionManager/DJIDataProtectionManager.html",
"",
- "Data Protection Manager. DJI SDK will send data to DJI servers in the background in order to complete logics, including data related to user's information. Data Protection Manager can be used to authorize DJI server to access the user- related data. SDK will NOT send the data to DJI server in the background before the authorization. Internet requests triggered by the user manually are not managed by `DataProtectionManager`. Involved user-related data is listed in the documentation of the interfaces. The authorization is not persistent and each authorization setting will be reset to the default value for each APP's life cycle. This class is accessible before calling `registerApp`. The UTMISSManager class needs to report flight dynamic data to the UTMISS server in accordance with the policy requirements of the Civil Aviation Administration of China. It is not in this category of management. For details, please refer to the UTMISSManager interface document.",
+ "Data Protection Manager. DJI SDK will send data to DJI servers in the background in order to complete logics, including data related to user's information. Data Protection Manager can be used to authorize DJI server to access the user- related data. SDK will NOT send the data to DJI server in the background before the authorization. Internet requests triggered by the user manually are not managed by `DataProtectionManager`. Involved user-related data is listed in the documentation of the interfaces. This class is accessible before calling `registerApp`. The UTMISSManager class needs to report flight dynamic data to the UTMISS server in accordance with the policy requirements of the Civil Aviation Administration of China. It is not in this category of management. For details, please refer to the UTMISSManager interface document.",
],
[
- "Data Protection Manager. DJI SDK will send data to DJI servers in the background in order to complete logics, including data related to user's information. Data Protection Manager can be used to authorize DJI server to access the user- related data. SDK will NOT send the data to DJI server in the background before the authorization. Internet requests triggered by the user manually are not managed by `DataProtectionManager`. Involved user-related data is listed in the documentation of the interfaces. The authorization is not persistent and each authorization setting will be reset to the default value for each APP's life cycle. This class is accessible before calling `registerApp`. The UTMISSManager class needs to report flight dynamic data to the UTMISS server in accordance with the policy requirements of the Civil Aviation Administration of China. It is not in this category of management. For details, please refer to the UTMISSManager interface document.",
+ "Data Protection Manager. DJI SDK will send data to DJI servers in the background in order to complete logics, including data related to user's information. Data Protection Manager can be used to authorize DJI server to access the user- related data. SDK will NOT send the data to DJI server in the background before the authorization. Internet requests triggered by the user manually are not managed by `DataProtectionManager`. Involved user-related data is listed in the documentation of the interfaces. This class is accessible before calling `registerApp`. The UTMISSManager class needs to report flight dynamic data to the UTMISS server in accordance with the policy requirements of the Civil Aviation Administration of China. It is not in this category of management. For details, please refer to the UTMISSManager interface document.",
1,
"/Components/DataProtectionManager/DJIDataProtectionManager.html",
"",
@@ -18284,29 +18250,15 @@ var search_data = {
2,
"/Components/Payload/DJIPayload.html",
"",
- "Class used to interact with the payload device mounted on DJI aircraft.",
+ "Class used to interact with the payload device mounted on DJI aircraft. Note: In the MSDK V4 version, the PSDK payload device cannot be used with Zenmuse L1 and Zenmuse P1 at the same time. If you need to use them at the same time, please upgrade to MSDK V5.",
],
[
- "Class used to interact with the payload device mounted on DJI aircraft.",
+ "Class used to interact with the payload device mounted on DJI aircraft. Note: In the MSDK V4 version, the PSDK payload device cannot be used with Zenmuse L1 and Zenmuse P1 at the same time. If you need to use them at the same time, please upgrade to MSDK V5.",
1,
"/Components/Payload/DJIPayload.html",
"",
"",
],
- [
- "Pipeline",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "",
- "Establishes a pipeline connected with Onboard device or Payload device to transmit data. Uses `connect` to create a pipeline. `disconnect` can be invoked to destroy the data transmission channel and disconnect from the Onboard device or Payload device.",
- ],
- [
- "Establishes a pipeline connected with Onboard device or Payload device to transmit data. Uses `connect` to create a pipeline. `disconnect` can be invoked to destroy the data transmission channel and disconnect from the Onboard device or Payload device.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "",
- "",
- ],
[
"AccessoryAggregation",
2,
@@ -32615,286 +32567,6 @@ var search_data = {
"#DJIError_DJIUpgradeError_InWifiLink_inline",
"",
],
- [
- "UNKNOWN",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_Unknown_inline",
- "Unknown.",
- ],
- [
- "Unknown.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_Unknown_inline",
- "",
- ],
- [
- "CRC_CHECK_FAILED",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_CRCCheckFailed_inline",
- "CRC check failed.",
- ],
- [
- "CRC check failed.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_CRCCheckFailed_inline",
- "",
- ],
- [
- "INVALID_PARAMETERS",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_InvalidParameters_inline",
- "Invalid Parameters.",
- ],
- [
- "Invalid Parameters.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_InvalidParameters_inline",
- "",
- ],
- [
- "NOT_ENOUGH_MEMORY",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_NotEnoughMemory_inline",
- "Not enough memory.",
- ],
- [
- "Not enough memory.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_NotEnoughMemory_inline",
- "",
- ],
- [
- "NOT_READY",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_NotReady_inline",
- "Usually occurs when allocating the local pipeline ID.",
- ],
- [
- "Usually occurs when allocating the local pipeline ID.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_NotReady_inline",
- "",
- ],
- [
- "SEND_FAILED",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_SendFailed_inline",
- "Send data exception.",
- ],
- [
- "Send data exception.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_SendFailed_inline",
- "",
- ],
- [
- "RECEIVE_FAILED",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ReceiveFailed_inline",
- "Receiving data exceptions.",
- ],
- [
- "Receiving data exceptions.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ReceiveFailed_inline",
- "",
- ],
- [
- "TIMEOUT",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_Timeout_inline",
- "Timeout error.",
- ],
- [
- "Timeout error.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_Timeout_inline",
- "",
- ],
- [
- "BUSY_OPERATION",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_BusyOperation_inline",
- "Busy now, please try again later.",
- ],
- [
- "Busy now, please try again later.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_BusyOperation_inline",
- "",
- ],
- [
- "UNACCEPTABLE_OPERATIONS",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_UnacceptableOperations_inline",
- "Resource occupied, please select another ID connection.",
- ],
- [
- "Resource occupied, please select another ID connection.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_UnacceptableOperations_inline",
- "",
- ],
- [
- "CLOSED",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ConnectionClosed_inline",
- "Connection closed, no need to call again.",
- ],
- [
- "Connection closed, no need to call again.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ConnectionClosed_inline",
- "",
- ],
- [
- "CONNECTING",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ConnectionConnecting_inline",
- "Connecting, no need to call again.",
- ],
- [
- "Connecting, no need to call again.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ConnectionConnecting_inline",
- "",
- ],
- [
- "RESOURCES_NOT_AVAILABLE",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ResourcesNotAvailable_inline",
- "Local resources are ineffective and unavailable. Please recreate.",
- ],
- [
- "Local resources are ineffective and unavailable. Please recreate.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ResourcesNotAvailable_inline",
- "",
- ],
- [
- "CLOSING",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ConnectionClosing_inline",
- "Connection closing, no need to call again.",
- ],
- [
- "Connection closing, no need to call again.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ConnectionClosing_inline",
- "",
- ],
- [
- "NOT_CONNECTED",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_NotConnected_inline",
- "Connection has not established.",
- ],
- [
- "Connection has not established.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_NotConnected_inline",
- "",
- ],
- [
- "LINK_BREAK",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_LinkBreak_inline",
- "Link broken, please check the connection with the aircraft.",
- ],
- [
- "Link broken, please check the connection with the aircraft.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_LinkBreak_inline",
- "",
- ],
- [
- "CONNECTION_REFUSED",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ConnectionRefused_inline",
- "The target device refuses to connect.",
- ],
- [
- "The target device refuses to connect.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_ConnectionRefused_inline",
- "",
- ],
- [
- "ID_OCCUPIED",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_IdIsOccupied_inline",
- "Duplicated binding is not allowed. Please try to bind with a new ID.",
- ],
- [
- "Duplicated binding is not allowed. Please try to bind with a new ID.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_IdIsOccupied_inline",
- "",
- ],
- [
- "INTERNAL_STATUS_ERROR",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_InternalStatusError_inline",
- "Internal status error. Please recreate the Pipeline object.",
- ],
- [
- "Internal status error. Please recreate the Pipeline object.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_InternalStatusError_inline",
- "",
- ],
- [
- "getDJIError",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_getDJIError_inline",
- "Get the object of `PipelineError` error information by error code. @param code An int value of the error code. @return An object of `PipelineError`.",
- ],
- [
- "Get the object of `PipelineError` error information by error code. @param code An int value of the error code. @return An object of `PipelineError`.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "#DJIError_DJIPipelineError_getDJIError_inline",
- "",
- ],
[
"getDJIError",
2,
@@ -35009,20 +34681,6 @@ var search_data = {
"",
"",
],
- [
- "PipelineError",
- 2,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "",
- "Errors related to the `Pipelines`.",
- ],
- [
- "Errors related to the `Pipelines`.",
- 1,
- "/Components/SDKError/DJIError_DJIPipelineError.html",
- "",
- "",
- ],
[
"DJISDKError",
2,
@@ -35107,6 +34765,20 @@ var search_data = {
"#DJIError_COMMON_DATA_ERROR_inline",
"",
],
+ [
+ "COMMON_INVALID_AUTHORIZATION_ID",
+ 2,
+ "/Components/SDKError/DJIError.html",
+ "#DJIError_COMMON_INVALID_AUTHORIZATION_ID_inline",
+ "Invalid authorization ID.",
+ ],
+ [
+ "Invalid authorization ID.",
+ 1,
+ "/Components/SDKError/DJIError.html",
+ "#DJIError_COMMON_INVALID_AUTHORIZATION_ID_inline",
+ "",
+ ],
[
"COMMON_UNDEFINED",
2,
@@ -40217,6 +39889,20 @@ var search_data = {
"#DJICodecManager_setOverexposureWarningEnabled_inline",
"",
],
+ [
+ "setCodecName",
+ 2,
+ "/Components/CodecManager/DJICodecManager.html",
+ "#DJICodecManager_setCodecName_inline",
+ "Set the codec name. For some mobile phones that cannot display video stream normally. You can set the codec name through this interface so that MSDK can call the correct decoder for decoding and display. You can call android API:MediaCodecList to get available codec names for testing. @param codecName ",
+ ],
+ [
+ "Set the codec name. For some mobile phones that cannot display video stream normally. You can set the codec name through this interface so that MSDK can call the correct decoder for decoding and display. You can call android API:MediaCodecList to get available codec names for testing. @param codecName ",
+ 1,
+ "/Components/CodecManager/DJICodecManager.html",
+ "#DJICodecManager_setCodecName_inline",
+ "",
+ ],
[
"setYuvDataCallback",
2,
@@ -41300,10 +40986,10 @@ var search_data = {
2,
"/Products/Aircraft/DJIAircraft.html",
"#DJIAircraft_lidars_inline",
- "Retrieves instances of the product's lidars. This is used when the aircraft has multiple DJI lidars, e.g. M300 RTK. Note, when two Zenmuse L1 do exist, lidar order within the array will not always the same. For example: On the M300 RTK, the port side (left) Zenmuse L1 will have an index of 0 and the starboard side (right) Zenmuse will have an index of 1. However, the first object of `getLidars` will not necessarily always be the lidar with `getIndex` of 0. @return A list of the aircraft's lidars.",
+ "Retrieves instances of the product's lidars. This is used when the aircraft has multiple DJI lidars, e.g. M300 RTK and M350 RTK. Note, when two Zenmuse L1 do exist, lidar order within the array will not always the same. For example: On the M300 RTK and M350 RTK, the port side (left) Zenmuse L1 will have an index of 0 and the starboard side (right) Zenmuse will have an index of 1. However, the first object of `getLidars` will not necessarily always be the lidar with `getIndex` of 0. @return A list of the aircraft's lidars.",
],
[
- "Retrieves instances of the product's lidars. This is used when the aircraft has multiple DJI lidars, e.g. M300 RTK. Note, when two Zenmuse L1 do exist, lidar order within the array will not always the same. For example: On the M300 RTK, the port side (left) Zenmuse L1 will have an index of 0 and the starboard side (right) Zenmuse will have an index of 1. However, the first object of `getLidars` will not necessarily always be the lidar with `getIndex` of 0. @return A list of the aircraft's lidars.",
+ "Retrieves instances of the product's lidars. This is used when the aircraft has multiple DJI lidars, e.g. M300 RTK and M350 RTK. Note, when two Zenmuse L1 do exist, lidar order within the array will not always the same. For example: On the M300 RTK and M350 RTK, the port side (left) Zenmuse L1 will have an index of 0 and the starboard side (right) Zenmuse will have an index of 1. However, the first object of `getLidars` will not necessarily always be the lidar with `getIndex` of 0. @return A list of the aircraft's lidars.",
1,
"/Products/Aircraft/DJIAircraft.html",
"#DJIAircraft_lidars_inline",
@@ -42191,20 +41877,6 @@ var search_data = {
"#DJISDKManager_getInstance_inline",
"",
],
- [
- "destroy",
- 2,
- "/Components/SDKManager/DJISDKManager.html",
- "#DJISDKManager_destroy_inline",
- "Releases the resources held by the DJISDKManager. This will unsubscribe the app from any updates sent by the SDK.",
- ],
- [
- "Releases the resources held by the DJISDKManager. This will unsubscribe the app from any updates sent by the SDK.",
- 1,
- "/Components/SDKManager/DJISDKManager.html",
- "#DJISDKManager_destroy_inline",
- "",
- ],
[
"setCallbackRunInUIThread",
2,
@@ -43283,230 +42955,6 @@ var search_data = {
"#DJIHandheld_DJIHandheldModelNameOsmoMobile2_inline",
"",
],
- [
- "getId",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_Id_inline",
- "The identification number of the pipeline connected with the Payload or the Onboard device. @return An int value of pipeline id.",
- ],
- [
- "The identification number of the pipeline connected with the Payload or the Onboard device. @return An int value of pipeline id.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_Id_inline",
- "",
- ],
- [
- "getType",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_transmissionType_inline",
- "Transmission processing type. @return An enum value of `TransmissionControlType`.",
- ],
- [
- "Transmission processing type. @return An enum value of `TransmissionControlType`.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_transmissionType_inline",
- "",
- ],
- [
- "getDeviceType",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_deviceType_inline",
- "Device type connected. @return An enum value of `PipelineDeviceType`.",
- ],
- [
- "Device type connected. @return An enum value of `PipelineDeviceType`.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_deviceType_inline",
- "",
- ],
- [
- "writeData",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_writeData_inline",
- "Data to be sent. 1 KB data size is recommended. @param data The data needs to be sent. @param offset The start offset in the data. @param length The number of bytes to write. @return If the return code greater than 0 it is the length of data written otherwise it is the error code.",
- ],
- [
- "Data to be sent. 1 KB data size is recommended. @param data The data needs to be sent. @param offset The start offset in the data. @param length The number of bytes to write. @return If the return code greater than 0 it is the length of data written otherwise it is the error code.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_writeData_inline",
- "",
- ],
- [
- "readData",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_readData_inline",
- "Read data from the pipeline. @param buff The buffer into which the data is read. @param offset The start offset in the array buff at which the data is written. @param length The maximum number of bytes to read. @return If the return code greater than 0 it is the length of data read otherwise it is the error code.",
- ],
- [
- "Read data from the pipeline. @param buff The buffer into which the data is read. @param offset The start offset in the array buff at which the data is written. @param length The maximum number of bytes to read. @return If the return code greater than 0 it is the length of data read otherwise it is the error code.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_readData_inline",
- "",
- ],
- [
- "TransmissionControlType",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJITransmissionControlType_inline",
- "Defines pipeline transmission control type.",
- ],
- [
- "Defines pipeline transmission control type.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJITransmissionControlType_inline",
- "",
- ],
- [
- "STABLE",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJITransmissionControlType_Stable_inline",
- "Guarantees delivery of data and that packets will be delivered in the order they were sent.",
- ],
- [
- "Guarantees delivery of data and that packets will be delivered in the order they were sent.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJITransmissionControlType_Stable_inline",
- "",
- ],
- [
- "PUSH",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJITransmissionControlType_Unreliable_inline",
- "This transmission control type does not provide guaranteed delivery and a datagram packet may become corrupt or lost in transit. Suitable for time- sensitive transmission.",
- ],
- [
- "This transmission control type does not provide guaranteed delivery and a datagram packet may become corrupt or lost in transit. Suitable for time- sensitive transmission.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJITransmissionControlType_Unreliable_inline",
- "",
- ],
- [
- "PipelineDeviceType",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJIPipelineDeviceType_inline",
- "The enum is used to represent the pipeline device type.",
- ],
- [
- "The enum is used to represent the pipeline device type.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJIPipelineDeviceType_inline",
- "",
- ],
- [
- "ON_BOARD",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJIPipelineDeviceType_Onboard_inline",
- "Onboard device. Please check the developer website: https://developer.dji.com /onboard-sdk/.",
- ],
- [
- "Onboard device. Please check the developer website: https://developer.dji.com /onboard-sdk/.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJIPipelineDeviceType_Onboard_inline",
- "",
- ],
- [
- "PAYLOAD",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJIPipelineDeviceType_Payload_inline",
- "Payload device. Please check the developer website: https://developer.dji.com /payload-sdk/.",
- ],
- [
- "Payload device. Please check the developer website: https://developer.dji.com /payload-sdk/.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJIPipelineDeviceType_Payload_inline",
- "",
- ],
- [
- "UNKNOWN",
- 2,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJIPipelineDeviceType_Unknown_inline",
- "Unknown.",
- ],
- [
- "Unknown.",
- 1,
- "/Components/Pipeline/DJIPipeline.html",
- "#DJIPipeline_DJIPipelineDeviceType_Unknown_inline",
- "",
- ],
- [
- "Pipelines",
- 2,
- "/Components/Pipeline/DJIPipelines.html",
- "",
- "Manage multiple pipelines. Only supported by Matrice 300 RTK with firmware version v01.00.01.01 and above.",
- ],
- [
- "Manage multiple pipelines. Only supported by Matrice 300 RTK with firmware version v01.00.01.01 and above.",
- 1,
- "/Components/Pipeline/DJIPipelines.html",
- "",
- "",
- ],
- [
- "getPipelines",
- 2,
- "/Components/Pipeline/DJIPipelines.html",
- "#DJIPipelines_pipelines_inline",
- "Retrieves instances of the products's pipelines. The key of the map table refers to the pipeline ID that connected with the Payload or the Onboard device, and the value refers to the pipeline instance object. When the pipeline connection is established successfully, a pipeline object is created and placed in the map table. When `disconnect` is invoked, the expired pipeline will be removed from the pipelins map table. @return The Pipeline Map object.",
- ],
- [
- "Retrieves instances of the products's pipelines. The key of the map table refers to the pipeline ID that connected with the Payload or the Onboard device, and the value refers to the pipeline instance object. When the pipeline connection is established successfully, a pipeline object is created and placed in the map table. When `disconnect` is invoked, the expired pipeline will be removed from the pipelins map table. @return The Pipeline Map object.",
- 1,
- "/Components/Pipeline/DJIPipelines.html",
- "#DJIPipelines_pipelines_inline",
- "",
- ],
- [
- "connect",
- 2,
- "/Components/Pipeline/DJIPipelines.html",
- "#DJIPipelines_connect_inline",
- "Establishes the pipeline connection with the pipeline's ID. Returns an instance of the pipeline when it is connected successfully, otherwise, error information will be returned. @param id The pipeline id. @param transmissionType An enum value of `TransmissionControlType`. @param callback Completion block to receive the result.",
- ],
- [
- "Establishes the pipeline connection with the pipeline's ID. Returns an instance of the pipeline when it is connected successfully, otherwise, error information will be returned. @param id The pipeline id. @param transmissionType An enum value of `TransmissionControlType`. @param callback Completion block to receive the result.",
- 1,
- "/Components/Pipeline/DJIPipelines.html",
- "#DJIPipelines_connect_inline",
- "",
- ],
- [
- "disconnect",
- 2,
- "/Components/Pipeline/DJIPipelines.html",
- "#DJIPipelines_disconnect_inline",
- "Disconnects from the Payload or the Onboard device by pipeline ID, and clear the cached data in pipeline. If it is disconnected successfully, the pipeline instance will be removed from the pipeline map table, otherwise, error information will be returned. @param callback Completion block to receive the result.",
- ],
- [
- "Disconnects from the Payload or the Onboard device by pipeline ID, and clear the cached data in pipeline. If it is disconnected successfully, the pipeline instance will be removed from the pipeline map table, otherwise, error information will be returned. @param callback Completion block to receive the result.",
- 1,
- "/Components/Pipeline/DJIPipelines.html",
- "#DJIPipelines_disconnect_inline",
- "",
- ],
[
"setAreaCode",
2,
@@ -45416,10 +44864,10 @@ var search_data = {
2,
"/Components/Payload/DJIPayload.html",
"#DJIPayload_pipelines_inline",
- "The pipelines to transmit data between DJI Payload device and DJI mobile SDK. This function does not support dual controllers scenarios. It's only supported by Matrice 300 RTK. @return The `Pipelines` objects.",
+ "The pipelines to transmit data between DJI Payload device and DJI mobile SDK. This function does not support dual controllers scenarios. It's only supported by Matrice 300 RTK. @return The DJIPipelines objects.",
],
[
- "The pipelines to transmit data between DJI Payload device and DJI mobile SDK. This function does not support dual controllers scenarios. It's only supported by Matrice 300 RTK. @return The `Pipelines` objects.",
+ "The pipelines to transmit data between DJI Payload device and DJI mobile SDK. This function does not support dual controllers scenarios. It's only supported by Matrice 300 RTK. @return The DJIPipelines objects.",
1,
"/Components/Payload/DJIPayload.html",
"#DJIPayload_pipelines_inline",
@@ -47824,10 +47272,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMissionOperator.html",
"#DJIWaypointMissionOperator_getPreviousInterruption_inline",
- "Gets the interruption of the last waypoint mission. If a waypoint mission is interrupted before the completion, the aircraft will record the interruption information. This information is only available when the last waypoint mission is incomplete and the first waypoint of the mission has been reached. The interruption will also be recorded if the mission is stopped by the user. The interruption information is recorded in the aircraft and the information persists even after the aircraft's reboot. Supported only by Phantom 4 RTK. @param callback The execution callback with the returned execution result.",
+ "Gets the interruption of the last waypoint mission. If a waypoint mission is interrupted before the completion, the aircraft will record the interruption information. This information is only available when the last waypoint mission is incomplete and the first waypoint of the mission has been reached. The interruption will also be recorded if the mission is stopped by the user. The interruption information is recorded in the aircraft and the information persists even after the aircraft's reboot. Supported only by Phantom 4 RTK. @param callback The execution callback with the returned execution result.",
],
[
- "Gets the interruption of the last waypoint mission. If a waypoint mission is interrupted before the completion, the aircraft will record the interruption information. This information is only available when the last waypoint mission is incomplete and the first waypoint of the mission has been reached. The interruption will also be recorded if the mission is stopped by the user. The interruption information is recorded in the aircraft and the information persists even after the aircraft's reboot. Supported only by Phantom 4 RTK. @param callback The execution callback with the returned execution result.",
+ "Gets the interruption of the last waypoint mission. If a waypoint mission is interrupted before the completion, the aircraft will record the interruption information. This information is only available when the last waypoint mission is incomplete and the first waypoint of the mission has been reached. The interruption will also be recorded if the mission is stopped by the user. The interruption information is recorded in the aircraft and the information persists even after the aircraft's reboot. Supported only by Phantom 4 RTK. @param callback The execution callback with the returned execution result.",
1,
"/Components/Missions/DJIWaypointMissionOperator.html",
"#DJIWaypointMissionOperator_getPreviousInterruption_inline",
@@ -47978,10 +47426,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMission.html",
"",
- "In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is not supported by Mavic Pro when using WiFi connection. It is not supported by Spark, Mavic Mini, DJI Mini 2, DJI Mini SE, Mavic Air 2, DJI Air 2S and Matrice 300 RTK.",
+ "In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is not supported by Mavic Pro when using WiFi connection. It is not supported by Spark, Mavic Mini, DJI Mini 2, DJI Mini SE, Mavic Air 2, DJI Air 2S and Matrice 300 RTK.",
],
[
- "In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is not supported by Mavic Pro when using WiFi connection. It is not supported by Spark, Mavic Mini, DJI Mini 2, DJI Mini SE, Mavic Air 2, DJI Air 2S and Matrice 300 RTK.",
+ "In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is not supported by Mavic Pro when using WiFi connection. It is not supported by Spark, Mavic Mini, DJI Mini 2, DJI Mini SE, Mavic Air 2, DJI Air 2S and Matrice 300 RTK.",
1,
"/Components/Missions/DJIWaypointMission.html",
"",
@@ -47992,10 +47440,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2Mission.html",
"",
- "In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is only supported by `MATRICE_300_RTK`.",
+ "In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is only supported by `MATRICE_300_RTK`.",
],
[
- "In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is only supported by `MATRICE_300_RTK`.",
+ "In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is only supported by `MATRICE_300_RTK`.",
1,
"/Components/Missions/DJIWaypointV2Mission.html",
"",
@@ -48552,10 +48000,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMission_DJIWaypointExecutionProgress.html",
"#DJIWaypointMission_DJIWaypointExecutionProgress_isWaypointReached_inline",
- "YES when the aircraft reaches a waypoint. After the waypoint actions and heading change is complete, the `targetWaypointIndex` will increment and this property will become NO.",
+ "YES when the aircraft reaches a waypoint. After the waypoint actions and heading change is complete, the `targetWaypointIndex` will increment and this property will become NO.",
],
[
- "YES when the aircraft reaches a waypoint. After the waypoint actions and heading change is complete, the `targetWaypointIndex` will increment and this property will become NO.",
+ "YES when the aircraft reaches a waypoint. After the waypoint actions and heading change is complete, the `targetWaypointIndex` will increment and this property will become NO.",
1,
"/Components/Missions/DJIWaypointMission_DJIWaypointExecutionProgress.html",
"#DJIWaypointMission_DJIWaypointExecutionProgress_isWaypointReached_inline",
@@ -48594,10 +48042,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_Moving_inline",
- "Aircraft is currently moving toward the mission's next waypoint. This happens when the `WaypointMissionFlightPathMode` is set to `NORMAL`.",
+ "Aircraft is currently moving toward the mission's next waypoint. This happens when the `WaypointMissionFlightPathMode` is set to `NORMAL`.",
],
[
- "Aircraft is currently moving toward the mission's next waypoint. This happens when the `WaypointMissionFlightPathMode` is set to `NORMAL`.",
+ "Aircraft is currently moving toward the mission's next waypoint. This happens when the `WaypointMissionFlightPathMode` is set to `NORMAL`.",
1,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_Moving_inline",
@@ -48608,10 +48056,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_CurveModeMoving_inline",
- "Aircraft is currently moving. This happens when the `WaypointMissionFlightPathMode` is set to `CURVED`.",
+ "Aircraft is currently moving. This happens when the `WaypointMissionFlightPathMode` is set to `CURVED`.",
],
[
- "Aircraft is currently moving. This happens when the `WaypointMissionFlightPathMode` is set to `CURVED`.",
+ "Aircraft is currently moving. This happens when the `WaypointMissionFlightPathMode` is set to `CURVED`.",
1,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_CurveModeMoving_inline",
@@ -48622,10 +48070,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_CurveModeTurning_inline",
- "Aircraft is currently turning. This happens when the `WaypointMissionFlightPathMode` is set to `CURVED`.",
+ "Aircraft is currently turning. This happens when the `WaypointMissionFlightPathMode` is set to `CURVED`.",
],
[
- "Aircraft is currently turning. This happens when the `WaypointMissionFlightPathMode` is set to `CURVED`.",
+ "Aircraft is currently turning. This happens when the `WaypointMissionFlightPathMode` is set to `CURVED`.",
1,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_CurveModeTurning_inline",
@@ -48636,10 +48084,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_BeginAction_inline",
- "Aircraft has reached a waypoint, has rotated to the new heading and is now processing actions. This state will be called before the waypoint actions starts executing and will occur for each waypoint action.",
+ "Aircraft has reached a waypoint, has rotated to the new heading and is now processing actions. This state will be called before the waypoint actions starts executing and will occur for each waypoint action.",
],
[
- "Aircraft has reached a waypoint, has rotated to the new heading and is now processing actions. This state will be called before the waypoint actions starts executing and will occur for each waypoint action.",
+ "Aircraft has reached a waypoint, has rotated to the new heading and is now processing actions. This state will be called before the waypoint actions starts executing and will occur for each waypoint action.",
1,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_BeginAction_inline",
@@ -48664,10 +48112,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_FinishedAction_inline",
- "Aircraft is at a waypoint and has finished executing the current waypoint action. This state occurs once for each waypoint action.",
+ "Aircraft is at a waypoint and has finished executing the current waypoint action. This state occurs once for each waypoint action.",
],
[
- "Aircraft is at a waypoint and has finished executing the current waypoint action. This state occurs once for each waypoint action.",
+ "Aircraft is at a waypoint and has finished executing the current waypoint action. This state occurs once for each waypoint action.",
1,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_FinishedAction_inline",
@@ -48678,10 +48126,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_ReturnToFirstWaypoint_inline",
- "Aircraft has returned to the first waypoint. This happens when the `getFinishedAction` is set to `RETURN_TO_FIRST_WAYPOINT`.",
+ "Aircraft has returned to the first waypoint. This happens when the `getFinishedAction` is set to `RETURN_TO_FIRST_WAYPOINT`.",
],
[
- "Aircraft has returned to the first waypoint. This happens when the `getFinishedAction` is set to `RETURN_TO_FIRST_WAYPOINT`.",
+ "Aircraft has returned to the first waypoint. This happens when the `getFinishedAction` is set to `RETURN_TO_FIRST_WAYPOINT`.",
1,
"/Components/Missions/DJIWaypointMission.html",
"#DJIWaypointMission_DJIWaypointMissionExecuteState_ReturnToFirstWaypoint_inline",
@@ -48706,10 +48154,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_loadedMission_inline",
- "Gets the currently loaded mission of the operator. There are two ways to load a mission. 1. A mission can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission when SDK is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. In that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. User can call `downloadMission` to get all the information for the loaded mission. The `getLoadedMission` will be reset to `null` when the execution of the loadedMission is stopped, finished. @return An object of `WaypointV2Mission`.",
+ "Gets the currently loaded mission of the operator. There are two ways to load a mission. 1. A mission can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission when SDK is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. In that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. User can call `downloadMission` to get all the information for the loaded mission. The `getLoadedMission` will be reset to `null` when the execution of the loadedMission is stopped, finished. @return An object of `WaypointV2Mission`.",
],
[
- "Gets the currently loaded mission of the operator. There are two ways to load a mission. 1. A mission can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission when SDK is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. In that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. User can call `downloadMission` to get all the information for the loaded mission. The `getLoadedMission` will be reset to `null` when the execution of the loadedMission is stopped, finished. @return An object of `WaypointV2Mission`.",
+ "Gets the currently loaded mission of the operator. There are two ways to load a mission. 1. A mission can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission when SDK is re-connected, the operator will download part of the mission's information from the aircraft and load it automatically. In that case, the loaded mission will only contain the summary of the executing mission but information for each waypoint is absent. User can call `downloadMission` to get all the information for the loaded mission. The `getLoadedMission` will be reset to `null` when the execution of the loadedMission is stopped, finished. @return An object of `WaypointV2Mission`.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_loadedMission_inline",
@@ -48720,10 +48168,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_loadMission_inline",
- "Loads a waypoint mission into the operator. A mission can be loaded only when the `WaypointV2MissionState` is one of the following : - `READY_TO_UPLOAD` - `READY_TO_EXECUTE` Calling `loadMission` when the current state is `READY_TO_EXECUTE` will change the state to `READY_TO_UPLOAD`. After calling `getLoadedMission`, @param mission Waypoint mission to load. @param callback Returns an error when mission data is invalid or the mission cannot be loaded in the current state.",
+ "Loads a waypoint mission into the operator. A mission can be loaded only when the `WaypointV2MissionState` is one of the following : - `READY_TO_UPLOAD` - `READY_TO_EXECUTE` Calling `loadMission` when the current state is `READY_TO_EXECUTE` will change the state to `READY_TO_UPLOAD`. After calling `getLoadedMission`, @param mission Waypoint mission to load. @param callback Returns an error when mission data is invalid or the mission cannot be loaded in the current state.",
],
[
- "Loads a waypoint mission into the operator. A mission can be loaded only when the `WaypointV2MissionState` is one of the following : - `READY_TO_UPLOAD` - `READY_TO_EXECUTE` Calling `loadMission` when the current state is `READY_TO_EXECUTE` will change the state to `READY_TO_UPLOAD`. After calling `getLoadedMission`, @param mission Waypoint mission to load. @param callback Returns an error when mission data is invalid or the mission cannot be loaded in the current state.",
+ "Loads a waypoint mission into the operator. A mission can be loaded only when the `WaypointV2MissionState` is one of the following : - `READY_TO_UPLOAD` - `READY_TO_EXECUTE` Calling `loadMission` when the current state is `READY_TO_EXECUTE` will change the state to `READY_TO_UPLOAD`. After calling `getLoadedMission`, @param mission Waypoint mission to load. @param callback Returns an error when mission data is invalid or the mission cannot be loaded in the current state.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_loadMission_inline",
@@ -48734,10 +48182,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_loadedActionCount_inline",
- "Gets the currently loaded actions count of the operator. There are two ways to load a mission. 1. Actions can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. @return An int value of loaded action count.",
+ "Gets the currently loaded actions count of the operator. There are two ways to load a mission. 1. Actions can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. @return An int value of loaded action count.",
],
[
- "Gets the currently loaded actions count of the operator. There are two ways to load a mission. 1. Actions can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. @return An int value of loaded action count.",
+ "Gets the currently loaded actions count of the operator. There are two ways to load a mission. 1. Actions can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. @return An int value of loaded action count.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_loadedActionCount_inline",
@@ -48748,10 +48196,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_loadedActions_inline",
- "Gets the count of loaded actions in current operator. There are two ways to load a mission. 1. Actions can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. load it automatically. In that case, the loaded actions will be `null`, if user want get summary of the executing actions user can call `downloadMission` to get all the information for the loaded actions. The `getLoadedActions` will be reset to `null` when the execution of the getLoadedMission is stopped, finished. @return A list of `WaypointV2Action` objects.",
+ "Gets the count of loaded actions in current operator. There are two ways to load a mission. 1. Actions can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. load it automatically. In that case, the loaded actions will be `null`, if user want get summary of the executing actions user can call `downloadMission` to get all the information for the loaded actions. The `getLoadedActions` will be reset to `null` when the execution of the getLoadedMission is stopped, finished. @return A list of `WaypointV2Action` objects.",
],
[
- "Gets the count of loaded actions in current operator. There are two ways to load a mission. 1. Actions can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. load it automatically. In that case, the loaded actions will be `null`, if user want get summary of the executing actions user can call `downloadMission` to get all the information for the loaded actions. The `getLoadedActions` will be reset to `null` when the execution of the getLoadedMission is stopped, finished. @return A list of `WaypointV2Action` objects.",
+ "Gets the count of loaded actions in current operator. There are two ways to load a mission. 1. Actions can be loaded by user through `loadMission`. 2. If the aircraft is already executing a waypoint mission and it has uploaded actions when SDK is re-connected, the operator will recover uploaded action count. load it automatically. In that case, the loaded actions will be `null`, if user want get summary of the executing actions user can call `downloadMission` to get all the information for the loaded actions. The `getLoadedActions` will be reset to `null` when the execution of the getLoadedMission is stopped, finished. @return A list of `WaypointV2Action` objects.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_loadedActions_inline",
@@ -48804,10 +48252,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_removeWaypointListener_inline",
- "Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener Listener to be removed.",
+ "Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener Listener to be removed.",
],
[
- "Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener Listener to be removed.",
+ "Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener Listener to be removed.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_removeWaypointListener_inline",
@@ -48832,10 +48280,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_removeActionListener_inline",
- "Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener Listener to be removed.",
+ "Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener Listener to be removed.",
],
[
- "Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener Listener to be removed.",
+ "Removes listener. If the same listener is listening to multiple events and notifications (e.g. upload event and download event), it will not receive any update of them. @param listener Listener to be removed.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_removeActionListener_inline",
@@ -49252,10 +48700,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_uploadMission_inline",
- "Starts to upload the `getLoadedMission` to the aircraft. It can only be called when the `getLoadedMission` is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_UPLOAD`. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the `WaypointV2MissionState` will become `READY_TO_EXECUTE`. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onUploadUpdate to receive the detailed progress. @param callback Callback will be invoked with the result if the upload command has been received successfully by the aircraft. If the upload command is successfully sent, use `addWaypointEventListener` to check the detailed progress.",
+ "Starts to upload the `getLoadedMission` to the aircraft. It can only be called when the `getLoadedMission` is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_UPLOAD`. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the `WaypointV2MissionState` will become `READY_TO_EXECUTE`. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onUploadUpdate to receive the detailed progress. @param callback Callback will be invoked with the result if the upload command has been received successfully by the aircraft. If the upload command is successfully sent, use `addWaypointEventListener` to check the detailed progress.",
],
[
- "Starts to upload the `getLoadedMission` to the aircraft. It can only be called when the `getLoadedMission` is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_UPLOAD`. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the `WaypointV2MissionState` will become `READY_TO_EXECUTE`. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onUploadUpdate to receive the detailed progress. @param callback Callback will be invoked with the result if the upload command has been received successfully by the aircraft. If the upload command is successfully sent, use `addWaypointEventListener` to check the detailed progress.",
+ "Starts to upload the `getLoadedMission` to the aircraft. It can only be called when the `getLoadedMission` is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_UPLOAD`. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the `WaypointV2MissionState` will become `READY_TO_EXECUTE`. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onUploadUpdate to receive the detailed progress. @param callback Callback will be invoked with the result if the upload command has been received successfully by the aircraft. If the upload command is successfully sent, use `addWaypointEventListener` to check the detailed progress.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_uploadMission_inline",
@@ -49266,10 +48714,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_uploadWaypointActions_inline",
- "Starts to upload the `getLoadedActions` to the aircraft. It can only be called when the `getLoadedActions` is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_EXECUTE`. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the DJIWaypointV2MissionActionState will become `READY_TO_EXECUTE`. @param actions A list of `WaypointV2Action` objects. @param callback Callback will be invoked with the result if the upload action command has been received successfully by the aircraft. If the upload command is successfully sent, use `addActionListener` to check the detailed progress.",
+ "Starts to upload the `getLoadedActions` to the aircraft. It can only be called when the `getLoadedActions` is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_EXECUTE`. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the DJIWaypointV2MissionActionState will become `READY_TO_EXECUTE`. @param actions A list of `WaypointV2Action` objects. @param callback Callback will be invoked with the result if the upload action command has been received successfully by the aircraft. If the upload command is successfully sent, use `addActionListener` to check the detailed progress.",
],
[
- "Starts to upload the `getLoadedActions` to the aircraft. It can only be called when the `getLoadedActions` is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_EXECUTE`. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the DJIWaypointV2MissionActionState will become `READY_TO_EXECUTE`. @param actions A list of `WaypointV2Action` objects. @param callback Callback will be invoked with the result if the upload action command has been received successfully by the aircraft. If the upload command is successfully sent, use `addActionListener` to check the detailed progress.",
+ "Starts to upload the `getLoadedActions` to the aircraft. It can only be called when the `getLoadedActions` is complete and the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_EXECUTE`. If a timeout error occurs during the previous upload, the upload operation will resume from the previous break-point. After a mission is uploaded successfully, the DJIWaypointV2MissionActionState will become `READY_TO_EXECUTE`. @param actions A list of `WaypointV2Action` objects. @param callback Callback will be invoked with the result if the upload action command has been received successfully by the aircraft. If the upload command is successfully sent, use `addActionListener` to check the detailed progress.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_uploadWaypointActions_inline",
@@ -49280,10 +48728,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_downloadMission_inline",
- "Downloads information of Actions from startActionID to endActionID. The information of waypoints missing in `getLoadedMission` ascending order. If `getLoadedMission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED` @param callback Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onDownloadUpdate to receive the detailed progress.",
+ "Downloads information of each waypoint from aircraft and save it to `getLoadedMission`. If a download operation starts, the operator will download the information of waypoints missing in `getLoadedMission` one-by-one in ascending order. If `getLoadedMission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED`. @param callback Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onDownloadUpdate to receive the detailed progress.",
],
[
- "Downloads information of Actions from startActionID to endActionID. The information of waypoints missing in `getLoadedMission` ascending order. If `getLoadedMission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED` @param callback Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onDownloadUpdate to receive the detailed progress.",
+ "Downloads information of each waypoint from aircraft and save it to `getLoadedMission`. If a download operation starts, the operator will download the information of waypoints missing in `getLoadedMission` one-by-one in ascending order. If `getLoadedMission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED`. @param callback Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_Listener_onDownloadUpdate to receive the detailed progress.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_downloadMission_inline",
@@ -49294,10 +48742,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_downloadActions_inline",
- "Downloads information of each waypoint from aircraft and save it to `getLoadedMission`. If a download operation starts, the operator will download the information of waypoints missing in `getLoadedMission` one-by-one in ascending order. If `getLoadedMission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED`. @param callback Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_addListenerToDownloadEvent to receive the detailed progress.",
+ "Downloads information of Actions from startActionID to endActionID. The information of waypoints missing in `getLoadedMission` ascending order. If `getLoadedMission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED` @param callback Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_addListenerToDownloadEvent to receive the detailed progress.",
],
[
- "Downloads information of each waypoint from aircraft and save it to `getLoadedMission`. If a download operation starts, the operator will download the information of waypoints missing in `getLoadedMission` one-by-one in ascending order. If `getLoadedMission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED`. @param callback Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_addListenerToDownloadEvent to receive the detailed progress.",
+ "Downloads information of Actions from startActionID to endActionID. The information of waypoints missing in `getLoadedMission` ascending order. If `getLoadedMission` is already complete (containing all the waypoints), this method will call `completion` immediately without error. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED` @param callback Callback that will be called when the download operation succeeds or fails to start. If it is started successfully, use DJIWaypointV2MissionOperator_addListenerToDownloadEvent to receive the detailed progress.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_downloadActions_inline",
@@ -49308,10 +48756,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_startMission_inline",
- "Starts the execution of the uploaded mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_EXECUTE`. After a mission is started successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param callback Completion block that will be called when the operator succeeds or fails to start the execution. If it fails, an error will be returned.",
+ "Starts the execution of the uploaded mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_EXECUTE`. After a mission is started successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param callback Completion block that will be called when the operator succeeds or fails to start the execution. If it fails, an error will be returned.",
],
[
- "Starts the execution of the uploaded mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_EXECUTE`. After a mission is started successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param callback Completion block that will be called when the operator succeeds or fails to start the execution. If it fails, an error will be returned.",
+ "Starts the execution of the uploaded mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `READY_TO_EXECUTE`. After a mission is started successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param callback Completion block that will be called when the operator succeeds or fails to start the execution. If it fails, an error will be returned.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_startMission_inline",
@@ -49322,10 +48770,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_interruptMission_inline",
- "Pauses the executing mission. It can only be called when the `WaypointV2MissionState` is `Executing`. After a mission is paused successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `INTERRUPTED`. @param callback Callback that will be called when the operator succeeds or fails to pause the mission. If it fails, an error will be returned.",
+ "Pauses the executing mission. It can only be called when the `WaypointV2MissionState` is `Executing`. After a mission is paused successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `INTERRUPTED`. @param callback Callback that will be called when the operator succeeds or fails to pause the mission. If it fails, an error will be returned.",
],
[
- "Pauses the executing mission. It can only be called when the `WaypointV2MissionState` is `Executing`. After a mission is paused successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `INTERRUPTED`. @param callback Callback that will be called when the operator succeeds or fails to pause the mission. If it fails, an error will be returned.",
+ "Pauses the executing mission. It can only be called when the `WaypointV2MissionState` is `Executing`. After a mission is paused successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `INTERRUPTED`. @param callback Callback that will be called when the operator succeeds or fails to pause the mission. If it fails, an error will be returned.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_interruptMission_inline",
@@ -49336,10 +48784,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_recoverMission_inline",
- "Resumes the paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `INTERRUPTED`. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param callback Callback that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
+ "Resumes the paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `INTERRUPTED`. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param callback Callback that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
],
[
- "Resumes the paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `INTERRUPTED`. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param callback Callback that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
+ "Resumes the paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `INTERRUPTED`. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param callback Callback that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_recoverMission_inline",
@@ -49350,10 +48798,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_recoverMissionWithRecoverType_inline",
- "Resumes the paused mission with recover type. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `INTERRUPTED`. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param type An enum value of `InterruptRecoverActionType` @param callback Callback that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
+ "Resumes the paused mission with recover type. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `INTERRUPTED`. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param type An enum value of `InterruptRecoverActionType` @param callback Callback that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
],
[
- "Resumes the paused mission with recover type. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `INTERRUPTED`. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param type An enum value of `InterruptRecoverActionType` @param callback Callback that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
+ "Resumes the paused mission with recover type. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is `INTERRUPTED`. After a mission is resumed successfully, the DJIWaypointV2MissionActionExecutionEvent_currentState will become `Executing`. @param type An enum value of `InterruptRecoverActionType` @param callback Callback that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_recoverMissionWithRecoverType_inline",
@@ -49364,10 +48812,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_stopMission_inline",
- "Stops the executing or paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED` After a mission finishes successfully, DJIWaypointV2MissionActionExecutionEvent_currentState will become `READY_TO_UPLOAD`. @param callback Completion block that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
+ "Stops the executing or paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED` After a mission finishes successfully, DJIWaypointV2MissionActionExecutionEvent_currentState will become `READY_TO_UPLOAD`. @param callback Completion block that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
],
[
- "Stops the executing or paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED` After a mission finishes successfully, DJIWaypointV2MissionActionExecutionEvent_currentState will become `READY_TO_UPLOAD`. @param callback Completion block that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
+ "Stops the executing or paused mission. It can only be called when the DJIWaypointV2MissionActionExecutionEvent_currentState is one of the following: - `Executing` - `INTERRUPTED` After a mission finishes successfully, DJIWaypointV2MissionActionExecutionEvent_currentState will become `READY_TO_UPLOAD`. @param callback Completion block that will be called when the operator succeeds or fails to resume the mission. If it fails, an error will be returned.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_stopMission_inline",
@@ -49378,10 +48826,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointMissionOperator.html",
"#DJIWaypointV2MissionOperator_setAutoFlightSpeed_inline",
- "Set the flight speed while the mission is executing automatically (without manual joystick speed input). This is the only property or method in this class that can communicate with the aircraft during a mission. All other properties and methods are used offline to prepare the mission which is then uploaded to the aircraft. @param speed Auto flight speed to be set. The absolute value of the auto flight speed should be less than or equal to the `getMaxFlightSpeed`. Its range is [-`getMaxFlightSpeed`, `getMaxFlightSpeed`] m/s. @param callback Callback.",
+ "Set the flight speed while the mission is executing automatically (without manual joystick speed input). This is the only property or method in this class that can communicate with the aircraft during a mission. All other properties and methods are used offline to prepare the mission which is then uploaded to the aircraft. @param speed Auto flight speed to be set. The absolute value of the auto flight speed should be less than or equal to the `getMaxFlightSpeed`. Its range is [-`getMaxFlightSpeed`, `getMaxFlightSpeed`] m/s. @param callback Callback.",
],
[
- "Set the flight speed while the mission is executing automatically (without manual joystick speed input). This is the only property or method in this class that can communicate with the aircraft during a mission. All other properties and methods are used offline to prepare the mission which is then uploaded to the aircraft. @param speed Auto flight speed to be set. The absolute value of the auto flight speed should be less than or equal to the `getMaxFlightSpeed`. Its range is [-`getMaxFlightSpeed`, `getMaxFlightSpeed`] m/s. @param callback Callback.",
+ "Set the flight speed while the mission is executing automatically (without manual joystick speed input). This is the only property or method in this class that can communicate with the aircraft during a mission. All other properties and methods are used offline to prepare the mission which is then uploaded to the aircraft. @param speed Auto flight speed to be set. The absolute value of the auto flight speed should be less than or equal to the `getMaxFlightSpeed`. Its range is [-`getMaxFlightSpeed`, `getMaxFlightSpeed`] m/s. @param callback Callback.",
1,
"/Components/Missions/DJIWaypointMissionOperator.html",
"#DJIWaypointV2MissionOperator_setAutoFlightSpeed_inline",
@@ -49630,10 +49078,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_DJIWaypointV2MissionState_Recovering_inline",
- "The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the state from the aircraft.",
+ "The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the state from the aircraft.",
],
[
- "The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the state from the aircraft.",
+ "The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the state from the aircraft.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_DJIWaypointV2MissionState_Recovering_inline",
@@ -49770,10 +49218,10 @@ var search_data = {
2,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_DJIWaypointV2MissionActionState_Recovering_inline",
- "The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the action state from the aircraft.",
+ "The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the action state from the aircraft.",
],
[
- "The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the action state from the aircraft.",
+ "The connection between the mobile device, remote controller and aircraft is built-up. The operator is synchronizing the action state from the aircraft.",
1,
"/Components/Missions/DJIWaypointV2MissionOperator.html",
"#DJIWaypointV2MissionOperator_DJIWaypointV2MissionActionState_Recovering_inline",
@@ -77261,6 +76709,34 @@ var search_data = {
"#DJICamera_GetLiveviewLocationWithGPS_inline",
"",
],
+ [
+ "setLinkZoomEnabled",
+ 2,
+ "/Components/Camera/DJICamera.html",
+ "#DJICamera_SetLinkZoomEnabled_inline",
+ "Enable or disable the link zoom function. After enabling the link zoom function, call `setThermalDigitalZoomFactor` to achieve synchronous zooming of the infrared lens and the zoom lens. In the split-screen mode PIP, the user can compare the images of the infrared lens and the zoom lens more efficiently. Supported by Zenmuse H20 Series. @param enabled True to enable link zoom. @param callback The execution callback with the returned value(s).",
+ ],
+ [
+ "Enable or disable the link zoom function. After enabling the link zoom function, call `setThermalDigitalZoomFactor` to achieve synchronous zooming of the infrared lens and the zoom lens. In the split-screen mode PIP, the user can compare the images of the infrared lens and the zoom lens more efficiently. Supported by Zenmuse H20 Series. @param enabled True to enable link zoom. @param callback The execution callback with the returned value(s).",
+ 1,
+ "/Components/Camera/DJICamera.html",
+ "#DJICamera_SetLinkZoomEnabled_inline",
+ "",
+ ],
+ [
+ "getLinkZoomEnabled",
+ 2,
+ "/Components/Camera/DJICamera.html",
+ "#DJICamera_GetLinkZoomEnabled_inline",
+ "Gets the link zoom status. Supported by Zenmuse H20 Series. @param callback The execution callback with the returned value(s).",
+ ],
+ [
+ "Gets the link zoom status. Supported by Zenmuse H20 Series. @param callback The execution callback with the returned value(s).",
+ 1,
+ "/Components/Camera/DJICamera.html",
+ "#DJICamera_GetLinkZoomEnabled_inline",
+ "",
+ ],
[
"restoreFactorySettings",
2,
@@ -86417,6 +85893,90 @@ var search_data = {
"#DJICamera_DJILens_getIRFilterEnabled_inline",
"",
],
+ [
+ "OFF",
+ 2,
+ "/Components/Camera/DJICamera_DJICameraSettingsDef.html",
+ "#DJICamera_DJICameraLensIRFilterMode_OFF_inline",
+ "Off.",
+ ],
+ [
+ "Off.",
+ 1,
+ "/Components/Camera/DJICamera_DJICameraSettingsDef.html",
+ "#DJICamera_DJICameraLensIRFilterMode_OFF_inline",
+ "",
+ ],
+ [
+ "ON",
+ 2,
+ "/Components/Camera/DJICamera_DJICameraSettingsDef.html",
+ "#DJICamera_DJICameraLensIRFilterMode_ON_inline",
+ "On.",
+ ],
+ [
+ "On.",
+ 1,
+ "/Components/Camera/DJICamera_DJICameraSettingsDef.html",
+ "#DJICamera_DJICameraLensIRFilterMode_ON_inline",
+ "",
+ ],
+ [
+ "AUTO",
+ 2,
+ "/Components/Camera/DJICamera_DJICameraSettingsDef.html",
+ "#DJICamera_DJICameraLensIRFilterMode_AUTO_inline",
+ "Auto.",
+ ],
+ [
+ "Auto.",
+ 1,
+ "/Components/Camera/DJICamera_DJICameraSettingsDef.html",
+ "#DJICamera_DJICameraLensIRFilterMode_AUTO_inline",
+ "",
+ ],
+ [
+ "IRFilterMode",
+ 2,
+ "/Components/Camera/DJICamera_DJICameraSettingsDef.html",
+ "#DJICamera_DJICameraLensIRFilterMode_inline",
+ "The IR filter mode.",
+ ],
+ [
+ "The IR filter mode.",
+ 1,
+ "/Components/Camera/DJICamera_DJICameraSettingsDef.html",
+ "#DJICamera_DJICameraLensIRFilterMode_inline",
+ "",
+ ],
+ [
+ "setIRFilterMode",
+ 2,
+ "/Components/Camera/DJICamera_DJILens.html",
+ "#DJICamera_DJILens_setIRFilterMode_inline",
+ "Sets the IR filter mode of the current lens. ON to reduce the color distortion caused by the infared light, OFF to enhance the image in low light environments, or AUTO to up to the system to decide whether to switch. Supported by the zoom lens of Zenmuse H20 Series. @param irFilterMode An enum type of the `IRFilterMode` to be used. @param callback The execution callback with the returned execution result.",
+ ],
+ [
+ "Sets the IR filter mode of the current lens. ON to reduce the color distortion caused by the infared light, OFF to enhance the image in low light environments, or AUTO to up to the system to decide whether to switch. Supported by the zoom lens of Zenmuse H20 Series. @param irFilterMode An enum type of the `IRFilterMode` to be used. @param callback The execution callback with the returned execution result.",
+ 1,
+ "/Components/Camera/DJICamera_DJILens.html",
+ "#DJICamera_DJILens_setIRFilterMode_inline",
+ "",
+ ],
+ [
+ "getIRFilterMode",
+ 2,
+ "/Components/Camera/DJICamera_DJILens.html",
+ "#DJICamera_DJILens_getIRFilterMode_inline",
+ "Gets the IR filter mode of the current lens. Supported by the zoom lens of Zenmuse H20 Series. @param callback The execution callback with the returned value(s).",
+ ],
+ [
+ "Gets the IR filter mode of the current lens. Supported by the zoom lens of Zenmuse H20 Series. @param callback The execution callback with the returned value(s).",
+ 1,
+ "/Components/Camera/DJICamera_DJILens.html",
+ "#DJICamera_DJILens_getIRFilterMode_inline",
+ "",
+ ],
[
"isDigitalZoomSupported",
2,
@@ -89782,10 +89342,10 @@ var search_data = {
2,
"/Components/Camera/DJIMediaManager_DJIMedia.html",
"#DJIMediaManager_DJIMedia_resolution_inline",
- "Camera resolution. @return An enum value of `VideoResolution`.",
+ "Camera video resolution. Only supported by video. @return An enum value of `VideoResolution`.",
],
[
- "Camera resolution. @return An enum value of `VideoResolution`.",
+ "Camera video resolution. Only supported by video. @return An enum value of `VideoResolution`.",
1,
"/Components/Camera/DJIMediaManager_DJIMedia.html",
"#DJIMediaManager_DJIMedia_resolution_inline",
@@ -93660,15 +93220,29 @@ var search_data = {
2,
"/Components/RTK/DJIRTK.html",
"#DJIRTK_DJIRTKReferenceStationSource_NetworkRTK_inline",
- "Default virtual reference station solution to provide cm level accurate position. The frame can be either WGS84 or CGCS 2000. Please note that this default solution can only be used in China. Please add the djinetworkrtkhelper to the project via gradle: implementation 'com.dji:library-networkrtk-helper:2.0.2'. It is only supported by Phantom 4 RTK, P4 Multispectral and Matrice 300 RTK.",
+ "Default virtual reference station solution to provide cm level accurate position. The frame can be either WGS84 or CGCS 2000. Please note that this default solution can only be used in China. Please add the djinetworkrtkhelper to the project via gradle: implementation 'com.dji:library-networkrtk-helper:2.0.2'. It is only supported by Matrice 300 RTK and Matrice 350 RTK.",
],
[
- "Default virtual reference station solution to provide cm level accurate position. The frame can be either WGS84 or CGCS 2000. Please note that this default solution can only be used in China. Please add the djinetworkrtkhelper to the project via gradle: implementation 'com.dji:library-networkrtk-helper:2.0.2'. It is only supported by Phantom 4 RTK, P4 Multispectral and Matrice 300 RTK.",
+ "Default virtual reference station solution to provide cm level accurate position. The frame can be either WGS84 or CGCS 2000. Please note that this default solution can only be used in China. Please add the djinetworkrtkhelper to the project via gradle: implementation 'com.dji:library-networkrtk-helper:2.0.2'. It is only supported by Matrice 300 RTK and Matrice 350 RTK.",
1,
"/Components/RTK/DJIRTK.html",
"#DJIRTK_DJIRTKReferenceStationSource_NetworkRTK_inline",
"",
],
+ [
+ "NTRIP_NETWORK_SERVICE",
+ 2,
+ "/Components/RTK/DJIRTK.html",
+ "#DJIRTK_DJIRTKReferenceStationSource_NTRIP_NETWORK_SERVICE_inline",
+ "Ntrip network service which is used for CMCC network RTK service. It is only supported Matrice 300 RTK and Matrice 350 RTK.",
+ ],
+ [
+ "Ntrip network service which is used for CMCC network RTK service. It is only supported Matrice 300 RTK and Matrice 350 RTK.",
+ 1,
+ "/Components/RTK/DJIRTK.html",
+ "#DJIRTK_DJIRTKReferenceStationSource_NTRIP_NETWORK_SERVICE_inline",
+ "",
+ ],
[
"UNKNOWN",
2,
@@ -94878,10 +94452,10 @@ var search_data = {
2,
"/Components/FlightController/DJIFlightController.html",
"#DJIOnboardSDKDevice_savePipelinesLog_inline",
- "Sets true to save log for pipelines. In order to improve developer's experience on SDK interconnectivity, `Pipeline` is designed to save log files locally when files are transferred, during which the speed is 475KB per minute. Please be careful with the device storage. @param enabled `true` to save log files.",
+ "Sets true to save log for pipelines. In order to improve developer's experience on SDK interconnectivity, DJIPipeline is designed to save log files locally when files are transferred, during which the speed is 475KB per minute. Please be careful with the device storage. @param enabled `true` to save log files.",
],
[
- "Sets true to save log for pipelines. In order to improve developer's experience on SDK interconnectivity, `Pipeline` is designed to save log files locally when files are transferred, during which the speed is 475KB per minute. Please be careful with the device storage. @param enabled `true` to save log files.",
+ "Sets true to save log for pipelines. In order to improve developer's experience on SDK interconnectivity, DJIPipeline is designed to save log files locally when files are transferred, during which the speed is 475KB per minute. Please be careful with the device storage. @param enabled `true` to save log files.",
1,
"/Components/FlightController/DJIFlightController.html",
"#DJIOnboardSDKDevice_savePipelinesLog_inline",
@@ -94892,10 +94466,10 @@ var search_data = {
2,
"/Components/FlightController/DJIFlightController.html",
"#DJIOnboardSDKDevice_getPipelines_inline",
- "The pipelines to transmit data between onboard device and DJI mobile SDK. It's only supported by Matrice 300 RTK. @return An instance of `Pipelines`.",
+ "The pipelines to transmit data between onboard device and DJI mobile SDK. It's only supported by Matrice 300 RTK. @return An instance of DJIPipelines.",
],
[
- "The pipelines to transmit data between onboard device and DJI mobile SDK. It's only supported by Matrice 300 RTK. @return An instance of `Pipelines`.",
+ "The pipelines to transmit data between onboard device and DJI mobile SDK. It's only supported by Matrice 300 RTK. @return An instance of DJIPipelines.",
1,
"/Components/FlightController/DJIFlightController.html",
"#DJIOnboardSDKDevice_getPipelines_inline",
@@ -96292,10 +95866,10 @@ var search_data = {
2,
"/Components/FlightController/DJIFlightController.html",
"#DJIFlightController_setGoHomeAltitude_inline",
- "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. @param height The aircraft's default go home altitude. @param callback The execution callback with the returned execution result.",
+ "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 or M350 RTK, the limit can beyond 500m. @param height The aircraft's default go home altitude. @param callback The execution callback with the returned execution result.",
],
[
- "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. @param height The aircraft's default go home altitude. @param callback The execution callback with the returned execution result.",
+ "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 or M350 RTK, the limit can beyond 500m. @param height The aircraft's default go home altitude. @param callback The execution callback with the returned execution result.",
1,
"/Components/FlightController/DJIFlightController.html",
"#DJIFlightController_setGoHomeAltitude_inline",
@@ -96306,10 +95880,10 @@ var search_data = {
2,
"/Components/FlightController/DJIFlightController.html",
"#DJIFlightController_setGoHomeAltitude_inline",
- "SDK Key for setGoHomeHeightInMeters: 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. @param height The aircraft's default go home altitude. @param callback The execution callback with the returned execution result.",
+ "SDK Key for setGoHomeHeightInMeters: 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 or M350 RTK, the limit can beyond 500m. @param height The aircraft's default go home altitude. @param callback The execution callback with the returned execution result.",
],
[
- "SDK Key for setGoHomeHeightInMeters: 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. @param height The aircraft's default go home altitude. @param callback The execution callback with the returned execution result.",
+ "SDK Key for setGoHomeHeightInMeters: 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 or M350 RTK, the limit can beyond 500m. @param height The aircraft's default go home altitude. @param callback The execution callback with the returned execution result.",
1,
"/Components/FlightController/DJIFlightController.html",
"#DJIFlightController_setGoHomeAltitude_inline",
@@ -96782,10 +96356,10 @@ var search_data = {
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 and M350 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.",
+ "Enables the coordinated turn. Improves aerodynamic efficiency. The aircraft is flying in the direction of the turn, without sideslipping. Only supported by M300 RTK and M350 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",
@@ -96796,10 +96370,10 @@ var search_data = {
2,
"/Components/FlightController/DJIFlightController.html",
"#DJIFlightController_getCoordinatedTurnEnabled_inline",
- "Get whether the coordinated turn switch is on. Only supported by M300 RTK. @param callback Completion block that receives the execution result.",
+ "Get whether the coordinated turn switch is on. Only supported by M300 RTK and M350 RTK. @param callback Completion block that receives the execution result.",
],
[
- "Get whether the coordinated turn switch is on. Only supported by M300 RTK. @param callback Completion block that receives the execution result.",
+ "Get whether the coordinated turn switch is on. Only supported by M300 RTK and M350 RTK. @param callback Completion block that receives the execution result.",
1,
"/Components/FlightController/DJIFlightController.html",
"#DJIFlightController_getCoordinatedTurnEnabled_inline",
@@ -96810,10 +96384,10 @@ var search_data = {
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 and M350 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.",
+ "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 and M350 RTK. @param system Navigation satellite system. @param callback Callback that receives the execution result.",
1,
"/Components/FlightController/DJIFlightController.html",
"#DJIFlightController_setNavigationSatelliteSystem_inline",
@@ -96824,10 +96398,10 @@ var search_data = {
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 and M350 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.",
+ "Get the navigation satellite system. Only supported by M300 RTK and M350 RTK. @param callback Callback that receives the execution result.",
1,
"/Components/FlightController/DJIFlightController.html",
"#DJIFlightController_getNavigationSatelliteSystem_inline",
@@ -103847,6 +103421,20 @@ var search_data = {
"#DJIFlyZoneManager_unlockFlyZones_inline",
"",
],
+ [
+ "unlockAuthorizationFlyZone",
+ 2,
+ "/Components/FlyZoneManager/DJIFlyZoneManager.html",
+ "#DJIFlyZoneManager_unlockAuthorizationFlyZone_inline",
+ "Unlock the authorization fly zone. After unlocking the authorization fly zone, the aircraft will be able to take off normally in the authorization fly zone, and the authorization fly zone will continue to be banned after reboot the aircraft. @param id The ID of `AUTHORIZATION` zone. @param callback The execution callback with the returned execution result.",
+ ],
+ [
+ "Unlock the authorization fly zone. After unlocking the authorization fly zone, the aircraft will be able to take off normally in the authorization fly zone, and the authorization fly zone will continue to be banned after reboot the aircraft. @param id The ID of `AUTHORIZATION` zone. @param callback The execution callback with the returned execution result.",
+ 1,
+ "/Components/FlyZoneManager/DJIFlyZoneManager.html",
+ "#DJIFlyZoneManager_unlockAuthorizationFlyZone_inline",
+ "",
+ ],
[
"reloadUnlockedZoneGroupsFromServer",
2,
@@ -108458,10 +108046,10 @@ var search_data = {
2,
"/Components/Lidar/DJILidarLiveViewDataProcessor.html",
"",
- "This processor is provided by DJI. We receive the `PointCloudLiveViewData` through `startReadPointCloudLiveViewData` interface, and then use `IDJILidarLiveViewDataProcessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through `PointCloudView`. If you want to display with your own algorithm. You can use `PointCloudLiveViewData` to draw the point cloud live view data by yourself.",
+ "This processor is provided by DJI. We receive the `PointCloudLiveViewData` through `startReadPointCloudLiveViewData` interface, and then use `IDJILidarLiveViewDataProcessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through DJILidarPointCloudView. If you want to display with your own algorithm. You can use `PointCloudLiveViewData` to draw the point cloud live view data by yourself.",
],
[
- "This processor is provided by DJI. We receive the `PointCloudLiveViewData` through `startReadPointCloudLiveViewData` interface, and then use `IDJILidarLiveViewDataProcessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through `PointCloudView`. If you want to display with your own algorithm. You can use `PointCloudLiveViewData` to draw the point cloud live view data by yourself.",
+ "This processor is provided by DJI. We receive the `PointCloudLiveViewData` through `startReadPointCloudLiveViewData` interface, and then use `IDJILidarLiveViewDataProcessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through DJILidarPointCloudView. If you want to display with your own algorithm. You can use `PointCloudLiveViewData` to draw the point cloud live view data by yourself.",
1,
"/Components/Lidar/DJILidarLiveViewDataProcessor.html",
"",
@@ -109391,20 +108979,6 @@ var search_data = {
"#DJILidar_pointCloudLiveViewData_blue_inline",
"",
],
- [
- "PointCloudView",
- 2,
- "/Components/Lidar/DJILidarPointCloudView.html",
- "",
- "This view is provided by DJI. We recevie the `PointCloudLiveViewData` through `startReadPointCloudLiveViewData` interface, and then use `IDJILidarLiveViewDataProcessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through this view. If you don't want to use this view, You can use `PointCloudLiveViewData` to draw the point cloud live view data by yourself.",
- ],
- [
- "This view is provided by DJI. We recevie the `PointCloudLiveViewData` through `startReadPointCloudLiveViewData` interface, and then use `IDJILidarLiveViewDataProcessor` to optimize the algorithm so that the point cloud data can be displayed efficiently through this view. If you don't want to use this view, You can use `PointCloudLiveViewData` to draw the point cloud live view data by yourself.",
- 1,
- "/Components/Lidar/DJILidarPointCloudView.html",
- "",
- "",
- ],
[
"PointCloudDisplayMode",
2,
@@ -109447,76 +109021,6 @@ var search_data = {
"#DJILidar_PointCloudDisplayMode_OVERALL_inline",
"",
],
- [
- "PointCloudColorMode",
- 2,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_inline",
- "Enums represent the point cloud live view color mode of lidar.",
- ],
- [
- "Enums represent the point cloud live view color mode of lidar.",
- 1,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_inline",
- "",
- ],
- [
- "INTENSITY",
- 2,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_INTENSITY_inline",
- "Using intensity data to coloring the point cloud live view data.",
- ],
- [
- "Using intensity data to coloring the point cloud live view data.",
- 1,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_INTENSITY_inline",
- "",
- ],
- [
- "HEIGHT",
- 2,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_HEIGHT_inline",
- "Using height(`getZ`) data to coloring the point cloud live view data. It will help you measure objects with a large height difference.",
- ],
- [
- "Using height(`getZ`) data to coloring the point cloud live view data. It will help you measure objects with a large height difference.",
- 1,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_HEIGHT_inline",
- "",
- ],
- [
- "HYBIRD",
- 2,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_HYBIRD_inline",
- "Hybird the intensity and distance(`getX`, `getY`) data to coloring the point cloud live view data. It will help you to measure objects better when flying horizontally.",
- ],
- [
- "Hybird the intensity and distance(`getX`, `getY`) data to coloring the point cloud live view data. It will help you to measure objects better when flying horizontally.",
- 1,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_HYBIRD_inline",
- "",
- ],
- [
- "VISIBLE_LIGHT",
- 2,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_VISIBLE_LIGHT_inline",
- "Using visible light(`getRed`, `getGreen`, `getBlue`) data to coloring the point cloud live view data. If you want to use this mode, please set `DJILidarPointCloudVisibleLightPixelMode` on.",
- ],
- [
- "Using visible light(`getRed`, `getGreen`, `getBlue`) data to coloring the point cloud live view data. If you want to use this mode, please set `DJILidarPointCloudVisibleLightPixelMode` on.",
- 1,
- "/Components/Lidar/DJILidarLiveViewDataProcessor.html",
- "#DJILidar_PointCloudColorMode_VISIBLE_LIGHT_inline",
- "",
- ],
[
"ResponseForGimbalControl",
2,
diff --git a/docs/API Reference/stylesheets/doc-app.css b/docs/API Reference/stylesheets/doc-app.css
index f32e59e9..1bd25962 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 753ff1a7..03e9e6c2 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_4.17_android_diff.html b/docs/SDK APIs Diff/4.16.4_4.17_android_diff.html
new file mode 100644
index 00000000..fe956629
--- /dev/null
+++ b/docs/SDK APIs Diff/4.16.4_4.17_android_diff.html
@@ -0,0 +1,46 @@
+
+
+
+
+
+