core/io.github.thibaultbee.streampack.streamers.live/BaseScreenRecorderLiveStreamer

BaseScreenRecorderLiveStreamer

open class BaseScreenRecorderLiveStreamer(context: Context, enableAudio: Boolean = true, muxer: IMuxer, endpoint: ILiveEndpoint, initialOnErrorListener: OnErrorListener? = null, initialOnConnectionListener: OnConnectionListener? = null) : BaseScreenRecorderStreamer, ILiveStreamer

A BaseScreenRecorderStreamer that sends microphone and screen frames to a remote device.

Parameters

context

application context

enableAudio

Boolean.true to capture audio. False to disable audio capture.

muxer

a IMuxer implementation

endpoint

a ILiveEndpoint implementation

initialOnErrorListener

initialize OnErrorListener

initialOnConnectionListener

initialize OnConnectionListener

Constructors

BaseScreenRecorderLiveStreamer

constructor(context: Context, enableAudio: Boolean = true, muxer: IMuxer, endpoint: ILiveEndpoint, initialOnErrorListener: OnErrorListener? = null, initialOnConnectionListener: OnConnectionListener? = null)

Properties

activityResult

var activityResult: ActivityResult?

Set/get activity result from ComponentActivity.registerForActivityResult callback. It is mandatory to set this before startStream.

helper

open override val helper: StreamerConfigurationHelper

Access configuration helper.

isConnected

open override val isConnected: Boolean

Check if the streamer is connected to the server.

onConnectionListener

open override var onConnectionListener: OnConnectionListener?

Listener to manage connection.

onErrorListener

open override var onErrorListener: OnErrorListener?

Listener that reports streamer error. Supports only one listener.

settings

open override val settings: BaseStreamerSettings

Access extended streamer settings.

Functions

configure

@RequiresPermission(value = "android.permission.RECORD_AUDIO")

open override fun configure(audioConfig: AudioConfig)

Configures audio settings. It is the first method to call after a BaseStreamer instantiation. It must be call when both stream and audio capture are not running.

open override fun configure(videoConfig: VideoConfig)

Configures video settings. It is the first method to call after a BaseStreamer instantiation. It must be call when both stream and video capture are not running.

@RequiresPermission(value = "android.permission.RECORD_AUDIO")

open override fun configure(audioConfig: AudioConfig, videoConfig: VideoConfig)

Configures both video and audio settings. It is the first method to call after a BaseStreamer instantiation. It must be call when both stream and audio and video capture are not running.

connect

open suspend override fun connect(url: String)

Connect to an remove server. To avoid creating an unresponsive UI, do not call on main thread.

disconnect

open override fun disconnect()

Disconnect from the remote server.

getCameraStreamer

fun IStreamer.getCameraStreamer(): ICameraStreamer?

getFileStreamer

fun IStreamer.getFileStreamer(): IFileStreamer?

getLiveStreamer

fun IStreamer.getLiveStreamer(): ILiveStreamer?

getStreamer

inline fun <T> IStreamer.getStreamer(): T?

Get a streamer if it from generic class or interface

release

open override fun release()

Releases recorders and encoders object. It also stops preview if needed

reportError

fun reportError(error: StreamPackError)

startStream

open suspend override fun startStream()

Same as BaseStreamer but it prepares ScreenSource.encoderSurface. You must have set activityResult before.

open suspend override fun startStream(url: String)

Connect to a remote server and start stream. Same as calling connect, then startStream. To avoid creating an unresponsive UI, do not call on main thread.

stopStream

open suspend override fun stopStream()

Stops audio/video stream.