MultiMedia_Camera

Overview

Defines the Camera class for camera-related operations.

Since:

1.0

Version:

1.0

Summary

Files

File Name

Description

camera.h

Declares functions in the Camera class to implement camera operations.

Data Structures

Data Structure Name

Description

OHOS::Media::Camera

Provides functions in the Camera class to implement camera operations. operations.

Functions

Function Name

Description

OHOS::Media::Camera::~Camera ()=default

virtual 

A destructor used to delete the Camera instance.

OHOS::Media::Camera::GetCameraId ()

virtual std::string 

Obtains the camera ID.

OHOS::Media::Camera::GetCameraConfig () const

virtual const CameraConfig  

Obtains the camera configuration. You can use the obtained CameraConfig object to configure the camera.

OHOS::Media::Camera::GetFrameConfig (int32_t type)

virtual FrameConfig  

Obtains the frame configuration.

OHOS::Media::Camera::Configure (CameraConfig &config)

virtual void 

Configures the camera using the CameraConfig object.

OHOS::Media::Camera::TriggerLoopingCapture (FrameConfig &frameConfig)

virtual int32_t 

Triggers looping-frame capture.

OHOS::Media::Camera::StopLoopingCapture ()

virtual void 

Stops looping-frame capture.

OHOS::Media::Camera::TriggerSingleCapture (FrameConfig &frameConfig)

virtual int32_t 

Starts single-frame capture. The frame parameters are set through the FrameConfig object, and the captured image data is stored in the surface of the FrameConfig object.

OHOS::Media::Camera::Release ()

virtual void 

Releases the Camera object and associated resources.

OHOS::Media::Camera::Camera ()=default

 

A constructor used to create a Camera instance.

Details

Function Documentation

Camera()

  1. OHOS::Media::Camera::Camera ()

Description:

A constructor used to create a Camera instance.

Configure()

  1. virtual void OHOS::Media::Camera::Configure ([CameraConfig]($api-api-SmartVision-Devices-OHOS-Media-CameraConfig.md) & config)

Description:

Configures the camera using the CameraConfig object.

Parameters:

Name

Description
config Indicates the pointer to the CameraConfig object.

GetCameraConfig()

  1. virtual const [CameraConfig]($api-api-SmartVision-Devices-OHOS-Media-CameraConfig.md)* OHOS::Media::Camera::GetCameraConfig () const

Description:

Obtains the camera configuration. You can use the obtained CameraConfig object to configure the camera.

Returns:

Returns the pointer to the CameraConfig object if obtained; returns NULL otherwise.

GetCameraId()

  1. virtual std::string OHOS::Media::Camera::GetCameraId ()

Description:

Obtains the camera ID.

Returns:

Returns the camera ID if obtained; returns the “Error” string if the camera fails to be created.

GetFrameConfig()

  1. virtual [FrameConfig]($api-api-SmartVision-Devices-OHOS-Media-FrameConfig.md)* OHOS::Media::Camera::GetFrameConfig (int32_t type)

Description:

Obtains the frame configuration.

Parameters:

Name

Description
type Indicates the type of the frame configuration.

Returns:

Returns the pointer to the FrameConfig object if obtained; returns NULL otherwise.

Release()

  1. virtual void OHOS::Media::Camera::Release ()

Description:

Releases the Camera object and associated resources.

StopLoopingCapture()

  1. virtual void OHOS::Media::Camera::StopLoopingCapture ()

Description:

Stops looping-frame capture.

Returns:

Returns true if the looping-frame capture is successfully stopped; returns false otherwise.

TriggerLoopingCapture()

  1. virtual int32_t OHOS::Media::Camera::TriggerLoopingCapture ([FrameConfig]($api-api-SmartVision-Devices-OHOS-Media-FrameConfig.md) & frameConfig)

Description:

Triggers looping-frame capture.

Parameters:

Name

Description
fc Indicates the frame configuration.

Returns:

Returns true if the looping-frame capture is successfully started; returns false otherwise.

TriggerSingleCapture()

  1. virtual int32_t OHOS::Media::Camera::TriggerSingleCapture ([FrameConfig]($api-api-SmartVision-Devices-OHOS-Media-FrameConfig.md) & frameConfig)

Description:

Starts single-frame capture. The frame parameters are set through the FrameConfig object, and the captured image data is stored in the surface of the FrameConfig object.

Parameters:

Name

Description
fc Indicates the frame configuration.

Returns:

Returns true if the single-frame capture is successfully started and the data is stored; returns false otherwise.

~Camera()

  1. virtual OHOS::Media::Camera::~Camera ()

Description:

A destructor used to delete the Camera instance.