Enums

The following enums are available globally.

  • Current ActiveTrack Mission execution state.

    See more

    Declaration

    Objective-C

    enum DJIActiveTrackMissionExecutionState : NSInteger {}

  • Different modes of the ActiveTrack Mission. Defaults to Trace, set to others to enable the feature.

    See more

    Declaration

    Objective-C

    enum DJIActiveTrackMode : NSInteger {}

WiFiLink

  • WiFi frequency band.

    See more

    Declaration

    Objective-C

    enum DJIWiFiFrequencyBand : uint8_t {}

  • WiFi Signal Quality - as measuremed by Osmo, Phantom 3 4K and Phantom 3 Standard.

    See more

    Declaration

    Objective-C

    enum DJIWiFiSignalQuality : uint8_t {}

  • WiFi data rate. Lower rates are used for longer ranges, but will have lower video quality.

    See more

    Declaration

    Objective-C

    enum DJIWiFiDataRate : uint8_t {}

LBAirLink

Data Struct

  • Downlink channel selection mode (manual or automatic) for the wireless link.

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkChannelSelectionMode : uint8_t {}

  • OSD data units.

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkOSDUnits : uint8_t {}

  • Remote Controller port to which to send secondary video (in addition to USB video sent to the Mobile Device).

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkSecondaryVideoOutputPort : uint8_t {}

  • Defines the combination of video sources to form the secondary output video. The secondary output can display video streams from one or two input sources. When the encode mode is single: * Source 1 represents video from one of the LB input ports (HDMI or AV). * Source 2 represents video from EXT input port (HD Gimbal Camera). When the encode mode is dual: * Source 1 represents video from HDMI input port. * Source 2 represents video from AV input port.

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkPIPDisplayMode : uint8_t {}

  • Secondary output video resolution and frame rate.

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkSecondaryVideoFormat : uint8_t {}

  • PIP (Picture In Picture) position on the screen reltaive to the main subject video.

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkPIPPosition : uint8_t {}

  • FPV(First-person view) Video can prioritize either quality or latency.

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkFPVVideoQualityLatency : uint8_t {}

  • Wireless downlink data rate. Lower rates are used for longer ranges, but will have lower video quality.

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkDataRate : uint8_t {}

  • The video source for the delegate method - (void)lbAirLink:(DJILBAirLink *_Nonnull)lbAirLink didReceiveVideoData:(NSData *)data in DJILBAirLinkDelegate and DJICameraDelegate.

    See more

    Declaration

    Objective-C

    enum DJIVideoDataChannel : uint8_t {}

  • Lightbridge 2 encode mode.

    See more

    Declaration

    Objective-C

    enum DJILBAirLinkEncodeMode : uint8_t {}

OcuSyncLink

  • Downlink channel selection mode (manual or automatic) for the wireless OcuSync Link.

    See more

    Declaration

    Objective-C

    enum DJIOcuSyncChannelSelectionMode : uint8_t {}

  • The channel bandwidth for the OcuSync downlink (from the aircraft to the remote controller). Setting a smaller bandwidth will reduce the data rate, but make the connection more robust. Only supported by Mavic Pro.

    See more

    Declaration

    Objective-C

    enum DJIOcuSyncBandwidth : uint8_t {}

  • OcuSync link warning messages. Only supported by Mavic Pro.

    See more

    Declaration

    Objective-C

    enum DJIOcuSyncWarningMessage : uint8_t {}

  • Battery cell voltage level threshold. Different thresholds will initiate different aircraft behaviors or operations. Level 3 is the lowest level. It is only supported when the connected product is stand-alone A3 and N3.

    See more

    Declaration

    Objective-C

    enum DJIBatteryCellVoltageLevel : uint8_t {}

  • Defines aircraft operation when the cell voltage is low. It is only supported when the connected product is stand-alone A3 and N3.

    See more

    Declaration

    Objective-C

    enum DJIBatteryLowCellVoltageOperation : uint8_t {}

  • Battery pairing state for batteries that can be paired. Only supported by Inspire 2.

    See more

    Declaration

    Objective-C

    enum DJIBatteryPairStatus : uint8_t {}

