Membrane Core v0.10.2

View Source Membrane.Bin.PadData (Membrane Core v0.10.2)

Struct describing current pad state.

The public fields are:

  • :accepted_caps - specification of possible caps that are accepted on the pad. See Membrane.Caps.Matcher for more information.
  • :availability - see Membrane.Pad.availability_t
  • :direction - see Membrane.Pad.direction_t
  • :mode - see Membrane.Pad.mode_t
  • :name - see Membrane.Pad.name_t. Do not mistake with :ref
  • :options - options passed in Membrane.ParentSpec when linking pad
  • :ref - see Membrane.Pad.ref_t

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

private_field()
t()

Link to this section Types

Link to this type

private_field()

View Source 
@type private_field() :: term()
Link to this type

t()

View Source 
@type t() :: %Membrane.Bin.PadData{
  accepted_caps: Membrane.Caps.Matcher.caps_specs_t(),
  availability: Membrane.Pad.availability_t(),
  demand_unit: private_field(),
  direction: Membrane.Pad.direction_t(),
  endpoint: private_field(),
  link_id: private_field(),
  linked?: private_field(),
  mode: Membrane.Pad.mode_t(),
  name: Membrane.Pad.name_t(),
  options: Membrane.ParentSpec.pad_options_t(),
  ref: Membrane.Pad.ref_t(),
  response_received?: private_field(),
  spec_ref: private_field()
}