Filter <TSettings, TSource>

Hierarchy

• Filter
  • MockFilter
  • ApplyLUTFilter
  • AspectRatioFilter
  • ChromaKeyFilter
  • ColorCorrectionFilter
  • ColorKeyFilter
  • CompressorFilter
  • CropPadFilter
  • ExpanderFilter
  • GainFilter
  • ImageMaskBlendFilter
  • InvertPolarityFilter
  • LimiterFilter
  • LumaKeyFilter
  • NoiseGateFilter
  • NoiseSuppressFilter
  • RenderDelayFilter
  • ScrollFilter
  • SharpenFilter

Index

Constructors

• constructor

Properties

• enabled
• kind
• name
• ref
• settings
• source

Methods

• getDefaultSettings
• remove
• setEnabled
• setSettings

Constructors

constructor

• new Filter<TSettings, TSource>(args: FilterArgs<Settings>): Filter<TSettings, TSource>

• Type parameters

  • TSettings: Settings = Settings
  • TSource: Source<{}, TSource> = Source<{}>

  Parameters

  • args: FilterArgs<Settings>

  Returns Filter<TSettings, TSource>

Properties

enabled

enabled: boolean

kind

kind: string

name

name: string

ref

ref: string

settings

settings: DeepPartial<TSettings> = ...

source

source: TSource

Methods

getDefaultSettings

• getDefaultSettings(): Promise<Settings>

• Returns Promise<Settings>

remove

• remove(): Promise<void>

• Returns Promise<void>

setEnabled

• setEnabled(enabled: boolean): Promise<void>

• Parameters

  • enabled: boolean

  Returns Promise<void>

setSettings

• setSettings(settings: DeepPartial<TSettings>, overlay?: boolean): Promise<void>

• Parameters

  • settings: DeepPartial<TSettings>

  • overlay: boolean = true

  Returns Promise<void>