Class MetadataPlugin

Namespace

Playnite.SDK.Plugins

Assembly

Playnite.SDK.dll

Represents plugin providing game metadata.

public abstract class MetadataPlugin : Plugin, IDisposable, IIdentifiable

Inheritance

object

Plugin

MetadataPlugin

Implements

IDisposable

IIdentifiable

Inherited Members

Plugin.Searches

Plugin.PlayniteApi

Plugin.Id

Plugin.Dispose()

Plugin.GetSettings(bool)

Plugin.GetSettingsView(bool)

Plugin.OnGameStarting(OnGameStartingEventArgs)

Plugin.OnGameStarted(OnGameStartedEventArgs)

Plugin.OnGameStopped(OnGameStoppedEventArgs)

Plugin.OnGameStartupCancelled(OnGameStartupCancelledEventArgs)

Plugin.OnGameInstalled(OnGameInstalledEventArgs)

Plugin.OnGameUninstalled(OnGameUninstalledEventArgs)

Plugin.OnGameSelected(OnGameSelectedEventArgs)

Plugin.OnApplicationStarted(OnApplicationStartedEventArgs)

Plugin.OnApplicationStopped(OnApplicationStoppedEventArgs)

Plugin.OnLibraryUpdated(OnLibraryUpdatedEventArgs)

Plugin.GetGameMenuItems(GetGameMenuItemsArgs)

Plugin.GetMainMenuItems(GetMainMenuItemsArgs)

Plugin.GetPluginUserDataPath()

Plugin.GetPluginConfiguration<TConfig>()

Plugin.LoadPluginSettings<TSettings>()

Plugin.SavePluginSettings<TSettings>(TSettings)

Plugin.OpenSettingsView()

Plugin.GetPlayActions(GetPlayActionsArgs)

Plugin.GetInstallActions(GetInstallActionsArgs)

Plugin.GetUninstallActions(GetUninstallActionsArgs)

Plugin.GetGameViewControl(GetGameViewControlArgs)

Plugin.AddCustomElementSupport(AddCustomElementSupportArgs)

Plugin.AddSettingsSupport(AddSettingsSupportArgs)

Plugin.AddConvertersSupport(AddConvertersSupportArgs)

Plugin.GetSidebarItems()

Plugin.GetTopPanelItems()

Plugin.GetSearchGlobalCommands()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

MetadataPlugin(IPlayniteAPI)

Creates new instance of MetadataPlugin.

public MetadataPlugin(IPlayniteAPI playniteAPI)

Parameters

playniteAPI IPlayniteAPI

Properties

Name

Gets metadata source name.

public abstract string Name { get; }

Property Value

string

Properties

Gets plugin's properties.

public MetadataPluginProperties Properties { get; protected set; }

Property Value

MetadataPluginProperties

SupportedFields

Gets list of game fields this metadata provider can provide.

public abstract List<MetadataField> SupportedFields { get; }

Property Value

List<MetadataField>

Methods

GetMetadataProvider(MetadataRequestOptions)

Gets metadata provider.

public abstract OnDemandMetadataProvider GetMetadataProvider(MetadataRequestOptions options)

Parameters

options MetadataRequestOptions

Returns

OnDemandMetadataProvider