CameraConfig

Kotlin |Java

@RequiresApi(21) interface CameraConfig : ReadableConfig

androidx.camera.core.impl.CameraConfig

Configuration for a androidx.camera.core.Camera.

Summary

Nested classes
abstract	`Builder` Builder for creating a `CameraConfig`.
	`RequiredRule`

Constants
static Int	`REQUIRED_RULE_COEXISTING_PREVIEW_AND_IMAGE_CAPTURE` Both `Preview` and `ImageCapture` use cases are needed when the camera is opened by the camera config.
static Int	`REQUIRED_RULE_NONE` No rule is required when the camera is opened by the camera config.

Public methods
abstract Identifier	`getCompatibilityId()` Retrieves the compatibility `Identifier`.
open SessionProcessor?	`getSessionProcessor(@Nullable valueIfMissing: SessionProcessor?)` Returns the session processor which will transform the stream configurations and will perform the repeating request and still capture request when being requested by CameraX.
open SessionProcessor	`getSessionProcessor()` Returns the session processor which will transform the stream configurations and will perform the repeating request and still capture request when being requested by CameraX.
open Int	`getUseCaseCombinationRequiredRule()` Returns the use case combination required rule when the camera is opened by the camera config.
open UseCaseConfigFactory	`getUseCaseConfigFactory()` Retrieves the use case config factory instance.
open Boolean	`isZslDisabled()` Retrieves the status for zsl disabled or not.

Inherited functions

From class ReadableConfig

`Boolean`	`containsOption(@NonNull id: Config.Option<*>)`
`Unit`	`findOptions(@NonNull idSearchString: String, @NonNull matcher: Config.OptionMatcher)`
`Config`	`getConfig()` Returns the underlying immutable `Config` object.
`Config.OptionPriority`	`getOptionPriority(@NonNull opt: Config.Option<*>)`
`MutableSet<Config.OptionPriority!>`	`getPriorities(@NonNull option: Config.Option<*>)`
`MutableSet<Config.Option<*>!>`	`listOptions()`
`ValueT?`	`retrieveOption(@NonNull id: Config.Option<ValueT>)`
`ValueT?`	`retrieveOption(@NonNull id: Config.Option<ValueT>, @Nullable valueIfMissing: ValueT?)`
`ValueT?`	`retrieveOptionWithPriority(@NonNull id: Config.Option<ValueT>, @NonNull priority: Config.OptionPriority)`

Properties
static Config.Option<Identifier!>!	`OPTION_COMPATIBILITY_ID`
static Config.Option<SessionProcessor!>!	`OPTION_SESSION_PROCESSOR`
static Config.Option<UseCaseConfigFactory!>!	`OPTION_USECASE_CONFIG_FACTORY`
static Config.Option<Int!>!	`OPTION_USE_CASE_COMBINATION_REQUIRED_RULE`
static Config.Option<Boolean!>!	`OPTION_ZSL_DISABLED`

Constants

REQUIRED_RULE_COEXISTING_PREVIEW_AND_IMAGE_CAPTURE

static val REQUIRED_RULE_COEXISTING_PREVIEW_AND_IMAGE_CAPTURE: Int

Both Preview and ImageCapture use cases are needed when the camera is opened by the camera config. An extra Preview or ImageCapture will be added only if one use case is lacking. If both Preview and ImageCapture are not bound, no extra Preview and ImageCapture will be added.

Value: 1

REQUIRED_RULE_NONE

static val REQUIRED_RULE_NONE: Int

No rule is required when the camera is opened by the camera config.

Value: 0

Public methods

getCompatibilityId

@NonNull abstract fun getCompatibilityId(): Identifier

Retrieves the compatibility Identifier.

If camera configs have the same compatibility identifier, they will allow to bind a new use case without unbinding all use cases first.

getSessionProcessor

@Nullable open fun getSessionProcessor(@Nullable valueIfMissing: SessionProcessor?): SessionProcessor?

Returns the session processor which will transform the stream configurations and will perform the repeating request and still capture request when being requested by CameraX.

Parameters
`valueIfMissing`	SessionProcessor?: The value to return if this configuration option has not been set.

Return
`SessionProcessor?`	The stored value or `valueIfMissing` if the value does not exist in this configuration.

getSessionProcessor

@NonNull open fun getSessionProcessor(): SessionProcessor

Returns the session processor which will transform the stream configurations and will perform the repeating request and still capture request when being requested by CameraX.

Return
`SessionProcessor`	The stored value, if it exists in this configuration.

Exceptions
`IllegalArgumentException`	if the option does not exist in this configuration.

getUseCaseCombinationRequiredRule

open fun getUseCaseCombinationRequiredRule(): Int

Returns the use case combination required rule when the camera is opened by the camera config.

getUseCaseConfigFactory

@NonNull open fun getUseCaseConfigFactory(): UseCaseConfigFactory

Retrieves the use case config factory instance.

isZslDisabled

@NonNull open fun isZslDisabled(): Boolean

Retrieves the status for zsl disabled or not.

Properties

OPTION_COMPATIBILITY_ID

static val OPTION_COMPATIBILITY_ID: Config.Option<Identifier!>!

OPTION_SESSION_PROCESSOR

static val OPTION_SESSION_PROCESSOR: Config.Option<SessionProcessor!>!

OPTION_USECASE_CONFIG_FACTORY

static val OPTION_USECASE_CONFIG_FACTORY: Config.Option<UseCaseConfigFactory!>!

OPTION_USE_CASE_COMBINATION_REQUIRED_RULE

static val OPTION_USE_CASE_COMBINATION_REQUIRED_RULE: Config.Option<Int!>!

OPTION_ZSL_DISABLED

static val OPTION_ZSL_DISABLED: Config.Option<Boolean!>!