Membrane Core v0.4.0 Membrane.Element.Pad.Data View Source

Struct describing current pad state.

The public fields are:

:caps - the most recent Membrane.Caps that have been sent (output) or received (input) on the pad. May be nil if not yet set.
:start_of_stream? - flag determining whether Membrane.Event.StartOfStream has been received (or sent) on the pad
:end_of_stream? - flag determining whether Membrane.Event.EndOfStream has been received (or sent) on the pad
:options - options passed in Membrane.Pipeline.Spec when linking pad

Other fields in the struct ARE NOT PART OF THE PUBLIC API and should not be accessed or relied on.

Link to this section Summary

Types

t()

Link to this section Types

t()

t() :: %Membrane.Element.Pad.Data{
  accepted_caps: any(),
  availability: Membrane.Element.Pad.availability_t(),
  caps: Membrane.Caps.t() | nil,
  current_id: non_neg_integer() | nil,
  demand: integer() | nil,
  demand_unit: Membrane.Buffer.Metric.unit_t() | nil,
  direction: Membrane.Element.Pad.direction_t(),
  end_of_stream?: boolean(),
  input_buf: Membrane.Core.InputBuffer.t() | nil,
  mode: Membrane.Element.Pad.mode_t(),
  options: Keyword.t(),
  other_demand_unit: Membrane.Buffer.Metric.unit_t() | nil,
  other_ref: Membrane.Element.Pad.ref_t(),
  pid: pid(),
  start_of_stream?: boolean(),
  sticky_messages: [Membrane.Event.t()]
}