Membrane.Element (Membrane Core v0.8.1) View Source
Module containing types and functions for operating on elements.
For behaviours for elements chceck Membrane.Source, Membrane.Filter and
Membrane.Sink.
Link to this section Summary
Types
Type that defines an element name by which it is identified.
Defines options that can be received in Membrane.Element.Base.handle_init/1
callback.
Type of user-managed state of element.
Defines possible element types
Functions
Checks whether module is an element.
Link to this section Types
Specs
name_t() :: any()
Type that defines an element name by which it is identified.
Specs
options_t() :: struct() | nil
Defines options that can be received in Membrane.Element.Base.handle_init/1
callback.
Specs
Type of user-managed state of element.
Specs
type_t() :: :source | :filter | :sink
Defines possible element types:
- source, producing buffers
- filter, processing buffers
- sink, consuming buffers
Link to this section Functions
Specs
Checks whether module is an element.