PcmSource

package com.socketsvc.api;

public interface PcmSource extends AutoCloseable { ... }

48 kHz, mono, signed 16-bit PCM. Called on a dedicated audio worker, never Bukkit's thread. Fill all 960 samples (20 ms); zero-pad the final partial frame. Return false at EOF. Reads must finish promptly and respond to interruption. Ownership transfers to play().

MethodsCopy Anchor Link

readFrameCopy Anchor Link

boolean readFrame(short[] samples) throws Exception

pendingFramesCopy Anchor Link

default int pendingFrames()

Whole frames already captured and waiting to be read, for a source backed by a real device; 0 for anything generated on demand, which by definition is never behind.

A caller that paces itself on a 20 ms timer needs this to tell "the device is keeping up" from "the device has a backlog". Reading one frame and then sleeping until the next tick carries a backlog forever rather than working it off, so whatever built up while the thread was descheduled becomes latency for as long as the source stays open.

closeCopy Anchor Link

default void close() throws Exception