Membrane Core v1.1.2

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

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

 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

 Pads

input

 :input

Accepted formats:

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

Link to this section Summary

Types

t()

Struct containing options for Membrane.Debug.Sink

Functions

noop(arg)
options()

Returns description of options available for this module

Link to this section Types

Link to this type

t()

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

Link to this section Functions

Link to this function

noop(arg)

View Source 
@spec noop(any()) :: :ok
Link to this function

options()

View Source 
@spec options() :: keyword()

Returns description of options available for this module