membrane_core

# Membrane Framework

[![Hex.pm](https://img.shields.io/hexpm/v/membrane_core.svg)](https://hex.pm/packages/membrane_core)
[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/membrane_core/)
[![CI](https://github.com/membraneframework/membrane_core/actions/workflows/ci.yml/badge.svg)](https://github.com/membraneframework/membrane_core/actions/workflows/ci.yml)
[![Ad](https://swm-delivery.com/www/images/zone-gh-membrane-1?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-membrane-1&n=1)
[![Ad](https://swm-delivery.com/www/images/zone-gh-membrane-2?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-membrane-2&n=1)
[![Ad](https://swm-delivery.com/www/images/zone-gh-membrane-3?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-membrane-3&n=1)

Membrane is a versatile multimedia streaming & processing framework. You can use it to build a media server of your need, that can:

- stream via WebRTC, RTSP, RTMP, HLS, HTTP and other protocols,
- transcode, mix and apply custom processing of video & audio,
- accept and generate / record to MP4, MKV, FLV and other containers,
- handle dynamically connecting and disconnecting streams,
- seamlessly scale and recover from errors,
- do whatever you imagine if you implement it yourself :D Membrane makes it easy to plug in your code at almost any point of processing.

The abbreviations above don't ring any bells? Visit [membrane.stream/learn](https://membrane.stream/learn) and let Membrane introduce you to the multimedia world!

If you have questions or need consulting, we're for you at our [Discord](https://discord.gg/nwnfVSY), [forum](https://elixirforum.com/c/elixir-framework-forums/membrane-forum/), [GitHub discussions](https://github.com/orgs/membraneframework/discussions), [X (Twitter)](https://twitter.com/ElixirMembrane) and via [e-mail](mailto:info@membraneframework.org).

You can also [follow Membrane on X (Twitter)](https://twitter.com/ElixirMembrane) or [join our Discord](https://discord.gg/nwnfVSY) to be up to date and get involved in the community.

If you already had a chance to use Membrane, we will be grateful if you could fill out a quick [survey](https://forms.gle/dgVDFHUD7CUGxU5VA) to help us improve framework and decide on what to do next.

For people who write Membrane code with AI assistants, we ship a [dedicated skill](#membrane-skill-for-ai-assistants) for them.

Membrane is maintained by [Software Mansion](https://swmansion.com).

## Quick start

```elixir
Mix.install([
  :membrane_hackney_plugin,
  :membrane_mp3_mad_plugin,
  :membrane_portaudio_plugin,
])

defmodule MyPipeline do
  use Membrane.Pipeline

  @impl true
  def handle_init(_ctx, mp3_url) do
    spec =
      child(%Membrane.Hackney.Source{
        location: mp3_url, hackney_opts: [follow_redirect: true]
      })
      |> child(Membrane.MP3.MAD.Decoder)
      |> child(Membrane.PortAudio.Sink)

    {[spec: spec], %{}}
  end
end