connectionquality

Documentation

Index

• Constants
• type ConnectionStats
  • func NewConnectionStats(params ConnectionStatsParams) *ConnectionStats
  • func (cs *ConnectionStats) AddBitrateTransition(bitrate int64)
  • func (cs *ConnectionStats) AddBitrateTransitionAt(bitrate int64, at time.Time)
  • func (cs *ConnectionStats) AddLayerTransition(distance float64)
  • func (cs *ConnectionStats) AddLayerTransitionAt(distance float64, at time.Time)
  • func (cs *ConnectionStats) Close()
  • func (cs *ConnectionStats) GetScoreAndQuality() (float32, livekit.ConnectionQuality)
  • func (cs *ConnectionStats) OnStatsUpdate(fn func(cs *ConnectionStats, stat *livekit.AnalyticsStat))
  • func (cs *ConnectionStats) Start(codecMimeType string, isFECEnabled bool)
  • func (cs *ConnectionStats) StartAt(codecMimeType string, isFECEnabled bool, at time.Time)
  • func (cs *ConnectionStats) UpdateLayerMute(isMuted bool)
  • func (cs *ConnectionStats) UpdateLayerMuteAt(isMuted bool, at time.Time)
  • func (cs *ConnectionStats) UpdateMute(isMuted bool)
  • func (cs *ConnectionStats) UpdateMuteAt(isMuted bool, at time.Time)
  • func (cs *ConnectionStats) UpdatePause(isPaused bool)
  • func (cs *ConnectionStats) UpdatePauseAt(isPaused bool, at time.Time)
• type ConnectionStatsParams
• type ConnectionStatsReceiverProvider
• type ConnectionStatsSenderProvider

Constants

const (
	MaxMOS = float32(4.5)
	MinMOS = float32(1.0)
)

const (
	UpdateInterval = 5 * time.Second
)

Types

type ConnectionStats

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

func NewConnectionStats

func NewConnectionStats(params ConnectionStatsParams) *ConnectionStats

func (*ConnectionStats) AddBitrateTransition

func (cs *ConnectionStats) AddBitrateTransition(bitrate int64)

func (*ConnectionStats) AddBitrateTransitionAt

func (cs *ConnectionStats) AddBitrateTransitionAt(bitrate int64, at time.Time)

func (*ConnectionStats) AddLayerTransition

func (cs *ConnectionStats) AddLayerTransition(distance float64)

func (*ConnectionStats) AddLayerTransitionAt

func (cs *ConnectionStats) AddLayerTransitionAt(distance float64, at time.Time)

func (*ConnectionStats) Close

func (cs *ConnectionStats) Close()

func (*ConnectionStats) GetScoreAndQuality

func (cs *ConnectionStats) GetScoreAndQuality() (float32, livekit.ConnectionQuality)

func (*ConnectionStats) OnStatsUpdate

func (cs *ConnectionStats) OnStatsUpdate(fn func(cs *ConnectionStats, stat *livekit.AnalyticsStat))

func (*ConnectionStats) Start

func (cs *ConnectionStats) Start(codecMimeType string, isFECEnabled bool)

func (*ConnectionStats) StartAt

func (cs *ConnectionStats) StartAt(codecMimeType string, isFECEnabled bool, at time.Time)

func (*ConnectionStats) UpdateLayerMute

func (cs *ConnectionStats) UpdateLayerMute(isMuted bool)

func (*ConnectionStats) UpdateLayerMuteAt

func (cs *ConnectionStats) UpdateLayerMuteAt(isMuted bool, at time.Time)

func (*ConnectionStats) UpdateMute

func (cs *ConnectionStats) UpdateMute(isMuted bool)

func (*ConnectionStats) UpdateMuteAt

func (cs *ConnectionStats) UpdateMuteAt(isMuted bool, at time.Time)

func (*ConnectionStats) UpdatePause

func (cs *ConnectionStats) UpdatePause(isPaused bool)

func (*ConnectionStats) UpdatePauseAt

func (cs *ConnectionStats) UpdatePauseAt(isPaused bool, at time.Time)

type ConnectionStatsParams

type ConnectionStatsParams struct {
	UpdateInterval     time.Duration
	IncludeRTT         bool
	IncludeJitter      bool
	EnableBitrateScore bool
	ReceiverProvider   ConnectionStatsReceiverProvider
	SenderProvider     ConnectionStatsSenderProvider
	Logger             logger.Logger
}

type ConnectionStatsReceiverProvider

type ConnectionStatsReceiverProvider interface {
	GetDeltaStats() map[uint32]*buffer.StreamStatsWithLayers
	GetLastSenderReportTime() time.Time
}

type ConnectionStatsSenderProvider

type ConnectionStatsSenderProvider interface {
	GetDeltaStatsSender() map[uint32]*buffer.StreamStatsWithLayers
	GetLastReceiverReportTime() time.Time
	GetTotalPacketsSent() uint64
}