14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

IPlaylist7.10

public interface Unbroken.LaunchBox.Plugins.Data.IPlaylist

Provides plugin access to playlist membership, filters, and presentation settings.

Properties

AutoPopulate 7.10

bool AutoPopulate { get; set; }

Gets or sets whether playlist membership is determined by its filters.

BackgroundImagePath 7.10

string BackgroundImagePath { get; }

Gets the selected background image path.

BannerImagePath 7.10

string BannerImagePath { get; }

Gets the selected banner image path.

BigBoxTheme 9.6

string BigBoxTheme { get; set; }

Gets or sets the Big Box theme selected for this item.

BigBoxView 7.10

string BigBoxView { get; set; }

Gets or sets the Big Box view selected for this item.

Category 7.10

string Category { get; set; }

Gets or sets the associated platform-category name.

ClearLogoImagePath 7.10

string ClearLogoImagePath { get; }

Gets the selected clear-logo image path.

Default3DBoxImagePath 9.10

string Default3DBoxImagePath { get; }

Gets the default three-dimensional box image path used for games without their own image.

Default3DCartImagePath 9.10

string Default3DCartImagePath { get; }

Gets the default three-dimensional cartridge image path used for games without their own image.

DefaultBoxImagePath 9.10

string DefaultBoxImagePath { get; }

Gets the default front box image path used for games without their own image.

DefaultCartImagePath 9.10

string DefaultCartImagePath { get; }

Gets the default cartridge image path used for games without their own image.

DeviceImagePath 7.10

string DeviceImagePath { get; }

Gets the selected device image path.

HideInBigBox 13.1

bool HideInBigBox { get; }

Gets whether the current Big Box visibility rules hide this item.

ImageType 7.10

string ImageType { get; set; }

Gets or sets the image category selected for game display.

IncludeWithPlatforms 7.10

bool IncludeWithPlatforms { get; set; }

Gets or sets whether the playlist appears alongside platforms.

LastGameId 7.10

string LastGameId { get; set; }

Gets or sets the identifier of the last selected game.

Name 7.10

string Name { get; }

Gets the display name.

NestedName 8.8

string NestedName { get; set; }

Gets or sets the name used for this item in the platform hierarchy.

Notes 7.10

string Notes { get; set; }

Gets or sets the descriptive notes, which may contain formatting.

PlatformCategoryClearLogoImagePath 7.10

string PlatformCategoryClearLogoImagePath { get; }

Gets the clear-logo image path of the associated platform category.

PlaylistId 7.10

string PlaylistId { get; }

Gets the playlist identifier.

SortBy 7.10

string SortBy { get; set; }

Gets or sets the game field used to sort the playlist.

SortTitle 7.10

string SortTitle { get; set; }

Gets or sets the alternate title used for sorting.

SortTitleOrTitle 7.10

string SortTitleOrTitle { get; }

Gets the sorting title, falling back to the display title when no sorting title is set.

VideoPath 7.10

string VideoPath { get; set; }

Gets or sets the configured video path.

Methods

Unbroken.LaunchBox.Plugins.Data.IPlaylistFilter AddNewPlaylistFilter()
Unbroken.LaunchBox.Plugins.Data.IPlaylistGame AddNewPlaylistGame()
void ClearGames()
Unbroken.LaunchBox.Plugins.Data.IGame[] GetAllGames(bool sort)
Unbroken.LaunchBox.Plugins.Data.IPlaylistFilter[] GetAllPlaylistFilters()
Unbroken.LaunchBox.Plugins.Data.IPlaylistGame[] GetAllPlaylistGames()
System.Collections.Generic.IList<Unbroken.LaunchBox.Plugins.Data.IPlatform> GetChildren()
int GetGameCount(bool includeHidden, bool includeBroken)
int GetGameCount(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)
string GetNewPlatformLogoPath(string url)
string GetNewPlatformVideoPath(string url)
string GetPlatformVideoPath(bool fallBackToGameVideos = true, bool allowThemePath = true)
bool HasGames(bool includeHidden, bool includeBroken)
bool HasGames(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)
bool TryRemovePlaylistFilter(Unbroken.LaunchBox.Plugins.Data.IPlaylistFilter playlistFilter)
bool TryRemovePlaylistGame(Unbroken.LaunchBox.Plugins.Data.IPlaylistGame playlistGame)

AddNewPlaylistFilter 7.10

Unbroken.LaunchBox.Plugins.Data.IPlaylistFilter AddNewPlaylistFilter()

Creates and adds a new playlist filter.

Returns

The new object, which the caller can populate.

AddNewPlaylistGame 7.10

Unbroken.LaunchBox.Plugins.Data.IPlaylistGame AddNewPlaylistGame()

Creates and adds a new playlist entry.

Returns

The new object, which the caller can populate.