DJIFlightControl

  • Defines aircraft failsafe action when signal between the remote controller and the aircraft is lost.

    See more

    Declaration

    Objective-C

    enum DJIFlightFailsafeOperation : uint8_t {}

DJIFlightControllerFlightMode

DJIFlightControllerGoHomeExecutionStatus

DJIFlightControllerNoFlyStatus

DJIGPSSignalStatus

DJIAircraftPowerLevel

  • Remaining battery life state. This state describes the recommended action based on remaining battery life.

    See more

    Declaration

    Objective-C

    enum DJIAircraftRemainingBatteryState : uint8_t {}

DJIFlightOrientationMode

  • Tells the aircraft how to interpret flight commands for forward, backward, left and right. See the Flight Controller User Guide for more information.

    See more

    Declaration

    Objective-C

    enum DJIFlightOrientationMode : uint8_t {}

  • An enum class represents the category of fly zone.

    See more

    Declaration

    Objective-C

    enum DJIFlyZoneCategory : uint8_t {}

  • An enum class contains the type of the fly zone.

    See more

    Declaration

    Objective-C

    enum DJIFlyZoneType : uint8_t {}

  • An enum class contains the shape of the fly zone.

    See more

    Declaration

    Objective-C

    enum DJIFlyZoneShape : uint8_t {}

  • This enum describes whether an aircraft is clear of, near a fly zone.

    See more

    Declaration

    Objective-C

    enum DJIFlyZoneStatus : uint8_t {}

DJIHandheldPowerMode Type

  • Handheld Power Mode.

    See more

    Declaration

    Objective-C

    enum DJIHandheldPowerMode : uint8_t {}

  • The status of the shutter button and record button on the handheld controller. Used by Osmo Mobile only.

    See more

    Declaration

    Objective-C

    enum DJIHandheldButtonStatus : uint8_t {}

  • The status of the trigger button on the handheld controller. Used by Osmo Mobile only.

    See more

    Declaration

    Objective-C

    enum DJIHandheldTriggerStatus : uint8_t {}

  • Status of the handheld joystick in vertical direction. Used by Osmo Mobile only.

    See more

    Declaration

    Objective-C

    enum DJIHandheldJoystickVerticalDirection : uint8_t {}

  • Status of the handheld joystick in horizontal direction. Used by Osmo Mobile only.

    See more

    Declaration

    Objective-C

    enum DJIHandheldJoystickHorizontalDirection : uint8_t {}

DJIIMUStatus

DJIMediaType

DJIMediaVideoPlaybackStatus

  • Defines options for different types of modes for panorama mission.

    See more

    Declaration

    Objective-C

    enum DJIPanoramaMode : NSUInteger {}

  • This enum defines the positioning solution the system is currently using.

    See more

    Declaration

    Objective-C

    enum DJIRTKPositioningSolution : NSInteger {}

DJIRemoteControllerMode

  • Remote Controller mode of operation can be normal (single RC connected to aircraft), master, slave, or unknown.

    See more

    Declaration

    Objective-C

    enum DJIRemoteControllerMode : uint8_t {}

DJIRCControlStyle

  • Remote Controller’s control style.

    See more

    Declaration

    Objective-C

    enum DJIRCControlStyle : uint8_t {}

DJIRCControlChannelName

  • Remote Controller control channels. These will be used in RC Custom Control Style. See RCControlStyleCustom and RCSlaveControlStyleCustom for more information.

    See more

    Declaration

    Objective-C

    enum DJIRCControlChannelName : uint8_t {}

DJIRCRequestGimbalControlResult

  • Result when a slave Remote Controller requests permission to control the gimbal.

    See more

    Declaration

    Objective-C

    enum DJIRCRequestGimbalControlResult : uint8_t {}

