Class ModelPluginMetadata
Contains metadata for a plugin. Used to identify a plugin before instantiation.
Inherited Members
Namespace: StrixMusic.Sdk.Plugins.Model
Assembly: StrixMusic.Sdk.dll
Syntax
public sealed class ModelPluginMetadata
Constructors
| Improve this Doc View SourceModelPluginMetadata(string, string, string, Version)
Creates a new instance of ModelPluginMetadata.
Declaration
public ModelPluginMetadata(string id, string displayName, string description, Version pluginVersion)
Parameters
Type | Name | Description |
---|---|---|
string | id | A unique identifier for this plugin, including all instances. |
string | displayName | The user-friendly name of the plugin. |
string | description | Briefly describes this plugin. |
Version | pluginVersion | This plugin's version number. |
Properties
| Improve this Doc View SourceDescription
Briefly describes this plugin.
Declaration
public string Description { get; }
Property Value
Type | Description |
---|---|
string |
DisplayName
The user-friendly name for the plugin.
Declaration
public string DisplayName { get; }
Property Value
Type | Description |
---|---|
string |
Id
A unique identifier for this plugin, across all instances.
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
string |
LogoUri
A path pointing to an SVG file containing the logo for this plugin.
Declaration
public Uri? LogoUri { get; set; }
Property Value
Type | Description |
---|---|
Uri |
PluginVersion
This plugin's version number.
Declaration
public Version PluginVersion { get; set; }
Property Value
Type | Description |
---|---|
Version |
SdkVersion
The version of the Strix Music SDK that this plugin was built against.
Declaration
public Version SdkVersion { get; }
Property Value
Type | Description |
---|---|
Version |