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.
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.
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 callback
The execution callback with the returned execution result.
voidreset(Axis axis, ResetDirection resetDirection, @Nullable final CompletionCallback callback)
Package:
dji.sdk.gimbal
Description:
Resets the gimbal. The behaviors are dependent on the selected axis and reset direction. Supported by: Zenmuse H20 and Zenmuse H20T (firmware version v01.00.06.98 and above) DJI X-port (firmware version v02.00.07.60 and above) Zenmuse Z30 (firmware version v01.01.03.00 and above) Zenmuse X5S (firmware version v01.01.03.00 and above) Zenmuse X7 (firmware version v00.02.05.68 and above) Zenmuse XT2 (firmware version v00.02.06.46 and above) Zenmuse XTS (firmware version v00.02.32.82 and above)
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.
The standard position for the upper gimbal is pointing up vertically to the sky. The standard position for the downward gimbal is pointing down vertically to the earth.
CENTER
Applies only to the yaw. The standard position is pointing to the center.
The 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.
FPV
The 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_FOLLOW
The 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.
For gimbals that allow payloads to be changed, a balance test should be performed to ensure the camera is mounted correctly.
Enum Members:
PASS
The balance test result is great.
MARGINAL
The 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.
FAIL
The balance test result is bad. The payload should be adjusted when this result is returned.
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:
FAST
The gimbal's SmoothTrack and Controller sensitivity is high. When the gimbal is using this profile, user cannot change the Movement Settings manually.
MEDIUM
The gimbal's SmoothTrack and Controller sensitivity is medium. When the gimbal is using this profile, user cannot change the Movement Settings manually.
SLOW
The gimbal's SmoothTrack and Controller sensitivity is slow. When the gimbal is using this profile, user cannot change the Movement Settings manually.
CUSTOM_1
The gimbal uses a custom configuration in memory slot 1 where the yaw and pitch speed, deadband, and acceleration can be defined.
CUSTOM_2
The gimbal uses a custom configuration in memory slot 2 where the yaw and pitch speed, deadband, and acceleration can be defined.
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:
BALANCED
The gimbal is balanced.
TILTING_LEFT
The gimbal is tilting left. Adjust the photo to the right hand side to balance the gimbal.
TILTING_RIGHT
The gimbal is tilting right. Adjust the photo to the left hand side to balance the gimbal.
Key enum in the getCapabilities dictionary that holds the complete capability of the gimbal. The value is capability range of the gimbal is placed downwards, A negative value in the valid range represents counter-clockwise rotation. A positive value in the valid range represents clockwise rotation.
ADJUST_PITCH_UPWARDS
Key enum in the getCapabilities dictionary that holds the complete capability of the gimbal. The value is capability range of the gimbal is placed upwards, A negative value in the valid range represents counter-clockwise rotation. A positive value in the valid range represents clockwise rotation.
ADJUST_YAW
Key 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_ROLL
Key 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.
Key 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_COEFFICIENT
Key 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_COEFFICIENT
Key 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_FACTOR
Key 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_FACTOR
Key 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_DEADBAND
Key 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_DEADBAND
Key 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_SPEED
Key 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_SPEED
Key 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_ENABLED
Key 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_ENABLED
Key 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_ACCELERATION
Key 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_ACCELERATION
Key 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_SPEED
Key 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_SPEED
Key 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_DEADBAND
Key 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_DEADBAND
Key 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_ENDPOINT
Key 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_ENDPOINT
Key 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_ENDPOINT
Key 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_ENDPOINT
Key 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_STIFFNESS
Key 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_STIFFNESS
Key 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_STIFFNESS
Key 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_STRENGTH
Key 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_STRENGTH
Key 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_STRENGTH
Key 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_FACTOR
Key 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_FACTOR
Key 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_FACTOR
Key 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_CONTROL
Key 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_CONTROL
Key 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_CONTROL
Key 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.
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 callback
The execution callback with the returned execution result.
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 offset
Fine-tuned offset, in degrees, to be tuned.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
voidfineTunePitchInDegrees(@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, Mavic 2 Series and Mavic Air 2, DJI Air 2S.
Input Parameters:
@FloatRange(from = -2.0f, to = 2.0f) float offset
Fine-tuned offset, in degrees, to be tuned.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
voidfineTuneYawInDegrees(@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 offset
Fine-tuned offset, in degrees, to be tuned.
@Nullable final CompletionCallback callback
The execution callback with the returned execution result.
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 callback
The execution callback with the returned value(s). The callback will execute when the balance test is successfully started.
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.
Extends the pitch range of gimbal. If extended, The range of the pitch angle should be gotten from the ADJUST_PITCH or ADJUST_PITCH_UPWARDS. Otherwise, the angle will be limited to avoid seeing the arm. Use PITCH_RANGE_EXTENSION to check if it is supported by the gimbal.
Input Parameters:
boolean isEnabled
Whether the pitch range should be extended.
@Nullable final CompletionCallback callback
The completion callback that receives the execution result.
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.
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).
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).
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 speedCoefficient
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).
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).
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). Only supported by Mavic Air 2, DJI Air 2S.
Gets physical controller smoothing value with axis and mode. 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). Only supported by Mavic Air 2, DJI Air 2S.
voidsetControllerMaxSpeed(@NonNull Axis axis, @IntRange(from = 0, to = 100)int maxSpeed, @Nullable final CompletionCallback callback)
Package:
dji.sdk.gimbal
Description:
Sets 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).
voidsetControllerMaxSpeed(@NonNull Axis axis, @NonNull HardwareState.FlightModeSwitch mode, @IntRange(from = 1, to = 100)int maxSpeed, @Nullable final CompletionCallback callback)
Package:
dji.sdk.gimbal
Description:
Sets 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). Only supported by Mavic Air 2, DJI Air 2S.
voidgetControllerMaxSpeed(@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).
voidgetControllerMaxSpeed(@NonNull Axis axis, @NonNull HardwareState.FlightModeSwitch mode, @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). Only supported by Mavic Air 2, DJI Air 2S.
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.
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.
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).
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).
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.
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.
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).
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).
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 callback
The execution callback with the returned execution result.
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.
voidsetAttitudeSynchronizationEnabled(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, not supported by DJI X-Port.
Input Parameters:
boolean enabled
true to enable the synchronization.
@Nullable final CompletionCallback callback
The execution callback with the returned value(s).
voidgetAttitudeSynchronizationEnabled(@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.
voidstartMultiGimbalAttitudeSynchronization(int[] gimbals, final CompletionCallback callback)
Package:
dji.sdk.gimbal
Description:
Selects two to three gimbals to run with Multi-Gimbal Connection, which can be controlled by a single user. Please check if payloads have been connected with gimbal. The left gimbal, the right gimbal and the upper gimbal can be chosen. You should call setControllingGimbalIndex to set the control of the remote controller to the gimbal you want to synchronize. It is only supported by Matrice 300 RTK.
Input Parameters:
int[] gimbals
Array of gimbal indexes, in which 0 represents the left gimbal, 1 represents the right gimbal and 2 stands for the upper one. nil if this function is disabled.
final CompletionCallback callback
The completion block that receives the execution result.
Stops the gimbals to run with Multi-Gimbal Connection. Please check if payloads have been connected with gimbal. It is only supported by Matrice 300 RTK.
voidsetYawSimultaneousFollowEnabled(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 isEnabled
true to enable yaw simultaneous follow.
@Nullable final CompletionCallback callback
The execution callback with the returned value(s).
voidgetYawSimultaneousFollowEnabled(@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> callback
The execution callback with the returned value(s).
Starts the balance detection. Note: Please DO NOT turn on the motors. The tilt angle of the pitch and roll axis should be between -30 and -20 degrees. Please fit the screw on the auxiliary arm after the balance detection. Invoked before startConcentricityDetection and startControlParametersAutoTuning. Or start balance detection with default control parameters. This can only be invoked during DEVELOPMENT phase.
Starts the coaxiality detection. Note: Please DO NOT turn on the motors. The tilt angle of the pitch and roll axis cannot be greater than 5 degrees. Please start coaxiality detection after gimbal's balance detection and fitting the screw on the auxiliary arm. This can only be invoked during DEVELOPMENT phase.
Starts the control parameters auto tuning. Note: Please DO NOT turn on the motors. The tilt angle of the pitch and roll axis cannot be greater than 5 degrees. This can only be invoked during DEVELOPMENT phase.
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, M210 RTK, M300 RTK and M350 RTK, Camera and Gimbal with index 0 corresponds to the camera and gimbal on the port (left hand) side of the aircraft. Lidar with index 0 corresponds to the lidar(Zenmuse L1) on the port (left hand) side of the aircraft.
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.
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> callback
The execution callback with the value(s) returned.