Event.eos


Description:

[ CCode ( has_construct_function = false ) ]
public Event.eos ()

Create a new EOS event.

The eos event can only travel downstream synchronized with the buffer flow. Elements that receive the EOS event on a pad can return EOS as a FlowReturn when data after the EOS event arrives.

The EOS event will travel down to the sink elements in the pipeline which will then post the EOS on the bus after they have finished playing any buffered data.

When all sinks have posted an EOS message, an EOS message is forwarded to the application.

The EOS event itself will not cause any state transitions of the pipeline.

Returns:

the new EOS event.