PeekResult

Result of PeekMedia() — the media assets the runtime’s currently visible choices would play, split by kind so each list can be handed to the appropriate prewarmer. Call this immediately after GetChoices() (or after any operation that may have changed the visible-choice set) to give the engine’s video/audio pipelines a head start on decoding. Lists are deduplicated by asset id; prewarming each entry exactly once is safe. Empty when no visible choice plays media.

public class PeekResult

Inheritance System.Object → PeekResult

Example

var peek = runtime.PeekMedia();
foreach (var video in peek.Video) myVideoPlayer.Prewarm(video.File);
foreach (var audio in peek.Audio) myAudioMixer.Prewarm(audio.File);

Properties

Audio

Deduplicated audio PeekMedia entries whose effective start falls within the first 3 seconds of the choice.

public IReadOnlyList<PeekMedia> Audio { get; }
Property Value

System.Collections.Generic.IReadOnlyList<PeekMedia>

Video

Deduplicated video / image PeekMedia entries the current choices would play (each choice’s first sequence).

public IReadOnlyList<PeekMedia> Video { get; }
Property Value

System.Collections.Generic.IReadOnlyList<PeekMedia>

Docs last synced: 2026-07-08
Screenshot viewer