Interface IPlayniteAPI
Describes object providing Playnite API.
Properties
| Improve this Doc View SourceAddons
Gets addons API.
Property Value
Type | Description |
---|---|
IAddons |
ApplicationInfo
Gets application info API.
Property Value
Type | Description |
---|---|
IPlayniteInfoAPI |
ApplicationSettings
Get application settings API.
Property Value
Type | Description |
---|---|
IPlayniteSettingsAPI |
Database
Gets database API.
Property Value
Type | Description |
---|---|
IGameDatabaseAPI |
Dialogs
Gets dialog API.
Property Value
Type | Description |
---|---|
IDialogsFactory |
Emulation
Gets emulation API.
Property Value
Type | Description |
---|---|
IEmulationAPI |
MainView
Gets main view API.
Property Value
Type | Description |
---|---|
IMainViewAPI |
Notifications
Gets notification API.
Property Value
Type | Description |
---|---|
INotificationsAPI |
Paths
Gets paths API.
Property Value
Type | Description |
---|---|
IPlaynitePathsAPI |
Resources
Gets resources API.
Property Value
Type | Description |
---|---|
IResourceProvider |
UriHandler
Gets URI handler API.
Property Value
Type | Description |
---|---|
IUriHandlerAPI |
WebViews
Gets web view API.
Property Value
Type | Description |
---|---|
IWebViewFactory |
Methods
| Improve this Doc View SourceAddConvertersSupport(Plugin, AddConvertersSupportArgs)
Parameters
Type | Name | Description |
---|---|---|
Plugin | source | |
AddConvertersSupportArgs | args |
AddCustomElementSupport(Plugin, AddCustomElementSupportArgs)
Parameters
Type | Name | Description |
---|---|---|
Plugin | source | |
AddCustomElementSupportArgs | args |
AddSettingsSupport(Plugin, AddSettingsSupportArgs)
Parameters
Type | Name | Description |
---|---|---|
Plugin | source | |
AddSettingsSupportArgs | args |
ExpandGameVariables(Game, GameAction)
Expands dynamic game variables in specified game action.
Parameters
Type | Name | Description |
---|---|---|
Game | game | Game to use dynamic variables from. |
GameAction | action | Game action to expand variables to. |
Returns
Type | Description |
---|---|
GameAction | Game action with expanded variables. |
ExpandGameVariables(Game, string, string)
Expands dynamic game variables in specified string.
Parameters
Type | Name | Description |
---|---|---|
Game | game | Game to use dynamic variables from. |
string | inputString | String containing dynamic variables. |
string | emulatorDir | String to be used to expand {EmulatorDir} variable if present. |
Returns
Type | Description |
---|---|
string | String with replaces variables. |
ExpandGameVariables(Game, string)
Expands dynamic game variables in specified string.
Parameters
Type | Name | Description |
---|---|---|
Game | game | Game to use dynamic variables from. |
string | inputString | String containing dynamic variables. |
Returns
Type | Description |
---|---|
string | String with replaces variables. |
InstallGame(Guid)
Installs game.
Parameters
Type | Name | Description |
---|---|---|
System.Guid | gameId | Game's database ID. |
StartGame(Guid)
Starts game.
Parameters
Type | Name | Description |
---|---|---|
System.Guid | gameId | Game's database ID. |
UninstallGame(Guid)
Uninstalls game.
Parameters
Type | Name | Description |
---|---|---|
System.Guid | gameId | Game's database ID. |