LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

GameMedia14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.GameData.GameMedia
Describes one downloadable asset. Values are declarative; LaunchBox owns acquisition, composition, destination, and duplicate policy.

Constructors

GameMedia 14.1 Beta

C#
public GameMedia(string mediaType, string url)
Creates a media candidate.
mediaType 14.1 Beta
The LaunchBox image or video type this asset should be saved as.
url 14.1 Beta
The absolute asset URL.

Properties

Crc32 14.1 Beta

C#
public uint? Crc32 { get; init; }
Gets or initializes the CRC-32 of the asset content, used to skip files LaunchBox already has.

IsPreferred 14.1 Beta

C#
public bool IsPreferred { get; init; }
Gets or initializes whether the source prefers this asset among equivalents of the same media type.

MediaType 14.1 Beta

C#
public string MediaType { get; }
Gets the LaunchBox media type.

Name 14.1 Beta

C#
public string? Name { get; init; }
Gets or initializes a source-defined variant name, such as a quality tier.

OverlayUrl 14.1 Beta

C#
public string? OverlayUrl { get; init; }
Gets or initializes an overlay asset URL to compose over the primary asset.

Region 14.1 Beta

C#
public string? Region { get; init; }
Gets or initializes the region the asset applies to.

SourceVideoCodec 14.1 Beta

C#
public string? SourceVideoCodec { get; init; }
Gets or initializes the source video codec identifier.

TargetHeight 14.1 Beta

C#
public int? TargetHeight { get; init; }
Gets or initializes the positive target height for composition.

TargetWidth 14.1 Beta

C#
public int? TargetWidth { get; init; }
Gets or initializes the positive target width for composition.

Url 14.1 Beta

C#
public string Url { get; }
Gets the asset URL.