DJI Windows SDK Documentation

Windows SDK

      Manager Classes
      DJISDKManager
      FlyZoneManager
      WaypointMissionManager
      ComponentManager
      MediaTaskManager
      UserAccountManager
      VideoFeeder
      VirtualRemoteController

      class BatteryHandler

      sealed class BatteryHandler
      Declaration:DJI.WindowsSDK.Components
      Description:

      This class manages information and real-time status of the connected product's batteries.

      Class Members:
      property
      ProductIndex
      property ProductIndex
      uint ProductIndex { get; }
      Declaration:DJI.WindowsSDK.Components
      Description:

      The index of the product to which this component handler belongs. The default product index is 0.

      property ComponentIndex
      uint ComponentIndex { get; }
      Declaration:DJI.WindowsSDK.Components
      Description:

      The index of the component. It is unique for a type of components inside a product. It is useful when a product has multiple handlers of the same kind. If the product only has one handler of this kind, the index is 0.

      method ~BatteryHandler
      ~BatteryHandler()
      Declaration:DJI.WindowsSDK.Components
      Description:

      The destructor. It should not be called explicitly.

      struct BatteryHeatingStateMsg
      struct BatteryHeatingStateMsg
      Declaration:DJI.WindowsSDK
      Description:

      A class that contains the brust count of camera.

      Struct Members:
      BatteryHeatingState valueThe actual value of the class.
      delegate BatteryHeatingStateMsgChangedEventHandler
      delegate void BatteryHeatingStateMsgChangedEventHandler(object sender, BatteryHeatingStateMsg? value)
      Declaration:DJI.WindowsSDK
      Description:

      A delegate type used to subscribe the updated values in type BatteryHeatingStateMsg.

      delegate PlayingAudioFileInfoChangedEventHandler
      delegate void PlayingAudioFileInfoChangedEventHandler(object sender, PlayingAudioFileInfo? value)
      Declaration:DJI.WindowsSDK
      Description:

      A delegate type used to subscribe the updated values in type PlayingAudioFileInfo.

      event FullChargeCapacityChanged
      event IntMsgChangedEventHandler FullChargeCapacityChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the total amount of energy, in mAh (milliamp hours), stored in the battery when the battery is fully charged. The energy of the battery at full charge changes over time as the battery continues to get used. Over time, as the battery continues to be recharged, the value of fullChargeCapacity will decrease.

      event ChargeRemainingChanged
      event IntMsgChangedEventHandler ChargeRemainingChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the remaining energy stored in the battery in mAh (milliamp hours).

      event ChargeRemainingInPercentChanged
      event IntMsgChangedEventHandler ChargeRemainingInPercentChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the percentage of battery energy left with range [0, 100].

      event VoltageChanged
      event IntMsgChangedEventHandler VoltageChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the current battery voltage (mV).

      event CurrentChanged
      event IntMsgChangedEventHandler CurrentChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the real time current draw of the battery (mA). A negative value means the battery is being discharged, and a positive value means it is being charged.

      event BatteryTemperatureChanged
      event DoubleMsgChangedEventHandler BatteryTemperatureChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the battery's temperature, in Celsius, with range [-128, 127] degrees.

      event ConnectionChanged
      event BoolMsgChangedEventHandler ConnectionChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive a component's connection change.

      event SerialNumberChanged
      event StringMsgChangedEventHandler SerialNumberChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the battery's serial number.

      event HeatingStateChanged
      event BatteryHeatingStateMsgChangedEventHandler HeatingStateChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of heating state.

      method GetFullChargeCapacityAsync
      async Task<ResultValue<IntMsg?>> GetFullChargeCapacityAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the event to receive changes of the total amount of energy, in mAh (milliamp hours), stored in the battery when the battery is fully charged. The energy of the battery at full charge changes over time as the battery continues to get used. Over time, as the battery continues to be recharged, the value of fullChargeCapacity will decrease.

      Return:
      async Task<ResultValue<IntMsg?>>A Task<ResultValue<IntMsg?>> object.
      method GetChargeRemainingAsync
      async Task<ResultValue<IntMsg?>> GetChargeRemainingAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the remaining energy stored in the battery in mAh (milliamp hours).

      Return:
      async Task<ResultValue<IntMsg?>>A Task<ResultValue<IntMsg?>> object.
      method GetChargeRemainingInPercentAsync
      async Task<ResultValue<IntMsg?>> GetChargeRemainingInPercentAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the percentage of battery energy left with range [0, 100].

      Return:
      async Task<ResultValue<IntMsg?>>A Task<ResultValue<IntMsg?>> object.
      method GetVoltageAsync
      async Task<ResultValue<IntMsg?>> GetVoltageAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the current battery voltage (mV).

      Return:
      async Task<ResultValue<IntMsg?>>A Task<ResultValue<IntMsg?>> object.
      method GetCurrentAsync
      async Task<ResultValue<IntMsg?>> GetCurrentAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the real time current draw of the battery (mA). A negative value means the battery is being discharged, and a positive value means it is being charged.

      Return:
      async Task<ResultValue<IntMsg?>>A Task<ResultValue<IntMsg?>> object.
      method GetBatteryTemperatureAsync
      async Task<ResultValue<DoubleMsg?>> GetBatteryTemperatureAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the battery's temperature, in Celsius, with range [-128, 127] degrees.

      Return:
      async Task<ResultValue<DoubleMsg?>>A Task<ResultValue<DoubleMsg?>> object.
      method GetConnectionAsync
      async Task<ResultValue<BoolMsg?>> GetConnectionAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Determines if a component is connected or not.

      Return:
      async Task<ResultValue<BoolMsg?>>A Task<ResultValue<BoolMsg?>> object.
      method GetSerialNumberAsync
      async Task<ResultValue<StringMsg?>> GetSerialNumberAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the serial number of the component.

      Return:
      async Task<ResultValue<StringMsg?>>A Task<ResultValue<StringMsg?>> object.
      method GetHeatingStateAsync
      async Task<ResultValue<BatteryHeatingStateMsg?>> GetHeatingStateAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the heating state of battery.

      Return:
      async Task<ResultValue<BatteryHeatingStateMsg?>>A Task<ResultValue<Value_BatteryHeatingStateMsg?>> object.