Package de.maxhenkel.voicechat.api

Interface VoicechatClientApi

All Superinterfaces:
VoicechatApi
public interface VoicechatClientApi extends VoicechatApi

  • Method Details

    • isMuted

      boolean isMuted()
      Returns:
      if the local voice chat is muted

    • isDisabled

      default boolean isDisabled()
      Does the same as isDisabled(UUID) with null as the player UUID.
      Returns:
      if the local voice chat is disabled

    • isDisabled

      boolean isDisabled(@Nullable UUID playerId)
      Parameters:
      playerId - the UUID of the player or null for the local player
      Returns:
      if the player with the provided UUID has the voice chat disabled

    • isDisconnected

      default boolean isDisconnected()
      Does the same as isDisconnected(UUID) with null as the player UUID.
      Returns:
      if the voice chat is disconnected from the server

    • isDisconnected

      boolean isDisconnected(@Nullable UUID playerId)
      Parameters:
      playerId - the UUID of the player or null for the local player
      Returns:
      if the player with the provided UUID is disconnected from voice chat

    • isTalking

      default boolean isTalking()
      Does the same as isTalking(UUID) with null as the player UUID.
      Returns:
      if the local player is talking

    • isTalking

      boolean isTalking(@Nullable UUID playerId)
      Parameters:
      playerId - the UUID of the player or null for the local player
      Returns:
      if the player with the provided UUID is currently talking

    • isWhispering

      default boolean isWhispering()
      Does the same as isWhispering(UUID) with null as the player UUID.
      Returns:
      if the local player is whispering

    • isWhispering

      boolean isWhispering(@Nullable UUID playerId)
      Parameters:
      playerId - the UUID of the player or null for the local player
      Returns:
      if the player with the provided UUID is currently whispering

    • isPushToTalkKeyPressed

      boolean isPushToTalkKeyPressed()
      This method returns if the push to talk key is pressed, even when using voice activation.
      Returns:
      if the push to talk key is pressed

    • isWhisperKeyPressed

      boolean isWhisperKeyPressed()
      Returns:
      if the whisper key is pressed

    • getGroup

      @Nullable Group getGroup()

    • createEntityAudioChannel

      @Deprecated ClientEntityAudioChannel createEntityAudioChannel(UUID uuid)
      Deprecated.
      use createEntityAudioChannel(UUID, Entity)
      Creates a client side entity audio channel.
      Parameters:
      uuid - the UUID of the entity
      Returns:
      the audio channel

    • createEntityAudioChannel

      ClientEntityAudioChannel createEntityAudioChannel(UUID uuid, Entity entity)
      Creates a client side entity audio channel.
      Parameters:
      uuid - the UUID of the entity
      entity - the entity
      Returns:
      the audio channel

    • createLocationalAudioChannel

      ClientLocationalAudioChannel createLocationalAudioChannel(UUID uuid, Position position)
      Creates a client side locational audio channel.
      Parameters:
      uuid - the ID of the channel
      Returns:
      the audio channel

    • createStaticAudioChannel

      ClientStaticAudioChannel createStaticAudioChannel(UUID uuid)
      Creates a client side static audio channel.
      Parameters:
      uuid - the ID of the channel
      Returns:
      the audio channel

    • registerClientVolumeCategory

      void registerClientVolumeCategory(VolumeCategory category)
      Registers a volume category just for this client. A category can be created with VoicechatApi.volumeCategoryBuilder(). The category can be unregistered with unregisterClientVolumeCategory(de.maxhenkel.voicechat.api.VolumeCategory).
      Parameters:
      category - the category to register

    • unregisterClientVolumeCategory

      default void unregisterClientVolumeCategory(VolumeCategory category)
      Unregisters a category on this client. This will release the texture ID for the icon if one exists.
      Parameters:
      category - the category to remove

    • unregisterClientVolumeCategory

      void unregisterClientVolumeCategory(String categoryId)
      Unregisters a category on this client. This will release the texture ID for the icon if one exists.
      Parameters:
      categoryId - the category ID to remove

    • getClientConfig

      ConfigAccessor getClientConfig()
      Returns:
      a read-only config accessor for the mods client config