StreamIngest

interface StreamIngest

Types

Link copied to clipboard
class Factory(context: Context, streamConfig: StreamConfig) : StreamIngestFactory

A factory class to create the StreamIngest object.

Properties

Link copied to clipboard
abstract val error: Flow<StreamIngestException>

A flow that emits the error occurred during the streaming process.

Link copied to clipboard

A flow that emits the stream insight for the ongoing streaming process.

Link copied to clipboard
abstract val streamStatus: Flow<StreamState>

A flow that emits the current state of the streaming process.

Functions

Link copied to clipboard
abstract fun enableSkinSmoothFaceOnly(isEnable: Boolean)

Enable or disable the skin smooth feature.

Link copied to clipboard

Gets the stream quality for the ongoing streaming process.

Link copied to clipboard
abstract fun isStreaming(): Boolean

Checks if the RTMP streaming process is ongoing.

Link copied to clipboard
abstract fun mutedAudio(isMute: Boolean)

Mutes or unmutes the audio stream based on the given flag.

Link copied to clipboard
abstract fun mutedVideo(isMute: Boolean)

Mutes or unmutes the video stream based on the given flag.

Link copied to clipboard
abstract fun onConfigChanged()

Called when the configuration of the view changes.

Link copied to clipboard
abstract fun registerFilter(filters: List<BeautyFilter>): Boolean

Register a list of beauty filters.

Link copied to clipboard
abstract fun release()

Releases resources associated with the streaming process.

Link copied to clipboard
abstract fun setIsStreamHorizontalFlip(isFlip: Boolean)

Sets the horizontal flip for the RTMP streaming process.

Link copied to clipboard
abstract fun setPreviewScaleType(previewScaleType: PreviewScaleType)

Sets the preview scale type for the camera preview.

Link copied to clipboard
abstract fun setRetries(retries: Int, retryInterval: Long)

Sets the number of retries and the interval between retries for the streaming process.

Link copied to clipboard
abstract fun setStreamQuality(streamQuality: StreamQuality)

Set the stream quality for the ongoing streaming process. Make sure this setting must be called before StreamIngest object assign to the view.

Link copied to clipboard
abstract fun startCameraPreview()

Starts the camera preview for the ongoing streaming process.

Link copied to clipboard
abstract fun startStream(rtmpUrl: String, streamKey: String)

Starts the streaming process with the provided RTMP URL.

Link copied to clipboard
abstract fun stopCameraPreview()

Stops the camera preview for the ongoing streaming process.

Link copied to clipboard
abstract fun stopStream()

Stops the ongoing streaming process.

Link copied to clipboard
abstract fun switchCamera()

Switches the camera for the ongoing streaming process.

Link copied to clipboard
abstract fun unregisterFilter(filters: List<BeautyFilter>)

Unregister a list of beauty filters.