config

Documentation

Index

• Constants
• Variables
• type CPUCostConfig
• type Config
  • func NewConfig(confString string) (*Config, error)
  • func (c *Config) GetLoggerFields() logrus.Fields
  • func (conf *Config) Init() error
  • func (c *Config) InitLogger(values ...interface{}) error
• type InternalConfig
• type ServiceConfig
  • func (conf *ServiceConfig) InitDefaults() error
  • func (c *ServiceConfig) InitWhipConf() error

Constants

const (
	DefaultRTMPPort      int = 1935
	DefaultWHIPPort          = 8080
	DefaultHTTPRelayPort     = 9090
)

Variables

var (
	DefaultICEPortRange = []uint16{2000, 4000}
)

Types

type CPUCostConfig

type CPUCostConfig struct {
	RTMPCpuCost                  float64 `yaml:"rtmp_cpu_cost"`
	WHIPCpuCost                  float64 `yaml:"whip_cpu_cost"`
	WHIPBypassTranscodingCpuCost float64 `yaml:"whip_bypass_transcoding_cpu_cost"`
	URLCpuCost                   float64 `yaml:"url_cpu_cost"`
	MinIdleRatio                 float64 `yaml:"min_idle_ratio"` // Target idle cpu ratio when deciding availability for new requests
}

type Config

type Config struct {
	*ServiceConfig  `yaml:",inline"`
	*InternalConfig `yaml:",inline"`
}

func NewConfig

func NewConfig(confString string) (*Config, error)

func (*Config) GetLoggerFields

func (c *Config) GetLoggerFields() logrus.Fields

To use with logrus

func (*Config) Init

func (conf *Config) Init() error

func (*Config) InitLogger

func (c *Config) InitLogger(values ...interface{}) error

type InternalConfig

type InternalConfig struct {
	// internal
	ServiceName string `yaml:"service_name"`
	NodeID      string `yaml:"node_id"` // Do not provide, will be overwritten
}

type ServiceConfig

type ServiceConfig struct {
	Redis     *redis.RedisConfig `yaml:"redis"`      // required
	ApiKey    string             `yaml:"api_key"`    // required (env LIVEKIT_API_KEY)
	ApiSecret string             `yaml:"api_secret"` // required (env LIVEKIT_API_SECRET)
	WsUrl     string             `yaml:"ws_url"`     // required (env LIVEKIT_WS_URL)

	HealthPort       int           `yaml:"health_port"`
	DebugHandlerPort int           `yaml:"debug_handler_port"`
	PrometheusPort   int           `yaml:"prometheus_port"`
	RTMPPort         int           `yaml:"rtmp_port"` // -1 to disable RTMP
	WHIPPort         int           `yaml:"whip_port"` // -1 to disable WHIP
	HTTPRelayPort    int           `yaml:"http_relay_port"`
	Logging          logger.Config `yaml:"logging"`
	Development      bool          `yaml:"development"`

	// Used for WHIP transport
	RTCConfig rtcconfig.RTCConfig `yaml:"rtc_config"`

	// CPU costs for various ingress types
	CPUCost CPUCostConfig `yaml:"cpu_cost"`
}

func (*ServiceConfig) InitDefaults

func (conf *ServiceConfig) InitDefaults() error

func (*ServiceConfig) InitWhipConf

func (c *ServiceConfig) InitWhipConf() error