streamallocator

Jan 3, 2025

Changes in this version

+ var DefaultStreamAllocatorConfig = StreamAllocatorConfig

+ type ProbeMode string

+ const ProbeModeMedia

+ const ProbeModePadding

type StreamAllocator

+ func (s *StreamAllocator) OnCongestionStateChange(fromState bwe.CongestionState, toState bwe.CongestionState, ...)

+ func (s *StreamAllocator) OnPacerProbeObserverClusterComplete(probeClusterId ccutils.ProbeClusterId)

+ func (s *StreamAllocator) OnProbeClusterSwitch(pci ccutils.ProbeClusterInfo)

+ func (s *StreamAllocator) SetSendSideBWEInterceptor(sendSideBWEInterceptor cc.BandwidthEstimator)

+ type StreamAllocatorConfig struct

+ DisableEstimationUnmanagedTracks bool

+ MinChannelCapacity int64

+ PausedMinWait time.Duration

+ ProbeMinBps int64

+ ProbeMode ProbeMode

+ ProbeOveragePct int64

type StreamAllocatorParams

+ BWE bwe.BWE

+ Pacer pacer.Pacer

+ RTTGetter func() (float64, bool)

type Track

+ func (t *Track) WriteProbePackets(bytesToSend int) int

Oct 16, 2023

Changes in this version

type StreamAllocator

+ func (s *StreamAllocator) IsBWEEnabled(downTrack *sfu.DownTrack) bool

+ func (s *StreamAllocator) IsSubscribeMutable(downTrack *sfu.DownTrack) bool

type Track

+ func (t *Track) IsSubscribeMutable() bool

Aug 23, 2023

Changes in this version

type ChannelObserverParams

+ Config config.CongestionControlChannelObserverConfig

type StreamState

+ const StreamStateInactive

type Track

+ func (t *Track) ProvisionalAllocateReset()

+ func (t *Track) SetStreamState(streamState StreamState) bool

type TrendDetectorParams

+ DownwardTrendMaxWait time.Duration

+ RequiredSamplesMin int

Jul 9, 2023

Changes in this version

type ChannelObserver

+ func (c *ChannelObserver) HasEnoughEstimateSamples() bool

type ChannelObserverParams

+ EstimateValidityWindow time.Duration

type ProbeControllerParams

+ Config config.CongestionControlProbeConfig

type TrendDetector

+ func (t *TrendDetector) HasEnoughSamples() bool

type TrendDetectorParams

+ ValidityWindow time.Duration

Jun 4, 2023

Changes in this version

+ type ProbeController struct

+ func NewProbeController(params ProbeControllerParams) *ProbeController

+ func (p *ProbeController) AbortProbe()

+ func (p *ProbeController) CanProbe() bool

+ func (p *ProbeController) CheckProbe(trend ChannelTrend, highestEstimate int64)

+ func (p *ProbeController) DoesProbeNeedFinalize() bool

+ func (p *ProbeController) InitProbe(probeGoalDeltaBps int64, expectedBandwidthUsage int64) (ProbeClusterId, int64)

+ func (p *ProbeController) IsInProbe() bool

+ func (p *ProbeController) MaybeFinalizeProbe()

+ func (p *ProbeController) OnProbeSuccess(f func())

+ func (p *ProbeController) ProbeClusterDone(info ProbeClusterInfo, lowestEstimate int64)

+ func (p *ProbeController) Reset()

+ func (p *ProbeController) StopProbe()

+ type ProbeControllerParams struct

+ Logger logger.Logger

+ Prober *Prober

May 10, 2023

Changes in this version

+ const FlagAllowOvershootInBoost

type ChannelObserver

+ func (c *ChannelObserver) GetNackHistory() []string

+ func (c *ChannelObserver) ToString() string

type ChannelObserverParams

+ EstimateCollapseThreshold time.Duration

+ type NackTracker struct

+ func NewNackTracker(params NackTrackerParams) *NackTracker

+ func (n *NackTracker) Add(packets uint32, repeatedNacks uint32)

+ func (n *NackTracker) GetHistory() []string

+ func (n *NackTracker) GetRatio() float64