DJIRCToAircraftPairingState

DJIRCJoinMasterResult

  • Result when a slave Remote Controller tries to join a master Remote Controller.

    See more

    Declaration

    Objective-C

    enum DJIRCJoinMasterResult : uint8_t {}

DJIRCGimbalControlDirection

  • Defines what the Gimbal Dial (upper left wheel on the Remote Controller) will control.

    See more

    Declaration

    Objective-C

    enum DJIRCGimbalControlDirection : uint8_t {}

DJIRCHardwareTransformationSwitchState

DJIRemoteControllerFlightModeSwitchPosition

DJIRCFiveDButton

  • Movement direction of the remote controller’s 5D button.

    See more

    Declaration

    Objective-C

    enum DJIRCFiveDButtonDirection : NSUInteger {}

DJIRCRemoteFocusControlType

DJIRCRemoteFocusControlDirection

DJIRemoteControllerChargeMobileMode

  • The DJI Remote Log levels.

    See more

    Declaration

    Objective-C

    enum DJILogLevel : NSUInteger {}

  • Direction aircraft is moving around or bypassing and obstacle.

    See more

    Declaration

    Objective-C

    enum DJIBypassDirection : NSInteger {}

  • TapFly Mission execution state.

    See more

    Declaration

    Objective-C

    enum DJITapFlyMissionExecutionState : NSInteger {}

  • Different modes of the TapFly Mission. Defaults to Forward, set to others to enable the feature.

    See more

    Declaration

    Objective-C

    enum DJITapFlyMode : NSInteger {}

  • Position of the sensor on the aircraft.

    See more

    Declaration

    Objective-C

    enum DJIVisionSensorPosition : NSUInteger {}

  • Distance warning returned by each sector of the front vision system. Warning Level 4 is the most serious level.

    See more

    Declaration

    Objective-C

    enum DJIVisionSectorWarning : NSInteger {}

  • Distance warning returned by the front vision system. Warning Level 4 is the most serious level.

    See more

    Declaration

    Objective-C

    enum DJIVisionSystemWarning : NSInteger {}

  • Landing protection status returned by the downward vision sensor.

    See more

    Declaration

    Objective-C

    enum DJIVisionLandingProtectionStatus : NSInteger {}

  • How the aircraft will turn at a waypoint to transition between headings.

    See more

    Declaration

    Objective-C

    enum DJIWaypointTurnMode : NSUInteger {}

  • Waypoint action types.

    See more

    Declaration

    Objective-C

    enum DJIWaypointActionType : NSUInteger {}

DJISDKRegistrationError

DJISDKError

DJISDKCameraError

DJISDKFlightControllerError

DJISDKMissionError

GEO Error

DJICameraMode

DJICameraShootPhotoMode

  • The ShootPhoto mode itself can have several modes. The default value is DJICameraShootPhotoModeSingle.

    See more

    Declaration

    Objective-C

    enum DJICameraShootPhotoMode : NSUInteger {}

DJICameraExposureMode

  • Camera exposure modes. The default value is DJICameraExposureModeProgram.

    The different exposure modes define whether Aperture, Shutter Speed, ISO can be set automatically or manually. Exposure compensation can be changed in all modes except Manual mode where it is not settable.

    X5, X5R, Phantom 4 Pro camera, X4S and X5S:
    Program Mode: Shutter: Auto Aperture: Auto ISO: Manual or Auto
    Shutter Priority: Shutter: Manual Aperture: Auto ISO: Manual or Auto
    Aperture Priority: Shutter: Auto Aperture: Manual ISO: Manual or Auto
    Manual Mode: Shutter: Manual Aperture: Manual ISO: Manual


    All other cameras:
    Program Mode: Shutter: Auto Aperture: Fixed ISO: Auto
    Shutter Priority: Shutter: Manual Aperture: Fixed ISO: Auto
    Aperture Priority: N/A
    Manual Mode: Shutter: Manual Aperture: Manual ISO: Manual

    See more

    Declaration

    Objective-C

    enum DJICameraExposureMode : NSUInteger {}

