# MultiMedia\_FrameConfig ## **Overview** Defines the **FrameConfig** class for operations related to frame configurations. **Since:** 1.0 **Version:** 1.0 ## **Summary** ## Files

File Name

Description

frame_config.h

Declares APIs of the FrameConfig class.

## Data Structures

Data Structure Name

Description

OHOS::Media::FrameConfig

Provides functions to configure frames.

## Functions

Function Name

Description

OHOS::Media::FrameConfig::FrameConfig ()=delete

 

A constructor used to create a FrameConfig instance.

OHOS::Media::FrameConfig::FrameConfig (int32_t type)

 

A constructor used to create a FrameConfig instance based on the configuration mode.

OHOS::Media::FrameConfig::~FrameConfig ()

 

A destructor used to delete the FrameConfig instance.

OHOS::Media::FrameConfig::GetFrameConfigType ()

int32_t 

Obtains the frame configuration type.

OHOS::Media::FrameConfig::GetSurfaces ()

std::list< Surface * > 

Obtains a list of shared memories (surface objects).

OHOS::Media::FrameConfig::AddSurface (Surface &surface)

void 

Adds a surface (an object of shared memory).

OHOS::Media::FrameConfig::RemoveSurface (Surface &surface)

void 

Removes a surface (an object of shared memory). You can call this function to release the surface when your application does not need to obtain data.

## **Details** ## **Function Documentation** ## AddSurface\(\) ``` void OHOS::Media::FrameConfig::AddSurface ([Surface](OHOS-Surface.md) & surface) ``` **Description:** Adds a surface \(an object of shared memory\). **Parameters:**

Name

Description
surface Indicates the surface to add.
## FrameConfig\(\) \[1/2\] ``` OHOS::Media::FrameConfig::FrameConfig () ``` **Description:** A constructor used to create a **[FrameConfig](OHOS-Media-FrameConfig.md)** instance. ## FrameConfig\(\) \[2/2\] ``` OHOS::Media::FrameConfig::FrameConfig (int32_t type) ``` **Description:** A constructor used to create a **[FrameConfig](OHOS-Media-FrameConfig.md)** instance based on the configuration mode. **Parameters:**

Name

Description
type Indicates the frame configuration mode, which can be FRAME_CONFIG_PREVIEW, <b>FRAME_CONFIG_RECORD, or FRAME_CONFIG_CAPTURE.
## GetFrameConfigType\(\) ``` int32_t OHOS::Media::FrameConfig::GetFrameConfigType () ``` **Description:** Obtains the frame configuration type. **Returns:** Returns the frame configuration type if obtained; returns **-1** otherwise. ## GetSurfaces\(\) ``` std::list<[Surface](OHOS-Surface.md) *> OHOS::Media::FrameConfig::GetSurfaces () ``` **Description:** Obtains a list of shared memories \(surface objects\). **Returns:** Returns the list of shared memories if obtained; returns **NULL** otherwise. ## RemoveSurface\(\) ``` void OHOS::Media::FrameConfig::RemoveSurface ([Surface](OHOS-Surface.md) & surface) ``` **Description:** Removes a surface \(an object of shared memory\). You can call this function to release the surface when your application does not need to obtain data. **Parameters:**

Name

Description
surface Indicates the surface to remove.
## \~FrameConfig\(\) ``` OHOS::Media::FrameConfig::~FrameConfig () ``` **Description:** A destructor used to delete the **[FrameConfig](OHOS-Media-FrameConfig.md)** instance.