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

CompositeEndpoint

open class CompositeEndpoint(val muxer: IMuxerInternal, val sink: ISinkInternal) : ICompositeEndpointInternal(source)

An IEndpointInternal implementation that combines a IMuxerInternal and a ISinkInternal.

Inheritors

CompositeEndpointWithMetrics

Constructors

CompositeEndpoint

constructor(muxer: IMuxerInternal, sink: ISinkInternal)

Types

EndpointInfo

class EndpointInfo(val muxerInfo: IMuxer.IMuxerInfo) : IEndpoint.IEndpointInfo

Properties

info

open override val info: CompositeEndpoint.EndpointInfo

A info to verify supported formats.

isOpenFlow

open override val isOpenFlow: StateFlow<Boolean>

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

muxer

open override val muxer: IMuxerInternal

sink

open override val sink: ISinkInternal

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

getInfo

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

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

Gets configuration information

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 the stream and releases the sink.

write

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

Writes a Frame to the IEndpointInternal.