DJI Windows SDK Documentation

Windows SDK

      Manager Classes
      DJISDKManager
      FlyZoneManager
      WaypointMissionManager
      ComponentManager
      MediaTaskManager
      UserAccountManager
      VideoFeeder
      VirtualRemoteController

      class WiFiHandler

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

      This class provides methods to change the setting of the product's WiFi. Rebooting WiFi is required in order to make new settings take effect.

      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 ~WiFiHandler
      ~WiFiHandler()
      Declaration:DJI.WindowsSDK.Components
      Description:

      The destructor. It should not be called explicitly.

      struct WiFiFrequencyBandMsg
      struct WiFiFrequencyBandMsg
      Declaration:DJI.WindowsSDK
      Description:

      A class contains a WiFi frequency band.

      Struct Members:
      WiFiFrequencyBand valueThe actual value of the class.
      enum WiFiFrequencyBand
      enum WiFiFrequencyBand
      Declaration:DJI.WindowsSDK
      Description:

      WiFi frequency band.

      Enum Members:
      BAND_2_DOT_4GThe WiFi Frequency band is 2.4 GHz.
      BAND_5GThe WiFi Frequency band is 5 GHz.
      BAND_DUALDual frequency band mode. The WiFi frequency band can be either 2.4 GHz or 5 GHz.
      UNKNOWNUnknown.
      Methods
      method
      SetWiFiSSIDAsync
      method SetWiFiSSIDAsync
      async Task<SDKError> SetWiFiSSIDAsync(StringMsg value)
      Declaration:DJI.WindowsSDK.Components
      Description:

      Sets the WiFi SSID. The setting will take effect only after the product reboots.

      Input Parameters:
      StringMsg valueA parameter object of type StringMsg. It should only include alphabetic characters, numbers, spaces, '-' and should not be more than 30 characters.
      Return:
      async Task<SDKError>A Task<SDKErrorCode> object.
      method GetWiFiSSIDAsync
      async Task<ResultValue<StringMsg?>> GetWiFiSSIDAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the WiFi SSID.

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

      Sets the WiFi password.

      Input Parameters:
      StringMsg valueA parameter object of type StringMsg. It must be at least 8 characters and can only includes alphabetic characters and numbers.
      Return:
      async Task<SDKError>A Task<SDKErrorCode> object.
      method GetWiFiPasswordAsync
      async Task<ResultValue<StringMsg?>> GetWiFiPasswordAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Get the WiFi password.

      Return:
      async Task<ResultValue<StringMsg?>>A Task<ResultValue<StringMsg?>> object.
      method SetFrequencyBandAsync
      async Task<SDKError> SetFrequencyBandAsync(WiFiFrequencyBandMsg value)
      Declaration:DJI.WindowsSDK.Components
      Description:

      Sets the frequency band of WiFi. It is not supported by Mavic Air. For Mavic Air, set different channel numbers to select the frequency band.

      Input Parameters:
      WiFiFrequencyBandMsg valueA parameter object of type WiFiFrequencyBandMsg.
      Return:
      async Task<SDKError>A Task<SDKErrorCode> object.
      method GetFrequencyBandAsync
      async Task<ResultValue<WiFiFrequencyBandMsg?>> GetFrequencyBandAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Gets the current WiFi frequency band. It is not supported by Mavic Air.

      Return:
      async Task<ResultValue<WiFiFrequencyBandMsg?>>A Task<ResultValue<WiFiFrequencyBandMsg?>> object.
      method RestartWiFiAsync
      async Task<SDKError> RestartWiFiAsync()
      Declaration:DJI.WindowsSDK.Components
      Description:

      Restarts the WiFi component. CAUTION: the connection to the DJI product will get broken.

      Return:
      async Task<SDKError>A Task<SDKErrorCode> 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.
      Event
      event
      WiFiSSIDChanged
      event WiFiSSIDChanged
      event StringMsgChangedEventHandler WiFiSSIDChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive the change of the WiFi SSID.

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

      Subscribe the event to receive changes of the WiFi password.

      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 serial number of the component.