ClearGames 7.10

void ClearGames()

Removes all explicitly stored playlist entries without deleting their library games.

GetAllGames 7.10

Unbroken.LaunchBox.Plugins.Data.IGame[] GetAllGames(bool sort)

Returns the games currently included in the playlist.

sort 7.10: Whether to apply the playlist sorting settings.

Returns

The resolved library games.

GetAllPlaylistFilters 7.10

Unbroken.LaunchBox.Plugins.Data.IPlaylistFilter[] GetAllPlaylistFilters()

Returns the automatic-population filters assigned to the playlist.

Returns

The automatic-population filters assigned to the playlist.

GetAllPlaylistGames 7.10

Unbroken.LaunchBox.Plugins.Data.IPlaylistGame[] GetAllPlaylistGames()

Returns the explicitly stored playlist entries.

Returns

The explicitly stored playlist entries.

GetChildren 8.8

System.Collections.Generic.IList<Unbroken.LaunchBox.Plugins.Data.IPlatform> GetChildren()

Returns this item's children in the platform hierarchy.

Returns

The child platforms, categories, and playlists. Playlists return an empty list.

GetGameCount 7.10

int GetGameCount(bool includeHidden, bool includeBroken)

Counts games that satisfy the visibility and media filters.

includeHidden 7.10: Whether to include games marked as hidden.

includeBroken 7.10: Whether to include games marked as broken.

Returns

The number of matching games.

GetGameCount 8.2

int GetGameCount(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)

Counts games that satisfy the visibility and media filters.

includeHidden 8.2: Whether to include games marked as hidden.

includeBroken 8.2: Whether to include games marked as broken.

excludeGamesMissingVideos 8.2: Whether to exclude games without videos.

excludeGamesMissingBoxFrontImage 8.2: Whether to exclude games without front box images.

excludeGamesMissingScreenshotImage 8.2: Whether to exclude games without screenshots.

excludeGamesMissingClearLogoImage 8.2: Whether to exclude games without clear-logo images.

excludeGamesMissingBackgroundImage 8.2: Whether to exclude games without background images.

Returns

The number of matching games.

GetNewPlatformLogoPath 7.10

string GetNewPlatformLogoPath(string url)

Requests a destination path for a platform logo download.

url 7.10: The source image URL.

Returns

The destination path, or null when this legacy operation is unsupported.

GetNewPlatformVideoPath 7.10

string GetNewPlatformVideoPath(string url)

Builds a video destination path using the item name and the source URL's extension.

url 7.10: The source video URL.

Returns

The destination path for the video.

GetPlatformVideoPath 7.10

string GetPlatformVideoPath(bool fallBackToGameVideos = true, bool allowThemePath = true)

Resolves a video for the platform, category, or playlist.

fallBackToGameVideos 7.10: Whether game videos may be used when no item video is found.

allowThemePath 7.10: Whether videos supplied by the current theme may be used.

Returns

The selected video path, or null when none is available.

HasGames 7.10

bool HasGames(bool includeHidden, bool includeBroken)

Checks whether any games satisfy the visibility and media filters.

includeHidden 7.10: Whether to include games marked as hidden.

includeBroken 7.10: Whether to include games marked as broken.

Returns

Whether at least one matching game exists.

HasGames 8.2

bool HasGames(bool includeHidden, bool includeBroken, bool excludeGamesMissingVideos, bool excludeGamesMissingBoxFrontImage, bool excludeGamesMissingScreenshotImage, bool excludeGamesMissingClearLogoImage, bool excludeGamesMissingBackgroundImage)

Checks whether any games satisfy the visibility and media filters.

includeHidden 8.2: Whether to include games marked as hidden.

includeBroken 8.2: Whether to include games marked as broken.

excludeGamesMissingVideos 8.2: Whether to exclude games without videos.

excludeGamesMissingBoxFrontImage 8.2: Whether to exclude games without front box images.

excludeGamesMissingScreenshotImage 8.2: Whether to exclude games without screenshots.

excludeGamesMissingClearLogoImage 8.2: Whether to exclude games without clear-logo images.

excludeGamesMissingBackgroundImage 8.2: Whether to exclude games without background images.

Returns

Whether at least one matching game exists.

TryRemovePlaylistFilter 7.10

bool TryRemovePlaylistFilter(Unbroken.LaunchBox.Plugins.Data.IPlaylistFilter playlistFilter)

Attempts to remove the specified playlist filter.

playlistFilter 7.10: The playlist filter to remove.

Returns

Whether the object was removed.

TryRemovePlaylistGame 7.10

bool TryRemovePlaylistGame(Unbroken.LaunchBox.Plugins.Data.IPlaylistGame playlistGame)

Attempts to remove the specified playlist entry.

playlistGame 7.10: The playlist entry to remove.

Returns

Whether the object was removed.