Public Member Functions | List of all members
LV2::SaveRestore< Required >::I< Derived > Struct Template Reference

#include <lv2plugin.hpp>

Inherits LV2::Extension< Required >.

Public Member Functions

char * save (const char *directory, LV2SR_File ***files)
char * restore (const LV2SR_File **files)

Detailed Description

template<bool Required = true>
template<class Derived>
struct LV2::SaveRestore< Required >::I< Derived >

This is the type that your plugin class will inherit when you use the SaveRestore mixin. The public and protected members defined here will be available in your plugin class.

Member Function Documentation

template<bool Required = true>
template<class Derived>
char* LV2::SaveRestore< Required >::I< Derived >::restore ( const LV2SR_File **  files)
inline

This function is called by the host when it wants to restore the plugin to a previous state. You should override it.

Parameters
filesAn array of pointers to LV2SR_File objects, listing the files from which the internal state of the plugin instance should be restored.
template<bool Required = true>
template<class Derived>
char* LV2::SaveRestore< Required >::I< Derived >::save ( const char *  directory,
LV2SR_File ***  files 
)
inline

This function is called by the host when it wants to save the current state of the plugin. You should override it.

Parameters
directoryA filesystem path to a directory where the plugin should write any files it creates while saving.
filesA pointer to a NULL-terminated array of LV2SR_File pointers. The plugin should set *files to point to the first element in a dynamically allocated array of LV2SR_File pointers to (also dynamically allocated) LV2SR_File objects, listing the files to which the internal state of the plugin instance has been saved. These objects, and the array, will be freed by the host.

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