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 HotpointAction

      class HotpointAction extends MissionAction
      Package:dji.sdk.mission.timeline.actions
      Inherits From:MissionAction
      Description:

      This class represents a hotpoint action used as an element in a Timeline mission. By creating an object of this class and adding it to Mission Control's Timeline, the aircraft will fly along a portion of a circle centered on a location of interest when the Timeline reaches the action.

      Class Members:
      Constructor
      method
      HotpointAction
      method HotpointAction
      HotpointAction(HotpointMission hotpointMission)
      Package:dji.sdk.mission.timeline.actions
      Description:

      Initialize with hotpoint mission. The Hotpoint action will automatically stop after one complete orbit (360 degrees).

      Input Parameters:
      HotpointMission hotpointMissionAn object of HotpointMission.
      method HotpointAction
      HotpointAction(HotpointMission mission, float surroundingAngle)
      Package:dji.sdk.mission.timeline.actions
      Description:

      Initialize with a hotpoint mission and the angular distance the aircraft should travel within the orbit.

      Input Parameters:
      HotpointMission missionAn object of HotpointMission.
      float surroundingAngleAngle in degrees.
      Surrounding Angle
      method
      setSurroundingAngle
      method setSurroundingAngle
      void setSurroundingAngle(float surroundingAngle)
      Package:dji.sdk.mission.timeline.actions
      Description:

      The angular distance in degrees the aircraft will travel in the orbit of the hotpoint. The default is 360 degrees.

      Input Parameters:
      float surroundingAngleAngle in degrees
      method getSurroundingAngle
      float getSurroundingAngle()
      Package:dji.sdk.mission.timeline.actions
      Description:

      The angular distance in degrees the aircraft will travel in the orbit of the hotpoint. The default is 360 degrees.

      Return:
      floatAngle in degrees.
      Mission
      method
      getHotpointMission
      method getHotpointMission
      HotpointMission getHotpointMission()
      Package:dji.sdk.mission.timeline.actions
      Description:

      The hotpoint mission which is associated with this action.

      Return:
      HotpointMissionA HotpointMission object.
      Inherited Methods:
      dji.sdk.mission.timeline.actions.MissionAction
      method
      isRunning
      method isRunning
      boolean isRunning()
      Package:dji.sdk.mission.timeline.actions
      Description:

      true if the action is running.

      Return:
      booleanA boolean value.
      Inherited Methods:
      dji.sdk.mission.timeline.TimelineElement
      method
      getTriggers
      method getTriggers
      List<Trigger> getTriggers()
      Package:dji.sdk.mission.timeline
      Description:

      If implemented, Mission Control loads and activates the triggers for the duration that the Timeline element is executing.

      Return:
      List<Trigger>A List of Trigger object.
      method setTriggers
      void setTriggers(List<Trigger> triggers)
      Package:dji.sdk.mission.timeline
      Description:

      Set the triggers array list to the timeline.

      Input Parameters:
      List<Trigger> triggersA list of Trigger objects.
      method isPausable
      boolean isPausable()
      Package:dji.sdk.mission.timeline
      Description:

      true if the element can be paused. If false, then when the Timeline is asked to pause when this element is running, nothing will happen.

      Return:
      booleantrue if the element can be paused.
      method checkValidity
      DJIError checkValidity()
      Package:dji.sdk.mission.timeline
      Description:

      Returns an error if there is a configuration or parameter error in the element. Returns null if there is no issue.

      Return:
      DJIErrorA DJIError object.
      method
      willRun
      method willRun
      void willRun()
      Package:dji.sdk.mission.timeline
      Description:

      If Implemented, this is called by Mission Control right before running the element.

      method
      run
      method run
      void run()
      Package:dji.sdk.mission.timeline
      Description:

      Starts execution of Timeline element. Missions adopting this behavior are being run with their respective operators.

      method
      pause
      method pause
      void pause()
      Package:dji.sdk.mission.timeline
      Description:

      Pauses the execution of the element. Must be implemented if isPausable returns true.

      method
      resume
      method resume
      void resume()
      Package:dji.sdk.mission.timeline
      Description:

      Resumes the execution of the element. Must be implemented if isPausable returns true.

      method
      stop
      method stop
      void stop()
      Package:dji.sdk.mission.timeline
      Description:

      Stops execution of the element.

      method
      didRun
      method didRun
      void didRun()
      Package:dji.sdk.mission.timeline
      Description:

      Called after element execution, regardless of whether or not it was successful.

      method setDelayTime
      void setDelayTime(long delayTime)
      Package:dji.sdk.mission.timeline
      Description:

      Sets the time you want to delay before element execution which is used for asynchronous processing scenarios. For example, if you want to execute GimbalAttitudeAction after ShootPhotoAction, you should set delay time in GimbalAttitudeAction. Because it takes 1 to 2 seconds to take a photo, the gimbal's commands will not be responded during this period, so we need to delay 2 seconds before turning the gimbal to ensure that the gimbal movement is executed correctly.

      Input Parameters:
      long delayTimeThe time you want to delay before element execution, unit:second.
      method getDelayTime
      long getDelayTime()
      Package:dji.sdk.mission.timeline
      Description:

      Gets the time you want to delay before element execution.

      Return:
      longThe time you set to delay before element execution.