Class Filter

Represents a filter in the filtergraph.

Index

Constructors

Methods

ref setArguments toString

Constructors

constructor

new Filter(name, args): Filter
Recommend using FilterComplexContext.filter.
Parameters
- name: string
- args: FilterArgument[]
Returns Filter
- Defined in index.ts:371

Methods

ref

ref(id): Filter
Set the instance name to distinguish it from other filters.
Parameters
- id: string
  Instance name.
Returns Filter
- Defined in index.ts:383

setArguments

setArguments(...args): void
Update the arguments for this filter.
Parameters
- Rest ...args: FilterArgument[]
Returns void
- Defined in index.ts:391

toString

toString(withArguments?): string
Return the string representation of this filter (e.g. name@id).
Parameters
- Optional withArguments: boolean
Returns string
- Defined in index.ts:402