View Source Membrane.Element.PadData (Membrane Core v0.11.0)
Struct describing current pad state.
The public fields are:
:availability
- seeMembrane.Pad.availability_t/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.:demand
- current demand requested on the pad working in pull mode.:direction
- seeMembrane.Pad.direction_t/0
:end_of_stream?
- flag determining whether the stream processing via the pad has been finished:mode
- seeMembrane.Pad.mode_t/0
.:name
- seeMembrane.Pad.name_t/0
. Do not mistake with:ref
:options
- options passed inMembrane.ParentSpec
when linking pad:ref
- seeMembrane.Pad.ref_t/0
:start_of_stream?
- flag determining whether the stream processing via the pad has been started
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
@type private_field() :: term()
@type t() :: %Membrane.Element.PadData{ associated_pads: private_field(), auto_demand_size: private_field(), availability: Membrane.Pad.availability_t(), demand: integer() | nil, demand_mode: private_field(), demand_unit: private_field(), direction: Membrane.Pad.direction_t(), end_of_stream?: boolean(), input_queue: private_field(), mode: Membrane.Pad.mode_t(), name: Membrane.Pad.name_t(), options: %{optional(atom()) => any()}, other_demand_unit: private_field(), other_ref: private_field(), pid: private_field(), ref: Membrane.Pad.ref_t(), start_of_stream?: boolean(), sticky_events: private_field(), sticky_messages: private_field(), stream_format: Membrane.StreamFormat.t() | nil, stream_format_validation_params: private_field(), toilet: private_field() }