DJI Mobile SDK Documentation

      class Gimbal

      class Gimbal extends BaseComponent
      Package:dji.sdk.gimbal
      Inherits From:BaseComponent
      Description:

      This class provides multiple methods to control the gimbal. These include setting the gimbal work mode, rotating the gimbal with angle, starting the gimbal auto calibration, etc. This object is available from the Aircraft or HandHeld object which is a subclass of BaseProduct.

      Class Members:

      State Updates

      General
      method
      method setStateCallback
      void setStateCallback(@Nullable GimbalState.Callback callback)
      Package:dji.sdk.gimbal
      Description:

      Sets up the gimbal state update callback.

      Input Parameters:
      @Nullable GimbalState.Callback callbackThe execution callback.
      method setMovementSettingsCallback
      void setMovementSettingsCallback(@Nullable MovementSettings.Callback callback)
      Package:dji.sdk.gimbal
      Description:

      Sets up the gimbal advanced setting state update callback.

      Input Parameters:
      @Nullable MovementSettings.Callback callbackThe execution callback.
      method setBatteryChargeRemainingCallback
      void setBatteryChargeRemainingCallback(@Nullable BatteryChargeRemainingCallback callback)
      Package:dji.sdk.gimbal
      Description:

      Sets the gimbal remaining energy callback. The unit is percentage.

      Input Parameters:
      @Nullable BatteryChargeRemainingCallback callbackThe execution callback.


      Information

      Gimbal Capability
      method
      method getCapabilities
      Map<CapabilityKey, DJIParamCapability> getCapabilities()
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.CAPABILITIES
      Description:

      Returns the gimbal's features and possible range of settings. Each key is a possible gimbal feature and is in CapabilityKey enum. The value for each key is an instance of DJIParamCapability or its sub-classes. The isSupported property can be used to query if a feature is supported by the gimbal and the getMin and getMax properties of DJIParamMinMaxCapability can be used to query the valid range for the setting. When a feature is not supported, the values for getMin and getMax are undefined.

      Return:
      Map<CapabilityKey, DJIParamCapability>A Map<CapabilityKey, DJIParamCapability> instance.


      Operation Mode

      Set Work Mode
      method
      method setMode
      void setMode(@NonNull final GimbalMode mode, @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.MODE
      Description:

      Sets the gimbal's work mode.

      Input Parameters:
      @NonNull final GimbalMode modeGimbal work mode to be set.
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      Reset Gimbal
      method
      method reset
      void reset(@Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.RESET_GIMBAL
      Description:

      Resets the gimbal. The behaviors are product-dependent. Osmo series (e.g. Osmo, Osmo Pro): The gimbal's pitch and yaw will be set to the origin, which is the standard position for the gimbal. Phantom series (e.g. Phantom 3 Professional, Phantom 4 series): The first call sets gimbal to point down vertically to the earth. The second call sets gimbal to the standard position. Other products (e.g. Inspire 1): Only the gimbal's pitch will the set to the origin.

      Input Parameters:
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.


      Moving the Gimbal

      Rotate Gimbal
      method
      method rotate
      void rotate(@NonNull final Rotation rotation, @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.ROTATE
      Description:

      Rotate gimbal's pitch, roll, and yaw with DJIGimbalRotation. For X5S, X4S and X7, rotating the gimbal with mode RELATIVE_ANGLE or ABSOLUTE_ANGLE, will reset the gimbal mode to FREE.

      Input Parameters:
      @NonNull final Rotation rotationAn instance of Rotation.
      @Nullable final CompletionCallback callbackThe callback of CompletionCallback.


      Calibration

      Calibrate
      method
      method startCalibration
      void startCalibration(@Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.START_CALIBRATION
      Description:

      Starts calibrating the gimbal. The product should be stationary (not flying, or being held) and horizontal during calibration. For gimbal's with adjustable payloads, the payload should be present and balanced before doing a calibration. For Osmo Mobile series, user should double-click the trigger (or mode button on Osmo Mobile 2) or restart the device to re-center the gimbal after the calibration.

      Input Parameters:
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      Fine Tune Roll
      method
      method fineTuneRollInDegrees
      void fineTuneRollInDegrees(@FloatRange(from = -2.0f, to = 2.0f) float offset,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.FINE_TUNE_ROLL_IN_DEGREES
      Description:

      The gimbal roll can be fine tuned with a custom offset. The range for the custom offset is [-2.0, 2.0] degrees. If the offset is negative, the gimbal will be fine tuned the specified number of degrees in the counterclockwise direction.

      Input Parameters:
      @FloatRange(from = -2.0f, to = 2.0f) float offsetFine-tuned offset, in degrees, to be tuned.
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      Fine Tune Pitch
      method
      method fineTunePitchInDegrees
      void fineTunePitchInDegrees(@FloatRange(from = -2.0f, to = 2.0f) float offset,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      Description:

      The gimbal pitch can be fine tuned with a custom offset. The range for the custom offset is [-2.0, 2.0] degrees. If the offset is negative, the gimbal will be fine tuned the specified number of degrees in the counterclockwise direction. It is only supported by Spark and Mavic 2 Series.

      Input Parameters:
      @FloatRange(from = -2.0f, to = 2.0f) float offsetFine-tuned offset, in degrees, to be tuned.
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      Fine Tune Yaw
      method
      method fineTuneYawInDegrees
      void fineTuneYawInDegrees(@FloatRange(from = -2.0f, to = 2.0f) float offset,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      Description:

      The gimbal yaw can be fine tuned with a custom offset. The range for the custom offset is [-2.0, 2.0] degrees. If the offset is negative, the gimbal will be fine tuned the specified number of degrees in the counterclockwise direction. It is only supported by Mavic Air and Mavic 2 Series.

      Input Parameters:
      @FloatRange(from = -2.0f, to = 2.0f) float offsetFine-tuned offset, in degrees, to be tuned.
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      Balance Test
      method
      method startBalanceTest
      void startBalanceTest(@Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.START_BALANCE_TEST
      Description:

      Starts testing the balance of the gimbal payload. For gimbals that allow payloads to be changed, a balance test should be performed to ensure the camera is mounted correctly. The product should be stationary (not flying, or being held) and horizontal during testing. See GimbalState for the test result.

      Input Parameters:
      @Nullable final CompletionCallback callbackThe execution callback with the returned value(s). The callback will execute when the balance test is successfully started.


      Movement Setting

      Gimbal Movement Setting
      method
      method setMovementSettingsProfile
      void setMovementSettingsProfile(@NonNull MovementSettingsProfile profile,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.MOVEMENT_SETTINGS_PROFILE
      Description:

      Sets the movement settings profile. The movement settings profile has options for both preset and custom profiles for SmoothTrack and Controller settings. Settings for SmoothTrack and Controller can only be set manually when using a custom profile.

      Input Parameters:
      @NonNull MovementSettingsProfile profileProfile to set.
      @Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
      method getMovementSettingsProfile
      void getMovementSettingsProfile(
      @NonNull final CompletionCallbackWith<MovementSettingsProfile> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.MOVEMENT_SETTINGS_PROFILE
      Description:

      Gets the advanced settings profile. Use MovementSettingsProfile to check if it is supported by the gimbal.

      Input Parameters:
      @NonNull final CompletionCallbackWith<MovementSettingsProfile> callbackcallback that receives the execution result.
      Load Factory Settings
      method
      method restoreFactorySettings
      void restoreFactorySettings(@Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.RESTORE_FACTORY_SETTINGS
      Description:

      Restores the gimbal's settings to factory settings.

      Input Parameters:
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.


      Range Extension

      Enable Pitch Range Extension
      method
      method setPitchRangeExtensionEnabled
      void setPitchRangeExtensionEnabled(boolean isEnabled,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_RANGE_EXTENSION_ENABLED
      Description:

      Extends the pitch range of gimbal. If extended, the gimbal's pitch control range can be [-30, 90], otherwise, it's [0, 90]. Use PITCH_RANGE_EXTENSION to check if it is supported by the gimbal.

      Input Parameters:
      boolean isEnabledWhether the pitch range should be extended.
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.
      method getPitchRangeExtensionEnabled
      void getPitchRangeExtensionEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_RANGE_EXTENSION_ENABLED
      Description:

      Get the extend gimbal pitch range state. Use PITCH_RANGE_EXTENSION to check if it is supported by the gimbal.

      Input Parameters:
      @NonNull final CompletionCallbackWith<Boolean> callbackThe completion callback that receives execution result.


      Motor Control Configuration

      method applyMotorControlPreset
      void applyMotorControlPreset(@NonNull MotorControlPreset preset,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.APPLY_MOTOR_CONTROL_PRESET
      Description:

      Configures gimbal's motor control with a preset configuration applicable for most popular cameras. In order to the optimize the performance, motor control tuning is still required.

      Input Parameters:
      @NonNull MotorControlPreset presetThe preset configuration to set.
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.
      method setMotorControlStiffness
      void setMotorControlStiffness(@NonNull Axis axis,
      @IntRange(from = 0, to = 100) int stiffness,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_MOTOR_CONTROL_STIFFNESS, GimbalKey.ROLL_MOTOR_CONTROL_STIFFNESS, GimbalKey.YAW_MOTOR_CONTROL_STIFFNESS
      Description:

      Sets the coefficient of speed error control. It can be seen as the coefficient for the proportional term in the PID controller. Use PITCH_MOTOR_CONTROL_STIFFNESS, YAW_MOTOR_CONTROL_STIFFNESS and ROLL_MOTOR_CONTROL_STIFFNESS with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisThe axis that the setting is applied to.
      @IntRange(from = 0, to = 100) int stiffnessThe stiffness value to set.
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.
      method getMotorControlStiffness
      void getMotorControlStiffness(@NonNull final Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_MOTOR_CONTROL_STIFFNESS, GimbalKey.ROLL_MOTOR_CONTROL_STIFFNESS, GimbalKey.YAW_MOTOR_CONTROL_STIFFNESS
      Description:

      Gets the coefficient of speed error control. It can be seen as the coefficient for the proportional term in the PID controller. Use PITCH_MOTOR_CONTROL_STIFFNESS, YAW_MOTOR_CONTROL_STIFFNESS and ROLL_MOTOR_CONTROL_STIFFNESS with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull final Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion callback that receives execution result.
      method setMotorControlStrength
      void setMotorControlStrength(@NonNull Axis axis,
      @IntRange(from = 0, to = 100) int strength,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_MOTOR_CONTROL_STRENGTH, GimbalKey.ROLL_MOTOR_CONTROL_STRENGTH, GimbalKey.YAW_MOTOR_CONTROL_STRENGTH
      Description:

      Sets the coefficient of attitude accuracy control. It can be seen as the coefficient for the integral term in the PID controller. Use PITCH_MOTOR_CONTROL_STRENGTH, YAW_MOTOR_CONTROL_STRENGTH and ROLL_MOTOR_CONTROL_STRENGTH with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisThe axis that the setting is applied to.
      @IntRange(from = 0, to = 100) int strengthThe strength value to set.
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.
      method getMotorControlStrength
      void getMotorControlStrength(@NonNull final Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_MOTOR_CONTROL_STRENGTH, GimbalKey.ROLL_MOTOR_CONTROL_STRENGTH, GimbalKey.YAW_MOTOR_CONTROL_STRENGTH
      Description:

      Gets the coefficient of attitude accuracy control. It can be seen as the coefficient for the integral term in the PID controller. Use PITCH_MOTOR_CONTROL_STRENGTH, YAW_MOTOR_CONTROL_STRENGTH and ROLL_MOTOR_CONTROL_STRENGTH with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull final Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion callback that receives execution result.
      method setMotorControlGyroFilteringFactor
      void setMotorControlGyroFilteringFactor(@NonNull Axis axis,
      @IntRange(from = 0, to = 100) int filteringFactor,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_MOTOR_CONTROL_GYRO_FILTERING_FACTOR, GimbalKey.ROLL_MOTOR_CONTROL_GYRO_FILTERING_FACTOR, GimbalKey.YAW_MOTOR_CONTROL_GYRO_FILTERING_FACTOR
      Description:

      Sets the coefficient of denoising the output. Use PITCH_MOTOR_CONTROL_GYRO_FILTERING_FACTOR, YAW_MOTOR_CONTROL_GYRO_FILTERING_FACTOR and ROLL_MOTOR_CONTROL_GYRO_FILTERING_FACTOR with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @IntRange(from = 0, to = 100) int filteringFactorThe gyro filtering value to set.
      @NonNull Axis axisThe axis that the setting is applied to.
      @Nullable final CompletionCallback callbackAsynchronous execution result.
      method getMotorControlGyroFilteringFactor
      void getMotorControlGyroFilteringFactor(@NonNull final Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_MOTOR_CONTROL_GYRO_FILTERING_FACTOR, GimbalKey.ROLL_MOTOR_CONTROL_GYRO_FILTERING_FACTOR, GimbalKey.YAW_MOTOR_CONTROL_GYRO_FILTERING_FACTOR
      Description:

      Gets the coefficient of denoising the output. Use PITCH_MOTOR_CONTROL_GYRO_FILTERING_FACTOR, YAW_MOTOR_CONTROL_GYRO_FILTERING_FACTOR and ROLL_MOTOR_CONTROL_GYRO_FILTERING_FACTOR with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull final Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion callback that receives execution result.
      method setMotorControlPreControl
      void setMotorControlPreControl(@NonNull Axis axis,
      @IntRange(from = 0, to = 100) int preControl,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_MOTOR_CONTROL_PRE_CONTROL, GimbalKey.ROLL_MOTOR_CONTROL_PRE_CONTROL, GimbalKey.YAW_MOTOR_CONTROL_PRE_CONTROL
      Description:

      Sets the value for pre-adjust. It can be seen as the coefficient for the derivative term in the PID controller. Use PITCH_MOTOR_CONTROL_PRE_CONTROL, YAW_MOTOR_CONTROL_PRE_CONTROL and ROLL_MOTOR_CONTROL_PRE_CONTROL with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisThe axis that the setting is applied to.
      @IntRange(from = 0, to = 100) int preControlThe Precontrol value to set.
      @Nullable final CompletionCallback callbackAsynchronous execution result.
      method getMotorControlPreControl
      void getMotorControlPreControl(@NonNull final Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_MOTOR_CONTROL_PRE_CONTROL, GimbalKey.ROLL_MOTOR_CONTROL_PRE_CONTROL, GimbalKey.YAW_MOTOR_CONTROL_PRE_CONTROL
      Description:

      Gets the value for pre-adjust. It can be seen as the coefficient for the derivative term in the PID controller. Only supported by Ronin-MX. Use PITCH_MOTOR_CONTROL_PRE_CONTROL, YAW_MOTOR_CONTROL_PRE_CONTROL and ROLL_MOTOR_CONTROL_PRE_CONTROL with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull final Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion callback that receives execution result.


      Controller Setting

      Deadband
      method
      method setControllerDeadband
      void setControllerDeadband(@NonNull Axis axis,
      @IntRange(from = 0, to = 90) int deadband,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_CONTROLLER_DEADBAND, GimbalKey.YAW_CONTROLLER_DEADBAND
      Description:

      Sets physical controller (e.g. the joystick on Osmo or the remote controller of the aircraft) deadband on an axis. A larger deadband requires more controller movement to start gimbal motion. Use YAW_CONTROLLER_DEADBAND and PITCH_CONTROLLER_DEADBAND with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @IntRange(from = 0, to = 90) int deadbandThe deadband value to be set.
      @NonNull Axis axisThe axis that the setting will be applied to.
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.
      method getControllerDeadband
      void getControllerDeadband(@NonNull final Axis direction,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_CONTROLLER_DEADBAND, GimbalKey.YAW_CONTROLLER_DEADBAND
      Description:

      Gets physical controller deadband value on an axis. A larger deadband requires more controller movement to start gimbal motion. Use YAW_CONTROLLER_DEADBAND and PITCH_CONTROLLER_DEADBAND with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull final Axis directionThe axis to query.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion callback that receives execution result.
      method setControllerSpeedCoefficient
      void setControllerSpeedCoefficient(@NonNull Axis axis,
      @IntRange(from = 0, to = 100) int speedCoefficient,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_CONTROLLER_SPEED_COEFFICIENT, GimbalKey.YAW_CONTROLLER_SPEED_COEFFICIENT
      Description:

      Sets physical controller (e.g. the joystick on Osmo or the remote controller of the aircraft) speed on an axis. Speed setting controls the mapping between the movement of the controller and the gimbal speed. Use YAW_CONTROLLER_SPEED_COEFFICIENT and PITCH_CONTROLLER_SPEED_COEFFICIENT with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @IntRange(from = 0, to = 100) int speedCoefficientThe speed value to be set.
      @NonNull Axis axisThe axis that the setting will be applied to.
      @Nullable final CompletionCallback callbackAsynchronous execution result.
      method getControllerSpeedCoefficient
      void getControllerSpeedCoefficient(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_CONTROLLER_SPEED_COEFFICIENT, GimbalKey.YAW_CONTROLLER_SPEED_COEFFICIENT
      Description:

      Gets physical controller speed value on an axis. Speed setting controls the mapping between the movement of the controller and the gimbal speed. Use YAW_CONTROLLER_SPEED_COEFFICIENT and PITCH_CONTROLLER_SPEED_COEFFICIENT with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion block that receives execution result.
      method setControllerSmoothingFactor
      void setControllerSmoothingFactor(@NonNull Axis axis,
      @IntRange(from = 0, to = 30) int smoothingFactor,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_CONTROLLER_SMOOTHING_FACTOR, GimbalKey.YAW_CONTROLLER_SMOOTHING_FACTOR
      Description:

      Sets physical controller (e.g. the joystick on Osmo or the remote controller of the aircraft) smoothing on an axis. Smoothing controls the deceleration of the gimbal. Use YAW_CONTROLLER_SMOOTHING_FACTOR and PITCH_CONTROLLER_SMOOTHING_FACTOR with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @IntRange(from = 0, to = 30) int smoothingFactorThe smoothing value to be set.
      @NonNull Axis axisThe axis that the setting will be applied to.
      @Nullable final CompletionCallback callbackThe completion block that receives execution result.
      method getControllerSmoothingFactor
      void getControllerSmoothingFactor(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_CONTROLLER_SMOOTHING_FACTOR, GimbalKey.YAW_CONTROLLER_SMOOTHING_FACTOR
      Description:

      Gets physical controller smoothing value on an axis. Smoothing controls the deceleration of the gimbal. Use YAW_CONTROLLER_SMOOTHING_FACTOR and PITCH_CONTROLLER_SMOOTHING_FACTOR with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion block that receives execution result.
      Max Speed
      method
      method setControllerMaxSpeed
      void setControllerMaxSpeed(@NonNull Axis axis,
      @IntRange(from = 0, to = 100) int maxSpeed,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      Description:

      Gets physical controller max speed value on an axis. It controls the mapping between the movement of the controller and the gimbal speed. Use PITCH_CONTROLLER_MAX_SPEED and YAW_CONTROLLER_MAX_SPEED with "capabilities" to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisThe axis that the setting will be applied to.
      @IntRange(from = 0, to = 100) int maxSpeedThe maximum speed to set for one axis.
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.
      method getControllerMaxSpeed
      void getControllerMaxSpeed(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      Description:

      Gets physical controller max speed value on an axis. It controls the mapping between the movement of the controller and the gimbal speed. Use PITCH_CONTROLLER_MAX_SPEED and YAW_CONTROLLER_MAX_SPEED with "capabilities" to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion callback that receives execution result.


      Smooth Track Setting

      method setSmoothTrackEnabled
      void setSmoothTrackEnabled(@NonNull Axis axis,
      boolean enabled,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_SMOOTH_TRACK_ENABLED, GimbalKey.YAW_SMOOTH_TRACK_ENABLED
      Description:

      Enables SmoothTrack for the axis. Only supported by Osmo. Ronin-MX supports SmoothTrack but it is always enabled for both pitch axis and yaw axis. Use PITCH_SMOOTH_TRACK_ENABLED and YAW_SMOOTH_TRACK_ENABLED with getCapabilities to check if the gimbal supports this feature.

      Input Parameters:
      boolean enabledtrue to enable SmoothTrack on the axis.
      @NonNull Axis axisThe axis that the setting will be applied to.
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.
      method getSmoothTrackEnabled
      void getSmoothTrackEnabled(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Boolean> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_SMOOTH_TRACK_ENABLED, GimbalKey.YAW_SMOOTH_TRACK_ENABLED
      Description:

      Gets whether an axis has SmoothTrack enabled. Only supported by Osmo. Ronin-MX supports SmoothTrack but it is always enabled for both pitch axis and yaw axis. Use PITCH_SMOOTH_TRACK_ENABLED and YAW_SMOOTH_TRACK_ENABLED with getCapabilities to check if the gimbal supports this feature.

      Input Parameters:
      @NonNull Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Boolean> callbackThe completion callback that receives execution result.
      method setSmoothTrackSpeed
      void setSmoothTrackSpeed(@NonNull Axis axis,
      @IntRange(from = 0, to = 100) int speed,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_SMOOTH_TRACK_SPEED, GimbalKey.YAW_SMOOTH_TRACK_SPEED
      Description:

      Sets gimbal SmoothTrack catch up speed on an axis. SmoothTrack speed determines how fast the gimbal will catch up with a large, translated handle movement. Use PITCH_SMOOTH_TRACK_SPEED and YAW_SMOOTH_TRACK_SPEED with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisGimbal axis.
      @IntRange(from = 0, to = 100) int speedSmoothTrack speed.
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      method getSmoothTrackSpeed
      void getSmoothTrackSpeed(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_SMOOTH_TRACK_SPEED, GimbalKey.YAW_SMOOTH_TRACK_SPEED
      Description:

      Gets gimbal SmoothTrack speed on an axis. SmoothTrack speed determines how fast the gimbal will catch up with a large, translated handle movement. Use PITCH_SMOOTH_TRACK_SPEED and YAW_SMOOTH_TRACK_SPEED with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisGimbal axis.
      @NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned value(s).
      method setSmoothTrackDeadband
      void setSmoothTrackDeadband(@NonNull Axis axis,
      @IntRange(from = 0, to = 90) int deadband,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.YAW_SMOOTH_TRACK_DEADBAND, GimbalKey.PITCH_SMOOTH_TRACK_DEADBAND
      Description:

      Sets SmoothTrack deadband on an axis. A larger deadband requires more handle movement to translate into gimbal motion. Use PITCH_SMOOTH_TRACK_DEADBAND and YAW_SMOOTH_TRACK_DEADBAND with getCapabilities to check if the gimbal supports this feature and the range of possible values in degrees.

      Input Parameters:
      @NonNull Axis axisGimbal axis.
      @IntRange(from = 0, to = 90) int deadbandSmoothTrack deadband [0,90].
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      method getSmoothTrackDeadband
      void getSmoothTrackDeadband(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.YAW_SMOOTH_TRACK_DEADBAND, GimbalKey.PITCH_SMOOTH_TRACK_DEADBAND
      Description:

      Gets SmoothTrack deadband on an axis. A larger deadband requires more handle movement to translate into gimbal motion. Use PITCH_SMOOTH_TRACK_DEADBAND and YAW_SMOOTH_TRACK_DEADBAND with getCapabilities to check if the gimbal supports this feature and the range of possible values in degrees.

      Input Parameters:
      @NonNull Axis axisGimbal axis.
      @NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned execution result.
      Acceleration
      method
      method setSmoothTrackAcceleration
      void setSmoothTrackAcceleration(@NonNull Axis axis,
      @IntRange(from = 0, to = 30) int acceleration,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.YAW_SMOOTH_TRACK_ACCELERATION, GimbalKey.PITCH_SMOOTH_TRACK_ACCELERATION
      Description:

      Sets SmoothTrack acceleration on an axis. Acceleration determines how closely the camera will follow the translated yaw handle movement. Use PITCH_SMOOTH_TRACK_ACCELERATION and YAW_SMOOTH_TRACK_ACCELERATION with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisGimbal axis.
      @IntRange(from = 0, to = 30) int accelerationSmoothTrack acceleration [0,30].
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      method getSmoothTrackAcceleration
      void getSmoothTrackAcceleration(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.YAW_SMOOTH_TRACK_ACCELERATION, GimbalKey.PITCH_SMOOTH_TRACK_ACCELERATION
      Description:

      Gets SmoothTrack acceleration on an axis. Acceleration determines how closely the camera will follow the translated yaw handle movement. Use PITCH_SMOOTH_TRACK_ACCELERATION and YAW_SMOOTH_TRACK_ACCELERATION with getCapabilities to check if the gimbal supports this feature and the range of possible values (unitless).

      Input Parameters:
      @NonNull Axis axisGimbal axis.
      @NonNull final CompletionCallbackWith<Integer> callbackThe execution callback with the returned execution result.


      Endpoint Setting

      Set Endpoint
      method
      method setEndpoint
      void setEndpoint(@NonNull EndpointDirection direction,
      @IntRange(from = 0, to = 179) int endpoint,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_UP_ENDPOINT, GimbalKey.YAW_RIGHT_ENDPOINT, GimbalKey.YAW_RIGHT_ENDPOINT, GimbalKey.YAW_LEFT_ENDPOINT, GimbalKey.PITCH_DOWN_ENDPOINT
      Description:

      Endpoint settings determine the farthest points to which the gimbal will rotate during manual controller input. Only supported by Ronin-MX. Use PITCH_UP_ENDPOINT, PITCH_DOWN_ENDPOINT, YAW_LEFT_ENDPOINT and YAW_RIGHT_ENDPOINT in getCapabilities to check if the gimbal supports this feature and what the valid range of endpoints are.

      Input Parameters:
      @IntRange(from = 0, to = 179) int endpointThe endpoint value to set.
      @NonNull EndpointDirection directionThe direction that the setting will be applied to.
      @Nullable final CompletionCallback callbackThe completion callback that receives execution result.
      Get Endpoint
      method
      method getEndpoint
      void getEndpoint(@NonNull final EndpointDirection direction,
      @NonNull final CompletionCallbackWith<Integer> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.PITCH_UP_ENDPOINT, GimbalKey.YAW_RIGHT_ENDPOINT, GimbalKey.YAW_RIGHT_ENDPOINT, GimbalKey.YAW_LEFT_ENDPOINT
      Description:

      Gets the farthest points to which the gimbal will rotate during manual controller input. Use PITCH_UP_ENDPOINT, PITCH_DOWN_ENDPOINT, YAW_LEFT_ENDPOINT and YAW_RIGHT_ENDPOINT with getCapabilities to check if the gimbal supports this feature.

      Input Parameters:
      @NonNull final EndpointDirection directionThe endpoint direction.
      @NonNull final CompletionCallbackWith<Integer> callbackThe completion callback that receives execution result.


      Other Settings

      Enable Motor
      method
      method setMotorEnabled
      void setMotorEnabled(boolean enabled, @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.MOTOR_ENABLED
      Description:

      Turns on and off the gimbal motors. false means the gimbal power remains on, however the motors will not work.

      Input Parameters:
      boolean enabledtrue to enable the motor.
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      method getMotorEnabled
      void getMotorEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.MOTOR_ENABLED
      Description:

      Determines whether the gimbal motors are enabled to work or not.

      Input Parameters:
      @NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
      Toggle Gimbal Selfie
      method
      method toggleSelfie
      void toggleSelfie(@Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.TOGGLE_SELFIE
      Description:

      Resets gimbal position to selfie setup. If the gimbal yaw is not at 180 degrees, then calling this method will rotate the gimbal yaw to 180 degrees (effectively pointing the camera to the person holding the gimbal). If the gimbal yaw is at 180 degrees, then the gimbal will rotate in yaw to 0 degrees. It's only supported by DJI OSMO, OSMO Pro and OSMO Raw.

      Input Parameters:
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      Gimbal Controller Mode
      method
      method setControllerMode
      void setControllerMode(@NonNull ControllerMode mode,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.CONTROLLER_MODE
      Description:

      Sets the gimbal's controller mode. The control mode for the gimbal controller (joystick for Osmo). The total controller deflection is a combination of horizontal and vertical deflection. This translates to gimbal movement around the yaw and pitch axes. The gimbal can be set to either move in both yaw and pitch simultaneously based on horizontal and vertical deflection of the controller, or move in only yaw or pitch exclusively based on whether horizontal or vertical deflection is larger.

      Input Parameters:
      @NonNull ControllerMode modeSee enum named ControllerMode in DJIGimbal to find details on different gimbal stick control modes.
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      method getControllerMode
      void getControllerMode(@NonNull final CompletionCallbackWith<ControllerMode> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.CONTROLLER_MODE
      Description:

      Gets the gimbal's controller mode.

      Input Parameters:
      @NonNull final CompletionCallbackWith<ControllerMode> callbackThe execution callback with the returned value(s).
      Inverted Control
      method
      method setInvertedControlEnabled
      void setInvertedControlEnabled(@NonNull Axis axis,
      boolean enabled,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.YAW_INVERTED_CONTROL_ENABLED, GimbalKey.PITCH_INVERTED_CONTROL_ENABLED
      Description:

      Inverts the physical control for gimbal movement on an axis. The setting can only be applied to the pitch or yaw axis.

      Input Parameters:
      boolean enabledtrue to enable inverted control.
      @NonNull Axis axisThe axis that the setting will be applied to.
      @Nullable final CompletionCallback callbackThe execution callback with the returned execution result.
      method getInvertedControlEnabled
      void getInvertedControlEnabled(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Boolean> callback)
      Package:dji.sdk.gimbal
      SDK Key:GimbalKey.YAW_INVERTED_CONTROL_ENABLED, GimbalKey.PITCH_INVERTED_CONTROL_ENABLED
      Description:

      Determines whether the physical control is inverted for gimbal movement on an axis. The setting can only be applied to the pitch or yaw axis.

      Input Parameters:
      @NonNull Axis axisThe axis to query.
      @NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
      Attitude Synchronization
      method
      method setAttitudeSynchronizationEnabled
      void setAttitudeSynchronizationEnabled(boolean enabled,
      @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      Description:

      Synchronizes the attitude of port (left) gimbal and starboard (right) gimbal. It is only valid when both gimbals are connected. If only 1 gimbal is connected, this setting will be reset to false. Enables this setting will reset getControllingGimbalIndex to index 0. It is only supported by M210 and M210 RTK.

      Input Parameters:
      boolean enabledtrue to enable the synchronization.
      @Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
      method getAttitudeSynchronizationEnabled
      void getAttitudeSynchronizationEnabled(@NonNull Axis axis,
      @NonNull final CompletionCallbackWith<Boolean> callback)
      Package:dji.sdk.gimbal
      Description:

      Determines whether both gimbals' attitudes are synchronized. If only 1 gimbal is connected, this setting will be reset to false. It is only supported by M210 and M210 RTK.

      Input Parameters:
      @NonNull Axis axisAn enum value of Axis.
      @NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).
      Yaw Simultaneous Follow
      method
      method setYawSimultaneousFollowEnabled
      void setYawSimultaneousFollowEnabled(boolean isEnabled, @Nullable final CompletionCallback callback)
      Package:dji.sdk.gimbal
      Description:

      Enables this to make the gimbal respond to the controller command to rotate aircraft's heading. Enabling this setting makes gimbal rotate simultaneously with aircraft's heading when the user is controlling the aircraft's heading with the remote controller.

      Input Parameters:
      boolean isEnabledtrue to enable yaw simultaneous follow.
      @Nullable final CompletionCallback callbackThe execution callback with the returned value(s).
      method getYawSimultaneousFollowEnabled
      void getYawSimultaneousFollowEnabled(@NonNull final CompletionCallbackWith<Boolean> callback)
      Package:dji.sdk.gimbal
      Description:

      Determines whether yaw simultaneous follow is enabled. Enabling this setting makes gimbal rotate simultaneously with aircraft's heading when the user is controlling the aircraft's heading with the remote controller.

      Input Parameters:
      @NonNull final CompletionCallbackWith<Boolean> callbackThe execution callback with the returned value(s).


      General
      class
      enum
      enum Axis
      @EXClassNullAway
      enum Axis
      Package:dji.common.gimbal
      Description:

      Gimbal Axis.

      Enum Members:
      YAWGimbal's yaw axis.
      PITCHGimbal's pitch axis.
      ROLLGimbal's roll axis.
      Class Members:
      enum GimbalMode
      @EXClassNullAway
      enum GimbalMode
      Package:dji.common.gimbal
      SDK Key:GimbalKey.MODE
      Description:

      Gimbal work modes.

      Enum Members:
      FREEThe gimbal can move independently of the aircraft's yaw. In this mode, even if the aircraft yaw changes, the camera will continue pointing in the same world direction. This mode is only available for the Ronin-MX when the M600 or M600 Pro landing gear is retracted.
      FPVThe gimbal's work mode is FPV mode. In this mode, the gimbal yaw will follow the aircraft's heading, and the gimbal roll will follow the RC's roll channel value. The pitch will be available to move. This mode is only available for the Ronin-MX when the M600 landing gear is retracted.
      YAW_FOLLOWThe gimbal's work mode is such that it will follow the yaw. In this mode, the gimbal yaw will be fixed, while pitch and roll will be available to move.
      UNKNOWNThe gimbal's work mode is unknown.
      Class Members:
      enum BalanceTestResult
      @EXClassNullAway
      enum BalanceTestResult
      Package:dji.common.gimbal
      SDK Key:GimbalKey.PITCH_TEST_RESULT, GimbalKey.ROLL_TEST_RESULT
      Description:

      For gimbals that allow payloads to be changed, a balance test should be performed to ensure the camera is mounted correctly.

      Enum Members:
      PASSThe balance test result is great.
      MARGINALThe balance test result is good. When this result is returned, it is possible there was some noise in the balance measurement. For best results, it is recommended to run the balance test again and adjust the payload position until the result becomes great.
      FAILThe balance test result is bad. The payload should be adjusted when this result is returned.
      UNKNOWNThe balance test result is unknown.
      Class Members:
      enum MovementSettingsProfile
      @EXClassNullAway
      enum MovementSettingsProfile
      Package:dji.common.gimbal
      SDK Key:GimbalKey.MOVEMENT_SETTINGS_PROFILE
      Description:

      The Movement Settings Profile contains presets for SmoothTrack and the Physical Controller sensitivity. SmoothTrack and Controller settings can only be manually changed if Custom1 or Custom2 profiles are selected.

      Enum Members:
      FASTThe gimbal's SmoothTrack and Controller sensitivity is high. When the gimbal is using this profile, user cannot change the Movement Settings manually.
      MEDIUMThe gimbal's SmoothTrack and Controller sensitivity is medium. When the gimbal is using this profile, user cannot change the Movement Settings manually.
      SLOWThe gimbal's SmoothTrack and Controller sensitivity is slow. When the gimbal is using this profile, user cannot change the Movement Settings manually.
      CUSTOM_1The gimbal uses a custom configuration in memory slot 1 where the yaw and pitch speed, deadband, and acceleration can be defined.
      CUSTOM_2The gimbal uses a custom configuration in memory slot 2 where the yaw and pitch speed, deadband, and acceleration can be defined.
      UNKNOWNThe gimbal's user config type is unknown.
      Class Members:
      enum MotorControlPreset
      @EXClassNullAway
      enum MotorControlPreset
      Package:dji.common.gimbal
      SDK Key:GimbalKey.APPLY_MOTOR_CONTROL_PRESET
      Description:

      Different cameras have different preset parameters for gimbal motor stiffness, strength, gyro filtering and pre-control.

      Enum Members:
      REDThe gimbal's motor control configuration is optimized for RED cameras.
      DSLRThe gimbal's motor control configuration is optimized for most DSLR cameras.
      MIRRORLESSThe gimbal's motor control configuration is optimized for most mirrorless cameras.
      Class Members:
      enum EndpointDirection
      @EXClassNullAway
      enum EndpointDirection
      Package:dji.common.gimbal
      Description:

      Gimbal endpoint setting.

      Enum Members:
      PITCH_UPPitch (also called tilt) endpoint setting in the upwards direction.
      PITCH_DOWNPitch (also called tilt) endpoint setting in the downwards direction.
      YAW_LEFTYaw (also called pan) endpoint setting in the left direction.
      YAW_RIGHTYaw (also called pan) endpoint setting in the right direction.
      Class Members:
      enum BalanceState
      @EXClassNullAway
      enum BalanceState
      Package:dji.common.gimbal
      SDK Key:GimbalKey.BALANCE_STATE
      Description:

      The loading balance status of the gimbal. The gimbal loading is changeable for Osmo Mobile. When the mounted mobile device is changed, in order to optimize the gimbal performance, user can adjust the gimbal physically based on the status.

      Enum Members:
      BALANCEDThe gimbal is balanced.
      TILTING_LEFTThe gimbal is tilting left. Adjust the photo to the right hand side to balance the gimbal.
      TILTING_RIGHTThe gimbal is tilting right. Adjust the photo to the left hand side to balance the gimbal.
      UNKNOWNThe balance status is unknown.
      Class Members:
      enum CapabilityKey
      @EXClassNullAway
      enum CapabilityKey
      Package:dji.common.gimbal
      Description:

      These enums are keys for gimbal capability map.

      Enum Members:
      ADJUST_PITCHKey enum in the getCapabilities dictionary that holds the complete capability of the gimbal. A negative value in the valid range represents counter-clockwise rotation. A positive value in the valid range represents clockwise rotation.
      ADJUST_YAWKey enum in getCapabilities associated with whether the gimbal supports yaw axis adjustment. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range in degrees is returned. A negative value in the valid range represents counter-clockwise rotation. A positive value in the valid range represents clockwise rotation. For Gimbal's that allow a pitch range extension (see PITCH_RANGE_EXTENSION, the range will be representative of the extended range whether it is enabled or not.
      ADJUST_ROLLKey enum in getCapabilities associated with whether the gimbal supports roll axis adjustment. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range in degrees is returned. A negative value in the valid range represents counter-clockwise rotation. A positive value in the valid range represents clockwise rotation.
      MOVEMENT_SETTINGSKey enum string in getCapabilities associated with whether the gimbal supports Advanced Settings Profiles. The corresponding value in getCapabilities is an instance of DJIParamCapability.
      PITCH_RANGE_EXTENSIONKey enum in getCapabilities associated with whether the gimbal supports a range extension in pitch. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range in degrees is returned.
      PITCH_CONTROLLER_SPEED_COEFFICIENTKey enum in getCapabilities associated with whether the gimbal's pitch axis response speed to manual control can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_CONTROLLER_SPEED_COEFFICIENTKey enum in getCapabilities associated with whether the gimbal's yaw axis response speed to manual control can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_CONTROLLER_SMOOTHING_FACTORKey enum in getCapabilities associated with whether the gimbal's pitch axis smoothing can be adjusted when using manual control. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_CONTROLLER_SMOOTHING_FACTORKey enum in getCapabilities associated with whether the gimbal's yaw axis smoothing can be adjusted when using manual control. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_CONTROLLER_DEADBANDKey enum in getCapabilities associated with whether the gimbal's manual control pitch axis deadband can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_CONTROLLER_DEADBANDKey enum in getCapabilities associated with whether the gimbal's manual control yaw axis deadband can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_CONTROLLER_MAX_SPEEDKey in getCapabilities associated with whether the gimbal's manual control pitch axis max speed can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_CONTROLLER_MAX_SPEEDKey in getCapabilities associated with whether the gimbal's manual control yaw axis max speed can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_SMOOTH_TRACK_ENABLEDKey enum in getCapabilities associated with whether the gimbal's pitch axis SmoothTrack can be toggled. The corresponding value in getCapabilities is an instance of DJIParamCapability. Ronin-MX cannot toggle the SmoothTrack functionality and it is always enabled.
      YAW_SMOOTH_TRACK_ENABLEDKey enum in getCapabilities associated with whether the gimbal's yaw axis SmoothTrack can be toggled. The corresponding value in getCapabilities is an instance of DJIParamCapability. Ronin-MX cannot toggle the SmoothTrack functionality and it is always enabled.
      PITCH_SMOOTH_TRACK_ACCELERATIONKey enum in getCapabilities associated with whether the gimbal's pitch axis SmoothTrack acceleration can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_SMOOTH_TRACK_ACCELERATIONKey enum in getCapabilities associated with whether the gimbal's yaw axis SmoothTrack acceleration can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_SMOOTH_TRACK_SPEEDKey enum in getCapabilities associated with whether the gimbal's pitch axis SmoothTrack speed can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_SMOOTH_TRACK_SPEEDKey enum in getCapabilities associated with whether the gimbal's yaw axis SmoothTrack speed can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_SMOOTH_TRACK_DEADBANDKey enum in getCapabilities associated with whether the gimbal's pitch axis SmoothTrack deadband can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_SMOOTH_TRACK_DEADBANDKey enum in getCapabilities associated with whether the gimbal's yaw axis SmoothTrack deadband can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_UP_ENDPOINTKey enum in getCapabilities associated with whether the gimbal's pitch up endpoint can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_DOWN_ENDPOINTKey enum in getCapabilities associated with whether the gimbal's pitch down endpoint can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_LEFT_ENDPOINTKey enum in getCapabilities associated with whether the gimbal's yaw left endpoint can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_RIGHT_ENDPOINTKey enum in getCapabilities associated with whether the gimbal's yaw right endpoint can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_MOTOR_CONTROL_STIFFNESSKey enum in getCapabilities associated with whether the gimbal's pitch axis motor control stiffness can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_MOTOR_CONTROL_STIFFNESSKey enum in getCapabilities associated with whether the gimbal's yaw axis motor control stiffness can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      ROLL_MOTOR_CONTROL_STIFFNESSKey enum in getCapabilities associated with whether the gimbal's roll axis motor control stiffness can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_MOTOR_CONTROL_STRENGTHKey enum in getCapabilities associated with whether the gimbal's pitch axis motor control strength can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_MOTOR_CONTROL_STRENGTHKey enum in getCapabilities associated with whether the gimbal's yaw axis motor control strength can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      ROLL_MOTOR_CONTROL_STRENGTHKey enum in getCapabilities associated with whether the gimbal's roll axis motor control strength can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_MOTOR_CONTROL_GYRO_FILTERING_FACTORKey enum in getCapabilities associated with whether the gimbal's pitch axis motor control gyro filtering can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_MOTOR_CONTROL_GYRO_FILTERING_FACTORKey enum in getCapabilities associated with whether the gimbal's yaw axis motor control gyro filtering can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      ROLL_MOTOR_CONTROL_GYRO_FILTERING_FACTORKey enum in getCapabilities associated with whether the gimbal's roll axis motor control gyro filtering can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      PITCH_MOTOR_CONTROL_PRE_CONTROLKey enum in getCapabilities associated with whether the gimbal's pitch axis motor control "precontrol" can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      YAW_MOTOR_CONTROL_PRE_CONTROLKey enum in getCapabilities associated with whether the gimbal's yaw axis motor control "precontrol" can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      ROLL_MOTOR_CONTROL_PRE_CONTROLKey enum in getCapabilities associated with whether the gimbal's roll axis motor control "precontrol" can be adjusted. The corresponding value in getCapabilities is an instance of DJIParamMinMaxCapability meaning both the feature's existence as well as its possible range (unitless) is returned.
      Class Members:
      interface
      interface Callback
      interface Callback
      Package:dji.common.gimbal
      Description:

      Callback for updating the gimbal's current state.

      Interface Methods:

      Callback Method

      State
      method
      method onUpdate
      void onUpdate(@NonNull GimbalState gimbalState)
      Package:dji.common.gimbal
      Description:

      Updates the gimbal's current state.

      Input Parameters:
      @NonNull GimbalState gimbalStateThe gimbal state.
      interface
      interface Callback
      interface Callback
      Package:dji.common.gimbal
      Description:

      This interface provides the method to receive the updated state and user configuration.

      Interface Methods:

      Callback Method

      State
      method
      method onUpdate
      void onUpdate(@NonNull MovementSettings settings)
      Package:dji.common.gimbal
      Description:

      Update the gimbal's user configuration data. This method is only supported by Osmo series.

      Input Parameters:
      @NonNull MovementSettings settingsAn instance of MovementSettings.
      interface BatteryChargeRemainingCallback
      interface BatteryChargeRemainingCallback
      Package:dji.sdk.gimbal
      Description:

      Gimbal energy remaining of Ronin MX in percent.

      Interface Methods:

      Protocol Method

      State
      method
      method onUpdate
      void onUpdate(@IntRange(from = 0, to = 100) int remainingChargeInPercent)
      Package:dji.sdk.gimbal
      Description:

      Update the gimbal's remaining energy in percentage.

      Input Parameters:
      @IntRange(from = 0, to = 100) int remainingChargeInPercentAn int value.
      Inherited Methods:
      dji.sdk.base.BaseComponent
      method
      method setComponentListener
      void setComponentListener(ComponentListener listener)
      Package:dji.sdk.base
      Description:

      Sets the listener for the DJI component.

      Input Parameters:
      ComponentListener listenerThe callback of ComponentListener.
      method
      method getIndex
      int getIndex()
      Package:dji.sdk.base
      Description:

      Returns the component index. Index is zero based. A component will have an index greater than zero when there are multiple components of the same type on the DJI product, and one of the components already has the index 0. For instance, M210 can have two gimbal mounted cameras, and will therefore have two gimbal components with indices 0 and 1, and two camera components with indices 0 and 1. For Matrice 600, there are printed numbers on the battery boxes. The Battery component instance with index 0 corresponds to battery compartment number 1. For Inspire 2 and M200 series, Battery with index 0 corresponds to the battery on the port (left hand) side of the aircraft. For M210 and M210 RTK, Camera and Gimbal with index 0 corresponds to the camera and gimbal on the port (left hand) side of the aircraft.

      Return:
      intAn int value of index.
      method isConnected
      boolean isConnected()
      Package:dji.sdk.base
      Description:

      true if the component is connected.

      Return:
      booleantrue if the component is connected.
      method getSerialNumber
      void getSerialNumber(@NonNull CompletionCallbackWith<String> callback)
      Package:dji.sdk.base
      Description:

      Gets the serial number of the component. Depending on the component, this serial number might not match the serial number found on the physical component.

      Input Parameters:
      @NonNull CompletionCallbackWith<String> callbackThe execution callback with the value returned.
      method getFirmwareVersion
      void getFirmwareVersion(@NonNull CompletionCallbackWith<String> callback)
      Package:dji.sdk.base
      Description:

      Returns the firmware version of the component. Each component will have a different firmware version, the combination of which will form the package firmware version getFirmwarePackageVersion found in BaseProduct.

      Input Parameters:
      @NonNull CompletionCallbackWith<String> callbackThe execution callback with the value(s) returned.