Membrane.Element.WithInputPads behaviour (Membrane Core v0.7.0) 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

def_input_pad(name, spec)

Macro that defines input pad for the element.

def_input_pads(pads) deprecated

Macro that defines multiple input pads for the element.

Callbacks

handle_caps(pad, caps, context, state)

Callback invoked when Element is receiving information about new caps for given pad.

handle_end_of_stream(pad, context, state)

Callback invoked when the previous element has finished processing via the pad, and it cannot be used anymore.

handle_start_of_stream(pad, context, state)

Callback invoked when element receives Membrane.Event.StartOfStream event.

Link to this section Functions

def_input_pad(name, spec)

(macro)

Macro that defines input pad for the element.

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

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

The type Membrane.Pad.input_spec_t/0 describes how the definition of pads should look.

def_input_pads(pads)

(macro)

This macro is deprecated. Use def_input_pad/2 for each pad instead.

Macro that defines multiple input pads for the element.

Deprecated in favor of def_input_pad/2

Link to this section Callbacks

handle_caps(pad, caps, context, state)

(optional)

Specs

handle_caps(
  pad :: Membrane.Pad.ref_t(),
  caps :: Membrane.Caps.t(),
  context :: Membrane.Element.CallbackContext.Caps.t(),
  state :: Membrane.Element.state_t()
) :: Membrane.Element.Base.callback_return_t()

Callback invoked when Element is receiving information about new caps for given pad.

In filters those caps are forwarded through all output pads by default.

handle_end_of_stream(pad, context, state)

Specs

handle_end_of_stream(
  pad :: Membrane.Pad.ref_t(),
  context :: Membrane.Element.CallbackContext.StreamManagement.t(),
  state :: Membrane.Element.state_t()
) :: Membrane.Element.Base.callback_return_t()

Callback invoked when the previous element has finished processing via the pad, and it cannot be used anymore.

handle_start_of_stream(pad, context, state)

Specs

handle_start_of_stream(
  pad :: Membrane.Pad.ref_t(),
  context :: Membrane.Element.CallbackContext.StreamManagement.t(),
  state :: Membrane.Element.state_t()
) :: Membrane.Element.Base.callback_return_t()

Callback invoked when element receives Membrane.Event.StartOfStream event.