Table of Contents

Interface IPlayniteSettingsAPI

Namespace
Playnite.SDK
Assembly
Playnite.SDK.dll

Describes application settings API.

public interface IPlayniteSettingsAPI

Properties

AgeRatingOrgPriority

AgeRatingOrg AgeRatingOrgPriority { get; }

Property Value

AgeRatingOrg

AsyncImageLoading

bool AsyncImageLoading { get; }

Property Value

bool

CloseToTray

bool CloseToTray { get; }

Property Value

bool

CompletionStatus

Gets completion status related settings.

ICompletionStatusSettignsApi CompletionStatus { get; }

Property Value

ICompletionStatusSettignsApi

DatabasePath

string DatabasePath { get; }

Property Value

string

DesktopTheme

string DesktopTheme { get; }

Property Value

string

DisableHwAcceleration

bool DisableHwAcceleration { get; }

Property Value

bool

DiscordPresenceEnabled

bool DiscordPresenceEnabled { get; }

Property Value

bool

DownloadMetadataOnImport

bool DownloadMetadataOnImport { get; }

Property Value

bool

EnableTray

bool EnableTray { get; }

Property Value

bool

FirstTimeWizardComplete

bool FirstTimeWizardComplete { get; }

Property Value

bool

FontFamilyName

string FontFamilyName { get; }

Property Value

string

ForcePlayTimeSync

[Obsolete("Use new PlaytimeImportMode property instead.")]
bool ForcePlayTimeSync { get; }

Property Value

bool

Fullscreen

Gets Fullscreen mode related settings.

IFullscreenSettingsAPI Fullscreen { get; }

Property Value

IFullscreenSettingsAPI

FullscreenTheme

string FullscreenTheme { get; }

Property Value

string

GridItemHeightRatio

int GridItemHeightRatio { get; }

Property Value

int

GridItemWidthRatio

int GridItemWidthRatio { get; }

Property Value

int

Language

string Language { get; }

Property Value

string

MinimizeToTray

bool MinimizeToTray { get; }

Property Value

bool

PlaytimeImportMode

PlaytimeImportMode PlaytimeImportMode { get; }

Property Value

PlaytimeImportMode

SidebarPosition

Dock SidebarPosition { get; }

Property Value

Dock

SidebarVisible

bool SidebarVisible { get; }

Property Value

bool

StartInFullscreen

bool StartInFullscreen { get; }

Property Value

bool

StartMinimized

bool StartMinimized { get; }

Property Value

bool

StartOnBoot

bool StartOnBoot { get; }

Property Value

bool

UpdateLibStartup

bool UpdateLibStartup { get; }

Property Value

bool

Version

int Version { get; }

Property Value

int

Methods

GetGameExcludedFromImport(string, Guid)

Checks if game is added on import exclusion list.

bool GetGameExcludedFromImport(string gameId, Guid libraryId)

Parameters

gameId string

Game ID.

libraryId Guid

Library plugin ID.

Returns

bool

True if game is on exclusion list.