haishinkit/com.haishinkit.stream/StreamSession

StreamSession

StreamSession is a session for live streaming.

Streaming with com.haishinkit.rtmp.RtmpConnection is difficult to use because it requires many idioms. This is a helper class specialized for a one-connection, one-stream setup.

Types

Builder

class Builder(context: Context, uri: Uri)

Helper class for building new StreamSession.

Mode

enum Mode : Enum<StreamSession.Mode>

Represents the type of session to establish.

ReadyState

enum ReadyState : Enum<StreamSession.ReadyState>

Represents the current connection state of a session.

Properties

isConnected

abstract val isConnected: Boolean

This instance connected to server(true) or not(false).

readyState

abstract val readyState: StateFlow<StreamSession.ReadyState>

The current readyState.

stream

abstract val stream: Stream

The stream instance.

Functions

abstract suspend fun close(): Result<Unit>

Closes the connection from the server.

connect

abstract suspend fun connect(): Result<Unit>

Creates a connection to an application on server.