Membrane Core v0.5.0 Membrane.Pad.Data View Source
Struct describing current pad state.
The public fields are:
:accepted_caps
- specification of possible caps that are accepted on the pad. SeeMembrane.Caps.Matcher
for more information. This field only applies to elements' pads.:availability
- seeMembrane.Pad.availability_t
:caps
- the most recentMembrane.Caps
that have been sent (output) or received (input) on the pad. May benil
if not yet set. This field only applies to elements' pads.:demand
- current demand requested on the pad working in pull mode. This field only applies to elements' pads.:direction
- seeMembrane.Pad.direction_t
:end_of_stream?
- flag determining whetherMembrane.Event.EndOfStream
has been received (or sent) on the pad:mode
- seeMembrane.Pad.mode_t
. This field only applies to elements' pads.:name
- seeMembrane.Pad.name_t
. Do not mistake with:ref
:options
- options passed inMembrane.ParentSpec
when linking pad:ref
- seeMembrane.Pad.ref_t
:start_of_stream?
- flag determining whetherMembrane.Event.StartOfStream
has been received (or sent) on the 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
Link to this section Types
Link to this type
t()
View Sourcet() :: %Membrane.Pad.Data{ accepted_caps: Membrane.Caps.Matcher.caps_specs_t(), availability: Membrane.Pad.availability_t(), bin?: boolean(), caps: Membrane.Caps.t() | nil, demand: integer() | nil, demand_unit: Membrane.Buffer.Metric.unit_t() | nil, direction: Membrane.Pad.direction_t(), end_of_stream?: boolean(), input_buf: Membrane.Core.InputBuffer.t() | nil, mode: Membrane.Pad.mode_t(), name: Membrane.Pad.name_t(), options: %{optional(atom()) => any()}, other_demand_unit: Membrane.Buffer.Metric.unit_t() | nil, other_ref: Membrane.Pad.ref_t(), pid: pid(), ref: Membrane.Pad.ref_t(), start_of_stream?: boolean(), sticky_messages: [Membrane.Event.t()] }