streampack-core/io.github.thibaultbee.streampack.core.elements.endpoints.composites.sinks/ISinkWithMetricsInternal

ISinkWithMetricsInternal

interface ISinkWithMetricsInternal<T : Any> : ISinkInternal, WithEndpointMetrics<T> (source)

Properties

abstract val isOpenFlow: StateFlow<Boolean>

Whether if the endpoint is opened. For example, if the file is opened for FileSink.

abstract val metrics: EndpointMetrics<T>

Metrics of the element.

Functions

abstract suspend fun close()

Closes and releases resources

abstract fun configure(config: SinkConfiguration)

Configure the Configurable implementation.

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.

abstract suspend fun open(mediaDescriptor: MediaDescriptor)

Opens the endpoint.

abstract suspend fun startStream()

Starts frames or data stream generation Throws an exception if not ready for live stream

abstract suspend fun stopStream()

Stops frames or data stream generation

abstract suspend fun write(packet: Packet): Int

Writes a buffer to the ISinkInternal.