+ func (n *NackTracker) IsTriggered() bool

+ func (n *NackTracker) ToString() string

+ type NackTrackerParams struct

+ Logger logger.Logger

+ Name string

+ RatioThreshold float64

+ WindowMaxDuration time.Duration

+ WindowMinDuration time.Duration

+ type ProbeClusterMode int

+ const ProbeClusterModeLinearChirp

+ const ProbeClusterModeUniform

+ func (p ProbeClusterMode) String() string

+ type RateMonitor struct

+ func NewRateMonitor() *RateMonitor

+ func (r *RateMonitor) GetHistory() []string

+ func (r *RateMonitor) GetQueuingGuess() float64

+ func (r *RateMonitor) Update(estimate int64, managedBytesSent uint32, managedBytesRetransmitted uint32, ...)

type StreamAllocator

+ func (s *StreamAllocator) OnMaxPublishedSpatialChanged(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) OnMaxPublishedTemporalChanged(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) OnNACK(downTrack *sfu.DownTrack, nackInfos []sfu.NackInfo)

+ func (s *StreamAllocator) OnRTCPReceiverReport(downTrack *sfu.DownTrack, rr rtcp.ReceptionReport)

+ func (s *StreamAllocator) OnResume(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) OnSubscribedLayerChanged(downTrack *sfu.DownTrack, layer buffer.VideoLayer)

+ func (s *StreamAllocator) SetAllowPause(allowPause bool)

+ func (s *StreamAllocator) SetChannelCapacity(channelCapacity int64)

type Track

+ func (t *Track) GetAndResetBytesSent() (uint32, uint32)

+ func (t *Track) GetAndResetNackStats() (lowest uint16, highest uint16, numNacked int, numNacks int, numRuns int)

+ func (t *Track) GetHistory() string

+ func (t *Track) GetRTCPReceiverReportDelta() (uint32, uint32, uint32)

+ func (t *Track) ProcessRTCPReceiverReport(rr rtcp.ReceptionReport)

+ func (t *Track) SetMaxLayer(layer buffer.VideoLayer) bool

+ func (t *Track) UpdateHistory()

+ func (t *Track) UpdateNack(nackInfos []sfu.NackInfo)

type TrendDetectorParams

+ CollapseThreshold time.Duration

Mar 31, 2023

Changes in this version

+ const ChannelCapacityInfinity

+ const FlagAllowOvershootExemptTrackWhileDeficient

+ const FlagAllowOvershootInCatchup

+ const FlagAllowOvershootInProbe

+ const FlagAllowOvershootWhileDeficient

+ const FlagAllowOvershootWhileOptimal

+ const NackRatioAttenuator

+ const PriorityDefaultScreenshare

+ const PriorityDefaultVideo

+ const PriorityMax

+ const PriorityMin

+ const ProbeBackoffFactor

+ const ProbeMaxDuration

+ const ProbeMinBps

+ const ProbeMinDuration

+ const ProbePct

+ const ProbeSettleWait

+ const ProbeTrendWait

+ const ProbeWaitBase

+ const ProbeWaitMax

+ var ChannelObserverParamsNonProbe = ChannelObserverParams

+ var ChannelObserverParamsProbe = ChannelObserverParams

+ type AddTrackParams struct

+ IsSimulcast bool

+ Priority uint8

+ PublisherID livekit.ParticipantID

+ Source livekit.TrackSource

+ type ChannelCongestionReason int

+ const ChannelCongestionReasonEstimate

+ const ChannelCongestionReasonLoss

+ const ChannelCongestionReasonNone

+ func (c ChannelCongestionReason) String() string

+ type ChannelObserver struct

+ func NewChannelObserver(params ChannelObserverParams, logger logger.Logger) *ChannelObserver

+ func (c *ChannelObserver) AddEstimate(estimate int64)

+ func (c *ChannelObserver) AddNack(packets uint32, repeatedNacks uint32)

+ func (c *ChannelObserver) GetHighestEstimate() int64

+ func (c *ChannelObserver) GetLowestEstimate() int64

+ func (c *ChannelObserver) GetNackRatio() (uint32, uint32, float64)

