DJI Mobile SDK Documentation

      class AccessoryAggregation

      class AccessoryAggregation extends BaseComponent
      Package:dji.sdk.accessory
      Inherits From:BaseComponent
      Description:

      This class contains all possible accessories (spotlight, beacon and speaker) supported by the aircraft. The accessory aggregation component is available when Mavic 2 Enterprise is connected. An accessory becomes available only when the accessory is connected to the aircraft.

      Class Members:

      State Updates

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

      Set Accessory Aggregation state update callback.

      Input Parameters:
      @Nullable AccessoryAggregationState.Callback callbackThe execution callback with the execution result returned.
      Spotlight Accessory
      method
      method getSpotlight
      @Nullable
      Spotlight getSpotlight()
      Package:dji.sdk.accessory
      Description:

      Gets the spotlight instance if it is connected.

      Return:
      SpotlightThe connected spotlight instance. NULL if no splotlight is connected.
      Beacon
      method
      method getBeacon
      @Nullable
      Beacon getBeacon()
      Package:dji.sdk.accessory
      Description:

      Gets the beacon instance if it is connected.

      Return:
      BeaconThe connected beacon instance. NULL if no beacon is connected.
      Speaker
      method
      method getSpeaker
      @Nullable
      Speaker getSpeaker()
      Package:dji.sdk.accessory
      Description:

      Gets the speaker instance if it is connected.

      Return:
      SpeakerThe connected speaker instance. NULL if no speaker is connected.
      method getAccessoryAggregationState
      AccessoryAggregationState getAccessoryAggregationState()
      Package:dji.sdk.accessory
      Description:

      Gets the accessory aggregation state.

      Return:
      AccessoryAggregationStateAn instance of AccessoryAggregationState.


      class
      class
      State Updates
      interface
      interface Callback
      interface Callback
      Package:dji.common.accessory
      Description:

      An interface for obtaining AccessoryAggregationState.

      Interface Methods:

      Callback Method

      State
      method
      method onUpdate
      void onUpdate(AccessoryAggregationState state)
      Package:dji.common.accessory
      Description:

      Callback function that updates the accessory aggregation state.

      Input Parameters:
      AccessoryAggregationState stateThe accessory aggregation state.
      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.