程序包 ohos.media.camera.device

接口 FrameConfig

public interface FrameConfig

Provides methods for frame capture configuration, image processing, and image output.

从以下版本开始:

1

嵌套类概要

嵌套类

限定符和类型	接口	说明
static interface	FrameConfig.Builder	Provides frame configuration Builder objects.

方法概要

限定符和类型	方法	说明
boolean	equals(Object obj)	Checks whether this FrameConfig object equals a specified 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.
Object	getMark()	Obtains the unique mark on a FrameConfig instance.
List<Surface>	getSurfaces()	Gets all surfaces configured for the current frame capture.
float	getZoomValue()	Gets the zoom value configured for the current frame capture.

方法详细资料

getFrameConfigType

int getFrameConfigType()

Gets the template type for frame capture configuration.

返回:

Returns the template type.

从以下版本开始:

1

另请参阅:

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.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.addSurface(Surface)

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

另请参阅:

FrameConfig.Builder.setCoordinateSurface(Surface)

getAfMode

int getAfMode()

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

返回:

Returns the configured AF mode.

从以下版本开始:

1

另请参阅:

Metadata.AfMode, FrameConfig.Builder.setAfMode(int, Rect)

getAfRect

Rect getAfRect()

Gets the AF area configured for the current frame capture.

返回:

Returns the configured AF area.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setAfMode(int, Rect)

getAfTrigger

int getAfTrigger()

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

返回:

Returns the configured AF trigger type.

从以下版本开始:

1

另请参阅:

Metadata.AfTrigger, FrameConfig.Builder.setAfTrigger(int)

getAeMode

int getAeMode()

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

返回:

Returns the configured AE mode.

从以下版本开始:

1

另请参阅:

Metadata.AeMode, FrameConfig.Builder.setAeMode(int, Rect)

getAeRect

Rect getAeRect()

Gets the AE area configured for the current frame capture.

返回:

Returns the configured AE area.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setAeMode(int, Rect)

getAeTrigger

int getAeTrigger()

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

返回:

Returns the configured AE trigger type.

从以下版本开始:

1

另请参阅:

Metadata.AeTrigger, FrameConfig.Builder.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, FrameConfig.Builder.setAwbMode(int, Rect)

getZoomValue

float getZoomValue()

Gets the zoom value configured for the current frame capture.

返回:

Returns the configured zoom value.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setZoom(float)

getFlashMode

int getFlashMode()

Gets the flash mode configured for the current frame capture.

返回:

Returns the configured flash mode.

从以下版本开始:

1

另请参阅:

Metadata.FlashMode, FrameConfig.Builder.setFlashMode(int)

getFaceDetectionType

int getFaceDetectionType()

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

返回:

Returns the configured face detection type.

从以下版本开始:

1

另请参阅:

Metadata.FaceDetectionType, FrameConfig.Builder.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.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setLocation(Location)

getImageRotation

int getImageRotation()

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

返回:

Returns the configured image rotation angle.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.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.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.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.

从以下版本开始:

1

另请参阅:

FrameConfig.Builder.setParameter(ParameterKey.Key, Object)

getMark

Object getMark()

Obtains the unique mark on a FrameConfig instance.

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

返回:

Returns the unique FrameConfig mark.

从以下版本开始:

3

另请参阅:

FrameStateCallback.onFrameStarted(Camera, FrameConfig, long, long), FrameStateCallback.onFrameProgressed(Camera, FrameConfig, FrameResult), FrameStateCallback.onFrameFinished(Camera, FrameConfig, FrameResult), FrameStateCallback.onFrameError(Camera, FrameConfig, int, FrameResult), FrameConfig.Builder.setMark(Object)

equals

boolean equals(Object obj)

Checks whether this FrameConfig object equals a specified object.

The two objects are equal only when all their elements are the same.

覆盖:

equals 在类中 Object

参数:

obj - Indicates the specified object to compare.

返回:

Returns true if the two objects are equal; returns false otherwise.

从以下版本开始:

5

另请参阅:

Object.hashCode(), HashMap