DJI Mobile SDK Documentation

      class DJICameraCapabilities

      @interface DJICameraCapabilities : NSObject
      Header:DJICameraCapabilities.h
      Inherits From:NSObject
      Description:

      Some of the camera's parameters have dynamic ranges. The DJICameraCapabilities class allows you to query the valid range for a parameter. Type-casting is required to get the corresponding enumerator value for each range element.

      Class Members:
      Add Listener
      method
      method addListener
      - (void)addListener:(nonnull id<DJICameraCapabilitiesListener>)listener
      Header:DJICameraCapabilities.h
      Description:

      Add listener to listen for the camera range change.

      Input Parameters:
      nonnull id<DJICameraCapabilitiesListener> listenerlistener
      State Updates
      method
      method removeListener
      - (void)removeListener:(nonnull id<DJICameraCapabilitiesListener>)listener
      Header:DJICameraCapabilities.h
      Description:

      Remove listener which is listening to the camera range change.

      Input Parameters:
      nonnull id<DJICameraCapabilitiesListener> listenerlistener
      method removeAllListeners
      - (void)removeAllListeners
      Header:DJICameraCapabilities.h
      Description:

      Remove all listeners.

      Camera Mode
      method
      method modeRange
      - (nonnull NSArray<NSNumber *> *)modeRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera mode (DJICameraMode). Returns nil if current camera has no supported camera mode or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represents one current supported camera mode.
      Exposure
      method
      method exposureModeRange
      - (nonnull NSArray<NSNumber *> *)exposureModeRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's exposure mode (DJICameraExposureMode). Returns nil if current camera does not support any exposure mode or the camera is disconnected. @return Array of NSNumber. Each element represent one current supported exposure mode.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported exposure mode.
      method
      method ISORange
      - (nonnull NSArray<NSNumber *> *)ISORange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's ISO (see DJICameraISO). Returns nil if current camera does not support any ISO value or the camera is disconnected. @return An NSNumber array. Each element represent one current supported ISO value.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported ISO value.
      method shutterSpeedRange
      - (nonnull NSArray<NSNumber *> *)shutterSpeedRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's shutter speed (see DJICameraShutterSpeed). Returns nil if current camera does not support any shutter speed value or the camera is disconnected. @return Array of NSNumber. Each element represent one current supported shutter speed value.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported shutter speed value.
      method apertureRange
      - (nonnull NSArray<NSNumber *> *)apertureRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's aperture (see DJICameraAperture). Returns nil if current camera does not support any aperture value or the camera is disconnected. @return Array of NSNumber. Each element represent one current supported aperture value.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported aperture value.
      method exposureCompensationRange
      - (nonnull NSArray<NSNumber *> *)exposureCompensationRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's exposure compensation (see DJICameraExposureCompensation). Returns nil if current camera does not support any exposure compensation value or the camera is disconnected. @return Array of NSNumber. Each element represent one current supported exposure compensation value.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported exposure compensation value.
      method AEBCaptureNumRange
      - (nonnull NSArray<NSNumber *> *)AEBCaptureNumRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's AEB (see DJICameraPhotoAEBCount). Returns nil if current camera does not support any AEB value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera AEB capture num range.
      White Balance
      method
      method whiteBalancePresetRange
      - (nonnull NSArray<NSNumber *> *)whiteBalancePresetRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid presets for camera's white balance (see DJICameraWhiteBalancePreset). Returns nil if current camera does not support any white balance value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera white balance preset range.
      method whiteBalanceCustomColorTemperatureRange
      - (nonnull NSArray<NSNumber *> *)whiteBalanceCustomColorTemperatureRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's custom color temperature.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera white balance custom color temperature range.
      Compression Standard Range
      method
      method videoFileCompressionStandardRange
      - (nonnull NSArray<NSNumber *> *)videoFileCompressionStandardRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for video file compression standard range.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represents one current supported video file compression standard.
      method videoResolutionAndFrameRateRange
      - (nonnull NSArray<DJICameraVideoResolutionAndFrameRate *> *)videoResolutionAndFrameRateRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for video resolution DJICameraVideoResolution and frame rate DJICameraVideoFrameRate. Returns nil if the current camera does not support any video resolution or frame rate setting, or if the camera is disconnected.

      Return:
      nonnull NSArray<DJICameraVideoResolutionAndFrameRate *> *Array of pairs. Each pair represents a valid DJICameraVideoResolution value and DJICameraVideoFrameRate value.
      method SSDVideoResolutionRange
      - (nonnull NSArray<NSNumber *> *)SSDVideoResolutionRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's RAW video resolution. Returns nil if current camera does not support any RAW video resolution or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported resolution value.
      method H1VideoFormatRange
      - (nonnull NSArray<NSNumber *> *)H1VideoFormatRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid video format range for h1 cameras in raw mode. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of pairs, each consisting of a valid 'DJIH1RawModeEnum' value, a valid DJICameraVideoResolution value and DJICameraVideoFrameRate.
      method videoFileFormatRange
      - (nonnull NSArray<NSNumber *> *)videoFileFormatRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid video file format. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera video file format range.
      method burstCaptureCountRange
      - (nonnull NSArray<NSNumber *> *)burstCaptureCountRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid camera burst count range. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera burst capture count range.
      method photoIntervalRange
      - (nonnull NSArray<NSNumber *> *)photoIntervalRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid camera photo interval range. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera photo interval range.
      method panoOriginalImagesFormatRange
      - (nonnull NSArray<NSNumber *> *)panoOriginalImagesFormatRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the photo formats supported by the camera for saving the original images of panorama. The return value is nil if current camera does not support any photo formats or is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element is a value of DJICameraPhotoFileFormat.
      method photoAspectRatioRange
      - (nonnull NSArray<NSNumber *> *)photoAspectRatioRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid range for camera's photo aspect ratio (See DJICameraPhotoAspectRatio). Returns nil if current camera does not support any photo aspect ratio value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported photo aspect ratio value.
      method photoFileFormatRange
      - (nonnull NSArray<NSNumber *> *)photoFileFormatRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid camera photo file format range. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera photo file format range.
      method photoShootModeRange
      - (nonnull NSArray<NSNumber *> *)photoShootModeRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the supported camera shoot photo modes. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represents one supported camera shoot photo mode.
      method pictureStyleCustomSaturationRange
      - (nonnull NSArray<NSNumber *> *)pictureStyleCustomSaturationRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid camera picture style custom saturation range. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera picture style custom saturation range.
      method pictureStyleCustomSharpnessRange
      - (nonnull NSArray<NSNumber *> *)pictureStyleCustomSharpnessRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid camera picture style custom sharpness range. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera picture style custom sharpness range.
      method pictureStyleCustomContrastRange
      - (nonnull NSArray<NSNumber *> *)pictureStyleCustomContrastRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid camera picture style custom contrast range. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera picture style custom contrast range.
      method colorRange
      - (nonnull NSArray<NSNumber *> *)colorRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the current valid camera color range. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element represent one current supported camera color range.
      Panorama Mode
      method
      method photoPanoramaModeRange
      - (nonnull NSArray<NSNumber *> *)photoPanoramaModeRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the panorama modes supported by the camera. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element is a value of DJICameraPhotoPanoramaMode.
      Orientation
      method
      method orientationRange
      - (nonnull NSArray<NSNumber *> *)orientationRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the orientations supported by the camera. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element is a value of DJICameraOrientation.
      Anti Flicker Frequency
      method
      method antiFlickerFrequencyRange
      - (nonnull NSArray<NSNumber *> *)antiFlickerFrequencyRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the anti flicker frequency supported by the camera. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber. Each element is a value of DJICameraAntiFlickerFrequency.
      Long Exposure Preview Time
      method
      method longExposurePreviewTimeRange
      - (nonnull NSArray<NSNumber *> *)longExposurePreviewTimeRange
      Header:DJICameraCapabilities.h
      Description:

      Returns the long exposure preview time supported by the camera. Returns nil if current camera does not support any value or the camera is disconnected.

      Return:
      nonnull NSArray<NSNumber *> *Array of NSNumber.
      State Updates
      protocol
      protocol DJICameraCapabilitiesListener
      @protocol DJICameraCapabilitiesListener <NSObject>
      Header:DJICameraCapabilities.h
      Inherits From:NSObject
      Description:

      This protocol provides a method that is notified when the camera parameters' range changes.

      Protocol Methods:

      Protocol Method

      method cameraCapabilities:change
      @optional
      - (void)cameraCapabilities:(nonnull DJICameraCapabilities *)capabilities change:(nonnull NSDictionary<id, NSString *> *)change
      Header:DJICameraCapabilities.h
      Description:

      When a parameter range is changed, the listener will receive this callback.

      Input Parameters:
      nonnull DJICameraCapabilities * capabilitiesThe parameters.
      nonnull NSDictionary<id, NSString *> * changeThe new range and key.
      const DJISupportedCameraVideoFileCompressionStandardRange
      extern NSString *const DJISupportedCameraVideoFileCompressionStandardRange
      Header:DJICameraCapabilities.h
      Description:

      CameraVideoCompressionStandardRange key.

      const DJISupportedCameraVideoResolutionAndFrameRateRange
      extern NSString *const DJISupportedCameraVideoResolutionAndFrameRateRange
      Header:DJICameraCapabilities.h
      Description:

      CameraVideoResolutionAndFrameRateRange key.

      const DJISupportedCameraVideoFOVRange
      extern NSString *const DJISupportedCameraVideoFOVRange
      Header:DJICameraCapabilities.h
      Description:

      DJISupportedCameraVideoFOVRange key.

      const DJISupportedCameraModeRange
      extern NSString *const DJISupportedCameraModeRange
      Header:DJICameraCapabilities.h
      Description:

      CameraModeRange key.

      const DJISupportedCameraExposureModeRange
      extern NSString *const DJISupportedCameraExposureModeRange
      Header:DJICameraCapabilities.h
      Description:

      CameraExposureModeRange key.

      const DJISupportedCameraISORange
      extern NSString *const DJISupportedCameraISORange
      Header:DJICameraCapabilities.h
      Description:

      CameraISORange key.

      const DJISupportedCameraShutterSpeedRange
      extern NSString *const DJISupportedCameraShutterSpeedRange
      Header:DJICameraCapabilities.h
      Description:

      CameraShutterSpeedRange key.

      const DJISupportedCameraExposureCompensationRange
      extern NSString *const DJISupportedCameraExposureCompensationRange
      Header:DJICameraCapabilities.h
      Description:

      CameraExposureCompensationRange key.

      const DJISupportedCameraApertureRange
      extern NSString *const DJISupportedCameraApertureRange
      Header:DJICameraCapabilities.h
      Description:

      CameraApertureRange key.

      const DJISupportedCameraSSDVideoResolutionRange
      extern NSString *const DJISupportedCameraSSDVideoResolutionRange
      Header:DJICameraCapabilities.h
      Description:

      Key to query the supported RAW video resolution. It is supported by X5S camera.

      const DJISupportedCameraBurstCaptureCountRange
      extern NSString *const DJISupportedCameraBurstCaptureCountRange
      Header:DJICameraCapabilities.h
      Description:

      Number of photos using burst capture mode return a array of DJICameraPhotoBurstCount.

      const DJISupportedCameraRAWBurstCaptureCountRange
      extern NSString *const DJISupportedCameraRAWBurstCaptureCountRange
      Header:DJICameraCapabilities.h
      Description:

      Number of photos using RAWBurst capture mode return a array of DJICameraPhotoBurstCount.

      const DJISupportedCameraAEBCaptureNumRange
      extern NSString *const DJISupportedCameraAEBCaptureNumRange
      Header:DJICameraCapabilities.h
      Description:

      The number of pictures to continuously take at one time in AEB mode return a array of DJICameraPhotoAEBCount.

      const DJISupportedCameraPhotoIntervalRange
      extern NSString *const DJISupportedCameraPhotoIntervalRange
      Header:DJICameraCapabilities.h
      Description:

      Interval range of camera timed shot return a array contains min value, max value in seconds.

      const DJISupportedCameraPhotoFileFormatRange
      extern NSString *const DJISupportedCameraPhotoFileFormatRange
      Header:DJICameraCapabilities.h
      Description:

      Camera photo file formats return a list of DJICameraPhotoFileFormat.

      const DJISupportedCameraVideoFileFormatRange
      extern NSString *const DJISupportedCameraVideoFileFormatRange
      Header:DJICameraCapabilities.h
      Description:

      Camera video file formats return a list of DJICameraVideoFileFormat.

      const DJISupportedCameraWhiteBalanceCustomColorTemperatureRange
      extern NSString *const DJISupportedCameraWhiteBalanceCustomColorTemperatureRange
      Header:DJICameraCapabilities.h
      Description:

      Return an array contains min wb color temp value and max value, for example value 20 is 20*100 = 2000k.

      const DJISupportedCameraPictureStyleCustomSaturationRange
      extern NSString *const DJISupportedCameraPictureStyleCustomSaturationRange
      Header:DJICameraCapabilities.h
      Description:

      Return an array contains min and max value for custom picture style saturation.

      const DJISupportedCameraPictureStyleCustomSharpnessRange
      extern NSString *const DJISupportedCameraPictureStyleCustomSharpnessRange
      Header:DJICameraCapabilities.h
      Description:

      Return an array contains min and max value for custom picture style sharpness.

      const DJISupportedCameraPictureStyleCustomContrastRange
      extern NSString *const DJISupportedCameraPictureStyleCustomContrastRange
      Header:DJICameraCapabilities.h
      Description:

      Return an array contains min and max value for custom picture style contrast.

      const DJISupportedCameraColorRange
      extern NSString *const DJISupportedCameraColorRange
      Header:DJICameraCapabilities.h
      Description:

      Return a list contains camera color supported.

      const DJISupportedCameraWhiteBalancePresetRange
      extern NSString *const DJISupportedCameraWhiteBalancePresetRange
      Header:DJICameraCapabilities.h
      Description:

      Return a list of DJICameraWhiteBalancePreset.

      const DJISupportedCameraPhotoAspectRatioRange
      extern NSString *const DJISupportedCameraPhotoAspectRatioRange
      Header:DJICameraCapabilities.h
      Description:

      Return a list of DJICameraPhotoAspectRatio.

      const DJISupportedCameraPhotoShootModeRange
      extern NSString *const DJISupportedCameraPhotoShootModeRange
      Header:DJICameraCapabilities.h
      Description:

      Return a list of DJICameraShootPhotoMode elements.

      const DJISupportedCameraPanoOriginalImagesFormatRange
      extern NSString *const DJISupportedCameraPanoOriginalImagesFormatRange
      Header:DJICameraCapabilities.h
      Description:

      Use this key to fetch all the file formats of original images supported by the camera in panorama mode.

      const DJISupportedCameraPhotoPanoramaModeRange
      extern NSString *const DJISupportedCameraPhotoPanoramaModeRange
      Header:DJICameraCapabilities.h
      Description:

      Use this key to fetch the panorama modes supported by the camera.

      const DJISupportedCameraOrientationRange
      extern NSString *const DJISupportedCameraOrientationRange
      Header:DJICameraCapabilities.h
      Description:

      Use this key to fetch the orientations supported by the camera.

      const DJISupportedCameraAntiFlickerFrequencyRange
      extern NSString *const DJISupportedCameraAntiFlickerFrequencyRange
      Header:DJICameraCapabilities.h
      Description:

      Use this key to fetch the anti flicker frequency supported by the camera.

      const DJISupportedCameraLongExposurePreviewTimeRange
      extern NSString *const DJISupportedCameraLongExposurePreviewTimeRange
      Header:DJICameraCapabilities.h
      Description:

      Use this key to fetch the long exposure preview time supported by the camera.