View Source Membrane.Buffer.Metric behaviour (Membrane Core v1.1.1)

Specifies API for metrics that analyze data in terms of a given unit

Summary

Types

unit()

Callbacks

buffer_size_approximation()

buffers_size(arg1)

split_buffers(arg1, non_neg_integer)

Functions

from_unit(atom)

Types

unit()

@type unit() :: :buffers | :bytes

Callbacks

buffer_size_approximation()

@callback buffer_size_approximation() :: pos_integer()

buffers_size(arg1)

@callback buffers_size(
  [
    %Membrane.Buffer{
      dts: term(),
      metadata: term(),
      payload: term(),
      pts: term()
    }
  ]
  | []
) ::
  non_neg_integer()

split_buffers(arg1, non_neg_integer)

@callback split_buffers(
  [
    %Membrane.Buffer{
      dts: term(),
      metadata: term(),
      payload: term(),
      pts: term()
    }
  ]
  | [],
  non_neg_integer()
) ::
  {[
     %Membrane.Buffer{
       dts: term(),
       metadata: term(),
       payload: term(),
       pts: term()
     }
   ]
   | [],
   [
     %Membrane.Buffer{
       dts: term(),
       metadata: term(),
       payload: term(),
       pts: term()
     }
   ]
   | []}

Functions

from_unit(atom)

@spec from_unit(unit()) :: module()