程序包 ohos.media.camera.device

接口 FrameConfig.Builder

封闭接口:

FrameConfig

public static interface FrameConfig.Builder

Provides frame configuration Builder objects.

A created Builder object cannot be changed.

从以下版本开始:

1

方法概要

限定符和类型	方法	说明
FrameConfig.Builder	addSurface(Surface surface)	Adds a surface as frame capture output.
FrameConfig	build()	Creates a FrameConfig object.
<T> T	get(ParameterKey.Key<T> key)	Gets the parameter value of the current frame capture configuration.
int	getAeMode()	Gets the automatic exposure (AE) mode configured for the current frame capture.
Rect	getAeRect()	Gets the AE area configured for the current frame capture.
int	getAeTrigger()	Gets the AE trigger type configured for the current frame capture.
int	getAfMode()	Gets the autofocus (AF) mode configured for the current frame capture.
Rect	getAfRect()	Gets the AF area configured for the current frame capture.
int	getAfTrigger()	Gets the AF trigger type configured for the current frame capture.
int	getAwbMode()	Gets the auto white balance (AWB) mode set for the current frame capture.
Surface	getCoordinateSurface()	Obtains the surface on which the central coordinate system is based.
int	getFaceDetectionType()	Gets the face detection type configured for the current frame capture.
int	getFlashMode()	Gets the flash mode configured for the current frame capture.
int	getFrameConfigType()	Gets the template type for frame capture configuration.
int	getImageRotation()	Gets the image rotation angle configured for the current frame capture.
List<ParameterKey.Key<?>>	getKeys()	Gets all parameters for the current frame capture configuration.
Location	getLocation()	Gets the geolocation configured for the current frame capture.
List<Surface>	getSurfaces()	Gets all surfaces configured for the current frame capture.
float	getZoomValue()	Gets the zoom value configured for the current frame capture.
FrameConfig.Builder	removeSurface(Surface surface)	Removes an output surface.
FrameConfig.Builder	setAeMode(int aeMode, Rect rect)	Sets the AE mode.
FrameConfig.Builder	setAeTrigger(int aeTrigger)	Triggers an AE.
FrameConfig.Builder	setAfMode(int afMode, Rect rect)	Sets the AF mode.
FrameConfig.Builder	setAfTrigger(int afTrigger)	Triggers an AF.
FrameConfig.Builder	setAwbMode(int awbMode, Rect rect)	Sets the auto white balance (AWB) mode.
FrameConfig.Builder	setCoordinateSurface(Surface surface)	Sets the surface holding the central coordinate system.
FrameConfig.Builder	setFaceDetection(int type, boolean isEnable)	Sets face detection and returns the result through a callback.
FrameConfig.Builder	setFlashMode(int flashMode)	Sets the flash mode.
FrameConfig.Builder	setImageRotation(int degrees)	Sets an image rotation angle to correct the image rotation information at the HAL layer.
FrameConfig.Builder	setLocation(Location location)	Sets geolocation information.
FrameConfig.Builder	setMark(Object mark)	Sets the unique mark on a FrameConfig instance.
<T> FrameConfig.Builder	setParameter(ParameterKey.Key<T> key, T value)	Sets a camera parameter.
FrameConfig.Builder	setZoom(float value)	Sets a zoom value.

方法详细资料

addSurface

FrameConfig.Builder addSurface(Surface surface)

Adds a surface as frame capture output.

The output surface to be added must have been added by calling CameraConfig.Builder#addSurface(Surface), and the camera have been successfully configured with CameraConfig. Otherwise, frame capture methods defined in Camera may throw parameter exceptions.

参数:

surface - Indicates an output surface to be added.

返回:

Returns a Builder object.

从以下版本开始:

1

removeSurface

FrameConfig.Builder removeSurface(Surface surface)

Removes an output surface.

参数:

surface - Indicates a surface added as frame capture output.

返回:

Returns a Builder object.

从以下版本开始:

1

setFaceDetection

FrameConfig.Builder setFaceDetection(int type,
                                     boolean isEnable)

Sets face detection and returns the result through a callback.

