Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
content_capability_manifest.hpp File Reference

The capabilities a plugin declares before consuming installed content packs, and the pulp.plugin-runtime.v1 JSON form a plugin bundle embeds. More...

#include <filesystem>
#include <optional>
#include <string>
#include <string_view>
#include <vector>

Go to the source code of this file.

Classes

struct  pulp::state::ContentCapabilityManifest
 Capabilities a plugin declares before consuming installed content packs. More...

Namespaces

namespace  pulp
namespace  pulp::state
 SequencerStateChannel is the audio-safe transport for a plugin's structured NON-parameter state: the bulk, observable state a step sequencer / mod-matrix / pattern engine holds outside its automatable parameter set (e.g.

Functions

std::optional< ContentCapabilityManifest > pulp::state::parse_content_capability_manifest (std::string_view json, std::string *error=nullptr)
 Parse the plugin-side content capability manifest embedded in a built plugin/app bundle.
std::optional< ContentCapabilityManifest > pulp::state::load_content_capability_manifest (const std::filesystem::path &path, std::string *error=nullptr)
 Load and parse a plugin content capability manifest from disk.
std::string pulp::state::content_capability_manifest_to_json (const ContentCapabilityManifest &manifest)
 Serialize a capability manifest for embedding in plugin bundle resources.

Detailed Description

The capabilities a plugin declares before consuming installed content packs, and the pulp.plugin-runtime.v1 JSON form a plugin bundle embeds.

pulp-state owns the value and its wire format; reading installed content packs belongs to the optional content-pack layer, so code that only needs to read or write a bundle's manifest does not depend on the content-pack reader.