Membrane Core v0.1.1 Membrane.Element.Base.Mixin.SinkBehaviour behaviour View Source

Module defining behaviour for sink and filter elements.

When used declares behaviour implementation, provides default callback definitions and imports macros.

For more information on implementing elements, see Membrane.Element.Base.

Link to this section Summary

Functions

Macro that defines known sink pads for the element type

Callbacks

Callback invoked when Element is receiving information about new caps for given pad. In filters those caps are forwarded through all source pads by default

Callback that defines what sink pads may be ever available for this element type

Link to this section Types

Link to this section Functions

Link to this macro def_known_sink_pads(raw_sink_pads) View Source (macro)

Macro that defines known sink pads for the element type.

Allows to use Membrane.Caps.Matcher.one_of/1 and Membrane.Caps.Matcher.range/2 functions without module prefix.

It automatically generates documentation from the given definition and adds compile-time caps specs validation.

Link to this section Callbacks

Callback invoked when Element is receiving information about new caps for given pad. In filters those caps are forwarded through all source pads by default.

Link to this callback known_sink_pads() View Source
known_sink_pads() :: known_sink_pads_t()

Callback that defines what sink pads may be ever available for this element type.

The default name for generic sink pad, in elements that just consume some buffers is :sink.