View Source Membrane.Filter behaviour (Membrane Core v0.11.0)
Module defining behaviour for filters - elements processing data.
Behaviours for filters are specified, besides this place, in modules
Membrane.Element.Base,
Membrane.Element.WithOutputPads,
and Membrane.Element.WithInputPads.
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
Membrane.Element.WithOutputPads.handle_demand/5 callback).
Filters, like all elements, can of course have multiple pads if needed to
provide more complex solutions.
list-of-available-callbacks
List of available callbacks
Below there is a list of all the callbacks available in a module, that implements Membrane.Filter behaviour.
We have put it for your convenience, as some of these callbacks aren't directly defined in that module and
their specification is available in different modules.
The callbacks available in Membrane.Filter behaviour:
Membrane.Element.Base.__struct__/0Membrane.Element.Base.__struct__/1Membrane.Element.Base.handle_event/4Membrane.Element.Base.handle_info/3Membrane.Element.Base.handle_init/2Membrane.Element.Base.handle_pad_added/3Membrane.Element.Base.handle_pad_removed/3Membrane.Element.Base.handle_parent_notification/3Membrane.Element.Base.handle_playing/2Membrane.Element.Base.handle_setup/2Membrane.Element.Base.handle_terminate_request/2Membrane.Element.Base.handle_tick/3
Link to this section Summary
Callbacks
Callback that is to process buffers. In contrast to handle_process_list/4, it is
passed only a single buffer.
Callback that is to process buffers.
Functions
Brings all the stuff necessary to implement a filter element.
Link to this section Callbacks
@callback 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/4.
@callback 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.
Link to this section Functions
Brings all the stuff necessary to implement a filter element.
Options:
:bring_pad?- if true (default) requires and aliasesMembrane.Pad