Class Pipe

Represents the pipe (link) between filter pads.

Index

Constructors

Methods

as hint inspect mark setBoundInput setBoundOutput toString

Constructors

constructor

new Pipe(name, fixed?, shared?): Pipe
Internal use only. Please use FilterComplexContext.pipe().
Parameters
- name: string
- Optional fixed: boolean
- Optional shared: boolean
Returns Pipe
- Defined in index.ts:133

Methods

as

as(name): Pipe
Give this pipe an unique name in order to refer to it elsewhere.

It makes this pipe fixed and prevents renaming.

An error will be thrown if this pipe is fixed.
Parameters
- name: string
  Name of the pipe.
Returns Pipe
- Defined in index.ts:148

hint

hint(hint): Pipe
Set the hint of the pipe.

It will be used in error messages.
Parameters
- hint: string
  Hint
Returns Pipe
- Defined in index.ts:180

inspect

inspect(): string
Similar to toString(), but only for debugging purpose.

Returns string
- Defined in index.ts:226

mark

mark(mediaType): Pipe
Mark this pipe with the specified media type.
Parameters
- mediaType: PipeMediaType
  Media type.
Returns Pipe
- Defined in index.ts:162

setBoundInput

setBoundInput(): Pipe
Notify that the input side of the pipe is connected to another pad.

This will throw an error if the input side has already been connected.

Returns Pipe
- Defined in index.ts:190

setBoundOutput

setBoundOutput(): Pipe
Notify that the output side of the pipe is connected to another pad.

This will throw an error if the output side has already been connected.

Returns Pipe
- Defined in index.ts:203

toString

toString(): string
Return the string representation of this pipe (e.g. [pipe]).

Returns string
- Defined in index.ts:216