StopAudioEvent

Command to stop in-progress audio on a specific layer. Issued by authored stopAudio events.

public class StopAudioEvent : EventBase

Inheritance System.Object → EventBase → StopAudioEvent

Properties

CustomLayer

Custom layer label when Layer is Custom.

public string? CustomLayer { get; }

Property Value

System.String

Layer

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

public AudioLayer Layer { get; }

Property Value

AudioLayer

PlayerIds

Multiplayer-only — which seats are affected. Single-player projects: empty.

public IReadOnlyList<int> PlayerIds { get; }

Property Value

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

Methods

Accept(IEventQueueVisitor)

Dispatches to Visit(StopAudioEvent).

public override void Accept(IEventQueueVisitor visitor);

Parameters

visitor IEventQueueVisitor

Visitor to dispatch this event to.

Inherited Properties