View Source Membrane.Element.PadData (Membrane Core v1.0.1)
Struct describing current pad state.
The public fields are:
:availability
- seeMembrane.Pad.availability/0
:stream_format
- the most recentMembrane.StreamFormat.t/0
that have been sent (output) or received (input) on the pad. May benil
if not yet set.:direction
- seeMembrane.Pad.direction/0
:end_of_stream?
- flag determining whether the stream processing via the pad has been finished:flow_control
- seeMembrane.Pad.flow_control/0
.:name
- seeMembrane.Pad.name/0
. Do not mistake with:ref
:options
- options passed inMembrane.ParentSpec
when linking pad:ref
- seeMembrane.Pad.ref/0
:start_of_stream?
- flag determining whether the stream processing via the pad has been startedauto_demand_paused?
- flag determining if auto-demanding on the pad is paused or no
Other fields in the struct ARE NOT PART OF THE PUBLIC API and should not be accessed or relied on.
Summary
Types
@type private_field() :: term()
@type t() :: %Membrane.Element.PadData{ associated_pads: private_field(), atomic_demand: private_field(), auto_demand_paused?: boolean(), auto_demand_size: private_field(), availability: Membrane.Pad.availability(), demand: integer() | nil, demand_unit: private_field(), direction: Membrane.Pad.direction(), end_of_stream?: boolean(), flow_control: Membrane.Pad.flow_control(), incoming_demand: integer() | nil, input_queue: private_field(), manual_demand_size: private_field(), name: Membrane.Pad.name(), options: %{optional(atom()) => any()}, other_demand_unit: private_field(), other_effective_flow_control: private_field(), other_ref: private_field(), pid: private_field(), ref: Membrane.Pad.ref(), stalker_metrics: private_field(), start_of_stream?: boolean(), sticky_events: private_field(), sticky_messages: private_field(), stream_format: Membrane.StreamFormat.t() | nil, stream_format_validation_params: private_field() }
Struct describing current pad state.
The public fields are:
:availability
- seeMembrane.Pad.availability/0
:stream_format
- the most recentMembrane.StreamFormat.t/0
that have been sent (output) or received (input) on the pad. May benil
if not yet set.:direction
- seeMembrane.Pad.direction/0
:end_of_stream?
- flag determining whether the stream processing via the pad has been finished:flow_control
- seeMembrane.Pad.flow_control/0
.:name
- seeMembrane.Pad.name/0
. Do not mistake with:ref
:options
- options passed inMembrane.ParentSpec
when linking pad:ref
- seeMembrane.Pad.ref/0
:start_of_stream?
- flag determining whether the stream processing via the pad has been startedauto_demand_paused?
- flag determining if auto-demanding on the pad is paused or no
Other fields in the struct ARE NOT PART OF THE PUBLIC API and should not be accessed or relied on.