MediaView

Read-only view of a Media definition. Returned from AllMedia and GetMedia(string). Title is locale-resolved lazily.

public class MediaView

Inheritance System.Object → MediaView

Properties

BackgroundClips

Authored B-roll clips usable as ambient background between scenes.

public IReadOnlyList<BackgroundClipView> BackgroundClips { get; }
Property Value

System.Collections.Generic.IReadOnlyList<BackgroundClipView>

Captions

Authored caption track (locale-resolved at hydration).

public IReadOnlyList<MediaCaptionView> Captions { get; }
Property Value

System.Collections.Generic.IReadOnlyList<MediaCaptionView>

Description

Optional author description (UI hint / debug).

public string? Description { get; }
Property Value

System.String

Duration

Asset duration in seconds (null for images).

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

System.Nullable<System.Single>

Extension

File extension when authored separately from File.

public string? Extension { get; }
Property Value

System.String

File

Filename relative to the project’s media root.

public string File { get; }
Property Value

System.String

Id

Writer’s human-readable media id (e.g. media_intro_cinematic). Stable across runs; safe in expressions and analytics.

public string Id { get; }
Property Value

System.String

Linked

Secondary media tied to this one (e.g. alternate angles, picture-in-picture).

public IReadOnlyList<LinkedMediaView> Linked { get; }
Property Value

System.Collections.Generic.IReadOnlyList<LinkedMediaView>

PlayerIds

Multiplayer-only — seats that should see this media. Single-player projects: empty.

public IReadOnlyList<int> PlayerIds { get; }
Property Value

System.Collections.Generic.IReadOnlyList<System.Int32>

StoryBeats

Recap-worthy moments on this media — used by GetStoryBeats() after playback.

public IReadOnlyList<StoryBeatView> StoryBeats { get; }
Property Value

System.Collections.Generic.IReadOnlyList<StoryBeatView>

Title

Display title; resolves under the active locale on each access (lazy). Setter writes the raw source; the resolver (set at hydration) overlays/ICU-formats it.

public string Title { get; }
Property Value

System.String

Type

Kind of asset (MediaItemType) — Video / Image / Audio.

public MediaItemType Type { get; }
Property Value

MediaItemType

Uuid

Structural uuid — the universal cross-reference key. Use this when storing references to the media in host state.

public string Uuid { get; }
Property Value

System.String

Docs last synced: 2026-07-08
Screenshot viewer