DJICameraVideoFileFormat

DJICameraVideoResolution

  • Camera video resolution values. The resolutions available for a product are in supportedCameraVideoResolutionAndFrameRateRange.

    See more

    Declaration

    Objective-C

    enum DJICameraVideoResolution : NSUInteger {}

DJICameraVideoFrameRate

  • Camera video frame rate values. The frame rates available for a product are in supportedCameraVideoResolutionAndFrameRateRange.

    See more

    Declaration

    Objective-C

    enum DJICameraVideoFrameRate : NSUInteger {}

DJICameraVideoStandard

  • Video standard values. The default value is NTSC.

    See more

    Declaration

    Objective-C

    enum DJICameraVideoStandard : NSUInteger {}

DJICameraPhotoFileFormat

  • Camera photo file formats. The default value is CameraPhotoJPEG.

    See more

    Declaration

    Objective-C

    enum DJICameraPhotoFileFormat : NSUInteger {}

DJICameraPhotoTimeLapseFileFormat

  • File format for camera when it is in time-lapse mode. The default file format is video. If video+JPEG is selected the minimum interval will be 2 seconds.

    See more

    Declaration

    Objective-C

    enum DJICameraPhotoTimeLapseFileFormat : NSUInteger {}

DJICameraPhotoQuality

  • Photo quality of the JPEG image. Higher photo quality results in larger file size. The default value is CameraPhotoQualityExcellent.

    See more

    Declaration

    Objective-C

    enum DJICameraPhotoQuality : NSUInteger {}

DJICameraPhotoAspectRatio

  • Photo aspect ratio, where the first value is the width and the second value is the height. The default value is CameraPhotoRatio4_3.

    See more

    Declaration

    Objective-C

    enum DJICameraPhotoAspectRatio : NSUInteger {}

DJICameraPhotoBurstCount

  • The number of photos taken in one burst shot (shooting photo in burst mode).

    See more

    Declaration

    Objective-C

    enum DJICameraPhotoBurstCount : NSUInteger {}

DJICameraShutterSpeed

DJICameraISO

  • Camera ISO values.

    See more

    Declaration

    Objective-C

    enum DJICameraISO : NSUInteger {}

DJICameraAperture

  • Camera aperture values. X5, X5R, Z30, Phantom 4 Pro camera, X4S and X5S support this setting.

    See more

    Declaration

    Objective-C

    enum DJICameraAperture : NSUInteger {}

DJICameraWhiteBalance

  • Camera white balance. The default value is CameraWhiteBalanceAuto.

    See more

    Declaration

    Objective-C

    enum DJICameraWhiteBalance : NSUInteger {}

DJICameraMeteringMode

  • Camera exposure metering. The default value is CameraExposureMeteringCenter.

    See more

    Declaration

    Objective-C

    enum DJICameraMeteringMode : NSUInteger {}

DJICameraExposureCompensation

DJICameraAntiFlicker

  • Camera anti-flickers. The default value is CameraAntiFlicker50Hz.

    See more

    Declaration

    Objective-C

    enum DJICameraAntiFlicker : NSUInteger {}

DJICameraSharpness

  • Camera sharpnesss. The default value is CameraSharpnessStandard.

    See more

    Declaration

    Objective-C

    enum DJICameraSharpness : NSUInteger {}

DJICameraContrast

  • Camera contrast. The default value is CameraContrastStandard.

    See more

    Declaration

    Objective-C

    enum DJICameraContrast : NSUInteger {}

DJICameraLensFocusMode

  • Camera focus mode. It is settable only when IsAdjustableFocalPointSupported returns YES and the physical AF switch on the camera is set to auto.

    See more

    Declaration

    Objective-C

    enum DJICameraLensFocusMode : NSUInteger {}

