streampack-core/io.github.thibaultbee.streampack.core.elements.metrics

Package-level declarations

Types

BasicEndpointMetrics

interface BasicEndpointMetrics

EmptyEndpointMetrics

object EmptyEndpointMetrics : EndpointMetrics<Any>

An empty implementation of EndpointMetrics that returns zeros for all metrics.

EndpointMetrics

interface EndpointMetrics<out T : Any> : BasicEndpointMetrics

Endpoint metrics interface

EndpointMetricsTracker

class EndpointMetricsTracker

Tracks BasicEndpointMetrics over time, providing both cumulative and instant (diff since last read) metrics.

data class TrackedMetrics(val instant: BasicEndpointMetrics, val cumulative: BasicEndpointMetrics)

Represents a pair of instant and cumulative metrics.

WithEndpointMetrics

interface WithEndpointMetrics<out T : Any> : WithMetrics<EndpointMetrics<T>>

A specific WithMetrics for EndpointMetrics.

interface WithMetrics<out T>

Minimal metrics interface

Properties

writtenBitrateInBps

val BasicEndpointMetrics.writtenBitrateInBps: Long

The total written bitrate in bits per second (bps).

Functions

createMetricsTracker

fun WithEndpointMetrics<*>.createMetricsTracker(): EndpointMetricsTracker

Creates an EndpointMetricsTracker for this WithEndpointMetrics.

fun WithEndpointMetrics<*>.metricsFlow(interval: Duration = 1000.milliseconds): Flow<TrackedMetrics>

Returns a Flow that emits the BasicEndpointMetrics difference since the last emission. Every collector gets its own isolated EndpointMetricsTracker to prevent state collisions.