AudioCueView

Read-only view of an AudioCue definition — a structured audio program (music / ambience / sfx / voice) the host’s cue runner plays. Returned from AllAudioCues and GetAudioCue(string).

public class AudioCueView

Inheritance System.Object → AudioCueView

Properties

CustomLayer

Custom layer label when Layer is Custom.

public string? CustomLayer { get; }
Property Value

System.String

Description

Author description (UI / debug hint).

public string? Description { get; }
Property Value

System.String

Id

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

public string Id { get; }
Property Value

System.String

Layer

Audio layer (AudioLayer) — Music / Ambience / Sfx / Voice / Custom.

public AudioLayer Layer { get; }
Property Value

AudioLayer

PlayerIds

Multiplayer-only — seats that should hear this cue. Single-player projects: empty.

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

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

Segments

Ordered segments — one or more clips with scope rules deciding when each ends.

public IReadOnlyList<CueSegment> Segments { get; }
Property Value

System.Collections.Generic.IReadOnlyList<CueSegment>

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

Uuid

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

public string Uuid { get; }
Property Value

System.String

Docs last synced: 2026-07-08
Screenshot viewer