14.1 Beta 1 SDK
This reference documents the current beta SDK. Beta APIs can change before stable.
GameMediaRequest14.1 Beta
public sealed class Unbroken.LaunchBox.Plugins.GameData.GameMediaRequestRequests media for a batch of source-local game IDs.
Remarks
Media types are the public LaunchBox image and video type names or source-documented type names. An empty collection requests every media type the source offers.Constructors
GameMediaRequest 14.1 Beta
public GameMediaRequest(System.Collections.Generic.IReadOnlyCollection<string> gameIds, System.Collections.Generic.IReadOnlyCollection<string> mediaTypes)Properties
public int AttemptNumber { get; init; }public System.Collections.Generic.IReadOnlyCollection<string> GameIds { get; }public System.Collections.Generic.IReadOnlyCollection<string> MediaTypes { get; }public string? Region { get; init; }public System.Collections.Generic.IReadOnlyCollection<string> RegionPriorities { get; init; }
AttemptNumber 14.1 Beta
public int AttemptNumber { get; init; }Gets or initializes the one-based attempt for this enrichment request. Waiting in the host queue does not advance it.
GameIds 14.1 Beta
public System.Collections.Generic.IReadOnlyCollection<string> GameIds { get; }Gets the requested game IDs.
MediaTypes 14.1 Beta
public System.Collections.Generic.IReadOnlyCollection<string> MediaTypes { get; }Gets the requested media types, or an empty collection for all.
Region 14.1 Beta
public string? Region { get; init; }Gets or initializes the region of the requested games, as a comma-separated list when a game spans regions.
Remarks
A source may use it to limit or order region-specific candidates. LaunchBox still applies its own region selection to the returned candidates.RegionPriorities 14.1 Beta
public System.Collections.Generic.IReadOnlyCollection<string> RegionPriorities { get; init; }Gets or initializes the user's region preference order.