Agora C++ API Reference for All Platforms

Public Member Functions | Public Attributes | List of all members
agora::rtc::FilterEffectOptions Struct Reference

## Public Member Functions
| FilterEffectOptions (const char *lut3dPath, float filterStrength)
| FilterEffectOptions ()

## Public Attributes
const char * | path
float | strength

## Detailed Description

Filter effect options. This structure defines options for filter effect.

Since
  v4.4.1

## Constructor & Destructor Documentation

## ◆ FilterEffectOptions() [1/2]

agora::rtc::FilterEffectOptions::FilterEffectOptions | ( | const char * | lut3dPath,
|  | float | filterStrength
| ) |  |
| inline

## ◆ FilterEffectOptions() [2/2]

agora::rtc::FilterEffectOptions::FilterEffectOptions | ( |  | ) |
| inline

## Member Data Documentation

## ◆ path

const char* agora::rtc::FilterEffectOptions::path

The local absolute path of the custom 3D Cube path. Only cube format is supported. The cube file must strictly comply with the Cube LUT Specification; otherwise, the filter effects will not take effect.

The following is an example of the Cube file format. The cube file starts with `LUT_3D_SIZE`, which indicates the cube size. In filter effects, the cube size is limited to 32.

LUT_3D_SIZE 32 0.0039215689 0 0.0039215682 0.0086021447 0.0037950677 0 0.0728652592 0.0039215689 0 ...

The SDK provides a built-in cube named `built_in_whiten.cube` for whitening. To use this cube, specify the path to `built_in_whiten_filter`

## ◆ strength

float agora::rtc::FilterEffectOptions::strength

The intensity of specified filter effect. The value ranges from 0.0 to 1.0. The default value is 0.5. The greater the value, the stronger the intensity of the filter.