README.md

rtmp

rtmp is a Golang implementation of the RTMP specification, found here. It is entirely specification compliant, and implements all modern parts of the RTMP spec, most used in the wild.

It is currently used in Beam's internal RTMP ingest server.

Getting Started

Installation

rtmp is distributed as a Golang library. It is easily accessible from within other Go packages by simply importing it. To make rtmp available in your environment, simply go get it:

go get github.com/todostreaming/rtmp

Alternatively, you can lock rtmp as a dependency, or fetch it using gopkg.in, applying the standard conventions.

Core Concepts

At its most basic form, the rtmp package provides a simple RTMP server implementation, that returns a <-chan *client.Client. The client.Client type has several methods defined on it which reference other packages in the library to preform more composable operations, such as chunk reading, data streams, and so forth.

Server

An RTMP has only one job, which is to return RTMP clients, such that the caller may do with them what they want. An example implementation of processing clients from a server follows:

package main

import (
        "github.com/todostreaming/rtmp/server"
)

func main() {
        s := server.New(":1935")

        go s.Accept()
        defer s.Close()

        for {
                select {
                case c := <-s.Clients():
                        // ...
                case err := <-s.Errs():
                        // ...
                }
        }
}

Client

The client, on the other hand, has many jobs. It serves as the top node in a tree, capable of calling into all other packages dealing with particular parts of the RTMP specification. For example, the client knows how to:

• Handshake itself by using the github.com/todostreaming/rtmp/handshake package
• Receive RTMP control sequences using the github.com/todostreaming/rtmp/control package
• More to come...

For more information on all of the things that the client can do, see the relevant documentation.

License

Creative Commons Attribution-NonCommercial 4.0 International.