clientconfiguration

package

v1.9.2 Latest Latest Go to latest Published: Oct 17, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/livekit/livekit-server

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type ClientConfigurationManager
type ConfigurationItem
type Match
type ScriptMatch
- func NewScriptMatch(expr string) (*ScriptMatch, error)
- func (m *ScriptMatch) Match(clientInfo *livekit.ClientInfo) (bool, error)
type StaticClientConfigurationManager
- func NewStaticClientConfigurationManager(confs []ConfigurationItem) *StaticClientConfigurationManager
- func (s *StaticClientConfigurationManager) GetConfiguration(clientInfo *livekit.ClientInfo) *livekit.ClientConfiguration

Constants ¶

This section is empty.

Variables ¶

View Source

var StaticConfigurations = []ConfigurationItem{

	{
		Match: must.Get(NewScriptMatch(`c.browser == "safari"`)),
		Configuration: &livekit.ClientConfiguration{
			DisabledCodecs: &livekit.DisabledCodecs{
				Codecs: []*livekit.Codec{
					{Mime: mime.MimeTypeAV1.String()},
				},
			},
		},
		Merge: true,
	},
	{
		Match: must.Get(NewScriptMatch(`c.browser == "safari" && c.browser_version > "18.3"`)),
		Configuration: &livekit.ClientConfiguration{
			DisabledCodecs: &livekit.DisabledCodecs{
				Publish: []*livekit.Codec{
					{Mime: mime.MimeTypeVP9.String()},
				},
			},
		},
		Merge: true,
	},
	{
		Match: must.Get(NewScriptMatch(`(c.device_model == "xiaomi 2201117ti" && c.os == "android") ||
		  ((c.browser == "firefox" || c.browser == "firefox mobile") && (c.os == "linux" || c.os == "android"))`)),
		Configuration: &livekit.ClientConfiguration{
			DisabledCodecs: &livekit.DisabledCodecs{
				Publish: []*livekit.Codec{
					{Mime: mime.MimeTypeH264.String()},
				},
			},
		},
		Merge: false,
	},
}

StaticConfigurations list specific device-side limitations that should be disabled at a global level

Functions ¶

This section is empty.

Types ¶

type ClientConfigurationManager ¶

type ClientConfigurationManager interface {
	GetConfiguration(clientInfo *livekit.ClientInfo) *livekit.ClientConfiguration
}

type ConfigurationItem ¶

type ConfigurationItem struct {
	Match
	Configuration *livekit.ClientConfiguration
	Merge         bool
}

type Match ¶

type Match interface {
	Match(clientInfo *livekit.ClientInfo) (bool, error)
}

type ScriptMatch ¶

type ScriptMatch struct {
	// contains filtered or unexported fields
}

func NewScriptMatch ¶ added in v1.9.1

func NewScriptMatch(expr string) (*ScriptMatch, error)

func (*ScriptMatch) Match ¶

func (m *ScriptMatch) Match(clientInfo *livekit.ClientInfo) (bool, error)

use result of eval script expression for match. expression examples: protocol bigger than 5 : c.protocol > 5 browser if firefox: c.browser == "firefox" combined rule : c.protocol > 5 && c.browser == "firefox"

type StaticClientConfigurationManager ¶

type StaticClientConfigurationManager struct {
	// contains filtered or unexported fields
}

func NewStaticClientConfigurationManager ¶

func NewStaticClientConfigurationManager(confs []ConfigurationItem) *StaticClientConfigurationManager

func (*StaticClientConfigurationManager) GetConfiguration ¶

func (s *StaticClientConfigurationManager) GetConfiguration(clientInfo *livekit.ClientInfo) *livekit.ClientConfiguration

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL