DJI Mobile SDK Documentation

Mobile SDK

      Manager Classes
      DJISDKManager
      DJIKeyManager
      DJIFlyZoneManager
      DJIAppActivationManager
      DJIUserAccountManager
      DJIDataProtectionManager
      DJILDMManager
      DJIUTMISSManager
      DJIFlightHubManager
      DJIUASRemoteIDManager
      DJIUpgradeManager
      Base Classes
      DJIBaseProduct
      DJIBaseComponent
      Product Classes
      DJIAircraft
      DJIHandheld
      Component Classes
      DJIFlightController
      DJIBattery
      DJICamera
      DJIGimbal
      DJIAirLink
      DJIRemoteController
      DJIHandheldController
      DJIMobileRemoteController
      DJIPayload
      DJIPipeline
      DJIAccessoryAggregation
      DJIRTKBaseStation
      DJILidar
      Mission Classes
      DJIMissionControl
      DJIMissionAction
      DJIMissionTrigger
      DJIWaypointMissionOperator
      DJIWaypointV2MissionOperator
      DJIFollowMeMissionOperator
      DJIPanoramaMissionOperator
      DJIHotpointMissionOperator
      DJIIntelligentHotpointMissionOperator
      DJITapFlyMissionOperator
      DJIActiveTrackMissionOperator
      DJIMission
      Misc Classes
      DJIParamCapability
      NSError
      DJIDiagnostics
      DJIRemoteLogger

      class DJIAircraft

      @interface DJIAircraft : DJIBaseProduct
      Header:DJIAircraft.h
      Inherits From:DJIBaseProduct
      Description:

      Aircraft product class, which includes basic product information and access to all components (such as flight controller, battery etc.). This object is accessed from product in DJISDKManager. Aircraft components are defined in both DJIAircraft and its parent DJIBaseProduct.

      Class Members:
      Components
      property
      flightController
      property flightController
      @property(nonatomic, readonly) DJIFlightController *_Nullable flightController
      Header:DJIAircraft.h
      Description:

      Returns an instance of the aircraft's flight controller.

      See Also:

      DJIFlightController

      property
      batteries
      property batteries
      @property(nonatomic, readonly) NSArray<DJIBattery *> *_Nullable batteries
      Header:DJIAircraft.h
      Description:

      Returns an array of the aircraft's batteries. It is used when the aircraft has multiple batteries, e.g. Matrice 600.

      See Also:

      DJIBattery

      property
      cameras
      property cameras
      @property(nonatomic, readonly) NSArray<DJICamera *> *_Nullable cameras
      Header:DJIAircraft.h
      Description:

      Retrieves instances of the product's cameras. This is used when the aircraft has multiple DJI cameras, e.g. M210 and M210 RTK. Note, when two cameras do exist, camera order within the array will not always the same. For example: On the M210, the port side (left) camera will have property index to be 0 and the starboard side (right) camera will have index to be 1. However, the first object of cameras will not necessarily always be the camera with index of 0.

      See Also:

      DJICamera

      property
      gimbals
      property gimbals
      @property(nonatomic, readonly) NSArray<DJIGimbal *> *_Nullable gimbals
      Header:DJIAircraft.h
      Description:

      Retrieves instances of the product's gimbals. This is used when the aircraft has multiple DJI gimbals, e.g. M210 and M210 RTK. Note, when two gimbals do exist, gimbal order within the array will not always the same. For example: On the M210, the port side (left) gimbal will have property index to be 0 and the starboard side (right) gimbal will have index to be 1. However, the first object of gimbals will not necessarily always be the gimbal with index of 0.

      See Also:

      DJIGimbal

      property remoteController
      @property(nonatomic, readonly) DJIRemoteController *_Nullable remoteController
      Header:DJIAircraft.h
      Description:

      Returns an instance of the aircraft's remote controller.

      See Also:

      DJIRemoteController

      property mobileRemoteController
      @property(nonatomic, readonly) DJIMobileRemoteController *_Nullable mobileRemoteController
      Header:DJIAircraft.h
      Description:

      A simulated remote controller on the mobile device. It is supported by Mavic Pro and Spark using WiFi.

      See Also:

      DJIMobileRemoteController

      property
      payload
      property payload
      @property(nonatomic, readonly) DJIPayload *_Nullable payload
      Header:DJIAircraft.h
      Description:

      The connected payload instance.

      See Also:

      DJIPayload

      property
      baseStation
      property baseStation
      @property(nonatomic, readonly) DJIRTKBaseStation *_Nullable baseStation
      Header:DJIAircraft.h
      Description:

      The connected base station instance. It is supported by Phantom 4 RTK and Matrice 210 RTK V2.

      See Also:

      DJIRTKBaseStation

      property accessoryAggregation
      @property(nonatomic, readonly) DJIAccessoryAggregation *_Nullable accessoryAggregation
      Header:DJIAircraft.h
      Description:

      The container of accessories on the aircraft. It is accessible when the connected aircraft supports extra accessories.

      See Also:

      DJIAccessoryAggregation

      property
      payloads
      property payloads
      @property(nonatomic, readonly) NSArray<DJIPayload *> *_Nullable payloads
      Header:DJIAircraft.h
      Description:

      Retrieves instances of the product's payloads. This is used when the aircraft has multiple gimbal slots, e.g. M210 and M210 RTK. Note, when two payload instances do exist, the order within the array will not always be the same. For example: On the M210, the port side (left) payload will have property index to be 0 and the starboard side (right) payload will have index to be 1. However, the first object of cameras will not necessarily always be the payload with index of 0.

      See Also:

      DJIPayload

      property
      radar
      property radar
      @property(nonatomic, readonly) DJIRadar *_Nullable radar
      Header:DJIAircraft.h
      Description:

      Retrieves an instance of the device's radar.

      See Also:

      DJIRadar

      const DJIAircraftModelNameUnknownAircraft
      extern NSString *const DJIAircraftModelNameUnknownAircraft
      Header:DJIAircraft.h
      Description:

      The Aircraft's model name is unknown.

      const DJIAircraftModelNameInspire1
      extern NSString *const DJIAircraftModelNameInspire1
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Inspire 1.

      const DJIAircraftModelNameInspire1Pro
      extern NSString *const DJIAircraftModelNameInspire1Pro
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Inspire 1 Pro.

      const DJIAircraftModelNameInspire1RAW
      extern NSString *const DJIAircraftModelNameInspire1RAW
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Inspire 1 Raw.

      const DJIAircraftModelNameInspire2
      extern NSString *const DJIAircraftModelNameInspire2
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Inspire 2.

      const DJIAircraftModelNamePhantom3Professional
      extern NSString *const DJIAircraftModelNamePhantom3Professional
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 3 Professional.

      const DJIAircraftModelNamePhantom3Advanced
      extern NSString *const DJIAircraftModelNamePhantom3Advanced
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 3 Advanced.

      const DJIAircraftModelNamePhantom3Standard
      extern NSString *const DJIAircraftModelNamePhantom3Standard
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 3 Standard.

      const DJIAircraftModelNamePhantom34K
      extern NSString *const DJIAircraftModelNamePhantom34K
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 3 4K.

      const DJIAircraftModelNamePhantom4
      extern NSString *const DJIAircraftModelNamePhantom4
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 4.

      const DJIAircraftModelNamePhantom4Pro
      extern NSString *const DJIAircraftModelNamePhantom4Pro
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 4 Pro.

      const DJIAircraftModelNamePhantom4ProV2
      extern NSString *const DJIAircraftModelNamePhantom4ProV2
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 4 Pro V2.

      const DJIAircraftModelNameP4Multispectral
      extern NSString *const DJIAircraftModelNameP4Multispectral
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is P4 Multispectral.

      const DJIAircraftModelNameMavicAir2
      extern NSString *const DJIAircraftModelNameMavicAir2
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Mavic Air 2.

      const DJIAircraftModelNameDJIMiniSE
      extern NSString *const DJIAircraftModelNameDJIMiniSE
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is DJI Mini SE.

      const DJIAircraftModelNameDJIMini2
      extern NSString *const DJIAircraftModelNameDJIMini2
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is DJI Mini 2.

      const DJIAircraftModelNamePhantom4RTK
      extern NSString *const DJIAircraftModelNamePhantom4RTK
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 4 RTK.

      const DJIAircraftModelNameMatrice100
      extern NSString *const DJIAircraftModelNameMatrice100
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 100.

      const DJIAircraftModelNameMatrice200
      extern NSString *const DJIAircraftModelNameMatrice200
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 200.

      const DJIAircraftModelNamePhantom4Advanced
      extern NSString *const DJIAircraftModelNamePhantom4Advanced
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Phantom 4 Advanced.

      const DJIAircraftModelNameMatrice600
      extern NSString *const DJIAircraftModelNameMatrice600
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 600.

      const DJIAircraftModelNameMatrice600Pro
      extern NSString *const DJIAircraftModelNameMatrice600Pro
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 600 Pro.

      const DJIAircraftModelNameA3
      extern NSString *const DJIAircraftModelNameA3
      Header:DJIAircraft.h
      Description:

      The aircraft flight controller's model name is A3.

      const DJIAircraftModelNameMavicPro
      extern NSString *const DJIAircraftModelNameMavicPro
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Mavic Pro.

      const DJIAircraftModelNameSpark
      extern NSString *const DJIAircraftModelNameSpark
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Spark.

      const DJIAircraftModelNameMatrice210
      extern NSString *const DJIAircraftModelNameMatrice210
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 210.

      const DJIAircraftModelNameMatrice210RTK
      extern NSString *const DJIAircraftModelNameMatrice210RTK
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 210 RTK.

      const DJIAircraftModelNameMatrice200V2
      extern NSString *const DJIAircraftModelNameMatrice200V2
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 200 V2.

      const DJIAircraftModelNameMatrice210V2
      extern NSString *const DJIAircraftModelNameMatrice210V2
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 210 V2.

      const DJIAircraftModelNameMatrice210RTKV2
      extern NSString *const DJIAircraftModelNameMatrice210RTKV2
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 210 RTK V2.

      const DJIAircraftModelNameMatrice300RTK
      extern NSString *const DJIAircraftModelNameMatrice300RTK
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Matrice 300 RTK.

      const DJIAircraftModelNameMavicAir
      extern NSString *const DJIAircraftModelNameMavicAir
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Mavic Air.

      const DJIAircraftModelNameMavic2Pro
      extern NSString *const DJIAircraftModelNameMavic2Pro
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Mavic 2 Pro.

      const DJIAircraftModelNameMavic2Zoom
      extern NSString *const DJIAircraftModelNameMavic2Zoom
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Mavic 2 Zoom.

      const DJIAircraftModelNameMavic2
      extern NSString *const DJIAircraftModelNameMavic2
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is either Mavic 2 Pro or Mavic 2 Zoom. The camera is not recognized yet.

      const DJIAircraftModelNameMavic2Enterprise
      extern NSString *const DJIAircraftModelNameMavic2Enterprise
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Mavic 2 Enterprise.

      const DJIAircraftModelNameMavic2EnterpriseDual
      extern NSString *const DJIAircraftModelNameMavic2EnterpriseDual
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Mavic 2 Enterprise Dual.

      const DJIAircraftModelNameMavicMini
      extern NSString *const DJIAircraftModelNameMavicMini
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is Mavic Mini.

      const DJIAircraftModelNameDJIAir2S
      extern NSString *const DJIAircraftModelNameDJIAir2S
      Header:DJIAircraft.h
      Description:

      The aircraft's model name is DJI Air 2S.

      const DJIAircraftModeNameOnlyRemoteController
      extern NSString *const DJIAircraftModeNameOnlyRemoteController
      Header:DJIAircraft.h
      Description:

      The display name when only the remote controller is connected.

      const DJIAircraftModelNameN3
      extern NSString *const DJIAircraftModelNameN3
      Header:DJIAircraft.h
      Description:

      The aircraft flight controller's model name is N3.