View Source Membrane.Element (Membrane Core v0.11.0)
Module containing types and functions for operating on elements.
For behaviours for elements chceck Membrane.Source, Membrane.Filter,
Membrane.Endpoint 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/2
callback.
Type of user-managed state of element.
Defines possible element types
Link to this section Types
Type that defines an element name by which it is identified.
@type options_t() :: struct() | nil
Defines options that can be received in Membrane.Element.Base.handle_init/2
callback.
@type state_t() :: any()
Type of user-managed state of element.
@type type_t() :: :source | :filter | :endpoint | :sink
Defines possible element types:
- source, producing buffers
- filter, processing buffers
- endpoint, producing and consuming buffers
- sink, consuming buffers
Link to this section Functions
Checks whether module is an element.