LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IGameMetadataCapability14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.GameData.IGameMetadataCapability
Supplies descriptive metadata for known source-local game IDs.

Properties

SupportsMetadataPriority 14.1 Beta

C#
bool SupportsMetadataPriority { get; }
Gets whether LaunchBox should offer to prioritize this source's descriptive metadata over the Games Database.

Remarks

Defaults to true. Return false when the source supplies only titles or media. This does not disable metadata or media retrieval.

Methods

GetMetadataAsync 14.1 Beta

C#
System.Threading.Tasks.Task<Unbroken.LaunchBox.Plugins.GameData.GameMetadataResult> GetMetadataAsync(Unbroken.LaunchBox.Plugins.GameData.GameMetadataRequest request, System.Threading.CancellationToken cancellationToken)
Gets metadata for the requested games.
request 14.1 Beta
The source-local game IDs.
cancellationToken 14.1 Beta
Cancels the operation.

Returns

Metadata for the games the source could describe; an omitted game is unknown, and an omitted field does not clear an existing value.