Client

abstract class Client<T : IClient, L : Listener>

The Client base class manages the connection with the Millicast platform. The actual classes are the Publisher and Subscriber classes instantiated through the Core object class.

Inheritors

Publisher

Subscriber

Properties

isConnected

val isConnected: Boolean

Returns a boolean indicating whether the client is currently connected to the Millicast platform.

Functions

connect

suspend fun connect(connectionOptions: ConnectionOptions? = null)

Initiates a connection to the Millicast platform. By default, the SDK will always attempt to make auto reconnection. To disable this feature, pass a ConnectionOptions instance where autoReconnect is disabled.

disconnect

fun disconnect()

Terminates the current connection to the Millicast platform. Any ongoing process of publishing or subscribing content is automatically stopped before termination. This method returns directly but will perform the call in its queue.

enableFrameTransformer

suspend fun enableFrameTransformer(enable: Boolean)

Enables or disables the frame transformation functionality.

enableStats

suspend fun enableStats(enabled: Boolean)

Enables or disables the collection and reporting of real-time statistics associated with streaming sessions.

getMid

suspend fun getMid(trackId: String): String?

Retrieves the Media ID of the corresponding track, providing a unique identifier for the streamed media.

release

fun release()

Releases any object involved with this instance. For example, object created in the native code which are not garbage collected Do not use this instance after calling release