+ func (c *ChannelObserver) GetTrend() (ChannelTrend, ChannelCongestionReason)

+ func (c *ChannelObserver) SeedEstimate(estimate int64)

+ func (c *ChannelObserver) SeedNack(packets uint32, repeatedNacks uint32)

+ type ChannelObserverParams struct

+ EstimateCollapseValues bool

+ EstimateDownwardTrendThreshold float64

+ EstimateRequiredSamples int

+ NackRatioThreshold float64

+ NackWindowMaxDuration time.Duration

+ NackWindowMinDuration time.Duration

+ Name string

+ type ChannelTrend int

+ const ChannelTrendClearing

+ const ChannelTrendCongesting

+ const ChannelTrendNeutral

+ func (c ChannelTrend) String() string

+ type Cluster struct

+ func NewCluster(id ProbeClusterId, desiredRateBps int, expectedRateBps int, ...) *Cluster

+ func (c *Cluster) GetInfo() ProbeClusterInfo

+ func (c *Cluster) GetSleepDuration() time.Duration

+ func (c *Cluster) IsFinished() bool

+ func (c *Cluster) PacketsSent(size int)

+ func (c *Cluster) ProbeSent(size int)

+ func (c *Cluster) Process(pl ProberListener)

+ func (c *Cluster) Start()

+ func (c *Cluster) String() string

+ type Event struct

+ Data interface{}

+ Signal streamAllocatorSignal

+ TrackID livekit.TrackID

+ func (e Event) String() string

+ type MaxDistanceSorter []*Track

+ func (m MaxDistanceSorter) Len() int

+ func (m MaxDistanceSorter) Less(i, j int) bool

+ func (m MaxDistanceSorter) Swap(i, j int)

+ type MinDistanceSorter []*Track

+ func (m MinDistanceSorter) Len() int

+ func (m MinDistanceSorter) Less(i, j int) bool

+ func (m MinDistanceSorter) Swap(i, j int)

+ type ProbeClusterId uint32

+ const ProbeClusterIdInvalid

+ type ProbeClusterInfo struct

+ BytesSent int

+ Duration time.Duration

+ Id ProbeClusterId

+ type Prober struct

+ func NewProber(params ProberParams) *Prober

+ func (p *Prober) AddCluster(desiredRateBps int, expectedRateBps int, minDuration time.Duration, ...) ProbeClusterId

+ func (p *Prober) IsRunning() bool

+ func (p *Prober) PacketsSent(size int)

+ func (p *Prober) ProbeSent(size int)

+ func (p *Prober) Reset()

+ func (p *Prober) SetProberListener(listener ProberListener)

+ type ProberListener interface

+ OnActiveChanged func(isActive bool)

+ OnProbeClusterDone func(info ProbeClusterInfo)

+ OnSendProbe func(bytesToSend int)

+ type ProberParams struct

+ Logger logger.Logger

+ type StreamAllocator struct

+ func NewStreamAllocator(params StreamAllocatorParams) *StreamAllocator

+ func (s *StreamAllocator) AddTrack(downTrack *sfu.DownTrack, params AddTrackParams)

+ func (s *StreamAllocator) OnActiveChanged(isActive bool)

+ func (s *StreamAllocator) OnAvailableLayersChanged(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) OnBitrateAvailabilityChanged(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) OnMaxPublishedLayerChanged(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) OnPacketsSent(downTrack *sfu.DownTrack, size int)

+ func (s *StreamAllocator) OnProbeClusterDone(info ProbeClusterInfo)

+ func (s *StreamAllocator) OnREMB(downTrack *sfu.DownTrack, remb *rtcp.ReceiverEstimatedMaximumBitrate)

+ func (s *StreamAllocator) OnSendProbe(bytesToSend int)

+ func (s *StreamAllocator) OnStreamStateChange(f func(update *StreamStateUpdate) error)

+ func (s *StreamAllocator) OnSubscribedLayersChanged(downTrack *sfu.DownTrack, layers buffer.VideoLayer)

+ func (s *StreamAllocator) OnSubscriptionChanged(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) OnTargetLayerReached(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) OnTransportCCFeedback(downTrack *sfu.DownTrack, fb *rtcp.TransportLayerCC)

