Interface IPlayniteApi

Namespace

Playnite

Assembly

Playnite.SDK.dll

public interface IPlayniteApi : IDisposable

Inherited Members

IDisposable.Dispose()

Properties

Addons

IAddonsApi Addons { get; }

Property Value

IAddonsApi

AppInfo

IApplicationInfoApi AppInfo { get; }

Property Value

IApplicationInfoApi

Dialogs

IDialogs Dialogs { get; }

Property Value

IDialogs

Library

ILibraryApi Library { get; }

Property Value

ILibraryApi

MainView

IMainViewApi MainView { get; }

Property Value

IMainViewApi

Notifications

INotificationsAPI Notifications { get; }

Property Value

INotificationsAPI

Settings

IApplicationSettingsApi Settings { get; }

Property Value

IApplicationSettingsApi

UriHandler

IUriHandlerAPI UriHandler { get; }

Property Value

IUriHandlerAPI

UserDataDir

string UserDataDir { get; }

Property Value

string

WebView

IWebViewApi WebView { get; }

Property Value

IWebViewApi

Methods

AddBackgroundOperation(BackgroundOperation)

void AddBackgroundOperation(BackgroundOperation operation)

Parameters

operation BackgroundOperation

CallPluginAsync(PluginCallRequestAsyncArgs)

Task<object?> CallPluginAsync(Plugin.PluginCallRequestAsyncArgs args)

Parameters

args Plugin.PluginCallRequestAsyncArgs

Returns

Task<object>

ExpandVariables(Game, string, bool)

string ExpandVariables(Game game, string inputString, bool fixSeparators)

Parameters

game Game

inputString string

fixSeparators bool

Returns

string

ExpandVariables(string, bool)

string ExpandVariables(string inputString, bool fixSeparators)

Parameters

inputString string

fixSeparators bool

Returns

string

GenerateCallbackAsync(OnPluginCallbackAsyncArgs)

Task GenerateCallbackAsync(Plugin.OnPluginCallbackAsyncArgs args)

Parameters

args Plugin.OnPluginCallbackAsyncArgs

Returns

Task

GetConnectedGamepads()

List<Gamepad> GetConnectedGamepads()

Returns

List<Gamepad>

GetGameState(string)

GameState? GetGameState(string gameId)

Parameters

gameId string

Returns

GameState

GetLocalizedString(string)

string GetLocalizedString(string stringId)

Parameters

stringId string

Returns

string

GetLocalizedString(string, params (string name, object value)[])

string GetLocalizedString(string stringId, params (string name, object value)[] args)

Parameters

stringId string

args (string name, object value)[]

Returns

string

GetPlatforms()

IReadOnlyList<PlatformDefinition> GetPlatforms()

Returns

IReadOnlyList<PlatformDefinition>

GetRegions()

IReadOnlyList<RegionDefinition> GetRegions()

Returns

IReadOnlyList<RegionDefinition>

InstallGameAsync(Game)

Task InstallGameAsync(Game game)

Parameters

game Game

Returns

Task

StartGameAsync(Game)

Task StartGameAsync(Game game)

Parameters

game Game

Returns

Task

UninstallGameAsync(Game)

Task UninstallGameAsync(Game game)

Parameters

game Game

Returns

Task