View Source Membrane.Endpoint (Membrane Core v1.1.1)

Module defining behaviour for endpoints - elements consuming and producing data.

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

Endpoint can have both input and output pads. Job of usual endpoint is both, to receive some data on such pad and consume it (write to a soundcard, send through TCP etc.) and to produce some data (read from soundcard, download through HTTP, etc.) and send it through such pad. If the pad has the flow control set to :manual, then endpoint 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). Endpoints, 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.Endpoint 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.Endpoint behaviour:

Membrane.Element.Base

Membrane.Element.WithInputPads

Membrane.Element.WithOutputPads

Summary

Functions

Brings all the stuff necessary to implement a endpoint element.

Functions

Link to this macro

__using__(options)

View Source (macro)

Brings all the stuff necessary to implement a endpoint element.

Options:

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