lib/live.hms.video.plugin.video/HMSVideoPlugin

HMSVideoPlugin

A plugin implementing this interface can be registered with HMSStreamFactory to transform, process or analyze the videoFrame. These can include applications like video filters, virtual background, live analysis of video etc. The below functions are required for the sdk to properly use the plugin, usually the plugin would also be exposing some public functions of its own for the UI to control its working.

Functions

getName

abstract fun getName(): String

The name is meant to uniquely specify a plugin instance. This will be used to track number of plugins added, and same name won't be allowed twice.

getPluginType

abstract fun getPluginType(): HMSVideoPluginType

init

abstract suspend fun init()

This function will be called in the beginning for initialization which may include tasks like setting up variables, loading ML models etc. This can be used by a plugin to ensure it's prepared at the time processVideoFrame is called.

isSupported

abstract fun isSupported(): Boolean

This function will be called before the call to init, it is used to check whether the plugin supports current OS and device or not. An error will be thrown back to the user if they try to use an unsupported plugin.

processVideoFrame

abstract fun processVideoFrame(input: VideoFrame, outputListener: HMSPluginResultListener?, skipProcessing: Boolean?)

This function will be called by the SDK for every video frame which the plugin needs to process.

setKey

open fun setKey(key: String)

stop

abstract fun stop()

the plugin can use this function to dispose off its resources. It'll be called when the processor instance is no longer needed at the end.

Inheritors

HMSBitmapPlugin

HmsVirtualBackgroundInterface