LaunchBoxContributors
On this page

IGameMetadataCapability14.1

Interface in Unbroken.LaunchBox.Plugins.Components.GameData

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

Properties

  • SupportsMetadataPriorityGets whether LaunchBox should offer to prioritize this source's descriptive metadata over the Games Database.

SupportsMetadataPriority

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

C#
Task<GameMetadataResult> GetMetadataAsync(
    GameMetadataRequest request,
    CancellationToken cancellationToken
)
Gets metadata for the requested games.
request
The source-local game IDs.
cancellationToken
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.
Exception: PluginAccountNotConfiguredException
A required account is confirmed absent. Do not use this signal for authentication or retrieval failures.