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

CombineEndpoint

open class CombineEndpoint(val endpointInternals: List<IEndpointInternal>) : IEndpointInternal

Combines multiple endpoints into one. This endpoint will write frames to all endpoints if they are opened.

For example, you can combine a local endpoint and a remote endpoint to record and stream at the same time.

For specific behavior like reconnecting your remote endpoint, you can create a custom endpoint that inherits from CombineEndpoint and override open, close, startStream, stopStream.

Inheritors

DualEndpoint

Constructors

CombineEndpoint

constructor(endpointInternals: List<IEndpointInternal>)

Types

CombineDescriptor

class CombineDescriptor(val descriptors: List<MediaDescriptor>) : MediaDescriptor

A MediaDescriptor that combines multiple MediaDescriptors.

Companion

object Companion

Properties

endpointInternals

protected val endpointInternals: List<IEndpointInternal>

endpoints

val endpoints: List<IEndpoint>

List of IEndpoints

endpointsToStreamIdsMap

protected val endpointsToStreamIdsMap: MutableMap<Pair<IEndpoint, Int>, Int>

Internal map of endpoint streamId to real streamIds

info

open override val info: IEndpoint.IEndpointInfo

The union of all endpoints' IEndpoint.IEndpointInfo.

isOpenFlow

open override val isOpenFlow: StateFlow<Boolean>

Whether at least one endpoint is open. This is a combination of all endpoints' IEndpoint.isOpenFlow.

metrics

open override val metrics: Any

Throws UnsupportedOperationException because CombineEndpoint does not have metrics.

Functions

addStream

open override fun addStream(streamConfig: CodecConfig): Int

Registers a new stream to the IEndpointInternal.

addStreams

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

Registers new streams to the IEndpointInternal.

open suspend override fun close()

Closes all endpoints

getInfo

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

The union of all endpoints' IEndpoint.IEndpointInfo.

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

Gets configuration information

open

open suspend override fun open(descriptor: MediaDescriptor)

Opens the endpoints. For specific behavior like reconnecting your remote endpoint, you can override this method.

release

open override fun release()

Releases an IEndpointInternal.

startStream

open suspend override fun startStream()

Starts all endpoints

stopStream

open suspend override fun stopStream()

Stops all endpoints

write

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

Writes frame to all opened endpoints.