Membrane Core v0.10.2

View Source Membrane.Endpoint behaviour (Membrane Core v0.10.2)

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 these pads work in pull mode, which is the most common case, 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.

Link to this section Summary

Callbacks

handle_write( pad, buffer, context, state )

Callback that is called when buffer should be written by the endpoint. In contrast to handle_write_list/4, it is passed only a single buffer.

handle_write_list( pad, buffers, context, state )

Callback that is called when buffer should be written by the endpoint.

Functions

__using__(options)

Brings all the stuff necessary to implement a endpoint element.

Link to this section Callbacks

Link to this callback

handle_write( pad, buffer, context, state )

View Source 
@callback handle_write(
  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 called when buffer should be written by the endpoint. In contrast to handle_write_list/4, it is passed only a single buffer.

Called by default implementation of handle_write_list/4.

Link to this callback

handle_write_list( pad, buffers, context, state )

View Source 
@callback handle_write_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 called when buffer should be written by the endpoint.

By default calls handle_write/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

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