FocusMeteringAction.Builder

Added in 1.0.0

Kotlin |Java

class FocusMeteringAction.Builder

The builder used to create the FocusMeteringAction.

Summary

Public constructors
`Builder(point: MeteringPoint)` Creates a Builder from a `MeteringPoint` with default mode `FLAG_AF` \| `FLAG_AE` \| `FLAG_AWB`.
`Builder(point: MeteringPoint, meteringMode: Int)` Creates a Builder from a `MeteringPoint` and MeteringMode.

Public functions
`FocusMeteringAction.Builder`	`addPoint(point: MeteringPoint)` Adds another `MeteringPoint` with default metering mode `FLAG_AF` \| `FLAG_AE` \| `FLAG_AWB`.
`FocusMeteringAction.Builder`	`addPoint(point: MeteringPoint, meteringMode: Int)` Adds another `MeteringPoint` with specified meteringMode.
`FocusMeteringAction`	`build()` Builds the `FocusMeteringAction` instance.
`FocusMeteringAction.Builder`	`disableAutoCancel()` Disables the auto-cancel.
`FocusMeteringAction.Builder`	`setAutoCancelDuration(duration: @IntRange(from = 1) Long, timeUnit: TimeUnit)` Sets the auto-cancel duration.

Public constructors

Builder

Added in 1.0.0

Builder(point: MeteringPoint)

Creates a Builder from a MeteringPoint with default mode FLAG_AF | FLAG_AE | FLAG_AWB.

Builder

Added in 1.0.0

Builder(point: MeteringPoint, meteringMode: Int)

Creates a Builder from a MeteringPoint and MeteringMode.

Metering mode is a combination of flags consisting of FLAG_AF, FLAG_AE, and FLAG_AWB. This combination indicates whether the MeteringPoint is used to set AF(Auto Focus) region, AE(Auto Exposure) region or AWB(Auto White Balance) region.

Public functions

addPoint

Added in 1.0.0

fun addPoint(point: MeteringPoint): FocusMeteringAction.Builder

Adds another MeteringPoint with default metering mode FLAG_AF | FLAG_AE | FLAG_AWB.

The points added here will be appended in order after the point set in builder constructor.

If more points are added than what current device supports for AF/AE/AWB, only the first point and then in order up to the number of points supported on the device will be enabled.

If none of the points is supported on the device, this FocusMeteringAction will cause startFocusAndMetering to fail.

See also
`startFocusAndMetering`

addPoint

Added in 1.0.0

fun addPoint(point: MeteringPoint, meteringMode: Int): FocusMeteringAction.Builder

Adds another MeteringPoint with specified meteringMode.

The points added here will be appended in order after the point set in builder constructor.

If more points are added than what current device supports for AF/AE/AWB, only the first point and then in order up to the number of points supported on the device will be enabled.

If none of the points is supported on the device, this FocusMeteringAction will cause startFocusAndMetering to fail.

See also
`startFocusAndMetering`

build

Added in 1.0.0

fun build(): FocusMeteringAction

Builds the FocusMeteringAction instance.

disableAutoCancel

Added in 1.0.0

fun disableAutoCancel(): FocusMeteringAction.Builder

Disables the auto-cancel.

setAutoCancelDuration

Added in 1.0.0

fun setAutoCancelDuration(duration: @IntRange(from = 1) Long, timeUnit: TimeUnit): FocusMeteringAction.Builder

Sets the auto-cancel duration. After set, cancelFocusAndMetering will be called in specified duration. By default, auto-cancel is enabled with 5 seconds duration. The duration must be greater than or equal to 1 otherwise it will throw a IllegalArgumentException.