CameraState

@AutoValue
abstract class CameraState

Represents the different states the camera can be in.

The following table displays the states the camera can be in, and the possible transitions between them.

Initially, a camera is in a CLOSED state. When it receives a signal to open, for example after one or multiple use cases are attached to it, its state moves to the OPENING state. If it successfully opens the camera device, its state moves to the OPEN state, otherwise, it may move to a different state depending on the error it encountered:

• If opening the camera device fails prematurely, for example, when "Do Not Disturb" mode is enabled on a device that's affected by a bug in Android 9 (see ERROR_DO_NOT_DISTURB_MODE_ENABLED), the state moves to the CLOSED state .
• If the error is recoverable, CameraX will attempt to reopen the camera device. If a recovery attempt succeeds, the camera state moves to the OPEN state, however, if all recovery attempts are unsuccessful, the camera waits in a PENDING_OPEN state to attempt recovery again once the camera device's availability changes.
• If the error is critical, and requires the intervention of the developer or user, the camera's state moves to the CLOSING state.

While in the PENDING_OPEN state, the camera waits for a signal indicating the camera device's availability. The signal can either be an external one from the camera service, or an internal one from within CameraX. When received, the camera's state moves to the OPENING state, and an attempt to open the camera device is made.

While in the OPEN state, the camera device may be disconnected due to an error. In this case, depending on whether the error is critical or recoverable, CameraX may or may not attempt to recover from it, thus the state will move to either a CLOSING or OPENING state.

If the camera is in an OPEN state and receives a signal to close the camera device, for example when all its previously attached use cases are detached, its state moves to the CLOSING state. Once the camera device finishes closing, the camera state moves to the CLOSED state.

Whenever the camera encounters an error, it reports it through getError.

Summary

const val ERROR_CAMERA_DISABLED = 5: Int

const val ERROR_CAMERA_FATAL_ERROR = 6: Int

const val ERROR_CAMERA_IN_USE = 2: Int

const val ERROR_DO_NOT_DISTURB_MODE_ENABLED = 7: Int

const val ERROR_MAX_CAMERAS_IN_USE = 1: Int

const val ERROR_OTHER_RECOVERABLE_ERROR = 3: Int

const val ERROR_STREAM_CONFIG = 4: Int

CameraState()

java-static fun create(type: CameraState.Type): CameraState

java-static fun create(type: CameraState.Type, error: CameraState.StateError?): CameraState

abstract fun getError(): CameraState.StateError?

abstract fun getType(): CameraState.Type