VCV Rack API  v1
rack::plugin Namespace Reference

Plugin loader and plugin manager. More...

Classes

struct  Model
 
struct  Plugin
 
struct  Update
 

Functions

void init ()
 
void destroy ()
 
void logIn (const std::string &email, const std::string &password)
 
void logOut ()
 
bool isLoggedIn ()
 
void queryUpdates ()
 
bool hasUpdates ()
 
void syncUpdate (Update *update)
 
void syncUpdates ()
 
bool isSyncing ()
 
PlugingetPlugin (const std::string &pluginSlug)
 
ModelgetModel (const std::string &pluginSlug, const std::string &modelSlug)
 
bool isSlugValid (const std::string &slug)
 Checks that the slug contains only alphanumeric characters, "-", and "_". More...
 
std::string normalizeSlug (const std::string &slug)
 Returns a string containing only the valid slug characters. More...
 

Variables

std::vector< Plugin * > plugins
 
std::string loginStatus
 
std::vector< Updateupdates
 
std::string updateStatus
 
bool restartRequested
 

Detailed Description

Plugin loader and plugin manager.

Function Documentation

◆ init()

void rack::plugin::init ( )

◆ destroy()

void rack::plugin::destroy ( )

◆ logIn()

void rack::plugin::logIn ( const std::string &  email,
const std::string &  password 
)

◆ logOut()

void rack::plugin::logOut ( )

◆ isLoggedIn()

bool rack::plugin::isLoggedIn ( )

◆ queryUpdates()

void rack::plugin::queryUpdates ( )

◆ hasUpdates()

bool rack::plugin::hasUpdates ( )

◆ syncUpdate()

void rack::plugin::syncUpdate ( Update update)

◆ syncUpdates()

void rack::plugin::syncUpdates ( )

◆ isSyncing()

bool rack::plugin::isSyncing ( )

◆ getPlugin()

Plugin* rack::plugin::getPlugin ( const std::string &  pluginSlug)

◆ getModel()

Model* rack::plugin::getModel ( const std::string &  pluginSlug,
const std::string &  modelSlug 
)

◆ isSlugValid()

bool rack::plugin::isSlugValid ( const std::string &  slug)

Checks that the slug contains only alphanumeric characters, "-", and "_".

◆ normalizeSlug()

std::string rack::plugin::normalizeSlug ( const std::string &  slug)

Returns a string containing only the valid slug characters.

Variable Documentation

◆ plugins

std::vector<Plugin*> rack::plugin::plugins

◆ loginStatus

std::string rack::plugin::loginStatus

◆ updates

std::vector<Update> rack::plugin::updates

◆ updateStatus

std::string rack::plugin::updateStatus

◆ restartRequested

bool rack::plugin::restartRequested