DJI Mobile SDK Documentation

Mobile SDK

      Widget
      FocusExposureSwitchWidget
      MapWidget
      WiFiSignalWidget
      RadarWidget
      HistogramWidget
      AutoExposureLockWidget
      PreFlightStatusWidget
      ConnectionWidget
      FlightModeWidget
      BatteryWidget
      RemoteControlSignalWidget
      GPSSignalWidget
      VideoSignalWidget
      VisionWidget
      DashboardWidget
      CompassWidget
      DistanceHomeWidget
      HorizontalVelocityWidget
      DistanceRCWidget
      VerticalVelocityWidget
      AltitudeWidget
      CameraControlsWidget
      PictureVideoSwitch
      CameraCaptureWidget
      ExposureSettingsMenu
      RemainingFlightTimeWidget
      ColorWaveformWidget
      FPVWidget
      FPVOverlayWidget
      TakeOffWidget
      ReturnHomeWidget
      FocusModeWidget
      CameraConfigShutterWidget
      CameraConfigApertureWidget
      CameraConfigISOAndEIWidget
      CameraConfigWBWidget
      CameraConfigStorageWidget
      CameraConfigSSDWidget
      CameraConfigEVWidget
      CompassCalibratingWorkFlow
      Widgets
      SpeakerWidget
      BeaconWidget
      SpotlightWidget
      Default Layout
      SpeakerPanel
      AccessLockerWidget
      SpotlightPanel
      Panel
      PreFlightCheckListPanel
      CameraSettingAdvancedPanel
      CameraSettingExposurePanel
      RTKStatusPanel

      class FPVOverlayWidget

      class FPVOverlayWidget extends FrameLayoutWidget implements View.OnTouchListener
      Package:dji.ux.widget
      Inherits From:FrameLayoutWidget implements View.OnTouchListener
      Display:

      Single tap will show the selected target on top of the FPVWidget.
      Has two modes with two different icons.

      • Focus mode will have a green square icon.
      • Meter mode will have a yellow circle icon.

      Press and hold will show the gimbal control.

      • Small white dot will stay at where user first taps the screen to indicate the anchor point.
      • Blue circle will follow user's drag. Together with the anchor point, this dictates the gimbal movement.

      When grid mode is turned on (using the CameraSettingAdvancedPanel), this also shows the grid lines. When center point is turned on (using the CameraSettingAdvancedPanel), this also shows the center point.

      Interaction:

      Tapping in focus mode will select that point as focus target point. Tapping in meter mode will select that point as exposure meter target point.

      Press and hold will activate gimbal control mode. Dragging gimbal control will move the gimbal accordingly.

      Usage:

      Should be the same size and placed on top of FPVOverlayWidget.

      Class Members:
      method setSpotMeteringEnabled
      void setSpotMeteringEnabled(boolean isSpotMeteringEnabled)
      Package:dji.ux.widget
      Description:

      Enable or disable spot metering by this method. Enabled by default.

      Input Parameters:
      boolean isSpotMeteringEnabledtrue to enable, false to disable.
      method isSpotMeteringEnabled
      boolean isSpotMeteringEnabled()
      Package:dji.ux.widget
      Description:

      Method to check if spot metering using touch is enabled.

      Return:
      booleantrue if enabled, false if disabled.
      method setGimbalControlEnabled
      void setGimbalControlEnabled(boolean isGimbalControlEnabled)
      Package:dji.ux.widget
      Description:

      Enable or disable gimbal control by this method. Enabled by default.

      Input Parameters:
      boolean isGimbalControlEnabledtrue to enable, false to disable.
      method isGimbalControlEnabled
      boolean isGimbalControlEnabled()
      Package:dji.ux.widget
      Description:

      Method to check if gimbal control using touch is enabled.

      Return:
      booleantrue if enabled, false if disabled.
      method setTouchFocusEnabled
      void setTouchFocusEnabled(boolean isTouhFocusEnabled)
      Package:dji.ux.widget
      Description:

      Enable or disable Touch to Focus by this method. Enabled by default.

      Input Parameters:
      boolean isTouhFocusEnabledtrue to enable, false to disable.
      method isTouchFocusEnabled
      boolean isTouchFocusEnabled()
      Package:dji.ux.widget
      Description:

      Method to check if Touch to Focus is enabled.

      Return:
      booleantrue if enabled, false if disabled.
      method setGridOverlayEnabled
      void setGridOverlayEnabled(boolean isGridOverlayEnabled)
      Package:dji.ux.widget
      Description:

      Defaults to true. If true, FPVOverlayWidget will display grid setting if prompted by the user via the CameraGridListWidget. Setting this to false means the grid will never be displayed.

      Input Parameters:
      boolean isGridOverlayEnabledtrue to enable, false to disable.
      method isGridOverlayEnabled
      boolean isGridOverlayEnabled()
      Package:dji.ux.widget
      Description:

      If true, FPVOverlayWidget will display grid setting if prompted by the user via the CameraGridListWidget. If false, the grid will never be displayed.

      Return:
      booleantrue to enable, false to disable.
      method setCurrentGridOverlayType
      void setCurrentGridOverlayType(GridOverlayType type)
      Package:dji.ux.widget
      Description:

      Sets the type of the grid overlay.

      Input Parameters:
      GridOverlayType typeThe grid overlay type.
      method getCurrentGridOverlayType
      GridOverlayType getCurrentGridOverlayType()
      Package:dji.ux.widget
      Description:

      Gets the current type of the grid overlay.

      Return:
      GridOverlayTypeThe current grid overlay type.
      enum GridOverlayType
      enum GridOverlayType
      Package:dji.ux.widget
      Description:

      Represents the types of grid lines that can be set to be on top of the FPV.

      Enum Members:
      NONENo grid lines are visible.
      PARALLELHorizontal and vertical grid lines are visible using a 3x3 grid.
      PARALLEL_DIAGONALSame as FPVOverlayWidget_GridOverlayType_PARALLEL with the addition of 2 diagonal lines running through the center.
      UNKNOWNThe type of grid is unknown.
      Class Members: