View Source Membrane.Debug.Sink (Membrane Core v1.1.0)

Membrane Sink, that can be used to create a child that will be used to debug data flowing thouth pipeline.

Usage example:

child(:source, CustomSource)
|> child(:sink, %Membrane.Debug.Sink{
  handle_buffer: &IO.inspect(&1, label: "buffer"),
  handle_event: &IO.inspect(&1, label: "event")
})

Element options

Passed via struct Membrane.Debug.Sink.t/0

  • handle_buffer

    (Buffer.t() -> any())

    Default value: &Membrane.Debug.Sink.noop/1
    Function with arity 1, that will be called with all buffers handled by this sink. Result of this function is ignored.

  • handle_event

    (Event.t() -> any())

    Default value: &Membrane.Debug.Sink.noop/1
    Function with arity 1, that will be called with all events handled by this sink. Result of this function is ignored.

  • handle_stream_format

    (StreamFormat.t() -> any())

    Default value: &Membrane.Debug.Sink.noop/1
    Function with arity 1, that will be called with all stream formats handled by this sink. Result of this function is ignored.

Pads

:input

Accepted formats:

_any
Direction::input
Availability::always
Flow control::auto

Summary

Types

t()

Struct containing options for Membrane.Debug.Sink

Functions

Returns description of options available for this module

Types

@type t() :: %Membrane.Debug.Sink{
  handle_buffer: (Membrane.Buffer.t() -> any()),
  handle_event: (Membrane.Event.t() -> any()),
  handle_stream_format: (Membrane.StreamFormat.t() -> any())
}

Struct containing options for Membrane.Debug.Sink

Functions

@spec noop(any()) :: :ok
@spec options() :: keyword()

Returns description of options available for this module