AudioCueEvent

Playback cue for an authored audioCue event — a structured audio program (music / ambience / sfx / voice) of one or more segments with scope rules. Drives the host’s audio mixer / cue runner.

public class AudioCueEvent : EventBase

Inheritance System.Object → EventBase → AudioCueEvent

Properties

Cue

Hydrated reference to the cached AudioCueView at emission. Null when CueId doesn’t resolve.

public AudioCueView? Cue { get; }

Property Value

AudioCueView

CueId

Id of the authored AudioCue this event plays.

public string CueId { get; }

Property Value

System.String

CustomLayer

Custom layer label when Layer is Custom.

public string? CustomLayer { get; }

Property Value

System.String

Description

Cue description for authoring / debug surfaces (mirrors Cue.Description).

public string? Description { get; }

Property Value

System.String

Layer

Mixer layer (AudioLayer) the cue routes to — Music / Ambience / Sfx / Voice / Custom. Defaults to Music when Cue is unhydrated.

public AudioLayer Layer { get; }

Property Value

AudioLayer

PlayerIds

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

public IReadOnlyList<int> PlayerIds { get; }

Property Value

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

Segments

Ordered list of segments to play (mirrors Cue.Segments). Empty when Cue is unhydrated.

public IReadOnlyList<CueSegment> Segments { get; }

Property Value

System.Collections.Generic.IReadOnlyList<CueSegment>

Title

Cue display title (mirrors Cue.Title). Null when Cue is unhydrated.

public string? Title { get; }

Property Value

System.String

Methods

Accept(IEventQueueVisitor)

Dispatches to Visit(AudioCueEvent).

public override void Accept(IEventQueueVisitor visitor);

Parameters

visitor IEventQueueVisitor

Visitor to dispatch this event to.

Inherited Properties