+ func (s *StreamAllocator) RemoveTrack(downTrack *sfu.DownTrack)

+ func (s *StreamAllocator) SetBandwidthEstimator(bwe cc.BandwidthEstimator)

+ func (s *StreamAllocator) SetTrackPriority(downTrack *sfu.DownTrack, priority uint8)

+ func (s *StreamAllocator) Start()

+ func (s *StreamAllocator) Stop()

+ type StreamAllocatorParams struct

+ Config config.CongestionControlConfig

+ Logger logger.Logger

+ type StreamState int

+ const StreamStateActive

+ const StreamStatePaused

+ func (s StreamState) String() string

+ type StreamStateInfo struct

+ ParticipantID livekit.ParticipantID

+ State StreamState

+ TrackID livekit.TrackID

+ type StreamStateUpdate struct

+ StreamStates []*StreamStateInfo

+ func NewStreamStateUpdate() *StreamStateUpdate

+ func (s *StreamStateUpdate) Empty() bool

+ func (s *StreamStateUpdate) HandleStreamingChange(isPaused bool, track *Track)

+ type Track struct

+ func NewTrack(downTrack *sfu.DownTrack, source livekit.TrackSource, isSimulcast bool, ...) *Track

+ func (t *Track) AllocateNextHigher(availableChannelCapacity int64, allowOvershoot bool) (sfu.VideoAllocation, bool)

+ func (t *Track) AllocateOptimal(allowOvershoot bool) sfu.VideoAllocation

+ func (t *Track) BandwidthRequested() int64

+ func (t *Track) DistanceToDesired() float64

+ func (t *Track) DownTrack() *sfu.DownTrack

+ func (t *Track) GetNackDelta() (uint32, uint32)

+ func (t *Track) GetNextHigherTransition(allowOvershoot bool) (sfu.VideoTransition, bool)

+ func (t *Track) ID() livekit.TrackID

+ func (t *Track) IsDeficient() bool

+ func (t *Track) IsManaged() bool

+ func (t *Track) Pause() sfu.VideoAllocation

+ func (t *Track) Priority() uint8

+ func (t *Track) ProvisionalAllocate(availableChannelCapacity int64, layers buffer.VideoLayer, allowPause bool, ...) int64

+ func (t *Track) ProvisionalAllocateCommit() sfu.VideoAllocation

+ func (t *Track) ProvisionalAllocateGetBestWeightedTransition() sfu.VideoTransition

+ func (t *Track) ProvisionalAllocateGetCooperativeTransition(allowOvershoot bool) sfu.VideoTransition

+ func (t *Track) ProvisionalAllocatePrepare()

+ func (t *Track) PublisherID() livekit.ParticipantID

+ func (t *Track) SetDirty(isDirty bool) bool

+ func (t *Track) SetMaxLayers(layers buffer.VideoLayer) bool

+ func (t *Track) SetPaused(isPaused bool) bool

+ func (t *Track) SetPriority(priority uint8) bool

+ func (t *Track) WritePaddingRTP(bytesToSend int) int

+ type TrackSorter []*Track

+ func (t TrackSorter) Len() int

+ func (t TrackSorter) Less(i, j int) bool

+ func (t TrackSorter) Swap(i, j int)

+ type TrendDetector struct

+ func NewTrendDetector(params TrendDetectorParams) *TrendDetector

+ func (t *TrendDetector) AddValue(value int64)

+ func (t *TrendDetector) GetDirection() TrendDirection

+ func (t *TrendDetector) GetHighest() int64

+ func (t *TrendDetector) GetLowest() int64

+ func (t *TrendDetector) GetValues() []int64

+ func (t *TrendDetector) Seed(value int64)

+ func (t *TrendDetector) ToString() string

+ type TrendDetectorParams struct

+ CollapseValues bool

+ DownwardTrendThreshold float64

+ Logger logger.Logger

+ Name string

+ RequiredSamples int

+ type TrendDirection int

+ const TrendDirectionDownward

+ const TrendDirectionNeutral

+ const TrendDirectionUpward

+ func (t TrendDirection) String() string