DJI Mobile SDK Documentation

      class SystemState

      @EXClassNullAway
      class SystemState
      Package:dji.common.camera
      Description:

      This class provides general information and current status of the camera.

      Class Members:
      Callback
      interface
      interface Callback
      interface Callback
      Package:dji.common.camera
      Description:

      Updates the camera's current state. In order to begin updates, call the startCameraStateUpdates method for the respective aircraft.

      Interface Methods:

      Callback Method

      State
      method
      method onUpdate
      void onUpdate(@NonNull SystemState systemState)
      Package:dji.common.camera
      Description:

      Called when the camera's current state has been updated.

      Input Parameters:
      @NonNull SystemState systemStateThe system state of camera.
      Mode
      method
      method getMode
      CameraMode getMode()
      Package:dji.common.camera
      SDK Key:CameraKey.MODE
      Description:

      The current mode of the camera.

      Return:
      CameraModeAn enum value of CameraMode
      method isShootingSinglePhoto
      boolean isShootingSinglePhoto()
      Package:dji.common.camera
      SDK Key:CameraKey.IS_SHOOTING_SINGLE_PHOTO
      Description:

      true when the camera is performing any photo capture in any ShootPhotoMode. Between photo capture in interval and time lapse mode, this property will be false. The camera is shooting a single photo.

      Return:
      booleanA boolean value.
      method isShootingSinglePhotoInRAWFormat
      boolean isShootingSinglePhotoInRAWFormat()
      Package:dji.common.camera
      SDK Key:CameraKey.IS_SHOOTING_SINGLE_PHOTO_IN_RAW_FORMAT
      Description:

      true when the camera is performing a photo capture in RAW or RAW+JPEG format. Between photo capture in interval and time lapse mode, this property will be false. If saving the photo in JPEG only, this property will always be false.

      Return:
      booleanA boolean value.
      method isShootingIntervalPhoto
      boolean isShootingIntervalPhoto()
      Package:dji.common.camera
      SDK Key:CameraKey.IS_SHOOTING_INTERVAL_PHOTO
      Description:

      true when the camera is performing an interval capture. true after startShootPhoto is called, and false after stopShootPhoto is called.

      Return:
      booleanA boolean value.
      method isShootingBurstPhoto
      boolean isShootingBurstPhoto()
      Package:dji.common.camera
      SDK Key:CameraKey.IS_SHOOTING_BURST_PHOTO
      Description:

      true when the camera is performing a burst capture. true after startShootPhoto is called, and false after the burst is complete. The camera is shooting burst photos.

      Return:
      booleanA boolean value.
      method isShootingRAWBurstPhoto
      boolean isShootingRAWBurstPhoto()
      Package:dji.common.camera
      SDK Key:CameraKey.IS_SHOOTING_RAW_BURST_PHOTO
      Description:

      true when the camera is performing a RAW burst capture. true after startShootPhoto is called, and false after the RAW burst is complete. The camera is shooting RAW burst photos.

      Return:
      booleanA boolean value.
      method getCurrentPanoramaPhotoCount
      int getCurrentPanoramaPhotoCount()
      Package:dji.common.camera
      Description:

      The current completed photo count of the executing panorama shot.

      Return:
      intAn int value.
      method isShootingShallowFocusPhoto
      boolean isShootingShallowFocusPhoto()
      Package:dji.common.camera
      Description:

      true when the camera is performing a ShallowFocus capture.

      Return:
      booleanA boolean value.
      method isShootingPanoramaPhoto
      boolean isShootingPanoramaPhoto()
      Package:dji.common.camera
      Description:

      true when the camera is performing a Panorama capture.

      Return:
      booleanA boolean value.
      method isStoringPhoto
      boolean isStoringPhoto()
      Package:dji.common.camera
      SDK Key:CameraKey.IS_STORING_PHOTO
      Description:

      true if the camera is storing a photo. When isStoringPhoto is true, the user cannot change the camera mode or start to shoot another photo.

      Return:
      booleanA boolean value.
      Panorama
      method
      method getPanoramaProgress
      int getPanoramaProgress()
      Package:dji.common.camera
      Description:

      The progress of the executing panorama shot. It is null if there is no executing panorama shot.

      Return:
      intAn int value.
      Video
      method
      method isRecording
      boolean isRecording()
      Package:dji.common.camera
      SDK Key:CameraKey.IS_RECORDING
      Description:

      true if the camera is recording video.

      Return:
      booleanA boolean value.
      method getCurrentVideoRecordingTimeInSeconds
      int getCurrentVideoRecordingTimeInSeconds()
      Package:dji.common.camera
      SDK Key:CameraKey.CURRENT_VIDEO_RECORDING_TIME_IN_SECONDS
      Description:

      The duration, in seconds, of the video currently being recorded by the camera.

      Return:
      intAn int value.
      Error
      method
      method isOverheating
      boolean isOverheating()
      Package:dji.common.camera
      SDK Key:CameraKey.IS_OVERHEATING
      Description:

      true if the camera is too hot.

      Return:
      booleanA boolean value.
      method
      method hasError
      boolean hasError()
      Package:dji.common.camera
      SDK Key:CameraKey.HAS_ERROR
      Description:

      true if there is a camera sensor error.

      Return:
      booleanA boolean value.