Membrane Core v0.3.0 Membrane.Pipeline.Spec View Source
Structure representing topology of a pipeline.
It can be returned from
Membrane.Pipeline.handle_init/1
callback upon pipeline's initialization.
It will define a topology of children and links that build the pipeline.
Children
Children that should be spawned when the pipeline starts can be defined
with the :children
field.
You have to set it to a keyword list, where keys are valid element names (Membrane.Element.name_t/0
)
that are unique within this pipeline and values are either element's module or
struct of that module.
Sample definitions:
[
first_element: %Element.With.Options.Struct{option_a: 42},
some_element: Element.Without.Options,
other_element: Element.Using.Default.Options
]
Links
Links that should be made when the pipeline starts, and children are spawned
can be defined with the :links
field.
You have to set it to a map, where both keys and values are tuples of
{element_name, pad_name}
. Entries can also have additional options passed by
keyword list at the end of a tuple (See endpoint_options_t/0
).
Element names have to match names given to the :children
field.
Once it's done, pipeline will ensure that links are present.
Sample definition:
%{
{:source_a, :output} => {:converter, :input, buffer: [preferred_size: 20_000]},
{:converter, :output} => {:mixer, :input_a},
{:source_b, :output} => {:mixer, :input_b, pad: [mute: true]}
{:mixer, :output} => {:sink, :input, buffer: [warn_size: 264_000, fail_size: 300_000]},
}
Link to this section Summary
Types
Description of all the children elements inside the pipeline
Options passed to the element when linking its pad with different one
Spec for one of the ends of the link
Map describing links between elements
Struct used when launching a pipeline
Link to this section Types
child_spec_t() View Source
children_spec_t()
View Source
children_spec_t() ::
[{Membrane.Element.name_t(), child_spec_t()}]
| %{optional(Membrane.Element.name_t()) => child_spec_t()}
children_spec_t() :: [{Membrane.Element.name_t(), child_spec_t()}] | %{optional(Membrane.Element.name_t()) => child_spec_t()}
Description of all the children elements inside the pipeline
endpoint_options_t()
View Source
endpoint_options_t() :: [
buffer: Membrane.Core.InputBuffer.props_t(),
pad: element_specific_opts :: any()
]
endpoint_options_t() :: [ buffer: Membrane.Core.InputBuffer.props_t(), pad: element_specific_opts :: any() ]
Options passed to the element when linking its pad with different one.
The allowed options are:
:buffer
- keywoed allowing to configureMembrane.Core.InputBuffer
between elements. Valid only for input pads. SeeMembrane.Core.InputBuffer.props_t/0
for configurable properties.:pad
- any element-specific options that will be available inMembrane.Element.Pad.Data
struct.
link_endpoint_spec_t()
View Source
link_endpoint_spec_t() ::
{Membrane.Element.name_t(), Membrane.Element.Pad.name_t()}
| {Membrane.Element.name_t(), Membrane.Element.Pad.name_t(),
endpoint_options_t()}
link_endpoint_spec_t() :: {Membrane.Element.name_t(), Membrane.Element.Pad.name_t()} | {Membrane.Element.name_t(), Membrane.Element.Pad.name_t(), endpoint_options_t()}
Spec for one of the ends of the link
links_spec_t()
View Source
links_spec_t() :: %{required(link_endpoint_spec_t()) => link_endpoint_spec_t()}
links_spec_t() :: %{required(link_endpoint_spec_t()) => link_endpoint_spec_t()}
Map describing links between elements
t()
View Source
t() :: %Membrane.Pipeline.Spec{
children: children_spec_t(),
links: links_spec_t()
}
t() :: %Membrane.Pipeline.Spec{ children: children_spec_t(), links: links_spec_t() }
Struct used when launching a pipeline