api

Documentation

Overview

Package api contains the API server.

Index

• type API
  • func (a *API) Close()
  • func (a *API) Initialize() error
  • func (a *API) Log(level logger.Level, format string, args ...interface{})
  • func (a *API) ReloadConf(conf *conf.Conf)
• type HLSServer
• type PathManager
• type RTMPServer
• type RTSPServer
• type SRTServer
• type WebRTCServer

Types

type API

type API struct {
	Address        string
	Encryption     bool
	ServerKey      string
	ServerCert     string
	AllowOrigin    string
	TrustedProxies conf.IPNetworks
	ReadTimeout    conf.Duration
	Conf           *conf.Conf
	AuthManager    apiAuthManager
	PathManager    PathManager
	RTSPServer     RTSPServer
	RTSPSServer    RTSPServer
	RTMPServer     RTMPServer
	RTMPSServer    RTMPServer
	HLSServer      HLSServer
	WebRTCServer   WebRTCServer
	SRTServer      SRTServer
	Parent         apiParent
	// contains filtered or unexported fields
}

API is an API server.

func (*API) Close

func (a *API) Close()

Close closes the API.

func (*API) Initialize

func (a *API) Initialize() error

Initialize initializes API.

func (*API) Log

func (a *API) Log(level logger.Level, format string, args ...interface{})

Log implements logger.Writer.

func (*API) ReloadConf

func (a *API) ReloadConf(conf *conf.Conf)

ReloadConf is called by core.

type HLSServer

type HLSServer interface {
	APIMuxersList() (*defs.APIHLSMuxerList, error)
	APIMuxersGet(string) (*defs.APIHLSMuxer, error)
}

HLSServer contains methods used by the API and Metrics server.

type PathManager

type PathManager interface {
	APIPathsList() (*defs.APIPathList, error)
	APIPathsGet(string) (*defs.APIPath, error)
}

PathManager contains methods used by the API and Metrics server.

type RTMPServer

type RTMPServer interface {
	APIConnsList() (*defs.APIRTMPConnList, error)
	APIConnsGet(uuid.UUID) (*defs.APIRTMPConn, error)
	APIConnsKick(uuid.UUID) error
}

RTMPServer contains methods used by the API and Metrics server.

type RTSPServer

type RTSPServer interface {
	APIConnsList() (*defs.APIRTSPConnsList, error)
	APIConnsGet(uuid.UUID) (*defs.APIRTSPConn, error)
	APISessionsList() (*defs.APIRTSPSessionList, error)
	APISessionsGet(uuid.UUID) (*defs.APIRTSPSession, error)
	APISessionsKick(uuid.UUID) error
}

RTSPServer contains methods used by the API and Metrics server.

type SRTServer

type SRTServer interface {
	APIConnsList() (*defs.APISRTConnList, error)
	APIConnsGet(uuid.UUID) (*defs.APISRTConn, error)
	APIConnsKick(uuid.UUID) error
}

SRTServer contains methods used by the API and Metrics server.

type WebRTCServer

type WebRTCServer interface {
	APISessionsList() (*defs.APIWebRTCSessionList, error)
	APISessionsGet(uuid.UUID) (*defs.APIWebRTCSession, error)
	APISessionsKick(uuid.UUID) error
}

WebRTCServer contains methods used by the API and Metrics server.