CameraXConfig.Builder

public static final class CameraXConfig.Builder
extends Object

java.lang.Object
   ↳ androidx.camera.core.CameraXConfig.Builder


A builder for generating CameraXConfig objects.

Summary

Public methods

CameraXConfig build()

Builds an immutable CameraXConfig from the current state.

static CameraXConfig.Builder fromConfig(CameraXConfig configuration)

Generates a Builder from another CameraXConfig object

CameraXConfig.Builder setCameraExecutor(Executor executor)

Sets an executor which CameraX will use to drive the camera stack.

CameraXConfig.Builder setSchedulerHandler(Handler handler)

Sets a handler that CameraX will use internally for scheduling future tasks.

Inherited methods

Public methods

build

public CameraXConfig build ()

Builds an immutable CameraXConfig from the current state.

Returns
CameraXConfig A CameraXConfig populated with the current state.

fromConfig

public static CameraXConfig.Builder fromConfig (CameraXConfig configuration)

Generates a Builder from another CameraXConfig object

Parameters
configuration CameraXConfig: An immutable configuration to pre-populate this builder.

Returns
CameraXConfig.Builder The new Builder.

setCameraExecutor

public CameraXConfig.Builder setCameraExecutor (Executor executor)

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.

Parameters
executor Executor

Returns
CameraXConfig.Builder

setSchedulerHandler

public CameraXConfig.Builder setSchedulerHandler (Handler handler)

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.

Parameters
handler Handler

Returns
CameraXConfig.Builder