FilterEffectOptions

Filter effect options.

export class FilterEffectOptions {
  path?: string;
  strength?: number;
}

Properties

path
The absolute local path of the 3D LUT (Lookup Table) file used to apply a custom filter effect. The referenced .cube file must strictly follow the Cube LUT specification, otherwise the filter effect will not take effect. Example of a .cube file:
LUT_3D_SIZE 32
0.0039215689 0 0.0039215682
0.0086021447 0.0037950677 0
...
0.0728652592 0.0039215689 0
Note:
  • The first line of the LUT file should contain the LUT_3D_SIZE identifier indicating the dimension of the 3D LUT. Currently, only a LUT size of 32 is supported.
  • The SDK provides a built-in built_in_whiten_filter.cube file. You can pass the absolute path of this file to apply a whitening filter effect.
strength
Filter effect strength. Value range: [0.0,1.0], where 0.0 means no filter effect. Default is 0.5. The greater the value, the stronger the filter effect.