SocketSvcProxyApi

package com.socketsvc.proxy.api;

public interface SocketSvcProxyApi { ... }

Addon API for the SocketSVC proxy relay plugin, on both Velocity and BungeeCord/Waterfall (the relay ships as one jar for both, and this is the same API on either).

The relay is a byte-level pipe: it reads the connecting player's uuid query parameter, picks a backend, and forwards bytes untouched. It never terminates the WebSocket handshake and never decodes audio. So this API covers routing and observation only — which backend a player is relayed to, and what the relay is doing. Anything about the voice itself (speakers, positions, per-player volume) lives on the backend's own SocketSvcApi / SocketSvcModApi, not here, and is documented as the spatial audio API.

Getting itCopy Anchor Link

Neither Velocity nor BungeeCord has a Bukkit-style services manager, so look it up statically:

SocketSvcProxyApi api = SocketSvcProxyApi.get();
if (api != null) api.addListener("my-addon", session -> ...);

It is null until the relay plugin has started, and null again once the proxy shuts down, so fetch it when you need it rather than caching it in a field. Depend on the -api jar with compileOnly; never shade it.

Registrations outlive reloadsCopy Anchor Link

Resolvers and listeners are held by the plugin, not by the relay listener, so /ssvc-proxy reload keeps them. Unregister on your own plugin's shutdown.

ConstantsCopy Anchor Link

MethodsCopy Anchor Link

getCopy Anchor Link

static SocketSvcProxyApi get()

The live API, or null before the relay plugin has started / after it has stopped.

registerCopy Anchor Link

static void register(SocketSvcProxyApi api)

Called by SocketSVC itself; not for addons.

isRunningCopy Anchor Link

boolean isRunning()

Whether the relay listener is currently accepting connections.

listenAddressCopy Anchor Link

InetSocketAddress listenAddress()

The single public address the relay is bound to, or null when it is not running.

activeRelaysCopy Anchor Link

int activeRelays()

Connections currently being relayed.

rejectedConnectionsCopy Anchor Link

long rejectedConnections()

Connections closed without being relayed since the listener started.

backendVoiceAddressesCopy Anchor Link

Map<String, InetSocketAddress> backendVoiceAddresses()

Immutable snapshot of the configured servers: map: proxy server name to backend voice address. Reflects the last successful config load, and does not include addresses a ProxyBackendResolver supplies at runtime.

setBackendResolverCopy Anchor Link

void setBackendResolver(String ownerId, ProxyBackendResolver resolver)

Registers a routing override, replacing any previous one from the same ownerId. Resolvers are consulted in registration order, before the configured map.

clearBackendResolverCopy Anchor Link

void clearBackendResolver(String ownerId)

Removes ownerId's routing override, if any.

addListenerCopy Anchor Link

void addListener(String ownerId, ProxyRelayListener listener)

Registers a lifecycle listener, replacing any previous one from the same ownerId.

removeListenerCopy Anchor Link

void removeListener(String ownerId)

Removes ownerId's listener, if any.

clearOwnerCopy Anchor Link

void clearOwner(String ownerId)

Removes everything ownerId registered. Call this from your plugin's shutdown.

reloadCopy Anchor Link

boolean reload()

Re-reads config.yml and restarts the relay listener, exactly as /ssvc-proxy reload does. Registered resolvers and listeners are kept. In-flight relayed connections are dropped; clients reconnect with their normal backoff.

Returns: whether the listener came back up; on failure the relay is left stopped and the reason is in the proxy log

isRelayingCopy Anchor Link

boolean isRelaying(UUID playerId)

Whether a connection claiming to be this player is currently being relayed. The claim is unverified - any client can send any player's id, and the backend may refuse it a moment later - so this is not proof the player is on voice; see RelaySession.

Nested typesCopy Anchor Link

• final class Registry