config

Documentation

Index

• type Capture
  • func (Capture) Init(cmd *cobra.Command) error
  • func (s *Capture) Set()
• type Config
• type Desktop
  • func (Desktop) Init(cmd *cobra.Command) error
  • func (s *Desktop) Set()
• type Member
  • func (Member) Init(cmd *cobra.Command) error
  • func (s *Member) Set()
• type Plugins
  • func (Plugins) Init(cmd *cobra.Command) error
  • func (s *Plugins) Set()
• type Root
  • func (Root) Init(cmd *cobra.Command) error
  • func (s *Root) Set()
• type Server
  • func (s *Server) AllowOrigin(origin string) bool
  • func (s *Server) HasCors() bool
  • func (Server) Init(cmd *cobra.Command) error
  • func (s *Server) Set()
• type Session
  • func (Session) Init(cmd *cobra.Command) error
  • func (s *Session) Set()
• type WebRTC
  • func (WebRTC) Init(cmd *cobra.Command) error
  • func (s *WebRTC) Set()
• type WebRTCEstimator

Types

type Capture

type Capture struct {
	Display string

	VideoCodec     codec.RTPCodec
	VideoIDs       []string
	VideoPipelines map[string]types.VideoConfig

	AudioDevice   string
	AudioCodec    codec.RTPCodec
	AudioPipeline string

	BroadcastAudioBitrate int
	BroadcastVideoBitrate int
	BroadcastPreset       string
	BroadcastPipeline     string
	BroadcastUrl          string

	ScreencastEnabled  bool
	ScreencastRate     string
	ScreencastQuality  string
	ScreencastPipeline string

	WebcamEnabled bool
	WebcamDevice  string
	WebcamWidth   int
	WebcamHeight  int

	MicrophoneEnabled bool
	MicrophoneDevice  string
}

func (Capture) Init

func (Capture) Init(cmd *cobra.Command) error

func (*Capture) Set

func (s *Capture) Set()

type Config

type Config interface {
	Init(cmd *cobra.Command) error
	Set()
}

type Desktop

type Desktop struct {
	Display string

	ScreenSize types.ScreenSize

	UseInputDriver bool
	InputSocket    string

	Unminimize        bool
	UploadDrop        bool
	FileChooserDialog bool
}

func (Desktop) Init

func (Desktop) Init(cmd *cobra.Command) error

func (*Desktop) Set

func (s *Desktop) Set()

type Member

type Member struct {
	Provider string

	// providers
	File      file.Config
	Object    object.Config
	Multiuser multiuser.Config
}

func (Member) Init

func (Member) Init(cmd *cobra.Command) error

func (*Member) Set

func (s *Member) Set()

type Plugins

type Plugins struct {
	Enabled  bool
	Dir      string
	Required bool
}

func (Plugins) Init

func (Plugins) Init(cmd *cobra.Command) error

func (*Plugins) Set

func (s *Plugins) Set()

type Root

type Root struct {
	Config string

	LogLevel   zerolog.Level
	LogTime    string
	LogJson    bool
	LogNocolor bool
	LogDir     string
}

func (Root) Init

func (Root) Init(cmd *cobra.Command) error

func (*Root) Set

func (s *Root) Set()

type Server

type Server struct {
	Cert       string
	Key        string
	Bind       string
	Proxy      bool
	Static     string
	PathPrefix string
	PProf      bool
	Metrics    bool
	CORS       []string
}

func (*Server) AllowOrigin

func (s *Server) AllowOrigin(origin string) bool

func (*Server) HasCors

func (s *Server) HasCors() bool

func (Server) Init

func (Server) Init(cmd *cobra.Command) error

func (*Server) Set

func (s *Server) Set()

type Session

type Session struct {
	File string

	PrivateMode       bool
	LockedControls    bool
	ImplicitHosting   bool
	InactiveCursors   bool
	MercifulReconnect bool
	APIToken          string

	CookieEnabled    bool
	CookieName       string
	CookieExpiration time.Duration
	CookieSecure     bool
}

func (Session) Init

func (Session) Init(cmd *cobra.Command) error

func (*Session) Set

func (s *Session) Set()

type WebRTC

type WebRTC struct {
	ICELite            bool
	ICETrickle         bool
	ICEServersFrontend []types.ICEServer
	ICEServersBackend  []types.ICEServer
	EphemeralMin       uint16
	EphemeralMax       uint16
	TCPMux             int
	UDPMux             int

	NAT1To1IPs     []string
	IpRetrievalUrl string

	Estimator WebRTCEstimator
}

func (WebRTC) Init

func (WebRTC) Init(cmd *cobra.Command) error

func (*WebRTC) Set

func (s *WebRTC) Set()

type WebRTCEstimator

type WebRTCEstimator struct {
	Enabled        bool
	Passive        bool
	Debug          bool
	InitialBitrate int

	// how often to read and process bandwidth estimation reports
	ReadInterval time.Duration
	// how long to wait for stable connection (only neutral or upward trend) before upgrading
	StableDuration time.Duration
	// how long to wait for unstable connection (downward trend) before downgrading
	UnstableDuration time.Duration
	// how long to wait for stalled connection (neutral trend with low bandwidth) before downgrading
	StalledDuration time.Duration
	// how long to wait before downgrading again after previous downgrade
	DowngradeBackoff time.Duration
	// how long to wait before upgrading again after previous upgrade
	UpgradeBackoff time.Duration
	// how bigger the difference between estimated and stream bitrate must be to trigger upgrade/downgrade
	DiffThreshold float64
}