Only a supported type of face detection can be set using this method. The supported face detection types can be obtained by calling CameraAbility#getSupportedFaceDetection().

The face detection result can be obtained by FrameResult#getFaceDetectionResult().

参数:

type - Indicates the face detection type.

The face detection type to set must be one or more supported types. Both Metadata.FaceDetectionType.FACE_DETECTION and Metadata.FaceDetectionType.FACE_SMILE_DETECTION can be enabled simultaneously by calling setFaceDetection(FaceDetectionType.FACE_DETECTION | FaceDetectionType.FACE_SMILE_DETECTION, true). An invalid detection type will be ignored.

isEnable - Indicates whether face detection is enabled. true means detection is enabled, while false means it is disabled.

返回:

Returns a Builder object.

从以下版本开始:

1

另请参阅:

Metadata.FaceDetectionType

setAfMode

FrameConfig.Builder setAfMode(int afMode,
                              Rect rect)

Sets the AF mode.

Only a supported AF mode can be set using this method. The supported AF modes can be obtained by CameraAbility#getSupportedAfMode().

The AF result can be obtained by FrameResult#getAfResult().

参数:

afMode - Indicates the AF mode to set. An invalid AF mode will be ignored.

rect - Indicates a rectangular area for AF.

If the input value is null, the area is the same as the preview area. The central coordinate system is adopted, which ranges from (-1000, -1000) to (1000, 1000), to describe the AF area. The value range and direction are consistent with those of the preview area, regardless of zooming, rotation direction, and other factors alike.

If the rectangle AF area exceeds the valid range, the AF mode will not take effect.

返回:

Returns a Builder object.

从以下版本开始:

1

另请参阅:

Metadata.AfMode

setAfTrigger

FrameConfig.Builder setAfTrigger(int afTrigger)

Triggers an AF.

Only supported types of AF triggers can be set using this method.

The AF result can be obtained by FrameResult#getAfResult().

参数:

afTrigger - Indicates the AF trigger type to set. An invalid trigger type will be ignored.

返回:

Returns a Builder object.

从以下版本开始:

1

另请参阅:

Metadata.AfTrigger

setAeMode

FrameConfig.Builder setAeMode(int aeMode,
                              Rect rect)

Sets the AE mode.

Only a supported AE mode can be set using this method. The supported AE modes can be obtained by CameraAbility#getSupportedAeMode().

The AE result can be obtained by FrameResult#getAeResult().

参数:

aeMode - Indicates the AE mode to set. An invalid AE mode will be ignored.

rect - Indicates the rectangle area for AE.

If the input value is null, the area is the same as the preview area. The central coordinate system is adopted, which ranges from (-1000, -1000) to (1000, 1000), to describe the AE area. The value range and direction are consistent with those of the preview area, regardless of zooming, rotation direction, and other factors alike.

If the rectangle AE area exceeds the valid range, the AE mode will not take effect.

返回:

Returns a Builder object.

从以下版本开始:

1

另请参阅:

Metadata.AeMode

setAeTrigger

FrameConfig.Builder setAeTrigger(int aeTrigger)

Triggers an AE.

Only supported types of AE triggers can be set using this method.

The AE result can be obtained by calling FrameResult#getAeResult().

参数:

aeTrigger - Indicates the AE trigger type. An invalid trigger type will be ignored.

返回:

Returns a Builder object.

从以下版本开始:

1

另请参阅:

Metadata.AeTrigger

setAwbMode

FrameConfig.Builder setAwbMode(int awbMode,
                               Rect rect)

Sets the auto white balance (AWB) mode.

You can call this method to set only the supported AWB modes got via CameraAbility#getSupportedAwbMode().

参数:

awbMode - Indicates the AWB mode to set. An invalid AWB mode will be ignored.

rect - Indicates the rectangle area for AWB.

If the input value is null, the area is the same as the preview area. The central coordinate system is adopted, which ranges from (-1000, -1000) to (1000, 1000), to describe the AWB area. The value range and direction are consistent with those of the preview area, regardless of zooming, rotation direction, and other factors alike.

If the AWB area exceeds the valid range, the AWB mode will not take effect.

返回:

Returns the Builder object.

