ChromaKeyFilter <TSource>

Hierarchy

• Filter<ChromaKeyFilterSettings, TSource>
  • ChromaKeyFilter

Index

Constructors

• constructor

Properties

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

Methods

• getDefaultSettings
• remove
• setEnabled
• setSettings

Constructors

constructor

• new ChromaKeyFilter<TSource>(args: CustomFilterArgs<ChromaKeyFilterSettings>): ChromaKeyFilter<TSource>

• Overrides Filter.constructor

  Type parameters

  • TSource: Source<{}, TSource>

  Parameters

  • args: CustomFilterArgs<ChromaKeyFilterSettings>

  Returns ChromaKeyFilter<TSource>

Properties

enabled

enabled: boolean

Inherited from Filter.enabled

kind

kind: string

Inherited from Filter.kind

name

name: string

Inherited from Filter.name

ref

ref: string

Inherited from Filter.ref

settings

settings: { brightness?: number; contrast?: number; gamma?: number; key_color?: number; key_color_type?: ChromaKeyColorType; opacity?: number; similarity?: number; smoothness?: number; spill?: number } = ...

Inherited from Filter.settings

Type declaration

• optionalbrightness?: number

• optionalcontrast?: number

• optionalgamma?: number

• optionalkey_color?: number

• optionalkey_color_type?: ChromaKeyColorType

• optionalopacity?: number

• optionalsimilarity?: number

• optionalsmoothness?: number

• optionalspill?: number

source

source: TSource

Inherited from Filter.source

Methods

getDefaultSettings

• getDefaultSettings(): Promise<Settings>

• Inherited from Filter.getDefaultSettings

  Returns Promise<Settings>

remove

• remove(): Promise<void>

• Inherited from Filter.remove

  Returns Promise<void>

setEnabled

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

• Inherited from Filter.setEnabled

  Parameters

  • enabled: boolean

  Returns Promise<void>

setSettings

• setSettings(settings: { brightness?: number; contrast?: number; gamma?: number; key_color?: number; key_color_type?: ChromaKeyColorType; opacity?: number; similarity?: number; smoothness?: number; spill?: number }, overlay?: boolean): Promise<void>

• Inherited from Filter.setSettings

  Parameters

  • settings: { brightness?: number; contrast?: number; gamma?: number; key_color?: number; key_color_type?: ChromaKeyColorType; opacity?: number; similarity?: number; smoothness?: number; spill?: number }

  • overlay: boolean = true

  Returns Promise<void>