Interface VolumeConfigAccessor

public interface VolumeConfigAccessor
An interface to access client side adjusted volumes.
Can be obtained by calling VoicechatClientApi.getVolumeConfig().

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getCategoryVolume(String category)
    Gets the volume of a category by its UUID.
    double
    getVolume(UUID uuid)
    Gets the volume of a player by its UUID.

  • Method Details

    • getVolume

      double getVolume(UUID uuid)
      Gets the volume of a player by its UUID.

      This will always return a value, even if the player is not in the volume config.
      By default, the volume will be 1.0. A volume of 0.0 means this player is muted. Can be larger than 1.0. Also works for players that are not online.

      If you want the Other volume (All volumes that are not covered by categories or players), use the UUID 00000000-0000-0000-0000-000000000000.
      Parameters:
      uuid - the UUID of the player
      Returns:
      the volume of the player
      Throws:
      NullPointerException - if the UUID is null

    • getCategoryVolume

      double getCategoryVolume(String category)
      Gets the volume of a category by its UUID.

      This will always return a value, even if the category doesn't exist.
      By default, the volume will be 1.0. A volume of 0.0 means this category is muted. Can be larger than 1.0. Also works for categories that are currently not registered.
      Parameters:
      category - the category
      Returns:
      the volume of the category
      Throws:
      NullPointerException - if the category is null