Vsdk::Addon::EntryPoint

#include <EntryPoint.hpp>

Inheritance diagram for Vsdk::Addon::EntryPoint:

Public Member Functions
virtual	~EntryPoint ()=default
virtual nlohmann::json	invoke (std::string const &command, nlohmann::json const &params)=0
	Invoke a named command in the addon with the given JSON arguments.

Constructor & Destructor Documentation

~EntryPoint()

virtual Vsdk::Addon::EntryPoint::~EntryPoint ( )

virtualdefault

Member Function Documentation

invoke()

virtual nlohmann::json Vsdk::Addon::EntryPoint::invoke ( std::string const & command, nlohmann::json const & params )

pure virtual

Invoke a named command in the addon with the given JSON arguments.

This function provides a dynamic dispatch mechanism: the host specifies a command name and an associated JSON value, and the addon implementation decides how to handle it. The returned JSON object may contain results, status information, or error details depending on the command. You can refer to the documenation to know which command is supported by which addon.

Parameters

command	The name of the command to execute.
params	JSON-formatted arguments passed to the command.

Returns

JSON-formatted response from the addon. May be null.

Exceptions

May	throw if the command name is unknown or arguments are invalid.