membraneframework-labs / guide Goto Github PK

• Concepts - demands, pull/push modes
• Developer introduction, internal architecture
• Element life cycle

I think the following libraries also need to be documented (for Ubuntu):

• libswresample-dev
• libavutil-dev

Otherwise, compilation fails

To be done after PR #22

There are several issues in the tutorial:

• In most codes @impl before some functions is used. But in this case we'll get warnings. Probably, @impl should be replaced with @impl true.
• chapter1/pipeline.md:
  The code won't work without the {:membrane_element_mad, "~> 0.1"} dependency. It also worth to mention that some of the dependencies require some libraries.
• chapter1/pipeline.md:
  Probably, it should be added alias Membrane.Pipeline before {:ok, pid} = Pipeline.start_link(Membrane.CoreTest.Pipeline, "/path/to/mp3", []); Pipeline.play(pid).
• chapter1/element.md:
  def handle_demand :source, size, :buffers, _context, state do -> def handle_demand :source, size, :bytes, _context, state do, otherwise we'll get an error during an execution.
• chapter1/element.md:
  def handle_init(%__MODULE{interval: interval}) -> def handle_init(%__MODULE__{interval: interval})
• Usage of the words 'source' and 'sink' is quite misleading in the tutorial.