Skip to content
Version 2.32.0
↓ Get the launcher

IVoiceSource interface

One independent voice in the uplink mixer. Not thread-safe for concurrent mutation by the caller.

public interface IVoiceSource : IDisposable
name description
Clip { get; set; } The clip to play. Assigning a new clip rewinds to the start and stops playback.
Loop { get; set; } Loop the clip instead of stopping at the end.
Playing { get; } True while this source is actively mixing. Goes false on Stop or at clip end (no loop).
Position { get; } Current playback position within the clip.
Volume { get; set; } Linear gain, 0..2 (1 = unity). Clamped. Mixing is additive-saturating against the live mic.
Play() Start (or restart) playback of the assigned clip from the beginning.
PlayOnce(…) Convenience one-shot: assign the clip, clear Loop, and play from the start.
Stop() Stop playback. Position is retained; Play restarts from the beginning.