3.0.0-RC

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

DualEndpoint

open class DualEndpoint(mainEndpoint: IEndpointInternal, secondEndpoint: IEndpointInternal) : CombineEndpoint

An implementation of CombineEndpoint that combines two endpoints. The mainEndpoint is the only one closed and opened by this endpoint. The secondEndpoint is opened and closed by the user.

For example, you can combine a local endpoint and a remote endpoint to record and stream at the same time. In that case, the local endpoint will be the mainEndpoint and the remote endpoint will be the secondEndpoint.

Parameters

mainEndpoint

the main endpoint

secondEndpoint

the second endpoint

Constructors

constructor(mainEndpoint: IEndpointInternal, secondEndpoint: IEndpointInternal)

Properties

endpointInternals

protected val endpointInternals: List<IEndpointInternal>

val endpoints: List<IEndpoint>

List of IEndpoints

endpointsToStreamIdsMap

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

Internal map of endpoint streamId to real streamIds

open override val info: IEndpoint.IEndpointInfo

The union of all endpoints' IEndpoint.IEndpointInfo.

open override val isOpenFlow: StateFlow<Boolean>

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

open override val metrics: Any

Throws UnsupportedOperationException because CombineEndpoint does not have metrics.

Functions

open override fun addStream(streamConfig: CodecConfig): Int

Registers a new stream to the IEndpointInternal.

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

Registers new streams to the IEndpointInternal.

open suspend override fun close()

Closes all endpoints

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 suspend override fun open(descriptor: MediaDescriptor)

Opens the mainEndpoint.

suspend fun openSecond(descriptor: MediaDescriptor)

Opens the secondEndpoint.

open override fun release()

Releases an IEndpointInternal.

open suspend override fun startStream()

Starts the mainEndpoint.

startStreamSecond

suspend fun startStreamSecond()

Starts the secondEndpoint.

startStreamSecond

suspend fun DualEndpoint.startStreamSecond(descriptor: MediaDescriptor)

Opens the secondEndpoint and starts the stream.

open suspend override fun stopStream()

Stops all endpoints

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

Writes frame to all opened endpoints.