Membrane RTSP

The RTSP client for Elixir

Currently supports only RTSP 1.1 defined by RFC2326

Installation

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

def deps do
  [
    {:membrane_rtsp, "~> 0.2.1"}
  ]
end

Usage

To use Membrane RTSP client you must first start a session by calling either:

alias Membrane.RTSP

# It will exit if Session can't be started
{:ok, session} = RTSP.Session.start_link("rtsp://domain.name:port/path")
# OR
# Requires you to start under Supervision tree providing Supervisor
{:ok, session} = RTSP.Session.new(supervisor, "rtsp://domain.name:port/path")

Then you can proceed with executing requests:

alias Membrane.RTSP.Response

{:ok, %Response{status: 200}} = RTSP.describe(session)

{:ok, %Response{status: 200}} =
  RTSP.setup(session, "/trackID=1", [
    {"Transport", "RTP/AVP;unicast;client_port=57614-57615"}
  ])

{:ok, %Response{status: 200}} =
  RTSP.setup(session, "/trackID=2", [
    {"Transport", "RTP/AVP;unicast;client_port=52614-52615"}
  ])

{:ok, %Response{status: 200}} = RTSP.play(session)

If you started session without linking it, it is advised to close it manually by calling:

RTSP.close(supervisor, session)

Implementing custom transport layer

To implement custom request execution logic you must implement Membrane.RTSP.Transport behavior. Then you can pass the name of your transport module to Membrane.RTSP.Session.new/4.

Membrane.RTSP.Session.new/4 assumes that the transport module also implements GenServer behavior.

Architecture

Session consists of two processes: Manager and Transport.

Manager is responsible for tracking CSeq header and SessionId and Transport is responsible for transmitting the request and receiving a response. We don't want Manager to die when Transport dies and vice versa, so they are started together using Container which allows starting and stopping them as one.

External tests

Tests that use external RTSP service are disabled by default but they are present in the codebase. They are tagged as external and are usually accompanied by tests that mimic their behavior by using predefined responses.

Copyright and License

Licensed under the Apache License, Version 2.0