Interface IPlayniteAPI

Describes object providing Playnite API.

Properties

| Improve this Doc View Source

Addons

Gets addons API.

Property Value
Type Description
IAddons
| Improve this Doc View Source

ApplicationInfo

Gets application info API.

Property Value
Type Description
IPlayniteInfoAPI
| Improve this Doc View Source

ApplicationSettings

Get application settings API.

Property Value
Type Description
IPlayniteSettingsAPI
| Improve this Doc View Source

Database

Gets database API.

Property Value
Type Description
IGameDatabaseAPI
| Improve this Doc View Source

Dialogs

Gets dialog API.

Property Value
Type Description
IDialogsFactory
| Improve this Doc View Source

Emulation

Gets emulation API.

Property Value
Type Description
IEmulationAPI
| Improve this Doc View Source

MainView

Gets main view API.

Property Value
Type Description
IMainViewAPI
| Improve this Doc View Source

Notifications

Gets notification API.

Property Value
Type Description
INotificationsAPI
| Improve this Doc View Source

Paths

Gets paths API.

Property Value
Type Description
IPlaynitePathsAPI
| Improve this Doc View Source

Resources

Gets resources API.

Property Value
Type Description
IResourceProvider
| Improve this Doc View Source

UriHandler

Gets URI handler API.

Property Value
Type Description
IUriHandlerAPI
| Improve this Doc View Source

WebViews

Gets web view API.

Property Value
Type Description
IWebViewFactory

Methods

| Improve this Doc View Source

AddConvertersSupport(Plugin, AddConvertersSupportArgs)

Parameters
Type Name Description
Plugin source
AddConvertersSupportArgs args
| Improve this Doc View Source

AddCustomElementSupport(Plugin, AddCustomElementSupportArgs)

Parameters
Type Name Description
Plugin source
AddCustomElementSupportArgs args
| Improve this Doc View Source

AddSettingsSupport(Plugin, AddSettingsSupportArgs)

Parameters
Type Name Description
Plugin source
AddSettingsSupportArgs args
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

InstallGame(Guid)

Installs game.

Parameters
Type Name Description
System.Guid gameId

Game's database ID.
| Improve this Doc View Source

StartGame(Guid)

Starts game.

Parameters
Type Name Description
System.Guid gameId

Game's database ID.
| Improve this Doc View Source

UninstallGame(Guid)

Uninstalls game.

Parameters
Type Name Description
System.Guid gameId

Game's database ID.