streampack-core/io.github.thibaultbee.streampack.core.elements.endpoints.composites/CompositeEndpointWithMetrics

CompositeEndpointWithMetrics

class CompositeEndpointWithMetrics<T : Any>(muxer: IMuxerInternal, sink: ISinkWithMetricsInternal<T>) : CompositeEndpoint, WithEndpointMetrics<T> (source)

An IEndpointInternal implementation of CompositeEndpoint with WithEndpointMetrics.

Constructors

CompositeEndpointWithMetrics

constructor(muxer: IMuxerInternal, sink: ISinkWithMetricsInternal<T>)

Properties

open override val info: CompositeEndpoint.EndpointInfo

A info to verify supported formats.

open override val isOpenFlow: StateFlow<Boolean>

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

open override val metrics: EndpointMetrics<T>

Metrics of the element.

open override val muxer: IMuxerInternal

open override val sink: ISinkInternal

open override val throwableFlow: StateFlow<Throwable?>

An asynchronous error that occurred during streaming. Synchronous errors must be thrown directly by the functions.

Functions

open suspend override fun addStream(streamConfig: CodecConfig): Int

Registers a new stream to the IEndpointInternal.

open suspend override fun addStreams(streamConfigs: List<CodecConfig>): Map<CodecConfig, Int>

Registers new streams to the IEndpointInternal.

open suspend override fun close()

Closes and releases resources

createMetricsTracker

fun WithEndpointMetrics<*>.createMetricsTracker(): EndpointMetricsTracker

Creates an EndpointMetricsTracker for this WithEndpointMetrics.

open fun getInfo(descriptor: MediaDescriptor): IEndpoint.IEndpointInfo

open override fun getInfo(type: MediaDescriptor.Type): CompositeEndpoint.EndpointInfo

Gets configuration information

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.

open suspend override fun open(descriptor: MediaDescriptor)

Opens the endpoint. The endpoint must check if the MediaDescriptor is supported and if it is not already opened.

open suspend override fun release()

Releases an IEndpointInternal.

open suspend override fun startStream()

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

open suspend override fun stopStream()

Stops the stream and releases the sink.

open suspend override fun write(frame: Frame, streamPid: Int)

Writes a Frame to the IEndpointInternal.