Interface VoiceTransmitterService

public interface VoiceTransmitterService
Service managing point-to-point voice broadcast from transmitter players to specific receivers.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addReceiver(@NotNull UUID transmitter, @NotNull ReceiverConfig receiverConfig)
    Adds a configured receiver to a transmitter.
    void
    addReceiver(@NotNull UUID transmitter, @NotNull UUID receiver)
    Adds an infinite-range receiver to a transmitter by UUID.
    void
    addReceiver(@NotNull UUID transmitter, @NotNull UUID receiver, double maxDistance)
    Adds a distance-limited receiver to a transmitter by UUID.
    void
    addReceiver(@NotNull org.bukkit.entity.Player transmitter, @NotNull org.bukkit.entity.Player receiver)
    Adds an infinite-range receiver to a transmitter.
    void
    addReceiver(@NotNull org.bukkit.entity.Player transmitter, @NotNull org.bukkit.entity.Player receiver, double maxDistance)
    Adds a distance-limited receiver to a transmitter.
    void
    addReceiverToAll(@NotNull UUID receiver)
    Adds a receiver with infinite range to all active transmitters by UUID.
    void
    addReceiverToAll(@NotNull UUID receiver, double maxDistance)
    Adds a distance-limited receiver to all active transmitters by UUID.
    void
    addReceiverToAll(@NotNull org.bukkit.entity.Player receiver)
    Adds a receiver with infinite range to all active transmitters.
    void
    addReceiverToAll(@NotNull org.bukkit.entity.Player receiver, double maxDistance)
    Adds a distance-limited receiver to all active transmitters.
    void
    clearReceivers(@NotNull UUID transmitter)
    Clears all receivers from a transmitter by UUID.
    void
    clearReceivers(@NotNull org.bukkit.entity.Player transmitter)
    Clears all receivers from a transmitter.
    void
    createTransmitter(@NotNull UUID uuid)
    Enables transmitter mode for a player UUID.
    void
    createTransmitter(@NotNull org.bukkit.entity.Player player)
    Enables transmitter mode for a player.
    @NotNull de.maxhenkel.voicechat.api.VoicechatServerApi
    getAPI()
    Gets the underlying VoicechatServerApi instance.
    @NotNull Collection<ReceiverConfig>
    getReceivers(@NotNull UUID uuid)
    Retrieves all configured receivers for a transmitter UUID.
    @NotNull Collection<ReceiverConfig>
    getReceivers(@NotNull org.bukkit.entity.Player player)
    Retrieves all configured receivers for a transmitter player.
    void
    init(@NotNull de.maxhenkel.voicechat.api.VoicechatServerApi api)
    Initializes the transmitter service with the Simple Voice Chat server API.
    boolean
    isTransmitter(@NotNull UUID uuid)
    Checks whether a player UUID is in transmitter mode.
    boolean
    isTransmitter(@NotNull org.bukkit.entity.Player player)
    Checks whether a player is in transmitter mode.
    void
    load()
    Reloads saved transmitters from disk.
    void
    removeReceiver(@NotNull UUID transmitter, @NotNull UUID receiver)
    Removes a receiver from a transmitter by UUID.
    void
    removeReceiver(@NotNull org.bukkit.entity.Player transmitter, @NotNull org.bukkit.entity.Player receiver)
    Removes a receiver from a transmitter.
    void
    removeReceiverFromAll(@NotNull UUID receiver)
    Removes a receiver from all active transmitters by UUID.
    void
    removeReceiverFromAll(@NotNull org.bukkit.entity.Player receiver)
    Removes a receiver from all active transmitters.
    void
    removeTransmitter(@NotNull UUID uuid)
    Disables transmitter mode for a player UUID.
    void
    removeTransmitter(@NotNull org.bukkit.entity.Player player)
    Disables transmitter mode for a player.
    void
    save()
    Saves all active transmitters to disk.

  • Method Details

    • getAPI

      @NotNull @NotNull de.maxhenkel.voicechat.api.VoicechatServerApi getAPI()
      Gets the underlying VoicechatServerApi instance.
      Returns:
      the active API instance

    • init

      void init(@NotNull @NotNull de.maxhenkel.voicechat.api.VoicechatServerApi api)
      Initializes the transmitter service with the Simple Voice Chat server API.
      Parameters:
      api - the VoicechatServerApi instance

    • isTransmitter

      boolean isTransmitter(@NotNull @NotNull org.bukkit.entity.Player player)
      Checks whether a player is in transmitter mode.
      Parameters:
      player - the player
      Returns:
      true if transmitter enabled

    • isTransmitter

      boolean isTransmitter(@NotNull @NotNull UUID uuid)
      Checks whether a player UUID is in transmitter mode.
      Parameters:
      uuid - the player UUID
      Returns:
      true if transmitter enabled

    • createTransmitter

      void createTransmitter(@NotNull @NotNull org.bukkit.entity.Player player)
      Enables transmitter mode for a player.
      Parameters:
      player - the player

    • createTransmitter

      void createTransmitter(@NotNull @NotNull UUID uuid)
      Enables transmitter mode for a player UUID.
      Parameters:
      uuid - the player UUID

    • removeTransmitter

      void removeTransmitter(@NotNull @NotNull org.bukkit.entity.Player player)
      Disables transmitter mode for a player.
      Parameters:
      player - the player

    • removeTransmitter

      void removeTransmitter(@NotNull @NotNull UUID uuid)
      Disables transmitter mode for a player UUID.
      Parameters:
      uuid - the player UUID

    • getReceivers

      @NotNull @NotNull Collection<ReceiverConfig> getReceivers(@NotNull @NotNull org.bukkit.entity.Player player)
      Retrieves all configured receivers for a transmitter player.
      Parameters:
      player - the transmitter player
      Returns:
      collection of ReceiverConfigs

    • getReceivers

      @NotNull @NotNull Collection<ReceiverConfig> getReceivers(@NotNull @NotNull UUID uuid)
      Retrieves all configured receivers for a transmitter UUID.
      Parameters:
      uuid - the transmitter UUID
      Returns:
      collection of ReceiverConfigs

    • addReceiver

      void addReceiver(@NotNull @NotNull org.bukkit.entity.Player transmitter, @NotNull @NotNull org.bukkit.entity.Player receiver)
      Adds an infinite-range receiver to a transmitter.
      Parameters:
      transmitter - the transmitter player
      receiver - the receiver player

    • addReceiver

      void addReceiver(@NotNull @NotNull UUID transmitter, @NotNull @NotNull UUID receiver)
      Adds an infinite-range receiver to a transmitter by UUID.
      Parameters:
      transmitter - the transmitter UUID
      receiver - the receiver UUID

    • addReceiver

      void addReceiver(@NotNull @NotNull org.bukkit.entity.Player transmitter, @NotNull @NotNull org.bukkit.entity.Player receiver, double maxDistance)
      Adds a distance-limited receiver to a transmitter.
      Parameters:
      transmitter - the transmitter player
      receiver - the receiver player
      maxDistance - maximum hearing range in blocks

    • addReceiver

      void addReceiver(@NotNull @NotNull UUID transmitter, @NotNull @NotNull UUID receiver, double maxDistance)
      Adds a distance-limited receiver to a transmitter by UUID.
      Parameters:
      transmitter - the transmitter UUID
      receiver - the receiver UUID
      maxDistance - maximum hearing range in blocks

    • addReceiver

      void addReceiver(@NotNull @NotNull UUID transmitter, @NotNull @NotNull ReceiverConfig receiverConfig)
      Adds a configured receiver to a transmitter.
      Parameters:
      transmitter - the transmitter UUID
      receiverConfig - the receiver configuration

    • removeReceiver

      void removeReceiver(@NotNull @NotNull org.bukkit.entity.Player transmitter, @NotNull @NotNull org.bukkit.entity.Player receiver)
      Removes a receiver from a transmitter.
      Parameters:
      transmitter - the transmitter player
      receiver - the receiver player

    • removeReceiver

      void removeReceiver(@NotNull @NotNull UUID transmitter, @NotNull @NotNull UUID receiver)
      Removes a receiver from a transmitter by UUID.
      Parameters:
      transmitter - the transmitter UUID
      receiver - the receiver UUID

    • clearReceivers

      void clearReceivers(@NotNull @NotNull org.bukkit.entity.Player transmitter)
      Clears all receivers from a transmitter.
      Parameters:
      transmitter - the transmitter player

    • clearReceivers

      void clearReceivers(@NotNull @NotNull UUID transmitter)
      Clears all receivers from a transmitter by UUID.
      Parameters:
      transmitter - the transmitter UUID

    • addReceiverToAll

      void addReceiverToAll(@NotNull @NotNull org.bukkit.entity.Player receiver)
      Adds a receiver with infinite range to all active transmitters.
      Parameters:
      receiver - the receiver player

    • addReceiverToAll

      void addReceiverToAll(@NotNull @NotNull UUID receiver)
      Adds a receiver with infinite range to all active transmitters by UUID.
      Parameters:
      receiver - the receiver UUID

    • addReceiverToAll

      void addReceiverToAll(@NotNull @NotNull org.bukkit.entity.Player receiver, double maxDistance)
      Adds a distance-limited receiver to all active transmitters.
      Parameters:
      receiver - the receiver player
      maxDistance - maximum hearing range

    • addReceiverToAll

      void addReceiverToAll(@NotNull @NotNull UUID receiver, double maxDistance)
      Adds a distance-limited receiver to all active transmitters by UUID.
      Parameters:
      receiver - the receiver UUID
      maxDistance - maximum hearing range

    • removeReceiverFromAll

      void removeReceiverFromAll(@NotNull @NotNull org.bukkit.entity.Player receiver)
      Removes a receiver from all active transmitters.
      Parameters:
      receiver - the receiver player

    • removeReceiverFromAll

      void removeReceiverFromAll(@NotNull @NotNull UUID receiver)
      Removes a receiver from all active transmitters by UUID.
      Parameters:
      receiver - the receiver UUID

    • save

      void save()
      Saves all active transmitters to disk.

    • load

      void load()
      Reloads saved transmitters from disk.