streampack-core/io.github.thibaultbee.streampack.core.elements.endpoints/DynamicEndpoint

DynamicEndpoint

open class DynamicEndpoint(context: Context, defaultDispatcher: CoroutineDispatcher, ioDispatcher: CoroutineDispatcher) : IEndpointInternal, WithEndpointMetrics<Any> (source)

An implementation of IEndpointInternal where the endpoint is created based on the MediaDescriptor.

Parameters

context

The application context

Inheritors

DynamicLocalEndpoint

Constructors

DynamicEndpoint

constructor(context: Context, defaultDispatcher: CoroutineDispatcher, ioDispatcher: CoroutineDispatcher)

Types

Companion

object Companion

Properties

info

open override val info: IEndpoint.IEndpointInfo

Only available when the endpoint is opened.

isOpenFlow

open override val isOpenFlow: StateFlow<Boolean>

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

metrics

open override val metrics: EndpointMetrics<Any>

Metrics of the element.

throwableFlow

open override val throwableFlow: StateFlow<Throwable?>

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

Functions

addStream

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

Registers a new stream to the IEndpointInternal.

addStreams

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.

getInfo

open override fun getInfo(type: MediaDescriptor.Type): IEndpoint.IEndpointInfo

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

Gets configuration information

metricsFlow

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

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.

release

open suspend override fun release()

Releases an IEndpointInternal.

startStream

open suspend override fun startStream()

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

stopStream

open suspend override fun stopStream()

Stops frames or data stream generation

write

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

Writes a Frame to the IEndpointInternal.