rtmp

Documentation

Overview

Package rtmp provides an RTMP server

Index

• Variables
• type Config
• type Server
  • func New(config Config) (Server, error)

Variables

var ErrServerClosed = rtmp.ErrServerClosed

ErrServerClosed is returned by ListenAndServe (or ListenAndServeTLS) if the server has been closed regularly with the Close() function.

Types

type Config

type Config struct {
	// Logger. Optional.
	Logger log.Logger

	Collector session.Collector

	// The address the RTMP server should listen on, e.g. ":1935"
	Addr string

	// The address the RTMPS server should listen on, e.g. ":1936"
	TLSAddr string

	// The app path for the streams, e.g. "/live". Optional. Defaults
	// to "/".
	App string

	// A token that needs to be added to the URL as query string
	// in order push or pull a stream. The key for the query
	// parameter is "token". Optional. By default no token is
	// required.
	Token string

	// TLSConfig optionally provides a TLS configuration for use
	// by ListenAndServe. Note that this value is cloned by
	// ListenAndServe, so it's not possible to modify the configuration
	// with methods like tls.Config.SetSessionTicketKeys.
	TLSConfig *tls.Config

	// ConnectionIdleTimeout is the timeout in seconds after which idle
	// connection will be closes. Default is no timeout.
	ConnectionIdleTimeout time.Duration
}

Config for a new RTMP server

type Server

type Server interface {
	// ListenAndServe starts the RTMP server
	ListenAndServe() error

	// ListenAndServe starts the RTMPS server
	ListenAndServeTLS(certFile, keyFile string) error

	// Close stops the RTMP server and closes all connections
	Close()

	// Channels return a list of currently publishing streams
	Channels() []string
}

Server represents a RTMP server

func New

func New(config Config) (Server, error)

New creates a new RTMP server according to the given config