Class LibraryPlugin
Represents base game library plugin.
Namespace: PlayniteSDKPlugins
Inherited members
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Constructors
| Improve this Doc View SourceLibraryPlugin(IPlayniteAPI)
Creates new instance of LibraryPlugin.
Parameters
Type | Name | Description |
---|---|---|
IPlayniteAPI | playniteAPI |
Properties
| Improve this Doc View SourceClient
Gets library client application or null if no client is associated with this library.
Property Value
Type | Description |
---|---|
LibraryClient |
LibraryBackground
Gets library background image or null if no background is available.
Property Value
Type | Description |
---|---|
string |
LibraryIcon
Gets library icon or null if no icon is available.
Property Value
Type | Description |
---|---|
string |
Name
Gets library name.
Property Value
Type | Description |
---|---|
string |
Properties
Gets plugin's properties.
Property Value
Type | Description |
---|---|
LibraryPluginProperties |
Methods
| Improve this Doc View SourceGetGames(LibraryGetGamesArgs)
Gets library games.
Parameters
Type | Name | Description |
---|---|---|
LibraryGetGamesArgs | args |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T>GameMetadata | List of library games. |
GetMetadataDownloader()
Gets library metadata downloader or null if no metadata provider is available.
Returns
Type | Description |
---|---|
LibraryMetadataProvider | Metadata downloader. |
ImportGames(LibraryImportGamesArgs)
Initiates game import if "HasCustomizedGameImport" capability is enabled.
Parameters
Type | Name | Description |
---|---|---|
LibraryImportGamesArgs | args |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T>Game | List of newly imported games. |
ToString()
Returns
Type | Description |
---|---|
string |
Overrides
object.ToString()
Implements
System.IDisposable