Packages

membrane_core

0.2.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)

HexDocs

Current section

Files

Jump to
Readme
65 Versions
2 Dependencies
136 Dependants
Files
Activity
membrane_core lib membrane element base.ex
Raw

lib/membrane/element/base.ex 

defmodule Membrane.Element.Base do

  @moduledoc """

  Modules in this namespace contain behaviours, default callback implementations

  and other stuff useful when creating elements.



  Elements are units that produce, process or consume data. They can be linked

  with `Membrane.Pipeline`, and thus form a pipeline able to perform complex data

  processing. Each element defines a set of pads, through which it can be linked

  with other elements. During playback, pads can either send (output pads) or

  receive (input pads) data. For more information on pads, see

  `Membrane.Element.Pad`.



  To implement an element, one of base modules (`Membrane.Element.Base.Source`,

  `Membrane.Element.Base.Filter`, `Membrane.Element.Base.Sink`)

  has to be `use`d, depending on the element type:

  - source, producing buffers (contain only output pads),

  - filter, processing buffers (contain both input and output pads),

  - sink, consuming buffers (contain only input pads).

  For more information on each element type, check documentation for appropriate

  base module.



  ## Behaviours

  Element-specific behaviours are specified in modules:

  - `Membrane.Element.Base.Mixin.CommonBehaviour` - behaviour common to all

  elements,

  - `Membrane.Element.Base.Mixin.SourceBehaviour` - behaviour common to sources

  and filters,

  - `Membrane.Element.Base.Mixin.SinkBehaviour` - behaviour common to sinks and

  filters,

  - Base modules (`Membrane.Element.Base.Source`, `Membrane.Element.Base.Filter`,

  `Membrane.Element.Base.Sink`) - behaviours specific to each element type.



  ## Callbacks

  Modules listed above provide specifications of callbacks that define elements

  lifecycle. All of these callbacks have names with the `handle_` prefix.

  They are used to define reaction to certain events that happen during runtime,

  and indicate what actions frawork should undertake as a result, besides

  executing element-specific code.



  For actions that can be returned by each callback, see `Membrane.Element.Action`

  module.

  """

end