DJI Mobile SDK Documentation

Mobile SDK

      Manager Classes
      DJISDKManager
      KeyManager
      FlyZoneManager
      AppActivationManager
      UserAccountManager
      DataProtectionManager
      LDMManager
      UTMISSManager
      FlightHubManager
      LiveStreamManager
      IUASRemoteIDManager
      UpgradeManager
      Base Classes
      BaseProduct
      BaseComponent
      Product Classes
      Aircraft
      HandHeld
      Component Classes
      FlightController
      Battery
      Camera
      Gimbal
      AirLink
      RemoteController
      HandheldController
      MobileRemoteController
      Payload
      Pipeline
      AccessoryAggregation
      BaseStation
      Lidar
      Mission Classes
      MissionControl
      MissionAction
      TimelineMission
      Trigger
      WaypointMissionOperator
      WaypointV2MissionOperator
      FollowMeMissionOperator
      PanoramaMissionOperator
      HotpointMissionOperator
      IntelligentHotpointMissionOperator
      TapFlyMissionOperator
      ActiveTrackOperator
      Misc Classes
      CommonCallbacks
      WarningStatusItem
      VideoSizeCalculatorUtil
      LocationUtil
      DJIParamCapability
      DJIError
      DJIDiagnostics
      DJICodecManager
      Stick

      class CustomUnlockZone

      @EXClassNullAway
       class CustomUnlockZone
      Package:dji.common.flightcontroller.flyzone
      Description:

      Users can unlock areas of a restricted fly zone through http://www.dji.com/flysafe/custom-unlock. A user needs to show special authorization (usually from a third party such as a regulatory or managing agency) as part of the process to unlock the area within the restricted fly zone. Therefore each request is unique and customized to the individual. If the request is successful, the unlocked area is tied to the user's account as an Custom Unlock Zone.

      This class contains the properties of an Custom Unlock Zone.

      Class Members:
      method
      getID
      method getID
      int getID()
      Package:dji.common.flightcontroller.flyzone
      Description:

      The unique ID of the Custom Unlock Zone.

      Return:
      intAn int value of the ID.
      method getUnlockZoneType
      UnlockZoneType getUnlockZoneType()
      Package:dji.common.flightcontroller.flyzone
      Description:

      The type of custom unlocking.

      Return:
      UnlockZoneTypeAn enum value of UnlockZoneType.
      method
      getName
      method getName
      String getName()
      Package:dji.common.flightcontroller.flyzone
      Description:

      Name of the Custom Unlock Zone.

      Return:
      StringA string value of the name.
      method
      getCenter
      method getCenter
      LocationCoordinate2D getCenter()
      Package:dji.common.flightcontroller.flyzone
      Description:

      The coordinate of the Custom Unlock Zone's center. Only used when getUnlockZoneType is CIRCLE_UNLOCK_AREA.

      Return:
      LocationCoordinate2DA LocationCoordinate2D object.
      method
      getRadius
      method getRadius
      double getRadius()
      Package:dji.common.flightcontroller.flyzone
      Description:

      The radius of the Custom Unlock Zone in meters. Valid when getUnlockZoneType is CIRCLE_UNLOCK_AREA.

      Return:
      doubleA float value of the radius.
      method getCountry
      String getCountry()
      Package:dji.common.flightcontroller.flyzone
      Description:

      Check country code (https://www.iso.org/iso-3166-country-codes.html) for the custom unlock zone's shape. Valid when getUnlockZoneType is COUNTRY_UNLOCK.

      Return:
      StringThe string of country code.
      method
      getHeight
      method getHeight
      int getHeight()
      Package:dji.common.flightcontroller.flyzone
      Description:

      The unlocked max flight altitude limit in the custom unlock zone. Valid when getUnlockZoneType is HEIGHT_UNLOCK.

      Return:
      intAn int value of max flight altitude.
      method
      getPoints
      method getPoints
      List<LocationCoordinate2D> getPoints()
      Package:dji.common.flightcontroller.flyzone
      Description:

      The vertices (locations) that make up the custom unlock zone shape. Only used when getUnlockZoneType is PENTAGON_UNLOCK.

      Return:
      List<LocationCoordinate2D>A list of LocationCoordinate2D objects.
      method getStartTime
      String getStartTime()
      Package:dji.common.flightcontroller.flyzone
      Description:

      The timestamp of when the unlocking begins, formatted in UTC (YYYY-MM-DD hh:mm:ss).

      Return:
      StringA string value of start time.
      method getEndTime
      String getEndTime()
      Package:dji.common.flightcontroller.flyzone
      Description:

      The timestamp of when the unlocking ends, formatted in UTC (YYYY-MM-DD hh:mm:ss).

      Return:
      StringA String value of the end time.
      method
      isExpired
      method isExpired
      boolean isExpired()
      Package:dji.common.flightcontroller.flyzone
      Description:

      true if the Custom Unlock Zone has expired. After a zone is expired, the location will be locked.

      Return:
      booleanA boolean value to check if is expired.
      enum UnlockZoneType
      enum UnlockZoneType
      Package:dji.common.flysafe
      Description:

      An enum class represents the type of custom unlocking.

      Enum Members:
      CIRCLE_UNLOCK_AREAThe custom unlock zone is a circle.
      COUNTRY_UNLOCKThe custom unlock zone is a country.
      HEIGHT_UNLOCKUnlock the max flight altitude limit in the custom unlock zone.
      PENTAGON_UNLOCKThe custom unlock zone is a polygon.
      UNKNOWNThe custom unlock type is unknown.
      Class Members: