rtvamp::hostsdk::PluginKey Class Reference

Identifier for a plugin uniquely within the scope of the current system. More...

#include <rtvamp/hostsdk/PluginKey.hpp>

Public Member Functions
	PluginKey (const char *key)
	PluginKey (std::string key)
	PluginKey (std::string_view key)
	PluginKey (std::string_view library, std::string_view identifier)
std::string_view	get () const noexcept
std::string_view	getLibrary () const noexcept
std::string_view	getIdentifier () const noexcept
auto	operator<=> (const PluginKey &) const =default

Detailed Description

Identifier for a plugin uniquely within the scope of the current system.

Is is composed of the library name and the plugin identifier: <library name>:<identifier>.

Example example-plugin:rms:

• library path: C:\Program Files\Vamp Plugins\example-plugin.dll
• plugin identifier: rms

Constructor & Destructor Documentation

PluginKey() [1/4]

rtvamp::hostsdk::PluginKey::PluginKey

(

const char *

key

)

PluginKey() [2/4]

rtvamp::hostsdk::PluginKey::PluginKey

(

std::string

key

)

PluginKey() [3/4]

rtvamp::hostsdk::PluginKey::PluginKey

(

std::string_view

key

)

PluginKey() [4/4]

rtvamp::hostsdk::PluginKey::PluginKey	(	std::string_view	library,
		std::string_view	identifier
	)

Member Function Documentation

get()

std::string_view rtvamp::hostsdk::PluginKey::get ( ) const

inlinenoexcept

getIdentifier()

std::string_view rtvamp::hostsdk::PluginKey::getIdentifier ( ) const

noexcept

getLibrary()

std::string_view rtvamp::hostsdk::PluginKey::getLibrary ( ) const

noexcept

operator<=>()

auto rtvamp::hostsdk::PluginKey::operator<=> ( const PluginKey &  ) const

default

---

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

• /home/runner/work/rt-vamp-plugin-sdk/rt-vamp-plugin-sdk/hostsdk/include/rtvamp/hostsdk/PluginKey.hpp