core/io.github.thibaultbee.streampack.streamers.bases/BaseStreamer

BaseStreamer

abstract class BaseStreamer(context: Context, audioSource: IAudioSource?, videoSource: IVideoSource?, muxer: IMuxer, endpoint: IEndpoint, initialOnErrorListener: OnErrorListener? = null) : EventHandler, IStreamer

Base class of all streamers.

Parameters

context

application context

videoSource

Video source

audioSource

Audio source

muxer

a IMuxer implementation

endpoint

a IEndpoint implementation

initialOnErrorListener

initialize OnErrorListener

Inheritors

BaseAudioOnlyStreamer

BaseCameraStreamer

BaseScreenRecorderStreamer

Constructors

BaseStreamer

constructor(context: Context, audioSource: IAudioSource?, videoSource: IVideoSource?, muxer: IMuxer, endpoint: IEndpoint, initialOnErrorListener: OnErrorListener? = null)

Types

Companion

object Companion

Properties

helper

open override val helper: StreamerConfigurationHelper

Access configuration helper.

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.

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()

Starts audio/video stream. Stream depends of the endpoint: Audio/video could be write to a file or send to a remote device. To avoid creating an unresponsive UI, do not call on main thread.

stopStream

open suspend override fun stopStream()

Stops audio/video stream.