rtmp

Documentation

Overview

Package rtmp provides client and server implementation for RTMP message and chunk streams

Index

• type ClientOptions
• type Connection
  • func Dial(parent context.Context, remote string, options *ClientOptions) (conn Connection, err error)
• type Server
  • func NewServer(parent context.Context, listener net.Listener, options *ServerOptions) *Server
  • func NewServerListen(parent context.Context, addr string, options *ServerOptions) (srv *Server, err error)
  • func (srv *Server) Accept(ctx context.Context) (conn Connection, err error)
• type ServerOptions

Types

type ClientOptions

type ClientOptions struct {
	Connection *connection.Options
	Handshaker handshake.Handshaker
}

ClientOptions provide configuration for RTMP client

type Connection

type Connection interface {
	Recv(ctx context.Context) (*message.Raw, error)
	Send(ctx context.Context, msg *message.Raw) error
	Close() error
}

Connection interface provides RTMP connection methods for terminating connection and writing and reading messages

func Dial

func Dial(parent context.Context, remote string, options *ClientOptions) (conn Connection, err error)

Dial established new connection with remote RTMP server

type Server

type Server struct {
	Listener    net.Listener
	Options     ServerOptions
	Context     context.Context
	Cancel      context.CancelFunc
	Connections chan Connection
}

Server provides RTMP server implementation

func NewServer

func NewServer(parent context.Context, listener net.Listener, options *ServerOptions) *Server

NewServer returns new RTMP server using existing listener

func NewServerListen

func NewServerListen(parent context.Context, addr string, options *ServerOptions) (srv *Server, err error)

NewServerListen returns new RTMP server creating TCP listener on provided endpoint

func (*Server) Accept

func (srv *Server) Accept(ctx context.Context) (conn Connection, err error)

Accept blocks until context is expired, or new RTMP connection is established

type ServerOptions

type ServerOptions struct {
	Connection *connection.Options
	Handshaker handshake.Handshaker
}

ServerOptions provide configuration for RTMP server