Selkies
Developer ReferenceDashboard (Wish)ComponentsDashboard

components/dashboard/system-monitoring

Functions

RadialGauge()

function RadialGauge(__namedParameters): Element;

Defined in: components/dashboard/system-monitoring.tsx:75

One gauge: a recharts radial bar with the value in its center.

Parameters

ParameterType
__namedParametersRadialGaugeProps

Returns

Element


readStreamAudioLevel()

function readStreamAudioLevel(meterRef): number;

Defined in: components/dashboard/system-monitoring.tsx:150

Audio level (RMS, 0 to 1) of the WebRTC stream's audio track via a dashboard-owned AnalyserNode, never routed to a destination so playback is unaffected. The websockets worklet path exposes window.currentAudioLevel instead.

Parameters

ParameterTypeDescription
meterRef{ current: AudioMeter; }Holds the analyser across calls; rebuilt when the stream changes.
meterRef.currentAudioMeter-

Returns

number

The level, or null when the stream has no audio track or no analyser could be built.


configuredMaxBandwidthMbps()

function configuredMaxBandwidthMbps(): number;

Defined in: components/dashboard/system-monitoring.tsx:189

The traffic the session is configured to use, video target plus audio, in Mbps: at 8 Mbps configured, 8 Mbps of traffic is a full bandwidth gauge. An explicit client choice in localStorage wins over the server's value; video_bitrate is kbps on the wire and in storage.

Returns

number


configuredFramerateMax()

function configuredFramerateMax(): number;

Defined in: components/dashboard/system-monitoring.tsx:207

The framerate the session is configured to push, the full reading of the FPS gauge. An explicit client choice in localStorage wins over the server's value.

Returns

number


SystemMonitoring()

function SystemMonitoring(): Element;

Defined in: components/dashboard/system-monitoring.tsx:224

Renders the gauges, polling the core's window stats twice a second.

The audio level is read on one scale for both transports: the websockets worklet exports a final 0 to 100 level (RMS times 141, a full-scale sine reading 100), and the WebRTC analyser fallback's raw RMS gets the same mapping. Only metrics with data are shown; video bitrate is omitted since it duplicates the bandwidth stat.

Returns

Element


getPerformanceStatus()

function getPerformanceStatus(value, type): object;

Defined in: components/dashboard/system-monitoring.tsx:285

Status label and colors for a reading; the audio level is an activity indicator, not a pressure gauge.

Parameters

ParameterType
valuenumber
type"percentage" | "fps" | "latency" | "audio" | "bandwidth"

Returns

object

status
status: string = 'excellent';
color
color: string = 'text-green-500';
bg
bg: string = 'bg-green-500/10';

References

default

Renames and re-exports SystemMonitoring

On this page

Edit on GitHub