Class ChainNode

Represents a node in the filter chain.

Iterate over this object to retrieve pipes connected to the output pads.

Implements

Iterable<Pipe>

Index

Constructors

Methods

[iterator] connect fork link mark pipe

Constructors

`Private` constructor

new ChainNode(): ChainNode
Returns ChainNode
- Defined in index.ts:476

Methods

[iterator]

[iterator](): Iterator<Pipe, any, undefined>
Return an iterator that can retrieve pipes connected to the output pads.

Returns Iterator<Pipe, any, undefined>
Implementation of Iterable.[iterator]
- Defined in index.ts:611

connect

connect(...pipes): ChainNode
Connect pipes to the output pads.
Parameters
- Rest ...pipes: Pipe[]
  Pipes to be connected.
Returns ChainNode
- Defined in index.ts:557

fork

fork(connectedPipeCount): ChainNode
Build a new filter chain and connect its input to the output pads of this filter chain.
Parameters
- connectedPipeCount: number
  Number of pipes to be passed to the new filter chain.
Returns ChainNode
The start node of the new filter chain.
- Defined in index.ts:532

link

link(node): ChainNode
Join this filter chain with another filter chain.
Parameters
- node: ChainNode
  Last node of the other filter chain
Returns ChainNode
Last node of the joined filter chain
- Defined in index.ts:582

mark

mark(...mediaTypes): ChainNode
Mark the output pipes with the specified media types.
Parameters
- Rest ...mediaTypes: PipeMediaType[]
  Media types.
Returns ChainNode
- Defined in index.ts:597

pipe

pipe(filterOrFunc, swsFlags?): ChainNode
Append a filter node to the filter chain.

If this node is a start node, it will be replaced by the appended node.
Parameters
- filterOrFunc: Filter | FilterFunction
  Filter or its filter factory.
- Optional swsFlags: string
  Flags that will be passed to swscale filters.
Returns ChainNode
The appended node.
- Defined in index.ts:508