streampack-core/io.github.thibaultbee.streampack.core.pipelines.outputs.encoding/IEncodingPipelineOutput

IEncodingPipelineOutput

interface IEncodingPipelineOutput : IPipelineOutput, IOpenableStreamer

An output component for a streamer.

Inheritors

Properties

Link copied to clipboard
abstract val endpoint: IEndpoint

Advanced settings for the endpoint.

Link copied to clipboard
abstract val isOpenFlow: StateFlow<Boolean>

Returns true if output is opened. For example, if the streamer is connected to a server if the endpoint is SRT or RTMP.

Link copied to clipboard
val IPipelineOutput.isStreaming: Boolean

Whether the output is streaming.

Link copied to clipboard
abstract val isStreamingFlow: StateFlow<Boolean>

Returns true if stream is running.

Link copied to clipboard
abstract val throwableFlow: StateFlow<Throwable?>

Returns the last throwable that occurred.

Link copied to clipboard
abstract val withAudio: Boolean

Whether the output has audio.

Link copied to clipboard
abstract val withVideo: Boolean

Whether the output has video.

Functions

Link copied to clipboard
abstract fun addBitrateRegulatorController(controllerFactory: IBitrateRegulatorController.Factory)

Adds a bitrate regulator controller to the streamer.

Link copied to clipboard
abstract suspend fun close()

Closes the streamer endpoint.

Link copied to clipboard
abstract suspend fun open(descriptor: MediaDescriptor)

Opens the streamer endpoint.

Link copied to clipboard
suspend fun IOpenableStreamer.open(uri: Uri)
suspend fun IOpenableStreamer.open(uriString: String)

Opens the streamer endpoint.

Link copied to clipboard
abstract suspend fun release()

Clean and reset the streamer.

Link copied to clipboard
fun IStreamer.releaseBlocking()

Clean and reset the streamer synchronously.

fun IPipelineOutput.releaseBlocking(dispatcher: CoroutineDispatcher = Dispatchers.Default)

Clean and reset the output synchronously.

Link copied to clipboard
abstract fun removeBitrateRegulatorController()

Removes the bitrate regulator controller from the streamer.

Link copied to clipboard
abstract suspend fun startStream()

Starts audio/video stream.

Link copied to clipboard
suspend fun IOpenableStreamer.startStream(uri: Uri)
suspend fun IOpenableStreamer.startStream(descriptor: MediaDescriptor)
suspend fun IOpenableStreamer.startStream(uriString: String)

Starts audio/video stream.

Link copied to clipboard
abstract suspend fun stopStream()

Stops audio/video stream.