# `Membrane.Bin.PadData`
[🔗](https://github.com/membraneframework/membrane-core/blob/v1.2.6/lib/membrane/bin/pad_data.ex#L1)

Struct describing current pad state.

The public fields are:
  - `:availability` - see `t:Membrane.Pad.availability/0`
  - `:direction` - see `t:Membrane.Pad.direction/0`
  - `:name` - see `t:Membrane.Pad.name/0`. Do not mistake with `:ref`
  - `:options` - options passed in `Membrane.ChildrenSpec` when linking pad
  - `:ref` - see `t:Membrane.Pad.ref/0`
  - `max_instances` - specifies maximal possible number of instances of a dynamic pad that can exist within single element. Equals `nil` for pads with `availability: :always`.

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

# `private_field`

```elixir
@type private_field() :: term()
```

# `t`

```elixir
@type t() :: %Membrane.Bin.PadData{
  availability: Membrane.Pad.availability(),
  direction: Membrane.Pad.direction(),
  endpoint: private_field(),
  link_id: private_field(),
  linked?: private_field(),
  linked_in_spec?: private_field(),
  linking_timeout_id: private_field(),
  max_instances: Membrane.Pad.max_instances() | nil,
  name: Membrane.Pad.name(),
  options: Membrane.ChildrenSpec.pad_options(),
  ref: Membrane.Pad.ref(),
  response_received?: private_field(),
  spec_ref: private_field()
}
```

Struct describing current pad state.

The public fields are:
  - `:availability` - see `t:Membrane.Pad.availability/0`
  - `:direction` - see `t:Membrane.Pad.direction/0`
  - `:name` - see `t:Membrane.Pad.name/0`. Do not mistake with `:ref`
  - `:options` - options passed in `Membrane.ChildrenSpec` when linking pad
  - `:ref` - see `t:Membrane.Pad.ref/0`
  - `max_instances` - specifies maximal possible number of instances of a dynamic pad that can exist within single element. Equals `nil` for pads with `availability: :always`.

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*