DJI Mobile SDK Documentation

      class RemoteControllerKey

      class RemoteControllerKey extends DJIKey
      Package:dji.keysdk
      Inherits From:DJIKey
      Description:

      RemoteControllerKey provides dedicated access to remote controller attributes.

      Class Members:
      method
      method create
      static RemoteControllerKey create(@RemoteControllerParamKey @NonNull String paramKey)
      Package:dji.keysdk
      Description:

      Creates a RemoteControllerKey key.

      Input Parameters:
      @RemoteControllerParamKey @NonNull String paramKeyA valid paramKey.
      Return:
      static RemoteControllerKeyRemote Controller Key
      Inherited Methods:
      Class Keys:

      SET_MASTER_AUTH_CODE

      Access:

      SET

      Type:

      String

      API:

      setMasterAuthorizationCode

      CUSTOM_BUTTON_1

      Access:

      PUSH

      Type:

      HardwareState.Button

      API:

      getC1Button

      MULTI_RC_GIMBALS_CONTROL_AUTH_OWNER

      Access:

      PUSH

      Type:

      DataGetPushMultiRcAuthOwnerStatus.RCModeChannel[]

      API:

      -

      FOCUS_CONTROLLER_IS_WORKING

      Access:

      PUSH

      Type:

      Boolean

      API:

      isWorking

      SHUTTER_BUTTON

      Access:

      PUSH

      Type:

      HardwareState.Button

      API:

      getShutterButton

      REMOTE_CONTROLLER_CALIBRATION_B_AXIS_STATUS

      Access:

      GET

      Type:

      Integer

      API:

      -

      IS_MASTER_SLAVE_MODE_V4_SUPPORTED

      Access:

      GET

      Type:

      Boolean

      API:

      -

      SECONDARY_VIDEO_OSD_TOP_MARGIN

      Access:

      SET, GET

      Type:

      Integer

      API:

      -

      RC_UPGRADE_VOICE_DISABLE

      Access:

      SET, GET

      Type:

      Boolean

      API:

      -

      GIMBAL_MAPPING_STYLE

      Access:

      SET, GET

      Type:

      GimbalMappingStyle

      API:

      GimbalMappingStyle

      setGimbalMappingStyle

      getGimbalMappingStyle

      SECONDARY_VIDEO_OSD_RIGHT_MARGIN

      Access:

      SET, GET

      Type:

      Integer

      API:

      -

      REMOTE_CONTROLLER_CALIBRATION_D_AXIS_STATUS

      Access:

      GET

      Type:

      Integer

      API:

      -

      CUSTOM_BUTTON_2

      Access:

      PUSH

      Type:

      HardwareState.Button

      API:

      getC2Button

      SECOND_CHARGE_REMAINING

      Access:

      PUSH

      Type:

      Integer

      API:

      -

      SELECT_BUTTON_PROFILE_GROUP

      Access:

      SET, GET

      Type:

      String

      API:

      -

      AIRCRAFT_MAPPING_STYLE

      Access:

      SET, GET

      Type:

      AircraftMappingStyle

      API:

      AircraftMappingStyle

      setAircraftMappingStyle

      getAircraftMappingStyle

      SWITCH_RC_STATE

      Access:

      PUSH

      Type:

      DataCommonGetPushUpgradeStatus.DJIUpgradeStep

      API:

      -

      RIGHT_STICK_VALUE

      Access:

      PUSH

      Type:

      Stick

      API:

      getRightStick

      SECONDARY_VIDEO_DISPLAY_MODE

      Access:

      SET, GET

      Type:

      SecondaryVideoDisplayMode

      API:

      -

      REMOTE_CONTROLLER_UNIT

      Access:

      SET

      Type:

      Integer

      API:

      -

      FETCH_CUSTOMIZED_ACTION_OF_BUTTON

      Access:

      ACTION

      Type:

      ProfessionalRC.CustomizableButton

      API:

      CustomizableButton

      PIP_POSITION

      Access:

      SET, GET

      Type:

      PIPPosition

      API:

      -

      FIRMWARE_VERSION

      Access:

      GET

      Type:

      String

      API:

      -

      MASTER_LIST

      Access:

      GET

      Type:

      String[]

      API:

      getMasters

      STOP_MULTI_DEVICE_PAIRING

      Access:

      ACTION

      Type:

      -

      API:

      -

      PAUSE_BUTTON

      Access:

      PUSH

      Type:

      HardwareState.Button

      API:

      getPauseButton

      IS_MASTER_SLAVE_MODE_V2_SUPPORTED

      Access:

      GET

      Type:

      Boolean

      API:

      -

      GO_HOME_BUTTON

      Access:

      PUSH

      Type:

      HardwareState.Button

      API:

      getGoHomeButton

      MULTI_RC_LOST_NOTICE

      Access:

      PUSH

      Type:

      DataMultiRcControlAuthorityLostNotice.MultiRcLostNotice

      API:

      -

      SECONDARY_VIDEO_OSD_ENABLED

      Access:

      SET, GET

      Type:

      Boolean

      API:

      -

      SECONDARY_VIDEO_OSD_UNIT

      Access:

      SET, GET

      Type:

      SecondaryVideoOSDUnit

      API:

      -

      GET_MASTER_AUTH_CODE

      Access:

      ACTION

      Type:

      String

      API:

      -

      IS_MASTER_SLAVE_MODE_V3_SUPPORTED

      Access:

      GET

      Type:

      Boolean

      API:

      -

      SHUTTER_BUTTON_BINDING_ENABLED

      Access:

      PUSH, SET

      Type:

      Boolean

      API:

      -

      REQUEST_LEGACY_GIMBAL_CONTROL

      Access:

      GET

      Type:

      RequestGimbalControlResult

      API:

      -

      RIGHT_DIAL

      Access:

      PUSH

      Type:

      HardwareState.RightDial

      API:

      -

      CUSTOM_GIMBAL_MAPPING

      Access:

      SET, GET

      Type:

      GimbalMapping

      API:

      GimbalMapping

      setCustomGimbalMapping

      getCustomGimbalMapping

      RECORD_BUTTON_BINDING_ENABLED

      Access:

      PUSH, SET

      Type:

      Boolean

      API:

      -

      BUTTON_PROFILE_GROUPS

      Access:

      GET

      Type:

      String[]

      API:

      -

      CONNECT_TO_MASTER

      Access:

      ACTION

      Type:

      Credentials

      API:

      connectToMaster

      Credentials

      CONNECTED_MASTER_CREDENTIALS

      Access:

      GET

      Type:

      Credentials

      API:

      getConnectedMasterCredentials

      Credentials

      FIVE_D_BUTTON

      Access:

      PUSH

      Type:

      FiveDButton

      API:

      getFiveDButton

      FiveDButton

      SLAVE_REMOTE_CONTROLLER_STICK_MODE

      Access:

      SET, GET

      Type:

      DataRcSlaveStickMode.StickMode

      API:

      -

      FOCUS_CONTROLLER_DIRECTION

      Access:

      PUSH

      Type:

      FocusControllerState.Direction

      API:

      getDirection

      Direction

      REMOTE_CONTROLLER_CALIBRATION_E_AXIS_STATUS

      Access:

      GET

      Type:

      Integer

      API:

      -

      STOP_MASTER_SEARCHING

      Access:

      ACTION

      Type:

      -

      API:

      stopMasterSearching

      COUNTRY_CODE

      Access:

      GET

      Type:

      String

      API:

      -

      STOP_PAIRING

      Access:

      ACTION

      Type:

      -

      API:

      stopPairing

      MULTI_DEVICES_PAIRING_STATE

      Access:

      PUSH

      Type:

      MultiDeviceAggregationState

      API:

      -

      MULTI_RC_RCS_ONLINE_STATE

      Access:

      PUSH

      Type:

      Boolean[]

      API:

      -

      LEFT_STICK_VALUE

      Access:

      PUSH

      Type:

      Stick

      API:

      getLeftStick

      RC_INDEX

      Access:

      PUSH, SET

      Type:

      Integer

      API:

      -

      REMOTE_CONTROLLER_CALIBRATION_NUMBER_OF_SEGMENT

      Access:

      GET

      Type:

      Integer

      API:

      -

      SLAVE_LIST

      Access:

      GET

      Type:

      Information[]

      API:

      getSlaveList

      Information

      MULTI_RC_APPS_ONLINE_STATE

      Access:

      PUSH

      Type:

      Boolean[]

      API:

      -

      CUSTOMIZE_BUTTON

      Access:

      ACTION

      Type:

      -

      API:

      -

      SHAKE_MOTOR

      Access:

      ACTION

      Type:

      -

      API:

      -

      BATTERY_STATE

      Access:

      PUSH

      Type:

      BatteryState

      API:

      Callback

      BatteryState

      REMOTE_CONTROLLER_CALIBRATION_G_AXIS_STATUS

      Access:

      GET

      Type:

      Integer

      API:

      -

      NAME

      Access:

      SET, GET

      Type:

      String

      API:

      -

      FOCUS_CONTROLLER_CONTROL_TYPE

      Access:

      PUSH

      Type:

      FocusControllerState.ControlType

      API:

      getControlType

      ControlType

      REMOVE_BUTTON_PROFILE_GROUP

      Access:

      ACTION

      Type:

      String

      API:

      -

      RECORD_BUTTON

      Access:

      PUSH

      Type:

      HardwareState.Button

      API:

      getRecordButton

      PAIRING_STATE

      Access:

      GET

      Type:

      PairingState

      API:

      getPairingState

      PairingState

      MASTER_SEARCHING_STATE

      Access:

      GET

      Type:

      Boolean

      API:

      getMasterSearchingState

      IS_FOCUS_CONTROLLER_SUPPORTED

      Access:

      PUSH

      Type:

      Boolean

      API:

      isFocusControllerSupported

      RENAME_BUTTON_PROFILE_GROUP

      Access:

      ACTION

      Type:

      -

      API:

      -

      GIMBAL_CONTROL_SPEED_COEFFICIENT

      Access:

      SET, GET

      Type:

      GimbalControlSpeedCoefficient

      API:

      setGimbalControlSpeedCoefficient

      getGimbalControlSpeedCoefficient

      GimbalControlSpeedCoefficient

      SECONDARY_VIDEO_OSD_LEFT_MARGIN

      Access:

      SET, GET

      Type:

      Integer

      API:

      -

      GPS_DATA

      Access:

      PUSH

      Type:

      GPSData

      API:

      Callback

      onUpdate

      GPSData

      SECONDARY_VIDEO_OUTPUT_PORT

      Access:

      SET, GET

      Type:

      SecondaryVideoOutputPort

      API:

      -

      RESET_BUTTON_CONFIG

      Access:

      ACTION

      Type:

      -

      API:

      -

      MULTI_RC_CONTROL_AUTHORITY_SURPASS

      Access:

      ACTION

      Type:

      ArrayList

      API:

      -

      LEFT_DIAL

      Access:

      PUSH

      Type:

      Integer

      API:

      -

      START_PAIRING

      Access:

      ACTION

      Type:

      -

      API:

      startPairing

      CUSTOM_BUTTON_TAGS

      Access:

      SET, GET

      Type:

      CustomButtonTags

      API:

      setCustomButtonTags

      getCustomButtonTags

      CustomButtonTags

      FUNCTION_BUTTON

      Access:

      PUSH

      Type:

      HardwareState.Button

      API:

      -

      REMOTE_CONTROLLER_CALIBRATION_C_AXIS_STATUS

      Access:

      GET

      Type:

      Integer

      API:

      -

      FLIGHT_MODE_SWITCH_POSITION

      Access:

      PUSH, SET

      Type:

      HardwareState.FlightModeSwitch

      API:

      getFlightModeSwitch

      FlightModeSwitch

      IS_MASTER_SLAVE_MODE_SUPPORTED

      Access:

      PUSH

      Type:

      Boolean

      API:

      isMasterSlaveModeSupported

      MULTI_RC_RCS_COUNT

      Access:

      PUSH

      Type:

      Integer

      API:

      -

      MASTER_SLAVE_STATE

      Access:

      PUSH

      Type:

      MasterSlaveState

      API:

      onUpdate

      MasterSlaveState

      getAuthorizationCode

      Callback

      MULTI_RC_APPS_COUNT

      Access:

      PUSH

      Type:

      Integer

      API:

      -

      SECONDARY_VIDEO_OSD_BOTTOM_MARGIN

      Access:

      SET, GET

      Type:

      Integer

      API:

      -

      AIRCRAFT_CUSTOM_MAPPING

      Access:

      SET, GET

      Type:

      AircraftMapping

      API:

      setCustomAircraftMapping

      getCustomAircraftMapping

      AircraftMapping

      BUTTON_CONFIG

      Access:

      SET, GET

      Type:

      ProfessionalRC.ButtonConfiguration

      API:

      ButtonConfiguration

      RC_MASTER_SLAVE_OPEN

      Access:

      SET, GET

      Type:

      Boolean

      API:

      -

      START_SEARCH_MASTER

      Access:

      ACTION

      Type:

      -

      API:

      startMasterSearching

      AVAILABLE_MASTERS

      Access:

      GET

      Type:

      Information[]

      API:

      getAvailableMasters

      Information

      CALIBRATION_STATE

      Access:

      SET

      Type:

      CalibrationState

      API:

      -

      RC_HAS_GIMBAL_CONTROL

      Access:

      PUSH

      Type:

      Boolean

      API:

      -

      SDI_OUTPUT_FORMAT

      Access:

      SET, GET

      Type:

      SecondaryVideoFormat

      API:

      -

      HDMI_OUTPUT_FORMAT

      Access:

      SET, GET

      Type:

      SecondaryVideoFormat

      API:

      -

      REQUEST_GIMBAL_CONTROL

      Access:

      ACTION

      Type:

      -

      API:

      RequestGimbalControlResult

      SECONDARY_VIDEO_OUTPUT_ENABLED

      Access:

      SET, GET

      Type:

      Boolean

      API:

      -

      REMOTE_CONTROLLER_CALIBRATION_A_AXIS_STATUS

      Access:

      GET

      Type:

      Integer

      API:

      -

      START_MULTI_DEVICE_PAIRING

      Access:

      ACTION

      Type:

      PairingDevice

      API:

      -

      SERIAL_NUMBER

      Access:

      GET

      Type:

      String

      API:

      -

      PLAYBACK_BUTTON

      Access:

      PUSH

      Type:

      HardwareState.Button

      API:

      getPlaybackButton

      IS_CHARGE_REMAINING_LOW

      Access:

      PUSH

      Type:

      Boolean

      API:

      -

      RTK_CHANNEL_ENABLE

      Access:

      PUSH, SET

      Type:

      Boolean

      API:

      -

      RESPONSE_TO_REQUEST_FOR_GIMBAL_CONTROL

      Access:

      ACTION

      Type:

      ResponseForGimbalControl

      API:

      respondToRequestForGimbalControl

      ResponseForGimbalControl

      MODE

      Access:

      PUSH, SET, GET

      Type:

      RCMode

      API:

      setMode

      getMode

      RCMode

      DISPLAY_NAME

      Access:

      PUSH

      Type:

      String

      API:

      -

      ADD_BUTTON_PROFILE_GROUP

      Access:

      ACTION

      Type:

      String

      API:

      -

      BUTTON_EVENT_OF_PROFESSIONAL_RC

      Access:

      PUSH

      Type:

      ProfessionalRC.Event

      API:

      Event

      REMOTE_CONTROLLER_CALIBRATION_H_AXIS_STATUS

      Access:

      GET

      Type:

      Integer

      API:

      -

      CONNECT_TO_MASTER_WITH_ID

      Access:

      ACTION

      Type:

      AuthorizationInfo

      API:

      connectToMaster

      AuthorizationInfo

      REMOTE_CONTROLLER_CALIBRATION_F_AXIS_STATUS

      Access:

      GET

      Type:

      Integer

      API:

      -

      PASSWORD

      Access:

      SET, GET

      Type:

      String

      API:

      setPassword

      getPassword

      SELECT_BUTTON_PROFILE

      Access:

      SET, GET

      Type:

      Integer

      API:

      -

      TRANSFORMATION_SWITCH

      Access:

      PUSH

      Type:

      HardwareState.TransformationSwitch

      API:

      getTransformationSwitch

      TransformationSwitch

      LEFT_DIAL_GIMBAL_CONTROL_AXIS

      Access:

      SET, GET

      Type:

      GimbalAxis

      API:

      -

      CHARGE_MOBILE_MODE

      Access:

      SET, GET

      Type:

      ChargeMobileMode

      API:

      getChargeMobileMode

      ChargeMobileMode

      CONTROLLING_GIMBAL_INDEX

      Access:

      PUSH, SET

      Type:

      Integer

      API:

      -

      HDMI_SYSTEM_SETTING_OUTPUT_ENABLED

      Access:

      GET

      Type:

      Boolean

      API:

      -