SocketSvcApi

package com.socketsvc.api;

public interface SocketSvcApi { ... }

Obtain with Bukkit ServicesManager.load(SocketSvcApi.class); use compileOnly, never shade this API.

ConstantsCopy Anchor Link

MethodsCopy Anchor Link

createLocationalChannelCopy Anchor Link

LocationalAudioChannel createLocationalChannel(Plugin owner, SpatialPosition position, SpatialSettings settings)

Call on Bukkit's main thread with an enabled owner. Maximum 32 live channels server-wide. Owner disable automatically closes its channels.

createLocationalChannelCopy Anchor Link

default LocationalAudioChannel createLocationalChannel(Plugin owner, UUID id, String name, SpatialPosition position, SpatialSettings settings)

Define a named speaker. Persist a globally unique UUID to retain client volume across restarts. Names are plain text, 1..64 characters; duplicate live IDs are rejected.

supportsSpatialAudioCopy Anchor Link

boolean supportsSpatialAudio(UUID player)

Whether this connected player negotiated spatial audio support.

isVoiceGroupsEnabledCopy Anchor Link

default boolean isVoiceGroupsEnabled()

Whether the operator has switched voice groups on.

voiceGroupsCopy Anchor Link

default java.util.List<VoiceGroupInfo> voiceGroups()

Every live group, ordered by name. Empty while groups are disabled.

voiceGroupOfCopy Anchor Link

default VoiceGroupInfo voiceGroupOf(UUID player)

The group player is in, or null.

voiceGroupCopy Anchor Link

default VoiceGroupInfo voiceGroup(UUID groupId)

One group by id, or null if it has been disbanded.

createVoiceGroupCopy Anchor Link

default UUID createVoiceGroup(String name, String password, VoiceGroupType type)

Creates a group with no members.

Created groups are persistent, because a group with nobody in it and no persistence would be disbanded the instant it was made. The per-player policy switches (allow-player-created, allow-passwords, allow-persistent) do not apply here: they exist to restrain players, and an addon is the operator's own code.

Returns: the new group's id, or null if it was refused (name taken, invalid, or the server is already at groups.max-groups)

addToVoiceGroupCopy Anchor Link

default boolean addToVoiceGroup(UUID player, UUID groupId)

Puts player in groupId without asking for its password, leaving whichever group they were in. False if the group is gone or full.

removeFromVoiceGroupCopy Anchor Link

default boolean removeFromVoiceGroup(UUID player)

Takes player out of whatever group they are in. False if they were in none.

removeVoiceGroupCopy Anchor Link

default boolean removeVoiceGroup(UUID groupId)

Disbands a group, whoever is in it. False if it was already gone.

setVoiceGroupTypeCopy Anchor Link

default boolean setVoiceGroupType(UUID groupId, VoiceGroupType type)

Changes a live group's type; audible immediately, on the next relayed frame.

isVoiceMutedCopy Anchor Link

default boolean isVoiceMuted(UUID player)

Whether player may not talk right now, for any reason - an individual mute or the server-wide one they are not exempt from. This is the question a chat or moderation addon actually wants; #voiceMute answers the narrower one.

voiceMuteCopy Anchor Link

default VoiceMuteInfo voiceMute(UUID player)

The individual mute against player, or null - including when they are silenced only by the server-wide mute.

voiceMutesCopy Anchor Link

default java.util.List<VoiceMuteInfo> voiceMutes()

Every individual mute, longest-standing first.

muteVoiceCopy Anchor Link

default boolean muteVoice(UUID player, long durationMillis, String reason, String moderator)

Mutes player, replacing any mute already against them.

Returns: whether anything changed. False when the player already held exactly this mute, or when they hold socketsvc.mute.exempt

unmuteVoiceCopy Anchor Link

default boolean unmuteVoice(UUID player)

Lifts an individual mute. False if there was none. Does not touch the server-wide mute.

isEveryoneVoiceMutedCopy Anchor Link

default boolean isEveryoneVoiceMuted()

Whether everybody without socketsvc.mute.exempt is currently silenced.

setEveryoneVoiceMutedCopy Anchor Link

default boolean setEveryoneVoiceMuted(boolean muted)

Silences, or stops silencing, everybody without socketsvc.mute.exempt.

Returns: whether this changed anything

voiceClientStateCopy Anchor Link

default VoiceClientState voiceClientState(UUID player)

Whether player is running the SocketSVC client mod.

Answered from plugin-channel registration - the same question SocketSVC already asks before it sends that player a handshake - and deliberately not from whether they have a live voice session, which also depends on the voice port being reachable from where they are.

Three states, because for a moment after somebody joins the honest answer is that nobody knows yet: see VoiceClientState. An addon that acts on ABSENT should say what it does about UNKNOWN rather than treating it as a no.

hasVoiceClientCopy Anchor Link

default boolean hasVoiceClient(UUID player)

#voiceClientState collapsed to the one state most callers want. false for a player nobody has heard from yet, so do not use this to decide whether to refuse somebody - voiceClientState is the one that can tell "no" from "not yet".

requiresVoiceClientCopy Anchor Link

default boolean requiresVoiceClient()

Whether this server refuses players without the client mod (require-client.enabled). Off unless an operator switched it on.

isMicrophoneTapEnabledCopy Anchor Link

default boolean isMicrophoneTapEnabled()

Whether the operator has switched microphone taps on (microphone-tap.enabled). Check this once and hide your own feature rather than letting #subscribeMicrophone throw.

subscribeMicrophoneCopy Anchor Link

default MicrophoneTapHandle subscribeMicrophone(Plugin owner, MicrophoneTap.Format format, MicrophoneTap tap)

Receives every microphone frame from every player who holds socketsvc.bridge, until the returned handle is closed.

Audio arrives on the relay's network thread, 50 times a second per talking player. Do not block in the callback and do not touch Bukkit's world or entity state from it.

SocketSVC closes the subscription when owner is disabled and when the server stops, so a plugin that taps for its whole lifetime can discard the handle.

Throws IllegalStateException: when microphone-tap.enabled is false, the owner is disabled, or the server already has the maximum number of subscriptions. The message says which

canTapMicrophoneCopy Anchor Link

default boolean canTapMicrophone(UUID player)

Whether player's microphone may currently reach a tap - the socketsvc.bridge check the relay itself applies, so a plugin can tell a player why it is not hearing them.