core/io.github.thibaultbee.streampack.streamers.file/BaseAudioOnlyFileStreamer

BaseAudioOnlyFileStreamer

open class BaseAudioOnlyFileStreamer(context: Context, muxer: IMuxer, initialOnErrorListener: OnErrorListener? = null) : BaseAudioOnlyStreamer, IFileStreamer

A BaseStreamer that sends only microphone frames to a File.

Parameters

context

application context

muxer

a IMuxer implementation

initialOnErrorListener

initialize OnErrorListener

Inheritors

AudioOnlyFlvFileStreamer

AudioOnlyMp4FileStreamer

AudioOnlyTsFileStreamer

Constructors

BaseAudioOnlyFileStreamer

constructor(context: Context, muxer: IMuxer, initialOnErrorListener: OnErrorListener? = null)

Properties

open override var file: File?

Get/Set file. To set an OutputStream instead, see outputStream.

open override val helper: StreamerConfigurationHelper

Access configuration helper.

onErrorListener

open override var onErrorListener: OnErrorListener?

Listener that reports streamer error. Supports only one listener.

open override var outputStream: OutputStream?

Get/Set outputStream. To set an File instead, see file.

open override val settings: BaseStreamerSettings

Access extended streamer settings.

Functions

@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?

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

Get a streamer if it from generic class or interface

open override fun release()

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

fun reportError(error: StreamPackError)

@RequiresPermission(allOf = ["android.permission.WRITE_EXTERNAL_STORAGE", "android.permission.RECORD_AUDIO"])

open suspend override fun startStream()

Same as BaseCameraStreamer.startStream with RequiresPermission annotation for Manifest.permission.WRITE_EXTERNAL_STORAGE.

open suspend override fun stopStream()

Stops audio/video stream.