14.1 Beta 1 SDK
This reference documents the current beta SDK. Beta APIs can change before stable.
StorefrontGameMedia14.1 Beta
public sealed class Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameMedia
Describes one provider-hosted media asset for a game.
Remarks
Media, overlay, and sizing values are declarative. The host owns acquisition, validation, composition, destination selection, and duplicate policy.Constructors
StorefrontGameMedia 14.1 Beta
public StorefrontGameMedia(string mediaType, string url, string? name = null, string? sourceVideoCodec = null, bool isPreferred = false)Initializes a new instance of the Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameMedia class.
mediaType14.1 Beta- The public or provider-defined media type.
url14.1 Beta- The provider-supplied asset URL.
name14.1 Beta- An optional provider-supplied asset name.
sourceVideoCodec14.1 Beta- An optional source video codec identifier, such as Unbroken.LaunchBox.Plugins.Data.VideoCodecs.Av1 or Unbroken.LaunchBox.Plugins.Data.VideoCodecs.H264.
isPreferred14.1 Beta- Whether the provider prefers this asset among equivalent candidates.
Properties
public bool IsPreferred { get; }public string MediaType { get; }public string? Name { get; }public string? OverlayUrl { get; init; }public string? SourceVideoCodec { get; }public int? TargetHeight { get; init; }public int? TargetWidth { get; init; }public string Url { get; }
IsPreferred 14.1 Beta
public bool IsPreferred { get; }Gets whether the provider prefers this asset among equivalent candidates.
MediaType 14.1 Beta
public string MediaType { get; }Gets the public or provider-defined media type.
Name 14.1 Beta
public string? Name { get; }Gets the optional provider-supplied asset name.
OverlayUrl 14.1 Beta
public string? OverlayUrl { get; init; }Gets or initializes an optional overlay asset URL to compose over the primary asset.
SourceVideoCodec 14.1 Beta
public string? SourceVideoCodec { get; }
Gets the optional source video codec identifier, such as Unbroken.LaunchBox.Plugins.Data.VideoCodecs.Av1 or
Unbroken.LaunchBox.Plugins.Data.VideoCodecs.H264.
TargetHeight 14.1 Beta
public int? TargetHeight { get; init; }Gets or initializes the positive target height for materialization.
TargetWidth 14.1 Beta
public int? TargetWidth { get; init; }Gets or initializes the positive target width for materialization.
Url 14.1 Beta
public string Url { get; }Gets the provider-supplied asset URL.