StoryBeatResult

One story beat — a recap-worthy moment authored on a media item. Returned by GetStoryBeats() with importance decayed by how many choices have passed since playback.

public class StoryBeatResult

Inheritance System.Object → StoryBeatResult

Properties

At

Beat start time within the source media, in seconds.

public float At { get; }
Property Value

System.Single

Content

Resolved beat content text (locale-aware).

public string Content { get; }
Property Value

System.String

Description

Optional human-readable description (debug / authoring).

public string? Description { get; }
Property Value

System.String

End

Beat end time within the source media, in seconds.

public float End { get; }
Property Value

System.Single

File

Source filename (relative to the project’s media root).

public string File { get; }
Property Value

System.String

Importance

Effective importance (StoryBeatImportance) after decay — drives recap ordering / filtering.

public StoryBeatImportance Importance { get; }
Property Value

StoryBeatImportance

MediaId

Id of the parent Media definition.

public string MediaId { get; }
Property Value

System.String

PlayOrder

1-based play-order index within the current run. Lets hosts sort beats chronologically.

public int PlayOrder { get; }
Property Value

System.Int32

Title

Parent media’s title.

public string Title { get; }
Property Value

System.String

Docs last synced: 2026-07-08
Screenshot viewer