DJILensType

  • The type of the installed lens.

    See more

    Declaration

    Objective-C

    enum DJILensType : NSUInteger {}

DJICameraLensFocusStatus

DJICameraSSDOperationState

DJICameraSSDCapacity

  • Solid State Drive (SSD) Capacity

    See more

    Declaration

    Objective-C

    enum DJICameraSSDCapacity : NSUInteger {}

  • DJI camera’s license keys. An Inspire 2 License Key activates the usage permission of CinemaDNG or Apple ProRes inside CineCore 2.0. License keys are obtained by by purchase from the DJI store website using the Inspire 2 serial number. The Inspire 2 is then connected to DJI Assistant 2, and the license keys downloaded to it. Only supported by X5S camera.

    See more

    Declaration

    Objective-C

    enum DJICameraSSDVideoLicense : NSUInteger {}

DJICameraThermalROI (Region Of Interest)

  • Region of interest. Use this feature to manage color range distribution across the screen to maximize contrast for regions of highest interest. Supported only by thermal imaging cameras.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalROI : NSUInteger {}

DJICameraThermalPalette

  • The different colors are used to show various temperatures in the thermal imagery image. The colors are not actually related to wavelengths of light, but rather the grayscale intensity. Supported only by thermal imaging cameras.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalPalette : NSUInteger {}

DJICameraThermalScene

  • Uses the Scene option to instantly enhance your image. Supported only by thermal imaging cameras.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalScene : NSUInteger {}

DJICameraThermalIsothermUnit

DJICameraThermalGainMode

  • The gain mode. Supported only by thermal imaging cameras.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalGainMode : NSUInteger {}

DJICameraThermalResolution

  • The resolution of thermal imaging camera. Supported only by thermal imaging cameras.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalResolution : NSUInteger {}

DJICameraThermalFrameRateUpperBound

  • The frame rate upper bound supported by the thermal camera. Supported only by thermal imaging cameras.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalFrameRateUpperBound : NSUInteger {}

DJICameraThermalLens

  • The lens model of the thermal imaging camera. Supported only by thermal imaging cameras.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalLensModel : NSUInteger {}

DJICameraThermalVersion

  • There is a standard version and version with Advanced Radiometry capabilities of the Zenmuse XT thermal camera. This enum defines the versions. Supported only by thermal imaging cameras.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalVersion : NSUInteger {}

DJICameraThermalCustomSettings

DJICameraThermalFFCMode

DJICameraThermalDigitalZoomScale

  • Thermal camera digital zoom scale. The default value is DJICameraThermalDigitalZoomScalex1.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalDigitalZoomScale : NSUInteger {}

DJICameraThermalMeasurementMode

  • Thermal camera temperature measurement mode. The default value is DJICameraThermalMeasurementModeDisabled.

    See more

    Declaration

    Objective-C

    enum DJICameraThermalMeasurementMode : NSUInteger {}

DJICameraOpticalZoomDirection

  • The direction to adjust the camera zoom (camera focal length). Supported by X5, X5R and X5S with zoom lens, Z3 camera and Z30 camera.

    See more

    Declaration

    Objective-C

    enum DJICameraOpticalZoomDirection : uint8_t {}

DJICameraOpticalZoomSpeed

  • The speed of lens to zoom. Supported by X5, X5R and X5S with zoom lens, Z3 camera and Z30 camera.

    See more

    Declaration

    Objective-C

    enum DJICameraOpticalZoomSpeed : uint8_t {}

DJICameraFileIndexMode

DJICameraCustomSettings

  • Camera user settings. A user can save or load camera settings to or from the specified user.

    See more

    Declaration

    Objective-C

    enum DJICameraCustomSettings : NSUInteger {}

