View Source Membrane.Sink (Membrane Core v1.0.1)

Module defining behaviour for sinks - elements consuming data.

Behaviours for sinks are specified, besides this place, in modules Membrane.Element.Base, and Membrane.Element.WithInputPads.

Sink elements can define only input pads. Job of a usual sink is to receive some data on such pad and consume it (write to a soundcard, send through TCP etc.). If the pad has the flow control set to :manual, then element is also responsible for requesting demands when it is able and willing to consume data (for more details, see Membrane.Element.Action.demand/0). Sinks, like all elements, can of course have multiple pads if needed to provide more complex solutions.

List of available callbacks

Below there is a list of all the callbacks available in a module, that implements Membrane.Sink 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.Sink behaviour:





Brings all the stuff necessary to implement a sink element.


Link to this macro


View Source (macro)

Brings all the stuff necessary to implement a sink element.


  • :bring_pad? - if true (default) requires and aliases Membrane.Pad