从以下版本开始:

5

另请参阅:

Metadata.AwbMode

setZoom

FrameConfig.Builder setZoom(float value)

Sets a zoom value.

Only a zoom value within the supported range can be set using this method. The supported zoom value range can be obtained by calling CameraAbility#getSupportedZoom().

参数:

value - Indicates the zoom value to set.

The value must be within the supported range. An invalid zoom value will be ignored.

返回:

Returns a Builder object.

从以下版本开始:

1

setFlashMode

FrameConfig.Builder setFlashMode(int flashMode)

Sets the flash mode.

Only supported flash mode can be set using this method. The supported flash modes can be obtained by calling CameraAbility#getSupportedFlashMode().

参数:

flashMode - Indicates the flash mode to set. An invalid flash mode will be ignored.

返回:

Returns a Builder object.

从以下版本开始:

1

另请参阅:

Metadata.FlashMode

setMark

FrameConfig.Builder setMark(Object mark)

Sets the unique mark on a FrameConfig instance.

The mark is used to identify a FrameConfig instance during frame processing by the camera.

参数:

mark - Indicates the unique FrameConfig mark.

返回:

Returns the Builder object.

从以下版本开始:

3

另请参阅:

FrameStateCallback.onFrameStarted(Camera, FrameConfig, long, long), FrameStateCallback.onFrameProgressed(Camera, FrameConfig, FrameResult), FrameStateCallback.onFrameFinished(Camera, FrameConfig, FrameResult), FrameStateCallback.onFrameError(Camera, FrameConfig, int, FrameResult), FrameConfig.getMark()

setLocation

FrameConfig.Builder setLocation(Location location)

Sets geolocation information.

参数:

location - Indicates the geolocation information to set. The value can be null, which means that a saved image does not have geolocation information.

返回:

Returns a Builder object.

从以下版本开始:

1

setImageRotation

FrameConfig.Builder setImageRotation(int degrees)

Sets an image rotation angle to correct the image rotation information at the HAL layer.

This method is used to update the rotation angle of an image (or a frame in JPEG format) whenever it is captured.

参数:

degrees - Indicates degrees of the rotation angle.

The value should be a multiple of 90, such as 0, 90, 180, and 270. Other integers will be rounded to multiples of 90.

返回:

Returns a Builder object.

从以下版本开始:

1

setParameter

<T> FrameConfig.Builder setParameter(ParameterKey.Key<T> key,
                                     T value)

Sets a camera parameter.

Only a supported parameter can be set using this method. Supported camera parameters can be obtained by calling CameraAbility#getSupportedParameters(). The parameter value range can be obtained by CameraAbility#getParameterRange(ParameterKey.Key).

The results related to the parameter settings can be obtained by FrameResult#getParametersResult().

类型参数:

T - Indicates the data type of a camera parameter.

参数:

key - Indicates a camera parameter to set.

value - Indicates a parameter value.

The value must be within the value range. An invalid value is ignored.

返回:

Returns a Builder object.

从以下版本开始:

1

另请参阅:

CameraAbility.getSupportedParameters(), CameraAbility.getParameterRange(ParameterKey.Key)

getCoordinateSurface

Surface getCoordinateSurface()

Obtains the surface on which the central coordinate system is based.

返回:

Returns the surface on which the central coordinate system is based.

从以下版本开始:

3

另请参阅:

setCoordinateSurface(Surface)

getFrameConfigType

int getFrameConfigType()

Gets the template type for frame capture configuration.

返回:

Returns the template type.

从以下版本开始:

3

另请参阅:

Camera.FrameConfigType, Camera.getFrameConfigBuilder(int)

getSurfaces

List<Surface> getSurfaces()

Gets all surfaces configured for the current frame capture.

返回:

Returns all surfaces configured; returns empty list if no surface is configured.

从以下版本开始:

3

另请参阅:

addSurface(Surface)

setCoordinateSurface

FrameConfig.Builder setCoordinateSurface(Surface surface)

Sets the surface holding the central coordinate system.

