Membrane.Filter behaviour (Membrane Core v0.7.0) View Source
Module defining behaviour for filters - elements processing data.
Filters can have both input and output pads. Job of a usual filter is to
receive some data on a input pad, process the data and send it through the
output pad. If these pads work in pull mode, which is the most common case,
then filter is also responsible for receiving demands on the output pad and
requesting them on the input pad (for more details, see
Filters, like all elements, can of course have multiple pads if needed to
provide more complex solutions.
Link to this section Summary
Link to this section Functions
Link to this section Callbacks
handle_process( pad :: Membrane.Pad.ref_t(), buffer :: Membrane.Buffer.t(), context :: Membrane.Element.CallbackContext.Process.t(), state :: Membrane.Element.state_t() ) :: Membrane.Element.Base.callback_return_t()
Callback that is to process buffers. In contrast to
handle_process_list/4, it is
passed only a single buffer.
Called by default implementation of
handle_process_list( pad :: Membrane.Pad.ref_t(), buffers :: [Membrane.Buffer.t()], context :: Membrane.Element.CallbackContext.Process.t(), state :: Membrane.Element.state_t() ) :: Membrane.Element.Base.callback_return_t()
Callback that is to process buffers.
By default calls
handle_process/4 for each buffer.
For pads in pull mode it is called when buffers have been demanded (by returning
:demand action from any callback).
For pads in push mode it is invoked when buffers arrive.