AbstractSink

abstract class AbstractSink : ISinkInternal

Abstract class to write data to a sink It provides a default implementation for open method.

Use openImpl to implement the opening of the sink.

Inheritors

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

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

Link copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun close()

Closes and releases resources

Link copied to clipboard
abstract fun configure(config: SinkConfiguration)

Configure the Configurable implementation.

Link copied to clipboard
open suspend override fun open(mediaDescriptor: MediaDescriptor)

Opens the endpoint.

Link copied to clipboard
abstract suspend fun openImpl(mediaDescriptor: MediaDescriptor)
Link copied to clipboard
abstract suspend fun startStream()

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

Link copied to clipboard
abstract suspend fun stopStream()

Stops frames or data stream generation

Link copied to clipboard
abstract suspend fun write(packet: Packet): Int

Writes a buffer to the ISinkInternal.