Origin coordinates of the central camera coordinate system are calculated based on the surface. The surface must have been added to the FrameConfig instance by the addSurface(ohos.agp.graphics.Surface) method. If no surface has been set by setCoordinateSurface(Surface), the first surface added by the addSurface(ohos.agp.graphics.Surface) method is used as the basis of the central coordinate system.

参数:

surface - Indicates the surface to be used as the basis of the central coordinate system.

返回:

Returns the Builder object.

抛出:

NullPointerException - Throws this exception if surface is null.

IllegalStateException - Throws this exception if surface does not exist in the FrameConfig instance.

从以下版本开始:

3

getAfMode

int getAfMode()

Gets the autofocus (AF) mode configured for the current frame capture.

返回:

Returns the configured AF mode.

从以下版本开始:

3

另请参阅:

Metadata.AfMode, setAfMode(int, Rect)

getAfRect

Rect getAfRect()

Gets the AF area configured for the current frame capture.

返回:

Returns the configured AF area.

从以下版本开始:

3

另请参阅:

setAfMode(int, Rect)

getAfTrigger

int getAfTrigger()

Gets the AF trigger type configured for the current frame capture.

返回:

Returns the configured AF trigger type.

从以下版本开始:

3

另请参阅:

Metadata.AfTrigger, setAfTrigger(int)

getAeMode

int getAeMode()

Gets the automatic exposure (AE) mode configured for the current frame capture.

返回:

Returns the configured AE mode.

从以下版本开始:

3

另请参阅:

Metadata.AeMode, setAeMode(int, Rect)

getAeRect

Rect getAeRect()

Gets the AE area configured for the current frame capture.

返回:

Returns the configured AE area.

从以下版本开始:

3

另请参阅:

setAeMode(int, Rect)

getAeTrigger

int getAeTrigger()

Gets the AE trigger type configured for the current frame capture.

返回:

Returns the configured AE trigger type.

从以下版本开始:

3

另请参阅:

Metadata.AeTrigger, setAeTrigger(int)

getAwbMode

int getAwbMode()

Gets the auto white balance (AWB) mode set for the current frame capture.

返回:

Returns the AWB mode that has been set; returns the default value Metadata.AwbMode#AWB_AUTOMATIC if the AWB mode is not set.

从以下版本开始:

5

另请参阅:

Metadata.AwbMode, setAwbMode(int, Rect)

getZoomValue

float getZoomValue()

Gets the zoom value configured for the current frame capture.

返回:

Returns the configured zoom value.

从以下版本开始:

3

另请参阅:

setZoom(float)

getFlashMode

int getFlashMode()

Gets the flash mode configured for the current frame capture.

返回:

Returns the configured flash mode.

从以下版本开始:

3

另请参阅:

Metadata.FlashMode, setFlashMode(int)

getFaceDetectionType

int getFaceDetectionType()

Gets the face detection type configured for the current frame capture.

返回:

Returns the configured face detection type.

从以下版本开始:

3

另请参阅:

Metadata.FaceDetectionType, setFaceDetection(int, boolean)

getLocation

Location getLocation()

Gets the geolocation configured for the current frame capture.

返回:

Returns the geolocation configuration; returns null if there is no configuration.

从以下版本开始:

3

另请参阅:

setLocation(Location)

getImageRotation

int getImageRotation()

Gets the image rotation angle configured for the current frame capture.

返回:

Returns the configured image rotation angle.

从以下版本开始:

3

另请参阅:

setImageRotation(int)

get

<T> T get(ParameterKey.Key<T> key)

Gets the parameter value of the current frame capture configuration.

类型参数:

T - Indicates the type of the parameter value.

参数:

key - Indicates the parameter.

返回:

Returns the parameter value.

从以下版本开始:

3

另请参阅:

setParameter(ParameterKey.Key, Object)

getKeys

List<ParameterKey.Key<?>> getKeys()

Gets all parameters for the current frame capture configuration.

返回:

Returns the parameters for the current frame capture configuration.

从以下版本开始:

3

另请参阅:

setParameter(ParameterKey.Key, Object)

build

FrameConfig build()

Creates a FrameConfig object.

返回:

Returns a FrameConfig object, which is used by Camera for the frame capture.

从以下版本开始:

1