DJI Windows SDK Documentation

Windows SDK

      Manager Classes
      DJISDKManager
      FlyZoneManager
      WaypointMissionManager
      ComponentManager
      MediaTaskManager
      UserAccountManager
      VideoFeeder
      VirtualRemoteController

      class RemoteControllerHandler

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

      This class represents the remote controller of the aircraft. It provides methods to change the settings of the physical remote controller. A remote controller is a device that can have a battery, radio, buttons, sticks, wheels, and output ports for video. The mobile device is connected to the remote controller, which is always sending out information about what everything is doing. The normal remote controller is called the master.

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

      The destructor. It should not be called explicitly.

      struct RCFlightModeSwitchMsg
      struct RCFlightModeSwitchMsg
      Declaration:DJI.WindowsSDK
      Description:

      A class that contains a flight mode switch state of remote controllers.

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

      Remote Controller Flight Mode switch position.

      Enum Members:
      SWITCH_ONEPosition One. For all products except Mavic Pro, this is the left most position of the flight mode switch on a remote controller from the perspective of the pilot. For example, on a Phantom 4 remote controller, Position One is labeled "A". For Mavic Pro, Spark and Mavic Air, this is the position that is furthest away from the pilot and labeled "Sport".
      SWITCH_TWOPosition Two. For all products except Mavic Pro, this is the middle position of the flight mode switch on a remote controller from the perspective of the pilot. For example, on a Phantom 4 remote controller, Position Two is labeled "S". For Mavic Pro, Spark and Mavic Air, this is the position that is closest to the pilot (the P position).
      SWITCH_THREEPosition Three. For all products except Mavic Pro, this is the right most position of the flight mode switch on a remote controller from the perspective of the pilot. For example, on a Phantom 4 remote controller, Position Two is labeled "P". Mavic Pro, Spark or Mavic Air does not have a third position for the flight mode switch.
      UNKNOWNUnknown.
      delegate RCFlightModeSwitchMsgChangedEventHandler
      delegate void RCFlightModeSwitchMsgChangedEventHandler(object sender, RCFlightModeSwitchMsg? value)
      Declaration:DJI.WindowsSDK
      Description:

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

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

      Gets the horizontal position of the left stick in the range of [-660, 660].

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

      Gets the vertical position of the left stick in the range of [-660, 660].

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

      Gets the horizontal position of the right stick in the range of [-660, 660].

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

      Gets the vertical position of the right stick in the range of [-660, 660].

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

      Gets Gimbal Dial's (upper left wheel) value in the range of [-660,660], where 0 is untouched and positive is turned in the clockwise direction.

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

      Gets the value of the remote controller's right wheel (Camera Settings Dial).

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

      Determines if the right wheel is push down. Not available now.

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

      Gets the state of the remote controller's flight mode switch.

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

      Determines if the go-home button is push down.

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

      Determines if the record button is push down.

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

      Determines if the shutter button is push down.

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

      Determines if the C1 button is push down.

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

      Determines if the C2 button is push down.

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

      Determines if the pause button is push down.

      Return:
      async Task<ResultValue<BoolMsg?>>A Task<ResultValue<BoolMsg?>> 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 RCStickLeftHorizontalChanged
      event IntMsgChangedEventHandler RCStickLeftHorizontalChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the horizontal position of the left stick in the range of [-660, 660].

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

      Subscribe the event to receive changes of the vertical position of the left stick in the range of [-660, 660].

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

      Subscribe the event to receive changes of the horizontal position of the right stick in the range of [-660, 660].

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

      Subscribe the event to receive changes of the vertical position of the right stick in the range of [-660, 660].

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

      Subscribe the event to receive changes of the remote controller's Gimbal Dial's (upper left wheel) value in the range of [-660,660], where 0 is untouched and positive is turned in the clockwise direction..

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

      Subscribe the event to receive changes of the remote controller's right wheel (Camera Settings Dial).

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

      Subscribe the event to receive changes about whether the right wheel is push down. Not available now.

      event RCFlightModeSwitchStateChanged
      event RCFlightModeSwitchMsgChangedEventHandler RCFlightModeSwitchStateChanged
      Declaration:DJI.WindowsSDK.Components
      Description:

      Subscribe the event to receive changes of the remote controller's flight mode switch.

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

      Subscribe the event to receive changes about whether the go-home button is push down.

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

      Subscribe the event to receive changes about whether the record button is push down.

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

      Subscribe the event to receive changes about whether the shutter button is push down.

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

      Subscribe the event to receive changes about whether the C1 button is push down.

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

      Subscribe the event to receive changes about whether the C2 button is push down.

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

      Subscribe the event to receive changes about whether the pause button is push down.

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