This abstract class is an API we need to implement from plugin side. More...

Inheritance diagram for jami::CallMediaHandler:

Collaboration diagram for jami::CallMediaHandler:

Public Member Functions
virtual void	detach ()=0
	Should detach the plugin data process (Observer).

virtual std::map< std::string, std::string >	getCallMediaHandlerDetails ()=0
	Should return a map with handler's name, iconPath, pluginId, attached, and dataType.

virtual void	notifyAVFrameSubject (const StreamData &data, avSubjectPtr subject)=0
	Should attach a AVSubject (Observable) to the plugin data process (Observer).

virtual bool	preferenceMapHasKey (const std::string &key)=0
	If a preference can be changed without the need to reload the plugin, this function should return True.

virtual void	setPreferenceAttribute (const std::string &key, const std::string &value)=0
	If a preference can be changed without the need to reload the plugin, it should be done through this function.

Public Member Functions inherited from jami::MediaHandler
std::string	id () const
	Returns the dataPath of the plugin that created this MediaHandler.

virtual void	setId (const std::string &id) final
	Should be called by the MediaHandler creator to set the plugins id_ variable with dataPath.

virtual	~MediaHandler ()=default

Detailed Description

This abstract class is an API we need to implement from plugin side.

In other words, a plugin functionality that plays with audio or video, must start from the implementation of this class.

Definition at line 65 of file mediahandler.h.

Member Function Documentation

virtual void jami::CallMediaHandler::detach ( )

pure virtual

Should detach the plugin data process (Observer).

virtual std::map< std::string, std::string > jami::CallMediaHandler::getCallMediaHandlerDetails ( )

pure virtual

Should return a map with handler's name, iconPath, pluginId, attached, and dataType.

Daemon expects: "attached" -> 1 if handler is attached; "dataType" -> 1 if data processed is video; "dataType" -> 0 if data processed is audio;

virtual void jami::CallMediaHandler::notifyAVFrameSubject	(	const StreamData &	data,
		avSubjectPtr	subject
	)

pure virtual

Should attach a AVSubject (Observable) to the plugin data process (Observer).

Parameters

data
subject

virtual bool jami::CallMediaHandler::preferenceMapHasKey ( const std::string & key )

pure virtual

If a preference can be changed without the need to reload the plugin, this function should return True.

Parameters

key

Returns: True if preference can be changed through setPreferenceAttribute method.

virtual void jami::CallMediaHandler::setPreferenceAttribute	(	const std::string &	key,
		const std::string &	value
	)

pure virtual

If a preference can be changed without the need to reload the plugin, it should be done through this function.

Parameters

key
value

The documentation for this class was generated from the following file: