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

BaseCameraStreamer

open class BaseCameraStreamer(context: Context, enableAudio: Boolean = true, muxer: IMuxer, endpoint: IEndpoint, initialOnErrorListener: OnErrorListener? = null) : BaseStreamer, ICameraStreamer

A BaseStreamer that sends microphone and camera frames.

Parameters

context

application context

enableAudio

Boolean.true to capture audio

muxer

a IMuxer implementation

endpoint

a IEndpoint implementation

initialOnErrorListener

initialize OnErrorListener

Inheritors

BaseCameraFileStreamer

BaseCameraLiveStreamer

Constructors

BaseCameraStreamer

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

Properties

camera

@set:RequiresPermission(value = "android.permission.CAMERA")

open override var camera: String

Get/Set current camera id.

helper

open override val helper: CameraStreamerConfigurationHelper

Access configuration helper.

onErrorListener

open override var onErrorListener: OnErrorListener?

Listener that reports streamer error. Supports only one listener.

settings

open override var settings: BaseCameraStreamerSettings

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

Same as BaseStreamer.release but it also calls stopPreview.

reportError

fun reportError(error: StreamPackError)

startPreview

@RequiresPermission(allOf = ["android.permission.CAMERA"])

open override fun startPreview(previewSurface: Surface, cameraId: String)

@RequiresPermission(allOf = ["android.permission.CAMERA"])

open fun startPreview(surfaceHolder: SurfaceHolder, cameraId: String = camera)

@RequiresPermission(allOf = ["android.permission.CAMERA"])

open fun startPreview(surfaceView: SurfaceView, cameraId: String = camera)

@RequiresPermission(allOf = ["android.permission.CAMERA"])

open fun startPreview(textureView: TextureView, cameraId: String = camera)

Starts audio and video capture. BaseStreamer.configure must have been called at least once.

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.

stopPreview

open override fun stopPreview()

Stops capture. It also stops stream if the stream is running.

stopStream

open suspend override fun stopStream()

Stops audio/video stream.