lib/live.hms.video.plugin.video.utils/HMSBitmapPlugin

HMSBitmapPlugin

class HMSBitmapPlugin(val hmsSDK: HMSSDK, val hmsBitmapUpdateListener: HMSBitmapUpdateListener) : HMSVideoPlugin

Constructors

HMSBitmapPlugin

fun HMSBitmapPlugin(hmsSDK: HMSSDK, hmsBitmapUpdateListener: HMSBitmapUpdateListener)

Types

Companion

object Companion

Functions

getName

open override 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

open override fun getPluginType(): HMSVideoPluginType

init

open suspend override 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

open override 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

open override fun processVideoFrame(inputVideoFrame: 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 override fun setKey(key: String)

stop

open override 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.

Properties

hmsBitmapUpdateListener

val hmsBitmapUpdateListener: HMSBitmapUpdateListener

hmsSDK

val hmsSDK: HMSSDK