DJICameraDigitalFilter

  • Camera digital filters. The default value is DJICameraDigitalFilterNone.

    Z30 camera only supports DJICameraDigitalFilterNone, DJICameraDigitalFilterBlackAndWhite and DJICameraDigitalFilterInverse.

    See more

    Declaration

    Objective-C

    enum DJICameraDigitalFilter : NSUInteger {}

DJICameraSSDVideoDigitalFilter

  • Camera digital filters for videos that will be stored in SSD with Apple ProRes codecs. The default value is DJICameraSSDVideoDigitalFilterNone.

    Only Supported by X5S.

    See more

    Declaration

    Objective-C

    enum DJICameraSSDVideoDigitalFilter : NSUInteger {}

DJIDownloadFileType

  • Download file types. This typedef is supported by Phantom 3 Profressional camera, X3, X5 and X5R cameras on aircraft and Phantom 4 camera.

    See more

    Declaration

    Objective-C

    enum DJIDownloadFileType : NSUInteger {}

DJICameraOrientation

  • Physical orientation of the camera.

    Only supported by Mavic Pro

    See more

    Declaration

    Objective-C

    enum DJICameraOrientation : NSUInteger {}

DJIVideoFileCompressionStandard

  • The compression standard used to store the video files. Only supported by X4S, X5S and Phantom 4 Pro cameras.

    See more

    Declaration

    Objective-C

    enum DJIVideoFileCompressionStandard : NSUInteger {}

DJIGimbalRotateDirection

  • Gimbal rotation direction when controlling gimbal movement by speed.

    See more

    Declaration

    Objective-C

    enum DJIGimbalRotateDirection : uint8_t {}

DJIGimbalRotateAngleMode

  • The rotation angle of the gimbal can be defined as either Absolute (relative to the heading), or Relative (relative to its current angle).

    See more

    Declaration

    Objective-C

    enum DJIGimbalRotateAngleMode : uint8_t {}

DJIGimbalWorkMode

DJIGimbalAdvancedSettingsProfile

  • The Advanced Settings Profile contains presets for SmoothTrack and the Physical Controller sensitivity. SmoothTrack and Controller settings can only be manually changed if Custom1 or Custom2 profiles are selected. Only supported by Osmo.

    See more

    Declaration

    Objective-C

    enum DJIGimbalAdvancedSettingsProfile : uint8_t {}

DJIGimbalAxis

DJIGimbalEndpointDirection

  • Gimbal endpoint setting. This is only supported by the Ronin-MX gimbal.

    See more

    Declaration

    Objective-C

    enum DJIGimbalEndpointDirection : uint8_t {}

DJIGimbalMotorControlPreset

  • For gimbals that allow payloads to be changed, the motor control configuration can be used to optimize gimbal performance for the different payloads. Only supported by the Ronin-MX gimbal.

    See more

    Declaration

    Objective-C

    enum DJIGimbalMotorControlPreset : uint8_t {}

DJIGimbalBalanceTestResult

  • For gimbals that allow payloads to be changed, a balance test should be performed to ensure the camera is mounted correctly. Only supported by Ronin-MX.

    See more

    Declaration

    Objective-C

    enum DJIGimbalBalanceTestResult : uint8_t {}

  • The control mode for the gimbal physical controller (joystick for Osmo). The total controller deflection is a combination of horizontal and vertical deflection. This translates to gimbal movement around the yaw and pitch axes. The gimbal can be set to either move in both yaw and pitch simultaneously based on horizontal and vertical deflection of the controller, or move in only yaw or pitch exclusively based on whether horizontal or vertical deflection is larger. Only supported by Osmo.

    See more

    Declaration

    Objective-C

    enum DJIGimbalControllerMode : uint8_t {}

  • The loading balance status of the gimbal. The gimbal loading is changeable for Osmo Mobile. When the mounted mobile device is changed, in order to optimize the gimbal performance, user can adjust the gimbal physically based on the status. Only supported by Osmo Mobile.

    See more

    Declaration

    Objective-C

    enum DJIGimbalLoadingBalanceStatus : uint8_t {}