Configuration.handleStreamEnd()
Description
Appends a handleStreamEnd filter to the current pipeline layout.
A handleStreamEnd filter calls back user scripts every time a StreamEnd event is found in the input stream.
- INPUT - Any types of Events.
- OUTPUT - Same Events as input.
The user function that gets called will have a StreamEnd object as parameter.
This filter passes every input event down to its output. It doesn't change how many or what events there are. However, since events are all just objects being passed around by reference, if you alter the event object itself, the change will be visible on the output, even though the references to the events are identical between the input and the output.
Syntax
pipy().pipeline().handleStreamEnd(event => onStreamEnd(event))
Parameters
handleStreamEnd(handler)
handler
A callback function that receives StreamEnd events passing through the filter.
Return Value
The same Configuration object.