IPlaylist7.10

Interface in Unbroken.LaunchBox.Plugins.Data

public interface IPlaylist

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

Properties

AutoPopulateGets or sets whether playlist membership is determined by its filters.
BackgroundImagePathGets the selected background image path.
BannerImagePathGets the selected banner image path.
BigBoxTheme9.6Gets or sets the Big Box theme selected for this item.
BigBoxViewGets or sets the Big Box view selected for this item.
CategoryGets or sets the associated platform-category name.
ClearLogoImagePathGets the selected clear-logo image path.
Default3DBoxImagePath9.10Gets the default three-dimensional box image path used for games without their own image.
Default3DCartImagePath9.10Gets the default three-dimensional cartridge image path used for games without their own image.
DefaultBoxImagePath9.10Gets the default front box image path used for games without their own image.
DefaultCartImagePath9.10Gets the default cartridge image path used for games without their own image.
DeviceImagePathGets the selected device image path.
HideInBigBox13.1Gets whether the current Big Box visibility rules hide this item.
ImageTypeGets or sets the image category selected for game display.
IncludeWithPlatformsGets or sets whether the playlist appears alongside platforms.
LastGameIdGets or sets the identifier of the last selected game.
NameGets the display name.
NestedName8.8Gets or sets the name used for this item in the platform hierarchy.
NotesGets or sets the descriptive notes, which may contain formatting.
PlatformCategoryClearLogoImagePathGets the clear-logo image path of the associated platform category.
PlaylistIdGets the playlist identifier.
SortByGets or sets the game field used to sort the playlist.
SortTitleGets or sets the alternate title used for sorting.
SortTitleOrTitleGets the sorting title, falling back to the display title when no sorting title is set.
VideoPathGets or sets the configured video path.

AutoPopulate

bool AutoPopulate { get; set; }

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

BackgroundImagePath

string BackgroundImagePath { get; }

Gets the selected background image path.

BannerImagePath

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

string BigBoxView { get; set; }

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

ClearLogoImagePath

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

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

string ImageType { get; set; }

Gets or sets the image category selected for game display.

IncludeWithPlatforms

bool IncludeWithPlatforms { get; set; }

Gets or sets whether the playlist appears alongside platforms.

LastGameId

string LastGameId { get; set; }

Gets or sets the identifier of the last selected game.

Name

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

string Notes { get; set; }

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

PlatformCategoryClearLogoImagePath

string PlatformCategoryClearLogoImagePath { get; }

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

PlaylistId

string PlaylistId { get; }

Gets the playlist identifier.

SortBy

string SortBy { get; set; }

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

SortTitle

string SortTitle { get; set; }

Gets or sets the alternate title used for sorting.

SortTitleOrTitle

string SortTitleOrTitle { get; }

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

VideoPath

string VideoPath { get; set; }

Gets or sets the configured video path.

Methods

AddNewPlaylistFilterCreates and adds a new playlist filter.
AddNewPlaylistGameCreates and adds a new playlist entry.
ClearGamesRemoves all explicitly stored playlist entries without deleting their library games.
GetAllGamesReturns the games currently included in the playlist.
GetAllPlaylistFiltersReturns the automatic-population filters assigned to the playlist.
GetAllPlaylistGamesReturns the explicitly stored playlist entries.
GetChildren8.8Returns this item's children in the platform hierarchy.
GetGameCount(bool, bool)Counts games that satisfy the visibility and media filters.
GetGameCount(bool, bool, bool, bool, bool, bool, bool)8.2Counts games that satisfy the visibility and media filters.
GetNewPlatformLogoPathRequests a destination path for a platform logo download.
GetNewPlatformVideoPathBuilds a video destination path using the item name and the source URL's extension.
GetPlatformVideoPathResolves a video for the platform, category, or playlist.
HasGames(bool, bool)Checks whether any games satisfy the visibility and media filters.
HasGames(bool, bool, bool, bool, bool, bool, bool)8.2Checks whether any games satisfy the visibility and media filters.
TryRemovePlaylistFilterAttempts to remove the specified playlist filter.
TryRemovePlaylistGameAttempts to remove the specified playlist entry.

AddNewPlaylistFilter

IPlaylistFilter AddNewPlaylistFilter()

Creates and adds a new playlist filter.

Returns

The new object, which the caller can populate.

AddNewPlaylistGame

IPlaylistGame AddNewPlaylistGame()

Creates and adds a new playlist entry.

Returns

The new object, which the caller can populate.

ClearGames

void ClearGames()

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

GetAllGames

IGame[] GetAllGames(bool sort)

Returns the games currently included in the playlist.

sort: Whether to apply the playlist sorting settings.

Returns

The resolved library games.

GetAllPlaylistFilters

IPlaylistFilter[] GetAllPlaylistFilters()

Returns the automatic-population filters assigned to the playlist.

Returns

The automatic-population filters assigned to the playlist.

GetAllPlaylistGames

IPlaylistGame[] GetAllPlaylistGames()

Returns the explicitly stored playlist entries.

Returns

The explicitly stored playlist entries.

GetChildren 8.8

IList<IPlatform> GetChildren()

Returns this item's children in the platform hierarchy.

Returns

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

GetGameCount(bool, bool)

int GetGameCount(bool includeHidden, bool includeBroken)

Counts games that satisfy the visibility and media filters.

includeHidden: Whether to include games marked as hidden.

includeBroken: Whether to include games marked as broken.

Returns

The number of matching games.

GetGameCount(bool, bool, bool, bool, bool, bool, bool) 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: Whether to include games marked as hidden.

includeBroken: Whether to include games marked as broken.

excludeGamesMissingVideos: Whether to exclude games without videos.

excludeGamesMissingBoxFrontImage: Whether to exclude games without front box images.

excludeGamesMissingScreenshotImage: Whether to exclude games without screenshots.

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

excludeGamesMissingBackgroundImage: Whether to exclude games without background images.

Returns

The number of matching games.

GetNewPlatformLogoPath

string GetNewPlatformLogoPath(string url)

Requests a destination path for a platform logo download.

url: The source image URL.

Returns

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

GetNewPlatformVideoPath

string GetNewPlatformVideoPath(string url)

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

url: The source video URL.

Returns

The destination path for the video.

GetPlatformVideoPath

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

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

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

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

Returns

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

HasGames(bool, bool)

bool HasGames(bool includeHidden, bool includeBroken)

Checks whether any games satisfy the visibility and media filters.

includeHidden: Whether to include games marked as hidden.

includeBroken: Whether to include games marked as broken.

Returns

Whether at least one matching game exists.

HasGames(bool, bool, bool, bool, bool, bool, bool) 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: Whether to include games marked as hidden.

includeBroken: Whether to include games marked as broken.

excludeGamesMissingVideos: Whether to exclude games without videos.

excludeGamesMissingBoxFrontImage: Whether to exclude games without front box images.

excludeGamesMissingScreenshotImage: Whether to exclude games without screenshots.

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

excludeGamesMissingBackgroundImage: Whether to exclude games without background images.

Returns

Whether at least one matching game exists.

TryRemovePlaylistFilter

bool TryRemovePlaylistFilter(IPlaylistFilter playlistFilter)

Attempts to remove the specified playlist filter.

playlistFilter: The playlist filter to remove.

Returns

Whether the object was removed.

TryRemovePlaylistGame

bool TryRemovePlaylistGame(IPlaylistGame playlistGame)

Attempts to remove the specified playlist entry.

playlistGame: The playlist entry to remove.

Returns

Whether the object was removed.