Membrane.Instrumentation.FrameTrace (Membrane Video Transcode v0.1.0)

Copy Markdown View Source

Lightweight per-frame trace used to correlate latency stages.

Summary

Types

t()

Functions

age_ns(frame_trace)
derive(parent, opts \\ [])
fetch(buffer)
mark(trace, stage, attrs \\ %{})
metadata_key()
new(opts \\ [])
put(buffer, trace)
token(trace)

Types

t()

@type t() :: %Membrane.Instrumentation.FrameTrace{
  annotations: %{optional(atom()) => map()},
  created_at_ns: integer(),
  frame_id: integer(),
  marks: %{optional(atom()) => integer()},
  pts: Membrane.Time.t() | nil,
  sampled?: boolean(),
  trace_id: integer()
}

Functions

age_ns(frame_trace)

@spec age_ns(t()) :: non_neg_integer()

derive(parent, opts \\ [])

@spec derive(t() | nil, keyword()) :: t()

fetch(buffer)

@spec fetch(Membrane.Buffer.t()) :: t() | nil

mark(trace, stage, attrs \\ %{})

@spec mark(t(), atom(), map()) :: t()

metadata_key()

@spec metadata_key() :: atom()

new(opts \\ [])

@spec new(keyword()) :: t()

put(buffer, trace)

@spec put(Membrane.Buffer.t(), t()) :: Membrane.Buffer.t()

token(trace)

@spec token(t()) :: Membrane.Instrumentation.TraceToken.t()