MultiMedia_FrameStateCallback

MultiMedia_FrameStateCallback

Overview

Provides callbacks for frame state changes, in which you can implement operations to response to the changes.

Since:

1.0

Version:

1.0

Summary

Files

File Name	Description
camera_kit.h	Declares functions in the CameraKit class.

Data Structures

Data Structure Name	Description
OHOS::Media::FrameStateCallback	Provides functions to listen for frame states and response to the state changes.

Functions

Function Name	Description
OHOS::Media::FrameStateCallback::FrameStateCallback ()=default	A constructor used to create a FrameStateCallback instance.
OHOS::Media::FrameStateCallback::~FrameStateCallback ()=default	A destructor used to delete the FrameStateCallback instance.
OHOS::Media::FrameStateCallback::OnFrameFinished (Camera &camera, FrameConfig &frameConfig, FrameResult &frameResult)	virtual void Called when the frame capture is finished.
OHOS::Media::FrameStateCallback::OnFrameError (Camera &camera, FrameConfig &frameConfig, int32_t errorCode, FrameResult &frameResult)	virtual void Called when the frame capture fails.

Details

Function Documentation

FrameStateCallback()

OHOS::Media::FrameStateCallback::FrameStateCallback ()

Description:

A constructor used to create a FrameStateCallback instance.

OnFrameError()

virtual void OHOS::Media::FrameStateCallback::OnFrameError ([Camera]($api-api-SmartVision-Devices-OHOS-Media-Camera.md) & camera, [FrameConfig]($api-api-SmartVision-Devices-OHOS-Media-FrameConfig.md) & frameConfig, int32_t errorCode, FrameResult & frameResult )

Description:

Called when the frame capture fails.

Parameters:

Name	Description
camera	Indicates the camera.
frameConfig	Indicates the frame configuration.
errorCode	Indicates the error code.
frameResult	Indicates the capture results.

OnFrameFinished()

virtual void OHOS::Media::FrameStateCallback::OnFrameFinished ([Camera]($api-api-SmartVision-Devices-OHOS-Media-Camera.md) & camera, [FrameConfig]($api-api-SmartVision-Devices-OHOS-Media-FrameConfig.md) & frameConfig, FrameResult & frameResult )

Description:

Called when the frame capture is finished.

Parameters:

Name	Description
camera	Indicates the camera.
frameConfig	Indicates the frame configuration.
frameResult	Indicates the capture results.

~FrameStateCallback()

OHOS::Media::FrameStateCallback::~FrameStateCallback ()

Description:

A destructor used to delete the FrameStateCallback instance.