Builder
class Builder : Builder<CameraX!, CameraXConfig.Builder!>
kotlin.Any | |
↳ | androidx.camera.core.CameraXConfig.Builder |
A builder for generating CameraXConfig
objects.
Summary
Public methods | |
---|---|
CameraXConfig |
build() Builds an immutable |
static CameraXConfig.Builder |
fromConfig(@NonNull configuration: CameraXConfig) Generates a Builder from another |
CameraXConfig.Builder |
setAvailableCamerasLimiter(@NonNull availableCameraSelector: CameraSelector) Sets a |
CameraXConfig.Builder |
setCameraExecutor(@NonNull executor: Executor) Sets an executor which CameraX will use to drive the camera stack. |
CameraXConfig.Builder |
setMinimumLoggingLevel(@IntRange(3, 6) logLevel: Int) Sets the minimum logging level to be used for CameraX logs. |
CameraXConfig.Builder |
setSchedulerHandler(@NonNull handler: Handler) Sets a handler that CameraX will use internally for scheduling future tasks. |
Public methods
build
@NonNull fun build(): CameraXConfig
Builds an immutable CameraXConfig
from the current state.
Return | |
---|---|
CameraXConfig |
A CameraXConfig populated with the current state. |
fromConfig
@NonNull static fun fromConfig(@NonNull configuration: CameraXConfig): CameraXConfig.Builder
Generates a Builder from another CameraXConfig
object
Parameters | |
---|---|
configuration |
CameraXConfig: An immutable configuration to pre-populate this builder. |
Return | |
---|---|
CameraXConfig.Builder |
The new Builder. |
setAvailableCamerasLimiter
@NonNull fun setAvailableCamerasLimiter(@NonNull availableCameraSelector: CameraSelector): CameraXConfig.Builder
Sets a CameraSelector
to determine the available cameras, thus defining which cameras can be used in the application.
Only cameras selected by this CameraSelector can be used in the application. If the application binds use cases with a CameraSelector that selects an unavailable camera, an IllegalArgumentException
will be thrown.
This configuration can help CameraX optimize the latency of CameraX initialization. The tasks CameraX initialization performs include enumerating cameras, querying camera characteristics and retrieving properties in preparation for resolution determination. On some low end devices, these tasks could take a significant amount of time. Using this method can avoid the initialization of unnecessary cameras and speed up the time for camera start-up. For example, if the application uses only back facing cameras, it can set this configuration with CameraSelector#DEFAULT_BACK_CAMERA
and then CameraX will avoid initializing front facing cameras to reduce the latency.
setCameraExecutor
@NonNull fun setCameraExecutor(@NonNull executor: Executor): CameraXConfig.Builder
Sets an executor which CameraX will use to drive the camera stack.
This option can be used to override the default internal executor created by CameraX, and will be used by the implementation to drive all cameras.
It is not necessary to set an executor for normal use, and should only be used in applications with very specific threading requirements. If not set, CameraX will create and use an optimized default internal executor.
setMinimumLoggingLevel
@NonNull fun setMinimumLoggingLevel(@IntRange(3, 6) logLevel: Int): CameraXConfig.Builder
Sets the minimum logging level to be used for CameraX logs.
The logging level should be one of the following: Log#DEBUG
, Log#INFO
, Log#WARN
or Log#ERROR
.
When not specified, the default minimum logging level used inside CameraX is Log#DEBUG
.
Parameters | |
---|---|
logLevel |
Int: The minimum logging level, which should be Log#DEBUG , Log#INFO , Log#WARN or Log#ERROR . |
Return | |
---|---|
CameraXConfig.Builder |
This Builder instance. |
setSchedulerHandler
@NonNull fun setSchedulerHandler(@NonNull handler: Handler): CameraXConfig.Builder
Sets a handler that CameraX will use internally for scheduling future tasks.
This scheduler may also be used for legacy APIs which require a Handler
. Tasks that are scheduled with this handler will always be executed by the camera executor. No business logic will be executed directly by this handler.
It is not necessary to set a scheduler handler for normal use, and should only be used in applications with very specific threading requirements. If not set, CameraX will create and use an optimized default internal handler.
See Also