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

CompositeEndpoint

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

An IEndpointInternal implementation that combines a IMuxerInternal and a ISinkInternal.

Constructors

Link copied to clipboard
constructor(muxer: IMuxerInternal, sink: ISinkInternal)

Types

Link copied to clipboard

Properties

Link copied to clipboard
open override val info: CompositeEndpoint.EndpointInfo

A info to verify supported formats.

Link copied to clipboard
open override val isOpenFlow: StateFlow<Boolean>

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

Link copied to clipboard
open override val metrics: Any

Metrics of the endpoint.

Link copied to clipboard
open override val muxer: IMuxerInternal
Link copied to clipboard
open override val sink: ISinkInternal

Functions

Link copied to clipboard
open override fun addStream(streamConfig: CodecConfig): Int

Registers a new stream to the IEndpointInternal.

Link copied to clipboard
open override fun addStreams(streamConfigs: List<CodecConfig>): Map<CodecConfig, Int>

Registers new streams to the IEndpointInternal.

Link copied to clipboard
open suspend override fun close()

Closes and releases resources

Link copied to clipboard
open fun getInfo(descriptor: MediaDescriptor): IEndpoint.IEndpointInfo
open override fun getInfo(type: MediaDescriptor.Type): CompositeEndpoint.EndpointInfo

Gets configuration information

Link copied to clipboard
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.

Link copied to clipboard
open override fun release()

Releases an IEndpointInternal.

Link copied to clipboard
open suspend override fun startStream()

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

Link copied to clipboard
open suspend override fun stopStream()

Stops the stream and releases the sink.

Link copied to clipboard
open suspend override fun write(frame: Frame, streamPid: Int)

Writes a Frame to the IEndpointInternal.