Packages
membrane_core
0.12.0
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.7
1.2.6
1.2.5
retired
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc1
1.1.2
1.1.1
1.1.0
1.1.0-rc1
1.1.0-rc0
1.0.1
1.0.0
1.0.0-rc1
1.0.0-rc0
0.12.9
0.12.8
0.12.7
0.12.6
0.12.5
0.12.4
0.12.3
0.12.2
0.12.1
0.12.0
retired
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.2
0.10.1
0.10.0
0.9.0
0.8.2
0.8.1
0.8.0
0.7.0
0.6.1
0.6.0
0.5.3
0.5.2
0.5.1
0.5.0
0.4.3
0.4.2
0.4.1
0.4.0
0.3.2
0.3.1
0.3.0
0.2.2
0.2.1
0.2.0
0.1.1
0.1.0
Membrane Multimedia Framework (Core)
Retired package: Deprecated - Package has an API change that will be no longer supported, use version 0.12.1 instead of this one
Current section
Files
Jump to
Current section
Files
lib/membrane/bin/pad_data.ex
defmodule Membrane.Bin.PadData do
@moduledoc """
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`
Other fields in the struct ARE NOT PART OF THE PUBLIC API and should not be
accessed or relied on.
"""
use Bunch.Access
@type private_field :: term()
@typedoc @moduledoc
@type t :: %__MODULE__{
ref: Membrane.Pad.ref(),
options: Membrane.ChildrenSpec.pad_options(),
availability: Membrane.Pad.availability(),
direction: Membrane.Pad.direction(),
name: Membrane.Pad.name(),
link_id: private_field,
endpoint: private_field,
linked?: private_field,
response_received?: private_field,
spec_ref: private_field
}
@enforce_keys [
:ref,
:options,
:availability,
:direction,
:name,
:link_id,
:endpoint,
:linked?,
:response_received?,
:spec_ref
]
defstruct @enforce_keys
end