BackgroundAudioResult

One audio media asset flagged as eligible to play as a background / menu loop track. Returned by GetAllBackgroundAudio().

public class BackgroundAudioResult

Inheritance System.Object → BackgroundAudioResult

Properties

Duration

Asset duration in seconds (null when unknown).

public Nullable<float> Duration { get; }
Property Value

System.Nullable<System.Single>

Extension

Optional file extension when authored separately from File (mirrors Media.Extension).

public string? Extension { get; }
Property Value

System.String

File

Source filename (relative to the project’s media root, in the audio/ subfolder).

public string File { get; }
Property Value

System.String

MediaId

Id of the parent Media definition.

public string MediaId { get; }
Property Value

System.String

Title

Parent media’s raw source title (not locale-resolved). Call GetMedia(string) with MediaId if you need the active-locale display title.

public string Title { get; }
Property Value

System.String

Docs last synced: 2026-07-08
Screenshot viewer