DJI Mobile SDK Documentation

      class HotpointMissionOperator

      class HotpointMissionOperator
      Package:dji.sdk.mission.hotpoint
      Description:

      The hotpoint mission operator is the only object that controls, runs and monitors Hotpoint Missions. It can be accessed from MissionControl.

      Class Members:
      Current State
      method
      method getCurrentState
      @NonNull
      HotpointMissionState getCurrentState()
      Package:dji.sdk.mission.hotpoint
      Description:

      The current state of the executing Hotpoint mission executing.

      Return:
      HotpointMissionStateThe state of the Hotpoint mission.
      Add Listener
      method
      method addListener
      void addListener(@NonNull HotpointMissionOperatorListener listener)
      Package:dji.sdk.mission.hotpoint
      Description:

      Adds listener to receive all of the Hotpoint mission operator events.

      Input Parameters:
      @NonNull HotpointMissionOperatorListener listenerListener that is interested in the Hotpoint mission operator.
      Remove Listener
      method
      method removeListener
      void removeListener(@NonNull HotpointMissionOperatorListener targetListener)
      Package:dji.sdk.mission.hotpoint
      Description:

      Removes listener.

      Input Parameters:
      @NonNull HotpointMissionOperatorListener targetListenerListener to be removed.
      method removeAllListeners
      void removeAllListeners()
      Package:dji.sdk.mission.hotpoint
      Description:

      Remove all listeners from listener pool.

      Start Mission
      method
      method startMission
      void startMission(@NonNull final HotpointMission mission, @Nullable final CompletionCallback callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Starts to execute a Hotpoint mission. This only be called when the getCurrentState is READY_TO_EXECUTE. After a mission is started successfully, the getCurrentState will become INITIAL_PHASE or EXECUTING.

      Input Parameters:
      @NonNull final HotpointMission missionAn object of HotpointMission.
      @Nullable final CompletionCallback callbackThe execution callback with the execution result returned.
      Pause Mission
      method
      method pause
      void pause(@Nullable CompletionCallback callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Pauses the executing mission. It can only be called when the getCurrentState is INITIAL_PHASE or EXECUTING. If this method is called in the INITIAL_PHASE state, the aircraft will continue flying to the start point but it will not continue to circle around the hotpoint until the user resumes the mission. After a mission is paused successfully, the getCurrentState will become EXECUTION_PAUSED.

      Input Parameters:
      @Nullable CompletionCallback callbackThe execution callback with the execution result returned.
      Resume Mission
      method
      method resume
      void resume(@Nullable CompletionCallback callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Resumes the paused mission. It can only be called when the getCurrentState is EXECUTION_PAUSED. After a mission is resumed successfully, the getCurrentState will become INITIAL_PHASE or EXECUTING.

      Input Parameters:
      @Nullable CompletionCallback callbackThe execution callback with the execution result returned.
      Stop Mission
      method
      method stop
      void stop(@Nullable CompletionCallback callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Stops the executing or paused mission. It can only be called when getCurrentState is one of the following:

      After a mission is stopped successfully, getCurrentState will become READY_TO_EXECUTE.

      Input Parameters:
      @Nullable CompletionCallback callbackThe execution callback with the execution result returned.
      Get Executing Mission
      method
      method getExecutingMission
      void getExecutingMission(@NonNull HotpointMission mission, @NonNull CompletionCallback callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Gets the executing mission from the aircraft. It can only be called when getCurrentState is one of the following:

      Input Parameters:
      @NonNull HotpointMission missionDetailed information of the mission being executed. setAltitude and setRadius may be different from the initial settings when starting the mission. It is null if there is an error encountered when trying to get the mission.
      @NonNull CompletionCallback callbackThe execution callback with the execution result returned.
      Set Angular Velocity
      method
      method setAngularVelocity
      void setAngularVelocity(float angularVelocity, @Nullable final CompletionCallback callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Sets angular velocity for the executing mission. It can only be called when getCurrentState is one of the following:

      Input Parameters:
      float angularVelocityAngular velocity to set.
      @Nullable final CompletionCallback callbackThe execution callback with the execution result returned.
      Set Radius
      method
      method setRadius
      void setRadius(@FloatRange(from = 5, to = 500) float radius, @Nullable final CompletionCallback callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Sets radius for the executing mission. It can only be called when the getCurrentState is one of the following:

      Input Parameters:
      @FloatRange(from = 5, to = 500) float radiusRadius to set.
      @Nullable final CompletionCallback callbackThe execution callback with the execution result returned.
      Reset Mission Heading
      method
      method resetHeading
      void resetHeading(@Nullable final CompletionCallback callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Resets aircraft's heading to the direction defined by setHeading of HotpointMission. It can only be called when the getCurrentState is one of the following:

      Input Parameters:
      @Nullable final CompletionCallback callbackThe execution callback with the execution result returned.
      Max Angular Velocity
      method
      method getMaxAngularVelocityForRadius
      static void getMaxAngularVelocityForRadius(@FloatRange(from = 5, to = 500) double radius,
      @NonNull final CompletionCallbackWith<Float> callback)
      Package:dji.sdk.mission.hotpoint
      Description:

      Returns the maximum supported angular velocity, in degrees/s, for a given Hotpoint mission radius in meters. Returns 0 if an unsupported radius is specified.

      Input Parameters:
      @FloatRange(from = 5, to = 500) double radiusHotpoint radius with a range of [5,500] meters. This is used to calculate the maximum angular velocity.
      @NonNull final CompletionCallbackWith<Float> callbackThe execution callback with the execution result returned.
      interface HotpointMissionOperatorListener
      interface HotpointMissionOperatorListener
      Package:dji.sdk.mission.hotpoint
      Description:

      Listener interface for listening to Hotpoint mission events.

      Interface Methods:

      Callback Method

      method onExecutionUpdate
      void onExecutionUpdate(@NonNull HotpointMissionEvent event)
      Package:dji.sdk.mission.hotpoint
      Description:

      Called when a new Hotpoint mission event occurs.

      Input Parameters:
      @NonNull HotpointMissionEvent eventUpdated event.
      method onExecutionStart
      void onExecutionStart()
      Package:dji.sdk.mission.hotpoint
      Description:

      Called when the Hotpoint mission starts.

      method onExecutionFinish
      void onExecutionFinish(@Nullable DJIError error)
      Package:dji.sdk.mission.hotpoint
      Description:

      Called when the Hotpoint mission ends.

      Input Parameters:
      @Nullable DJIError errorUsed when mission is finishes in an unexpected way.