Membrane Core v0.11.0

View Source Membrane.Element.WithInputPads behaviour (Membrane Core v0.11.0)

Module defining behaviour for sink, filter and endpoint 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

Callbacks

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.

handle_stream_format(pad, stream_format, context, state)

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

Functions

def_input_pad(name, spec)

Macro that defines input pad for the element.

Link to this section Callbacks

Link to this callback

handle_end_of_stream(pad, context, state)

View Source 
@callback 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.

Link to this callback

handle_start_of_stream(pad, context, state)

View Source 
@callback 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.

Link to this callback

handle_stream_format(pad, stream_format, context, state)

View Source (optional) 
@callback handle_stream_format(
  pad :: Membrane.Pad.ref_t(),
  stream_format :: Membrane.StreamFormat.t(),
  context :: Membrane.Element.CallbackContext.StreamFormat.t(),
  state :: Membrane.Element.state_t()
) :: Membrane.Element.Base.callback_return_t()

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

In filters stream format is forwarded through all output pads by default.

Link to this section Functions

Link to this macro

def_input_pad(name, spec)

View Source (macro)

Macro that defines input pad for the element.

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

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