extension-srt/io.github.thibaultbee.streampack.ext.srt.streamers/ScreenRecorderSrtLiveStreamer

ScreenRecorderSrtLiveStreamer

class ScreenRecorderSrtLiveStreamer(context: Context, enableAudio: Boolean = true, tsServiceInfo: TsServiceInfo = context.defaultTsServiceInfo, bitrateRegulatorFactory: IBitrateRegulatorFactory? = null, bitrateRegulatorConfig: BitrateRegulatorConfig? = null, initialOnErrorListener: OnErrorListener? = null, initialOnConnectionListener: OnConnectionListener? = null) : BaseScreenRecorderLiveStreamer, ISrtLiveStreamer

BaseScreenRecorderStreamer that sends microphone and screen frames to a remote Secure Reliable Transport (SRT) device. To run this streamer while application is on background, you have to extend a Service. To simplify the integration, a service is provided in ScreenRecorderSrtLiveService.

As an example, see demo-screenrecorder.

Parameters

context

application context

enableAudio

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

tsServiceInfo

MPEG-TS service description

bitrateRegulatorFactory

a IBitrateRegulatorFactory implementation. Use it to customized bitrate regulator. If bitrateRegulatorConfig is not null, bitrateRegulatorFactory must not be null.

bitrateRegulatorConfig

bitrate regulator configuration. If bitrateRegulatorFactory is not null, bitrateRegulatorConfig must not be null.

initialOnErrorListener

initialize OnErrorListener

initialOnConnectionListener

initialize OnConnectionListener

Constructors

ScreenRecorderSrtLiveStreamer

constructor(context: Context, enableAudio: Boolean = true, tsServiceInfo: TsServiceInfo = context.defaultTsServiceInfo, bitrateRegulatorFactory: IBitrateRegulatorFactory? = null, bitrateRegulatorConfig: BitrateRegulatorConfig? = null, initialOnErrorListener: OnErrorListener? = null, initialOnConnectionListener: OnConnectionListener? = null)

Properties

activityResult

var activityResult: ActivityResult?

helper

open override val helper: StreamerConfigurationHelper

isConnected

open override val isConnected: Boolean

latency

open override val latency: Int

Get/set bidirectional latency in milliseconds. See: SRT Socket Options

onConnectionListener

open override var onConnectionListener: OnConnectionListener?

onErrorListener

open override var onErrorListener: OnErrorListener?

passPhrase

open override var passPhrase: String

Get/set SRT passphrase. See: SRT Socket Options

settings

open override val settings: BaseStreamerSettings

streamId

open override var streamId: String

Get/set SRT stream ID. See: SRT Socket Options

Functions

configure

open override fun configure(audioConfig: AudioConfig)

open override fun configure(videoConfig: VideoConfig)

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

connect

open suspend override fun connect(connection: SrtConnectionDescriptor)

Connect to an SRT server with correct Live streaming parameters. To avoid creating an unresponsive UI, do not call on main thread.

open suspend override fun connect(url: String)

disconnect

open override fun disconnect()

release

open override fun release()

reportError

fun reportError(error: StreamPackError)

startStream

open suspend override fun startStream()

open suspend override fun startStream(url: String)

Same as BaseScreenRecorderLiveStreamer.startStream but also starts bitrate regulator.

open suspend override fun startStream(connection: SrtConnectionDescriptor)

Connect to an SRT 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()

Same as BaseScreenRecorderLiveStreamer.stopStream but also stops bitrate regulator.