MultiMedia_FrameConfig

Overview

Defines the FrameConfig class for operations related to frame configurations.

Since:

1.0

Version:

1.0

Summary

Files

Data Structures

Functions

Details

Function Documentation

AddSurface()

void OHOS::Media::FrameConfig::AddSurface ([Surface](OHOS-Surface.md) & surface)

Description:

Adds a surface (an object of shared memory).

Parameters:

FrameConfig() [1/2]

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

Description:

A constructor used to create a FrameConfig instance.

FrameConfig() [2/2]

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

Description:

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

Parameters:

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:

~FrameConfig()

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

Description:

A destructor used to delete the FrameConfig instance.