Membrane Core
v0.12.9

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

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.

Summary

Callbacks

handle_buffer(pad, buffer, context, state)

Callback that is called when buffer should be processed by the Element. In contrast to handle_buffers_batch/4, it is passed only a single buffer.

handle_buffers_batch(pad, buffers, context, state)

Callback that is called when buffer should be processed by the Element.

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_process(pad, buffer, context, state)
handle_process_list(pad, buffers, context, state)
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.

handle_write(pad, buffer, context, state)
handle_write_list(pad, buffers, context, state)

Functions

def_input_pad(name, spec)

Macro that defines input pad for the element.

Callbacks

Link to this callback

handle_buffer(pad, buffer, context, state)

View Source 
@callback handle_buffer(
  pad :: Membrane.Pad.ref(),
  buffer :: Membrane.Buffer.t(),
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()

Callback that is called when buffer should be processed by the Element. In contrast to handle_buffers_batch/4, it is passed only a single buffer.

Called by default implementation of handle_buffers_batch/4.

Link to this callback

handle_buffers_batch(pad, buffers, context, state)

View Source 
@callback handle_buffers_batch(
  pad :: Membrane.Pad.ref(),
  buffers :: [Membrane.Buffer.t()],
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()

Callback that is called when buffer should be processed by the Element.

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

handle_end_of_stream(pad, context, state)

View Source 
@callback handle_end_of_stream(
  pad :: Membrane.Pad.ref(),
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()

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

Link to this callback

handle_process(pad, buffer, context, state)

View Source (optional) 
@callback handle_process(
  pad :: Membrane.Pad.ref(),
  buffer :: Membrane.Buffer.t(),
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()
Link to this callback

handle_process_list(pad, buffers, context, state)

View Source (optional) 
@callback handle_process_list(
  pad :: Membrane.Pad.ref(),
  buffers :: [Membrane.Buffer.t()],
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()
Link to this callback

handle_start_of_stream(pad, context, state)

View Source 
@callback handle_start_of_stream(
  pad :: Membrane.Pad.ref(),
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()

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(),
  stream_format :: Membrane.StreamFormat.t(),
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()

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.

Context passed to this callback contains additional field :old_stream_format.

Link to this callback

handle_write(pad, buffer, context, state)

View Source (optional) 
@callback handle_write(
  pad :: Membrane.Pad.ref(),
  buffer :: Membrane.Buffer.t(),
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()
Link to this callback

handle_write_list(pad, buffers, context, state)

View Source (optional) 
@callback handle_write_list(
  pad :: Membrane.Pad.ref(),
  buffers :: [Membrane.Buffer.t()],
  context :: Membrane.Element.CallbackContext.t(),
  state :: Membrane.Element.state()
) :: Membrane.Element.Base.callback_return()

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.element_spec/0 describes how the definition of pads should look.