Interface IPlayniteAPI

Namespace

Playnite.SDK

Assembly

Playnite.SDK.dll

Describes object providing Playnite API.

public interface IPlayniteAPI

Properties

Addons

Gets addons API.

IAddons Addons { get; }

Property Value

IAddons

ApplicationInfo

Gets application info API.

IPlayniteInfoAPI ApplicationInfo { get; }

Property Value

IPlayniteInfoAPI

ApplicationSettings

Get application settings API.

IPlayniteSettingsAPI ApplicationSettings { get; }

Property Value

IPlayniteSettingsAPI

Database

Gets database API.

IGameDatabaseAPI Database { get; }

Property Value

IGameDatabaseAPI

Dialogs

Gets dialog API.

IDialogsFactory Dialogs { get; }

Property Value

IDialogsFactory

Emulation

Gets emulation API.

IEmulationAPI Emulation { get; }

Property Value

IEmulationAPI

MainView

Gets main view API.

IMainViewAPI MainView { get; }

Property Value

IMainViewAPI

Notifications

Gets notification API.

INotificationsAPI Notifications { get; }

Property Value

INotificationsAPI

Paths

Gets paths API.

IPlaynitePathsAPI Paths { get; }

Property Value

IPlaynitePathsAPI

Resources

Gets resources API.

IResourceProvider Resources { get; }

Property Value

IResourceProvider

UriHandler

Gets URI handler API.

IUriHandlerAPI UriHandler { get; }

Property Value

IUriHandlerAPI

WebViews

Gets web view API.

IWebViewFactory WebViews { get; }

Property Value

IWebViewFactory

Methods

AddConvertersSupport(Plugin, AddConvertersSupportArgs)

void AddConvertersSupport(Plugin source, AddConvertersSupportArgs args)

Parameters

source Plugin

args AddConvertersSupportArgs

AddCustomElementSupport(Plugin, AddCustomElementSupportArgs)

void AddCustomElementSupport(Plugin source, AddCustomElementSupportArgs args)

Parameters

source Plugin

args AddCustomElementSupportArgs

AddSettingsSupport(Plugin, AddSettingsSupportArgs)

void AddSettingsSupport(Plugin source, AddSettingsSupportArgs args)

Parameters

source Plugin

args AddSettingsSupportArgs

ExpandGameVariables(Game, GameAction)

Expands dynamic game variables in specified game action.

GameAction ExpandGameVariables(Game game, GameAction action)

Parameters

game Game

Game to use dynamic variables from.

action GameAction

Game action to expand variables to.

Returns

GameAction

Game action with expanded variables.

ExpandGameVariables(Game, string)

Expands dynamic game variables in specified string.

string ExpandGameVariables(Game game, string inputString)

Parameters

game Game

Game to use dynamic variables from.

inputString string

String containing dynamic variables.

Returns

string

String with replaces variables.

ExpandGameVariables(Game, string, string)

Expands dynamic game variables in specified string.

string ExpandGameVariables(Game game, string inputString, string emulatorDir)

Parameters

game Game

Game to use dynamic variables from.

inputString string

String containing dynamic variables.

emulatorDir string

String to be used to expand {EmulatorDir} variable if present.

Returns

string

String with replaces variables.

InstallGame(Guid)

Installs game.

void InstallGame(Guid gameId)

Parameters

gameId Guid

Game's database ID.

StartGame(Guid)

Starts game.

void StartGame(Guid gameId)

Parameters

gameId Guid

Game's database ID.

UninstallGame(Guid)

Uninstalls game.

void UninstallGame(Guid gameId)

Parameters

gameId Guid

Game's database ID.