View Source Membrane RTMP Plugin

Hex.pm API Docs CircleCI

This package provides RTMP server which listens to a connection from a client and element for streaming to an RTMP server. It is part of Membrane Multimedia Framework.

server

Server

After establishing connection it receives RTMP stream, demux it and outputs H264 video and AAC audio. At this moment only one client can connect to the server.

client

Client

After establishing connection with server it waits to receive video and audio streams. Once both streams are received they are streamed to the server. Currently only the following codecs are supported:

  • H264 for video
  • AAC for audio

installation

Installation

The package can be installed by adding membrane_rtmp_plugin to your list of dependencies in mix.exs:

def deps do
  [
    {:membrane_rtmp_plugin, "~> 0.6.0"}
  ]
end

prerequisites

Prerequisites

In order to successfully build and install the plugin, you need to have ffmpeg == 4.4 installed on your system

usage

Usage

membrane-rtmp-source-rtmp-server

Membrane.RTMP.Source - RTMP Server

Server-side example, in which Membrane will act as an RTMP server and receive the stream, can be found under examples/source.exs. Run it with:

elixir examples/source.exs

When the server is ready you can connect to it with RTMP. If you just want to test it, you can use FFmpeg:

ffmpeg -re -i test/fixtures/testsrc.flv -f flv -c:v copy -c:a copy rtmp://localhost:5000

membrane-rtmp-sink-streaming-over-rtmp

Membrane.RTMP.Sink - Streaming over RTMP

Streaming implementation example is provided with the following script. Run it with:

elixir examples/sink.exs

It will connect to RTMP server provided via URL and stream H264 video and AAC audio. RTMP server that will receive this stream can be launched with ffmpeg by running the following commands:

export RTMP_URL=rtmp://localhost:1935
ffmpeg -listen 1 -f flv -i rtmp://localhost:1935 -c copy dest.flv

It will receive stream and once streaming is completed dump it to .flv file. If you are using the command above, please remember to run it before the streaming script.

Copyright 2021, Software Mansion

Software Mansion

Licensed under the Apache License, Version 2.0