FocusMeteringAction.Builder
public
static
class
FocusMeteringAction.Builder
extends Object
java.lang.Object | |
↳ | androidx.camera.core.FocusMeteringAction.Builder |
The builder used to create the FocusMeteringAction
.
Summary
Public constructors | |
---|---|
Builder(MeteringPoint point)
Creates a Builder from a |
|
Builder(MeteringPoint point, int meteringMode)
Creates a Builder from a |
Public methods | |
---|---|
FocusMeteringAction.Builder
|
addPoint(MeteringPoint point, int meteringMode)
Adds another |
FocusMeteringAction.Builder
|
addPoint(MeteringPoint point)
Adds another |
FocusMeteringAction
|
build()
Builds the |
FocusMeteringAction.Builder
|
disableAutoCancel()
Disables the auto-cancel. |
FocusMeteringAction.Builder
|
setAutoCancelDuration(long duration, TimeUnit timeUnit)
Sets the auto-cancel duration. |
Inherited methods | |
---|---|
Public constructors
Builder
public Builder (MeteringPoint point)
Creates a Builder from a MeteringPoint
with default mode FocusMeteringAction.FLAG_AF
|
FocusMeteringAction.FLAG_AE
| FocusMeteringAction.FLAG_AWB
.
Parameters | |
---|---|
point |
MeteringPoint |
Builder
public Builder (MeteringPoint point, int meteringMode)
Creates a Builder from a MeteringPoint
and MeteringMode.
Metering mode is a combination of flags consisting of FocusMeteringAction.FLAG_AF
,
FocusMeteringAction.FLAG_AE
, and FocusMeteringAction.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.
Parameters | |
---|---|
point |
MeteringPoint |
meteringMode |
int |
Public methods
addPoint
public FocusMeteringAction.Builder addPoint (MeteringPoint point, int meteringMode)
Adds another MeteringPoint
with specified meteringMode.
Metering mode is a combination of flags consisting of FocusMeteringAction.FLAG_AF
,
FocusMeteringAction.FLAG_AE
, and FocusMeteringAction.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.
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
CameraControl.startFocusAndMetering(FocusMeteringAction)
to fail.
Parameters | |
---|---|
point |
MeteringPoint |
meteringMode |
int |
Returns | |
---|---|
FocusMeteringAction.Builder |
addPoint
public FocusMeteringAction.Builder addPoint (MeteringPoint point)
Adds another MeteringPoint
with default metering mode FocusMeteringAction.FLAG_AF
|
FocusMeteringAction.FLAG_AE
| FocusMeteringAction.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
CameraControl.startFocusAndMetering(FocusMeteringAction)
to fail.
Parameters | |
---|---|
point |
MeteringPoint |
Returns | |
---|---|
FocusMeteringAction.Builder |
build
public FocusMeteringAction build ()
Builds the FocusMeteringAction
instance.
Returns | |
---|---|
FocusMeteringAction |
disableAutoCancel
public FocusMeteringAction.Builder disableAutoCancel ()
Disables the auto-cancel.
Returns | |
---|---|
FocusMeteringAction.Builder |
setAutoCancelDuration
public FocusMeteringAction.Builder setAutoCancelDuration (long duration, TimeUnit timeUnit)
Sets the auto-cancel duration. After set, CameraControl.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
.
Parameters | |
---|---|
duration |
long Value is 1 or greater. |
timeUnit |
TimeUnit |
Returns | |
---|---|
FocusMeteringAction.Builder |