Membrane Core v0.9.0

View Source Membrane.Element (Membrane Core v0.9.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

name_t()

Type that defines an element name by which it is identified.

options_t()

Defines options that can be received in Membrane.Element.Base.handle_init/1 callback.

state_t()

Type of user-managed state of element.

type_t()

Defines possible element types

Functions

element?(module)

Checks whether module is an element.

Link to this section Types

Link to this type

name_t()

View Source

Specs

name_t() :: any()

Type that defines an element name by which it is identified.

Link to this type

options_t()

View Source

Specs

options_t() :: struct() | nil

Defines options that can be received in Membrane.Element.Base.handle_init/1 callback.

Link to this type

state_t()

View Source

Specs

state_t() :: map() | struct()

Type of user-managed state of element.

Link to this type

type_t()

View Source

Specs

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

Link to this function

element?(module)

View Source

Specs

element?(module()) :: boolean()

Checks whether module is an element.