### Initialize KeyStartIMUCalibration Action Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html Defines the DJIActionKeyInfo for starting IMU calibration. This key is used to perform the action and does not support getting, setting, or listening for its state directly. ```java static final DJIActionKeyInfo KeyStartIMUCalibration = new DJIActionKeyInfo<>(componentType.value(),subComponentType.value(),"StartIMUCalibration", EmptyValueConverter.converter,EmptyValueConverter.converter).canGet(false).canSet(false).canListen(false).canPerformAction(true).setIsEvent(false) ``` -------------------------------- ### startMission Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IIntelligentFlightManager/IIntelligentFlightManager_ISpotLightManager.html Start task. ```APIDOC ## startMission ### Description Start task. ### Method void ### Parameters #### Input Parameters - **target** (SpotLightTarget) - Required - The target for the spotlight mission. - **param** (SpotLightParam) - Required - The parameters for the spotlight mission. - **callback** (CommonCallbacks.CompletionCallback) - Required - The callback to be executed upon completion. ``` -------------------------------- ### onExecutionStart Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IWaypointMissionManager/IWaypointMissionManager_WaypointActionListener.html This method will be called back when the waypoint action starts to execute. ```APIDOC ## onExecutionStart ### Description This method will be called back when the waypoint action starts to execute. ### Method `void onExecutionStart(int actionGroup, int actionId)` ### Parameters #### Path Parameters - **actionGroup** (int) - Required - The waypoint action group to start executing. - **actionId** (int) - Required - The waypoint action ID to start executing. ### Remarks _Supported since MSDK 5.8.0_ ``` -------------------------------- ### PlayingAudioFileInfo Methods Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Value_Accessory_Struct_PlayingAudioFileInfo.html This snippet details the methods available for the PlayingAudioFileInfo class, including getting and setting the playing status, retrieving the index, and getting the storage location. ```APIDOC ## Class: PlayingAudioFileInfo ### Description Represents information about an audio file that is currently playing. ### Methods #### getIsPlaying - **Description**: Retrieves the playing status of the audio file. - **Return**: Boolean - `true` if the audio file is playing, `false` otherwise. #### setIsPlaying - **Description**: Sets the playing status of the audio file. - **Parameters**: - `isPlaying` (Boolean) - Required - The new playing status. #### getIndex - **Description**: Retrieves the index of the audio file. - **Return**: Integer - The index of the audio file. #### getLocation - **Description**: Retrieves the storage location of the audio file. - **Return**: AudioStorageLocation - The location where the audio file is stored. ``` -------------------------------- ### Set and Get Photo File Format Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Allows setting and getting the current photo file format for the camera. ```java static final DJIKeyInfo KeyPhotoFileFormat = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"PhotoFileFormat", new SingleValueConverter<>(PhotoFileFormat.class,PhotoStorageFormatMsg.class)).canGet(true).canSet(true).canListen(true).canPerformAction(false).setIsEvent(false).setInnerIdentifier("PhotoStorageFormat") ``` -------------------------------- ### KeyCustomExpandDirectoryNameSettings Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Allows setting and getting the extension name for customized file folders. Newly generated media files will be stored in folders with names appended with this extension. This key supports both getting and setting. ```APIDOC ## KeyCustomExpandDirectoryNameSettings ### Description Sets and gets the extension name of the customized file folder. Newly generated media files will be stored in a new file folder with the default name plus the extension. Multiple extension directory names can be set in one flight to create multiple customized folders. ### Supported Since MSDK 5.0.0 ### Notes 1. Do not set the extension name during video recording. 2. Avoid using pure numbers and special characters as the extension name. 3. The total length of the file name (original + extension) must be less than 128 bytes. ### Parameters - **customExpandDirectoryNameSettings** (`CustomExpandNameSettings`) - Required - The settings for the custom directory name extension. ### Get - **Returns**: `CustomExpandNameSettings` - The current settings for the custom directory name extension. ### Set - **Parameters**: - **customExpandDirectoryNameSettings** (`CustomExpandNameSettings`) - Required - The settings for the custom directory name extension. ``` -------------------------------- ### Start Mission at Breakpoint Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IWaypointMissionManager/IWaypointMissionManager.html Starts executing a waypoint mission from a specified breakpoint. This allows resuming a mission from a specific point or starting from a custom breakpoint. ```APIDOC ## startMission ### Description Starts executing the waypoint mission at the specified breakpoint. You can use `queryBreakPointInfoFromAircraft` to query the breakpoint information when the last waypoint mission was suspended. After the breakpoint information is obtained, it can be passed as a parameter to this interface, and the aircraft will fly to the incoming breakpoint position, and then execute the waypoint mission in sequence according to the waypoint order. If you don’t want to start the waypoint mission from the position of the aircraft when it was paused last time, you can also construct the breakpoint information by yourself and set any waypoint position to start the waypoint mission. **Note:** * The M300 RTK and M350 RTK do not support this interface to execute the waypoint mission at the specified breakpoint. If you want to resume flying to the next waypoint after pausing, please set the breakpoint recovery type `setRecoverActionType` through `resumeMission`. * After suspending the waypoint mission, this interface can be called to re-execute the waypoint mission only after exiting the waypoint mission. Common application scenarios include: return and land after the flight mission is completed or the aircraft is powered on again. * If you want to start flying from the specified breakpoint without exiting the waypoint mission. You can call `resumeMission` to resume execution of the waypoint mission. _Supported since MSDK 5.6.0_ ### Method `startMission(String missionFileName, BreakPointInfo breakPointInfo, CommonCallbacks.CompletionCallback callback)` ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - **missionFileName** (String) - Required - The file name of the Mission to be executed. - **breakPointInfo** (BreakPointInfo) - Required - Breakpoint information of the Mission to be executed. ### Request Example ```java // Assuming breakPointInfo is obtained from queryBreakPointInfoFromAircraft or constructed manually waypointMissionManager.startMission("mission.txt", breakPointInfo, new CommonCallbacks.CompletionCallback() { @Override public void onResult(DJIError error) { if (error == null) { // Mission started successfully } else { // Handle error } } }); ``` ### Response #### Success Response (200) - None (Callback indicates success or failure) #### Response Example - None (Callback based) ``` -------------------------------- ### getCpuLoading Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IPayloadCenter/IIntelligentBoxManager_IntelligentBoxInfo.html Gets the current CPU loading of the intelligent box. ```APIDOC ## getCpuLoading ### Description Gets cpu loading of intelligent box. ### Method `int getCpuLoading()` ### Return int - CPU loading percentage. ``` -------------------------------- ### getGpuLoading Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IPayloadCenter/IIntelligentBoxManager_IntelligentBoxInfo.html Gets the current GPU loading of the intelligent box. ```APIDOC ## getGpuLoading ### Description Gets gpu loading of intelligent box. ### Method `int getGpuLoading()` ### Return int - GPU loading percentage. ``` -------------------------------- ### createKey(DJIKeyInfo, int, int, int, int) Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/KeyTools.html Creates a Key instance using DJIKeyInfo, productId, componentIndex, subComponentType, and subComponentIndex. This is the default method for creating Key instances and is suitable for general use. ```APIDOC ## method createKey ### Description The default method for creating Key instances. ### Method Signature static DJIKey createKey(DJIKeyInfo mKeyInfo, int productId, int componentIndex, int subComponentType, int subComponentIndex) ### Parameters #### Path Parameters * **mKeyInfo** (DJIKeyInfo) - Required - A key interface in `[DJIKey](../../Components/IKeyManager/DJIKey.html#djikey)`. For example, CameraKey.`[KeyCameraType](../../Components/IKeyManager/Key_Camera_CameraKey.html#key_camera_msdkcameratype)`, which represents the key of the camera type. * **productId** (int) - Required - Product ID of the currently connected device, defaults to 0. * **componentIndex** (int) - Required - Gimbal load position. Please refer to `[ComponentIndexType](../../Components/IKeyManager/KeyTools.html#value_common_enum_componentindextype)` to set the corresponding int value. * **subComponentType** (int) - Required - Camera lens type. Please refer to `[CameraLensType](../../Components/IKeyManager/KeyTools.html#value_common_enum_cameralenstype)` to set the corresponding int value. * **subComponentIndex** (int) - Required - Reserved parameter. ### Return static DJIKey _Return instance of `[DJIKey](../../Components/IKeyManager/DJIKey.html#djikey)`._ ``` -------------------------------- ### getStartTimeStamp Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IFlyZoneManager/IFlyZoneManager_FlyZoneLicenseInfo.html Gets the start timestamp of the validity period of the restricted fly zone license. Supported since MSDK 5.3.0. ```APIDOC ## getStartTimeStamp ### Description Gets the start timestamp of the validity period of the restricted fly zone license. ### Method ```java long getStartTimeStamp() ``` ### Return - **long**: Returns the start timestamp of the validity period of the restricted fly zone license. ``` -------------------------------- ### Get Return Button Status Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_RemoteController_RemoteControllerKey.html Retrieves the status of the return button. Use this to determine if the aircraft is returning or if the return action should be started or stopped. ```java static final DJIKeyInfo KeyPauseButtonDown = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"PauseButtonDown", SingleValueConverter.BooleanConverter).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false).setInnerIdentifier("RCPauseButtonDown") ``` -------------------------------- ### Create Simulator Initialization Settings Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/ISimulatorManager/ISimulatorManager_InitializationSettings.html Use this static method to create an instance of InitializationSettings. It requires the initial coordinates and the number of satellites for the simulator. Supported since MSDK 5.0.0. ```java static InitializationSettings createInstance(LocationCoordinate2D location, @IntRange(from=0,to=20) int satelliteCount) ``` -------------------------------- ### Get Gimbal Calibration Status Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Gimbal_GimbalKey.html Retrieves the calibration status information for the standard gimbal. This key is used to monitor the progress after starting calibration. ```java static final DJIKeyInfo KeyGimbalCalibrationStatus = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"GimbalCalibrationStatus", new DJIValueConverter<>(GimbalCalibrationStatusInfo.class)).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false).setInnerIdentifier("GimbalCalibrationState"); ``` -------------------------------- ### Start Auto Landing Key Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html Initiates the automatic landing process for the aircraft. ```java static final DJIActionKeyInfo KeyStopAutoLanding = new DJIActionKeyInfo<>(componentType.value(),subComponentType.value(),"StopAutoLanding", EmptyValueConverter.converter,EmptyValueConverter.converter).canGet(false).canSet(false).canListen(false).canPerformAction(true).setIsEvent(false) ``` -------------------------------- ### KeyStartRecord Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Starts recording video. Ensure the camera mode is set to VIDEO_NORMAL and there is sufficient SD card space before calling. Supports shooting photos during recording for infrared lenses. ```APIDOC ## KeyStartRecord ### Description Starts recording video. It is required that calling `KeyCameraMode` to set camera working mode to `VIDEO_NORMAL`. For the Infrared lens, the user can shooting photo when the video is recording. Before using this method, SD Card status should be checked to make sure there has enough space. _Supported since MSDK 5.0.0_ ### Method Perform Action ### Endpoint KeyStartRecord ``` -------------------------------- ### Get Newly Generated Media File Info Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Retrieves information about media files (photos or videos) generated after shooting or recording starts. Supported since MSDK 5.0.0. ```java static final DJIKeyInfo KeyNewlyGeneratedMediaFile = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"NewlyGeneratedMediaFile", new DJIValueConverter<>(GeneratedMediaFileInfo.class)).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### Start Infinity Calibration Key Information Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Initiates the infinity calibration process for the camera. This action should be called if the infinity calibration state is NOT_CALIBRATE. Supported since MSDK 5.9.0. Note: Only Zenmuse P1 supports infinity calibration. ```java static final DJIActionKeyInfo KeyStartInfinityCalibration = new DJIActionKeyInfo<>(componentType.value(),subComponentType.value(),"StartInfinityCalibration", EmptyValueConverter.converter,EmptyValueConverter.converter).canGet(false).canSet(false).canListen(false).canPerformAction(true).setIsEvent(false).setInnerIdentifier("StartMFDemarcate") ``` -------------------------------- ### Get Camera Pre-recording Status Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Retrieves the camera's pre-recording status. During STARTING or STOPPING states, the camera cannot capture photos or record videos. Only supported by H30 series cameras. ```java static final DJIKeyInfo KeyRecordCameraStreamSettings = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"VideoRecordingStatus", new SingleValueConverter<>(VideoRecordingStatus.class,IsRecordingInfoMsg.class)).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false).setInnerIdentifier("VideoRecordingStatus") ``` -------------------------------- ### KeyPhotoIntervalCountdown Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Allows getting the countdown of interval photo shooting. When the interval shooting mode is set and shooting is started via `KeyStartShootPhoto`, the camera will count down the interval time between photos. Supported since MSDK 5.0.0. ```APIDOC ## KeyPhotoIntervalCountdown ### Description Allows getting the countdown of interval photo shooting. When the interval shooting mode is set, after calling `KeyStartShootPhoto` to start shooting, the camera will count down the interval time between photos and will shoot one photo after the countdown reaches 0. ### Supported since MSDK 5.0.0 ### Type Integer ``` -------------------------------- ### startChannel Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IMediaDataCenter/IVideoStreamManager_IVideoChannel.html Sets the video source and enables the video channel to start receiving video data. ```APIDOC ## startChannel ### Description Set the video source and enable it. The channel will start receiving video data after you call this method. You can call `addStreamDataListener` to receive the video data. After receiving the video data, you can decode it and render it. You can use DJI decoder `IVideoDecoder` to decode the video stream, it supports YUV output mode and SURFACE output mode. You can call `addVideoChannelStateChangeListener` to receive the video data. After enabling it, the channel state will change to `ON`. ### Method POST ### Endpoint N/A (Method within an interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **source** (StreamSource) - Required - An instance of video source. - **callback** (CommonCallbacks.CompletionCallback) - Optional - A callback that returns the execution result. ``` -------------------------------- ### KeyStartRecord Action Definition Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Defines the action key to start recording video. This is an action and cannot be set or listened to. ```java static final DJIActionKeyInfo KeyStartRecord = new DJIActionKeyInfo<>(componentType.value(),subComponentType.value(),"StartRecord", EmptyValueConverter.converter,EmptyValueConverter.converter).canGet(false).canSet(false).canListen(false).canPerformAction(true).setIsEvent(false) ``` -------------------------------- ### onExecutionStart Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IWaypointMissionManager/IWaypointMissionManager_WaypointActionListener.html This method will be called back when the waypoint action starts to execute. This is a deprecated method. ```APIDOC ## onExecutionStart ### Description This method will be called back when the waypoint action starts to execute. ### Method `void onExecutionStart(int actionId)` ### Parameters #### Path Parameters - **actionId** (int) - Required - The waypoint action ID to start executing. ### Remarks _Supported since MSDK 5.6.0_ @Deprecated ``` -------------------------------- ### Get RTK Module Status Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IRTKCenter/IRTKCenter.html Gets whether the RTK module of an aircraft is currently enabled or disabled. ```APIDOC ## getAircraftRTKModuleEnabled ### Description Get whether the RTK module of an aircraft is enabled or disabled. `_Supported since MSDK 5.0.0_` ### Method ```java void getAircraftRTKModuleEnabled(CommonCallbacks.CompletionCallbackWithParam callback) ``` ### Parameters #### Path Parameters None #### Request Body - **callback** (CommonCallbacks.CompletionCallbackWithParam) - Required - Return the result of execution. ``` -------------------------------- ### KeyStartMultiGimbalSyncControl Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html Initiates multi-gimbal synchronization control. This is an action that can be performed. ```APIDOC ## KeyStartMultiGimbalSyncControl ### Description Initiates multi-gimbal synchronization control. This is an action that can be performed. ### Supported SDK Version MSDK 5.0.0 ### Key Type `DJIActionKeyInfo` ### Capabilities - Get: false - Set: false - Listen: false - Perform Action: true - Is Event: false ### Package dji.sdk.keyvalue.key ``` -------------------------------- ### createKey (DJIActionKeyInfo) Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/KeyTools.html Create an ActionKey instance by passing in a DJIKeyInfo instance of a Key interface. This method is suitable for instance creation of ActionKey which is not related to gimbal load and camera. ```APIDOC ## createKey ### Description Create an ActionKey instance by passing in a DJIKeyInfo instance of a Key interface. This method is suitable for instance creation of ActionKey which is not related to gimbal load and camera. _Supported since MSDK 5.0.0_ ### Method Signature `static DJIKey.ActionKey createKey(DJIActionKeyInfo mKeyInfo)` ### Parameters #### Input Parameters - **mKeyInfo** (DJIActionKeyInfo) - Required - A key interface in `DJIKey`. For example, `CameraKey.KeyCameraType`, which represents the key of the camera type. ### Return - **DJIKey.ActionKey** - Returns an instance of `DJIActionKey`. ``` -------------------------------- ### KeyControlMode Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_RemoteController_RemoteControllerKey.html Gets or sets the control mode of the remote controller. For the initial 'get' operation, use the asynchronous method `getValue`. ```APIDOC ## KeyControlMode ### Description Gets or sets the control mode of the remote controller. For the initial 'get' operation, use the asynchronous method `getValue`. ### Type [ControlMode](../../Components/IKeyManager/DJIValue.html#value_remotecontroller_enum_rccontrolmode) ### Supported Since MSDK 5.0.0 ``` -------------------------------- ### Get Wind Warning Key Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html This key is used to get the current wind speed level. Supported since MSDK 5.0.0. ```java static final DJIKeyInfo KeyWindWarning = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"WindWarning", new SingleValueConverter<>(WindWarning.class,FCWindWarningMsg.class)).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### onInitProcess Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/SDKManager/ISDKManager_SDKManagerCallback.html The callback method of MSDK initialization progress. It is invoked during the MSDK initialization phase to report the current progress. ```APIDOC ## method onInitProcess ### Description The callback method of MSDK initialization progress. ### Signature ```java void onInitProcess(DJISDKInitEvent event, int totalProcess) ``` ### Parameters - **event** (DJISDKInitEvent) - The event type of MSDK initialization. - **totalProcess** (int) - The total progress of the initialization. ### Supported Since MSDK 5.0.0 ``` -------------------------------- ### Get Calibrated Infinity Value Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Get the calibrated infinity value for the camera lens. Only supported on Zenmuse P1. Supported since MSDK 5.9.0. ```java static final DJIKeyInfo KeyLensCalibratedInfinityValue = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"LensCalibratedInfinityValue", SingleValueConverter.IntegerConverter).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### GB28181Settings Methods Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IMediaDataCenter/ILiveStreamManager_LiveStreamSettings_GB28181Settings.html This section provides documentation for the methods available in the GB28181Settings class, allowing retrieval of various GB28181 live stream configuration parameters. ```APIDOC ## GB28181Settings ### Description It is used to build and get the GB28181 live stream settings. _Supported since MSDK 5.0.0_ ### Class Members: #### method getServerIP ```java String getServerIP() ``` ##### Description: Get server ip address. _Supported since MSDK 5.0.0_ ##### Return: String _Return server ip address._ #### method getServerPort ```java int getServerPort() ``` ##### Description: Get server port. _Supported since MSDK 5.0.0_ ##### Return: int _Return server port._ #### method getServerID ```java String getServerID() ``` ##### Description: Get server id. _Supported since MSDK 5.0.0_ ##### Return: String _Return server id._ #### method getAgentID ```java String getAgentID() ``` ##### Description: Get agent id. _Supported since MSDK 5.0.0_ ##### Return: String _Return agent id._ #### method getPassword ```java String getPassword() ``` ##### Description: Get password. _Supported since MSDK 5.0.0_ ##### Return: String _Return password._ #### method getLocalPort ```java int getLocalPort() ``` ##### Description: Get local port. _Supported since MSDK 5.0.0_ ##### Return: int _Return local port._ #### method getChannel ```java String getChannel() ``` ##### Description: Get channel name. _Supported since MSDK 5.0.0_ ##### Return: String _Return channel name._ ``` -------------------------------- ### Get Camera Infinity Calibration Result Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Get the result of the camera infinity calibration. Only supported on Zenmuse P1. Supported since MSDK 5.9.0. ```java static final DJIKeyInfo KeyInfinityCalibrationResult = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"InfinityCalibrationResult", new SingleValueConverter<>(InfinityCalibrationResult.class,MFDemarcateResultMsg.class)).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false).setInnerIdentifier("MFDemarcateResult") ``` -------------------------------- ### KeyPhotoPanoramaProgress Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Gets the percentage of panorama photo shooting progress. This key is used when the camera mode is set to PHOTO_PANORAMA. It supports getting and listening for changes. ```APIDOC ## KeyPhotoPanoramaProgress ### Description Gets the percentage of panorama photo shooting progress. This key is used when `[KeyCameraMode](../../Components/IKeyManager/Key_Camera_CameraKey.html#key_camera_cameramode)` is `[PHOTO_PANORAMA](../../Components/IKeyManager/DJIValue.html#value_camera_enum_cameramode_photo_panorama)`. `_Supported since MSDK 5.0.0_` ### Method GET, LISTEN ### Endpoint KeyCamera/PhotoPanoramaProgress ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **PhotoPanoramaProgress** (Integer) - The percentage of panorama photo shooting progress (0-100). #### Response Example ```json { "example": "50" } ``` ``` -------------------------------- ### KeyStartRecord Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Initiates video recording. This is an action key that triggers the start of video recording. ```APIDOC ## KeyStartRecord ### Description Initiates video recording. `_Supported since MSDK 5.0.0_` ### Method PERFORM_ACTION ### Endpoint KeyCamera/StartRecord ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **Success** (EmptyMsg) - Indicates the action was successful. #### Response Example None ``` -------------------------------- ### Set and Get ISO Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Allows setting and getting the current ISO value for the camera lens. Ensure the exposure mode is set to MANUAL when using this key. ```java static final DJIKeyInfo KeyISO = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"ISO", new SingleValueConverter<>(CameraISO.class,CameraISOMsg.class)).canGet(true).canSet(true).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### startStream Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IMediaDataCenter/ILiveStreamManager.html Starts the live streaming process. Requires a CompletionCallback to handle the result of the operation. ```APIDOC ## method startStream void startStream(CommonCallbacks.CompletionCallback callback) ### Description Start live streaming. `_Supported since MSDK 5.0.0_` ### Input Parameters: - callback (CommonCallbacks.CompletionCallback) - Required - Return the result of execution. ``` -------------------------------- ### InitializationSettings Class Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/ISimulatorManager/ISimulatorManager_InitializationSettings.html The InitializationSettings class is used to initialize simulator parameters. It provides methods to create an instance with initial coordinates and satellite count, and to retrieve these settings. ```APIDOC ## Class InitializationSettings Simulator initialization settings class, which is used to initialize simulator parameters. _Supported since MSDK 5.0.0_ ### Methods #### static InitializationSettings createInstance(LocationCoordinate2D location, @IntRange(from=0,to=20) int satelliteCount) **Description:** The initialized method of simulator parameter. **Parameters:** * **location** (LocationCoordinate2D) - Required - The initial coordinates of the aircraft in the simulator. * **satelliteCount** (int) - Required - The initial number of satellites of the aircraft in the simulator. The range of satellite numbers is [0, 20]. **Return:** static InitializationSettings - Return the instance of simulator. #### LocationCoordinate2D getLocation() **Description:** To get the initial coordinates of the aircraft in the simulator. **Return:** LocationCoordinate2D - Return the initial coordinates of the aircraft in the simulator. #### int getSatelliteCount() **Description:** To get the initial number of satellites of the aircraft in the simulator. **Return:** int - Return the initial number of satellites of the aircraft in the simulator. ``` -------------------------------- ### Get Wind Direction Key Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html This key is used to get the current wind direction using the world coordinate system. Supported since MSDK 5.0.0. ```java static final DJIKeyInfo KeyWindDirection = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"WindDirection", new SingleValueConverter<>(WindDirection.class,FCWindDirectionStatusMsg.class)).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### Start Shoot Photo Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Initiates the action of shooting a photo with the camera. This key is actionable. ```APIDOC ## PERFORM ACTION KeyStartShootPhoto ### Description Initiates the action to shoot a single photo with the camera. This action can only be performed if the camera is in a compatible mode (e.g., `SHOOT_PHOTO`). ### Method PERFORM ACTION ### Endpoint KeyStartShootPhoto ### Parameters None ### Request Example ```json { "action": "KeyStartShootPhoto" } ``` ### Response #### Success Response (200) - **EmptyMsg**: Indicates the action was successfully triggered. ### Response Example ```json { "result": "success" } ``` ``` -------------------------------- ### Get Remote Controller Flight Mode Key Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html This key is used to get the current flight mode as determined by the remote controller. Supported since MSDK 5.0.0. ```java static final DJIKeyInfo KeyRemoteControllerFlightMode = new KeyRemoteControllerFlightMode().canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### ISimulatorManager InitializationSettings Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/cn/Components/ISimulatorManager/ISimulatorManager_InitializationSettings.html Provides details on the InitializationSettings for the ISimulatorManager. ```APIDOC ## ISimulatorManager InitializationSettings ### Description Configuration settings used to initialize the simulator manager. ### Method N/A (This is a configuration structure, not a direct method call.) ### Endpoint N/A ### Parameters This section would typically detail the fields within the InitializationSettings structure, such as: - **param1** (type) - Required/Optional - Description of the parameter. - **param2** (type) - Required/Optional - Description of the parameter. (Note: Specific fields are not detailed in the provided source text.) ### Request Example N/A ### Response N/A ``` -------------------------------- ### Set and Get Battery Self-Discharge Days Key Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Battery_BatteryKey.html Defines the key to set and get the battery self-discharge days. The range is [1, 10]. Supported since MSDK 5.0.0. ```Java static final DJIKeyInfo KeyBatterySelfDischargeInDays = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"BatterySelfDischargeInDays", SingleValueConverter.IntegerConverter).canGet(true).canSet(true).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### KeyStartCompassCalibration Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html Initiates the compass calibration process. Supported since MSDK 5.0.0. ```APIDOC ## KeyStartCompassCalibration ### Description Initiates the compass calibration process. ### Supported SDK Version MSDK 5.0.0 ### Key Type PERFORM_ACTION ### Return Value - **EmptyMsg**: Indicates the action has been performed. ``` -------------------------------- ### KeyStartGoHome Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html Initiates the intelligent return-to-home process. This function requires a good GPS signal. It can also be triggered by the remote controller's smart return-to-home button. During the process, users can control altitude and speed, and regain control by exiting the process. The status can be monitored using `KeyGoHomeStatus`. Supported since MSDK 5.0.0. ```APIDOC ## KeyStartGoHome ### Description To start intelligent return-to-home. When the GPS signal is not good, intelligent return-to-home can not be started. Intelligent return-to-home can also be started by the smart return-to-home button on the remote controller. During the return-to-home home process, the user can control the altitude of the aircraft with the throttle stick and control the speed of the aircraft with the pitch stick to avoid obstacles. During the return-to-home process, the user can regain control of the aircraft after exiting the intelligent return-to-home home via the intelligent return-to-home button or by calling `KeyStopGoHome`. `KeyGoHomeStatus` can be used to get intelligent return-to-home status. _Supported since MSDK 5.0.0_ ### Action - `KeyStartGoHome` - Starts the intelligent return-to-home process. ### Related Keys - `[KeyStopGoHome](#key_flightcontroller_stopgohome_inline)` - `[KeyGoHomeStatus](#key_flightcontroller_gohomestatus_inline)` ``` -------------------------------- ### Initialize KeyIMUCalibrationInfo Listener Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html Defines the DJIKeyInfo for listening to IMU calibration status. This key allows retrieval and listening for IMUCalibrationInfo, which provides details about the ongoing calibration process. ```java static final DJIKeyInfo KeyIMUCalibrationInfo = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"IMUCalibrationInfo", new DJIValueConverter<>(IMUCalibrationInfo.class)).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false).setInnerIdentifier("IMUCalibrationHint") ``` -------------------------------- ### Get and Set Camera Video Resolution and Frame Rate Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Gets or sets the current video resolution and frame rate for the camera lens. This key allows direct manipulation of the video output settings. ```java static final DJIKeyInfo KeyVideoResolutionFrameRate = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"VideoResolutionFrameRate", new DJIValueConverter<>(VideoResolutionFrameRate.class)).canGet(true).canSet(true).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### startMission Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IIntelligentFlightManager/IIntelligentFlightManager_IFlyToMissionManager.html Starts the fly-to mission with the specified target, parameters, and a completion callback. ```APIDOC ## method startMission ### Description Start task. `_Supported since MSDK 5.14.0_` ### Method Signature ```java void startMission(FlyToTarget target, FlyToParam param, CommonCallbacks.CompletionCallback callback) ``` ### Parameters #### Input Parameters - **target** (FlyToTarget) - Required - The target for the fly-to mission. - **param** (FlyToParam) - Required - The parameters for the fly-to mission. - **callback** (CommonCallbacks.CompletionCallback) - Required - The callback to be invoked upon mission completion. ``` -------------------------------- ### Simulator Management Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Product_ProductKey.html Interfaces for simulator initialization and status monitoring. ```APIDOC ## ISimulatorManager ### Description Manages simulator operations. ## InitializationSettings ### Description Settings for initializing the simulator. ## SimulatorStatusListener ### Description Listener for simulator status updates. ## SimulatorState ### Description Represents the current state of the simulator. ``` -------------------------------- ### Get Low Battery Return-to-Home Information Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html Retrieves information related to the intelligent low battery return-to-home feature. This key allows you to get the current status and details of the low battery RTH functionality. ```java static final DJIKeyInfo KeyLowBatteryRTHInfo = new KeyLowBatteryRTHInfo().canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false) ``` -------------------------------- ### KeyStartInfinityCalibration Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Camera_CameraKey.html Initiates the infinity calibration process. This action is only supported on Zenmuse P1 cameras. ```APIDOC ## KeyStartInfinityCalibration ### Description Initiates the infinity calibration process. This action is only supported on Zenmuse P1 cameras. ### Method Perform Action ### Parameters None ### Response #### Success Response (200) Indicates the action was performed successfully. No specific response body is detailed. ### Supported Since MSDK 5.9.0 ``` -------------------------------- ### getPayloadType Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IPayloadCenter/IPayloadManager_PayloadBasicInfo.html Gets the payload type. ```APIDOC ## getPayloadType ### Description Gets the payload type. ### Method ```java PayloadType getPayloadType() ``` ### Return - **PayloadType**: Returns the payload type. ``` -------------------------------- ### enableSimulator Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/ISimulatorManager/ISimulatorManager.html Enables the simulator with the provided initialization settings and a completion callback to report the execution result. ```APIDOC ## enableSimulator ### Description Turn on the simulator. ### Method ```java void enableSimulator(@NonNull final InitializationSettings settings, @Nullable final CommonCallbacks.CompletionCallback callback) ``` ### Parameters #### Input Parameters - **settings** (InitializationSettings) - Required - Initialized parameter of simulator. - **callback** (CommonCallbacks.CompletionCallback) - Optional - Return the callback of execution result. ``` -------------------------------- ### getHeading() Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Value_FlightController_Struct_AirSenseAirplaneState.html Gets the heading of the airplane. ```APIDOC ## method getHeading ### Description Gets the heading of the airplane. ### Return: Double _Returns the heading of the airplane._ ``` -------------------------------- ### KeyFineTunePitchTotalDegree Initialization Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Gimbal_GimbalKey.html Initializes the KeyFineTunePitchTotalDegree key. This key retrieves the total offset value for the gimbal's pitch axis fine-tuning. It supports getting and listening but not setting or performing actions. ```java static final DJIKeyInfo KeyFineTunePitchTotalDegree = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"FineTunePitchTotalDegree", SingleValueConverter.DoubleConverter).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false).setInnerIdentifier("PitchAdjustDegree") ``` -------------------------------- ### getFirmwareVersion Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IPayloadCenter/IPayloadManager_PayloadBasicInfo.html Gets the payload Firmware version. ```APIDOC ## getFirmwareVersion ### Description Gets the payload Firmware version. ### Method ```java String getFirmwareVersion() ``` ### Return - **String**: Returns the payload Firmware version. ``` -------------------------------- ### KeyFirmwareVersion Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Product_ProductKey.html Retrieves the firmware version of the hardware product. This key is gettable. ```APIDOC ## KeyFirmwareVersion ### Description Retrieves the firmware version of the hardware product. ### Type `DJIKeyInfo` ### Get `true` ### Set `false` ### Listen `false` ### Event `false` ### Supported Since MSDK 5.0.0 ``` -------------------------------- ### getSerialNumber Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IPayloadCenter/IPayloadManager_PayloadBasicInfo.html Gets the payload serial number. ```APIDOC ## getSerialNumber ### Description Gets the payload serial number. ### Method ```java String getSerialNumber() ``` ### Return - **String**: Returns the payload serial number. ``` -------------------------------- ### createKey (DJIActionKeyInfo, ComponentIndexType) Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/KeyTools.html Create a Key instance by passing in the DJIKeyInfo instance of an ActionKey interface and the load position of the gimbal. This method is suitable for instance creation of ActionKey related to gimbal load. ```APIDOC ## createKey ### Description Create a Key instance by passing in the `DJIKeyInfo` instance of an ActionKey interface and the load position of the gimbal. This method is suitable for instance creation of ActionKey related to gimbal load. _Supported since MSDK 5.0.0_ ### Method Signature `static DJIKey.ActionKey createKey(DJIActionKeyInfo mKeyInfo, ComponentIndexType componentIndexType)` ### Parameters #### Input Parameters - **mKeyInfo** (DJIActionKeyInfo) - Required - A key interface in `DJIKey`. For example, `CameraKey.KeyCameraType`, which represents the key of the camera type. - **componentIndexType** (ComponentIndexType) - Required - Gimbal load position. ### Return - **DJIKey.ActionKey** - Returns an instance of `DJIActionKey`. ``` -------------------------------- ### isConnected Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IPayloadCenter/IPayloadManager_PayloadBasicInfo.html Gets whether the payload is connected. ```APIDOC ## isConnected ### Description Gets whether the payload is connected. ### Method ```java boolean isConnected() ``` ### Return - **boolean**: Returns whether the payload is connected. ``` -------------------------------- ### KeyGoHomeHeight Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_FlightController_FlightControllerKey.html Sets and gets the Go Home height. Supported since MSDK 5.0.0. ```APIDOC ## KeyGoHomeHeight ### Description Sets and gets the Go Home height. Supported since MSDK 5.0.0. ### Method Get/Set ### Endpoint FlightController/GoHomeHeight ### Parameters #### Request Body (for Set) - **GoHomeHeight** (Integer) - The Go Home height in meters. ### Request Example None ### Response #### Success Response (200) - **GoHomeHeight** (Integer) - The current Go Home height. #### Response Example None ``` -------------------------------- ### getAbsoluteAltitude() Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Value_FlightController_Struct_AirSenseAirplaneState.html Gets the altitude of the airplane in meters. ```APIDOC ## method getAbsoluteAltitude ### Description Gets the altitude of the airplane, unit: meter. ### Return: Double _Returns the altitude of the airplane._ ``` -------------------------------- ### getTargetIndex Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IIntelligentFlightManager/IIntelligentFlightManager_SpotLightManager_SpotLightTarget.html Gets the index of the spotlight function. ```APIDOC ## getTargetIndex ### Description Gets the index of spotlight function. ### Method GET ### Endpoint /intelligentFlightManager/spotlight/targetIndex ### Return: Integer _Returns the index of spotlight function._ ``` -------------------------------- ### KeyFineTuneYawTotalDegree Initialization Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Gimbal_GimbalKey.html Initializes the KeyFineTuneYawTotalDegree key. This key retrieves the total offset value for the gimbal's yaw axis fine-tuning. It supports getting and listening but not setting or performing actions. ```java static final DJIKeyInfo KeyFineTuneYawTotalDegree = new DJIKeyInfo<>(componentType.value(),subComponentType.value(),"FineTuneYawTotalDegree", SingleValueConverter.DoubleConverter).canGet(true).canSet(false).canListen(true).canPerformAction(false).setIsEvent(false).setInnerIdentifier("YawAdjustDegree") ``` -------------------------------- ### getPayloadProductPhaseType Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IPayloadCenter/IPayloadManager_PayloadBasicInfo.html Gets the current payload product phase. ```APIDOC ## getPayloadProductPhaseType ### Description Gets the current payload product phase. ### Method ```java PayloadProductPhaseType getPayloadProductPhaseType() ``` ### Return - **PayloadProductPhaseType**: Returns the current payload product phase. ``` -------------------------------- ### createKey(DJIKeyInfo) Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/KeyTools.html Creates a Key instance by passing a DJIKeyInfo instance. This method is suitable for creating keys that are not related to gimbal load or cameras. ```APIDOC ## method createKey ### Description Create a Key instance by passing a `[DJIKeyInfo](../../Components/IKeyManager/DJIKeyInfo.html#djikeyinfo)` instance of a Key interface. This method is suitable for instance creation of keys that have nothing to do with the gimbal load and camera. ### Method Signature static DJIKey createKey(DJIKeyInfo mKeyInfo) ### Parameters #### Path Parameters * **mKeyInfo** (DJIKeyInfo) - Required - A key interface in `[DJIKey](../../Components/IKeyManager/DJIKey.html#djikey)`. For example, FlightControllerKey.`[KeyAircraftAttitude](../../Components/IKeyManager/Key_FlightController_FlightControllerKey.html#key_flightcontroller_attitude)`, which represents the key to get the aircraft attitude. ### Return static DJIKey _Return instance of `[DJIKey](../../Components/IKeyManager/DJIKey.html#djikey)`._ ``` -------------------------------- ### createCameraKey Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/KeyTools.html Create a Key instance by passing in the DJIKeyInfo instance of an ActionKey interface, camera lens type and the load position of the gimbal. This method is suitable for instance creation of ActionKey related to camera. ```APIDOC ## createCameraKey ### Description Create a Key instance by passing in the `DJIKeyInfo` instance of an ActionKey interface, camera lens type and the load position of the gimbal. This method is suitable for instance creation of ActionKey related to camera. ### Method Signature `static DJIKey.ActionKey createCameraKey(DJIActionKeyInfo mKeyInfo, ComponentIndexType componentIndexType, CameraLensType cameraLensType)` ### Parameters #### Input Parameters - **mKeyInfo** (DJIActionKeyInfo) - Required - A key interface in `DJIKey`. For example, `CameraKey.KeyCameraType`, which represents the key of the camera type. - **componentIndexType** (ComponentIndexType) - Required - Gimbal load position. - **cameraLensType** (CameraLensType) - Required - Camera lens type. ### Return - **DJIKey.ActionKey** - Returns an instance of `DJIActionKey`. ``` -------------------------------- ### getResult Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IMediaDataCenter/ICameraStreamManager_PinPointInfo.html Gets the result of the pin point callback. ```APIDOC ## method getResult ### Description Gets the result of pin point callback. ### Return [Result](../../Components/IMediaDataCenter/ICameraStreamManager.html#icamerastreammanager_pinpointresult) _Returns the result of pin point callback._ ``` -------------------------------- ### getLongitude() Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Value_FlightController_Struct_AirSenseAirplaneState.html Gets the longitude of the airplane’s position. ```APIDOC ## method getLongitude ### Description Gets the longitude of the airplane’s position. ### Return: Double _Returns the longitude of the airplane's position._ ``` -------------------------------- ### getLatitude() Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Value_FlightController_Struct_AirSenseAirplaneState.html Gets the latitude of the airplane’s position. ```APIDOC ## method getLatitude ### Description Gets the latitude of the airplane’s position. ### Return: Double _Returns the latitude of the airplane's position._ ``` -------------------------------- ### GoHomeInfo Class Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Value_FlightController_GoHomeInfo.html Provides return-to-home information. Note that KeyGoHomeInfo currently only supports DJI_MATRICE_4_SERIES. ```APIDOC ## Class GoHomeInfo Provides return-to-home information. **Note:** `KeyGoHomeInfo` currently only supports `DJI_MATRICE_4_SERIES`. ### Class Members #### Methods ##### getType `GoHomeNeedConfirmType getType()` **Description:** Returns the return-to-home confirm status. When the status is `NORMAL`, you need to call the `KeyGoHomeConfirm` interface to confirm or cancel the return-to-home operation. **Parameters:** - None **Return:** - `GoHomeNeedConfirmType`: Returns whether to confirm return-to-home. ``` -------------------------------- ### getCode() Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Value_FlightController_Struct_AirSenseAirplaneState.html Gets the unique ICAO code of the airplane. ```APIDOC ## method getCode ### Description Gets the unique code (ICAO) of the airplane. ### Return: String _Returns The unique code (ICAO) of the airplane._ ``` -------------------------------- ### KeyChargeRemaining Source: https://github.com/dji-sdk/mobile-sdk-android-v5/blob/dev-sdk-main/Docs/Android_API/en/Components/IKeyManager/Key_Battery_BatteryKey.html Gets the remaining battery capacity in mAh. ```APIDOC ## KeyChargeRemaining ### Description Gets the remaining battery capacity. The unit is mAh. ### Method GET ### Endpoint N/A (This is an SDK key) ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **Remaining Charge** (Integer) - The remaining battery capacity in mAh. #### Response Example ```json { "value": 2500 } ``` ```