Simple Voice Chat API

https://voicechat.modrepo.de
Admin
Simple Voice Chat API is a Minecraft mod API that provides voice communication functionality with...
Tokens:67,386
Snippets:1,206
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### startPlaying()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/audiochannel/AudioPlayer.html

Starts playing/streaming the audio.

```APIDOC
## startPlaying()

### Description
Starts playing/streaming the audio.

### Method
`void startPlaying()`

### Parameters
None

### Returns
None

```

--------------------------------

### isStarted()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/audiochannel/AudioPlayer.html

Checks if the player has been started.

```APIDOC
## isStarted()

### Description
Returns whether the player has been started.

### Method
`boolean isStarted()`

### Parameters
None

### Returns
- `boolean` - `true` if the player has been started, `false` otherwise.

```

--------------------------------

### isInstalled()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatConnection.html

Returns whether the player has a compatible version of voice chat installed.

```APIDOC
## isInstalled()

### Description
Returns whether the player has a compatible version of voice chat installed.

### Method
`boolean isInstalled()`

### Returns
- `boolean` - `true` if the player has a compatible version installed, `false` otherwise.
```

--------------------------------

### getSocketImplementation() - VoicechatServerStartingEvent

Source: https://voicechat.modrepo.de/index-all.html

Retrieves the socket implementation from the server starting event.

```APIDOC
## getSocketImplementation()

### Description
Returns the socket implementation used by the voicechat server.

### Method
GET

### Interface
de.maxhenkel.voicechat.api.events.VoicechatServerStartingEvent

### Returns
- **SocketImplementation** - The socket implementation.
```

--------------------------------

### getString(String, String) - ConfigAccessor

Source: https://voicechat.modrepo.de/index-all.html

Gets the string value of a given key from the configuration.

```APIDOC
## getString(String key, String defaultValue)

### Description
Gets the string value of the given key from the configuration.

### Method
GET

### Interface
de.maxhenkel.voicechat.api.config.ConfigAccessor

### Parameters
- **key** (String) - Required - The configuration key.
- **defaultValue** (String) - Required - The default value if the key is not found.

### Returns
- **String** - The string value.
```

--------------------------------

### getGroup

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatServerApi.html

Gets a group by its ID.

```APIDOC
## getGroup

### Description
Gets a group by its ID.

### Method
getGroup

### Parameters
- **groupId** (UUID) - Required - the ID of the group

### Returns
- **Group** - the group or `null` if the group doesn't exist
```

--------------------------------

### open(int port, String bindAddress)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatSocket.html

Opens the socket on the specified port and bind address. Throws an exception if the operation fails.

```APIDOC
## open(int port, String bindAddress)

### Description
Opens the socket on the specified port and bind address.

### Method
`void open(int port, String bindAddress)`

### Parameters
- **port** (int) - Required - The port to bind to.
- **bindAddress** (String) - Required - The address to bind to.

### Throws
- `Exception` - If the socket cannot be opened.

```

--------------------------------

### getConnectionOf(ServerPlayer)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatServerApi.html

Gets the connection of the player.

```APIDOC
## getConnectionOf

### Description
Gets the connection of the player.

### Method
getConnectionOf

### Parameters
- **player** (ServerPlayer) - Required - the player

### Returns
- **VoicechatConnection** - the connection or `null` if the player is not connected
```

--------------------------------

### initialize(VoicechatApi api)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatPlugin.html

Called after loading the plugin. Provides the VoicechatApi instance for plugin initialization.

```APIDOC
## initialize(VoicechatApi api)

### Description
Called after loading the plugin. Provides the VoicechatApi instance for plugin initialization.

### Method
`default void initialize(VoicechatApi api)`

### Parameters
- **api** (VoicechatApi) - The Voicechat API instance.

```

--------------------------------

### getGroup(UUID) - VoicechatServerApi

Source: https://voicechat.modrepo.de/index-all.html

Gets a group by its ID.

```APIDOC
## GET getGroup(UUID)

### Description
Gets a group by its ID.

### Method
GET

### Interface
VoicechatServerApi

### Parameters
#### Path Parameters
- **uuid** (UUID) - Required - The UUID of the group
```

--------------------------------

### build()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/packets/SoundPacket.Builder.html

Builds the sound packet. Throws IllegalStateException if required values are missing.

```APIDOC
## build()

### Description
Builds the packet. If you are missing required values, this will throw an `IllegalStateException`.

### Method
`P build()`

### Returns
The built packet (`P`).
```

--------------------------------

### getConnectionOf(UUID)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatServerApi.html

Gets the connection of the player with this UUID.

```APIDOC
## getConnectionOf

### Description
Gets the connection of the player with this UUID.

### Method
getConnectionOf

### Parameters
- **playerUuid** (UUID) - Required - the players UUID

### Returns
- **VoicechatConnection** - the connection or `null` if the player is not connected
```

--------------------------------

### open() methods

Source: https://voicechat.modrepo.de/index-all.html

Documentation for the open() methods in the ClientVoicechatSocket and VoicechatSocket interfaces.

```APIDOC
## [METHOD] open()

### Description
Method in interface `de.maxhenkel.voicechat.api.ClientVoicechatSocket`.

### Method
`open()`

### Interface
`de.maxhenkel.voicechat.api.ClientVoicechatSocket`

```

```APIDOC
## [METHOD] open(int, String)

### Description
Method in interface `de.maxhenkel.voicechat.api.VoicechatSocket`.

### Method
`open(int, String)`

### Interface
`de.maxhenkel.voicechat.api.VoicechatSocket`

```

--------------------------------

### open()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/ClientVoicechatSocket.html

Opens the socket. Throws an exception if the operation fails.

```APIDOC
## open()

### Description
Opens the socket.

### Method
open

### Signature
`void open() throws Exception`

### Throws
- `Exception` - if the operation fails

```

--------------------------------

### NameTagIconRenderEvent

Source: https://voicechat.modrepo.de/index-all.html

Documentation for the NameTagIconRenderEvent interface, which is emitted when an icon is getting rendered.

```APIDOC
## [EVENT] NameTagIconRenderEvent

### Description
This event is emitted when an icon is getting rendered.

### Event
NameTagIconRenderEvent

### Interface
`de.maxhenkel.voicechat.api.events.NameTagIconRenderEvent`

```

--------------------------------

### createStaticAudioChannel

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatClientApi.html

Creates a client-side static audio channel.

```APIDOC
## ClientStaticAudioChannel createStaticAudioChannel(UUID uuid)

### Description
Creates a client-side static audio channel.

### Parameters
- **uuid** (UUID) - Required - The ID of the channel.

### Returns
- **ClientStaticAudioChannel** - The audio channel.
```

--------------------------------

### getSecret

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatServerApi.html

Gets the secret for the user with this `userId`. Deprecated. this will just return `null`.

```APIDOC
## getSecret

### Description
Gets the secret for the user with this `userId`. Deprecated. this will just return `null`.

### Method
getSecret

### Parameters
- **userId** (UUID) - Required - the user ID

### Returns
- **UUID** - the secret or `null` if no server is running
```

--------------------------------

### getCategoryVolume(String category)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/config/VolumeConfigAccessor.html

Method to get the volume of a category by its name.

```APIDOC
## getCategoryVolume(String category)

### Description
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.

### Method
`double getCategoryVolume(String category)`

### Parameters
- `category` (String) - Required - The category

### Returns
- `double` - The volume of the category

### Throws
- `NullPointerException` - if the category is null
```

--------------------------------

### ConfigAccessor Interface

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/config/ConfigAccessor.html

Documentation for the ConfigAccessor interface, including all its methods with parameters, return types, and exceptions.

```APIDOC
## ConfigAccessor Interface

### Description
An interface to access a config. This is kept very generic, so it can be used for any config type. This contains a few default methods to get primitive values from the config. **NOTE**: You need to implement more complex values yourself (e.g. enums). Can be obtained by calling `VoicechatServerApi.getServerConfig()` or `VoicechatClientApi.getClientConfig()`.

### Methods

#### hasKey

```java
boolean hasKey(String key)
```

Checks if the config has the given key.

**Parameters:**
- `key` (String) - the key

**Returns:**
- `true` if the config has the key, `false` otherwise

#### getValue

```java
@Nullable String getValue(String key)
```

Gets the raw value of the given key. **NOTE**: This gets the _raw_ value from the config, so it will be a `String` even if the value is a number, a boolean or an enum.

**Parameters:**
- `key` (String) - the key

**Returns:**
- the value or `null` if the key doesn't exist

#### getString

```java
default String getString(String key, String def)
```

Gets the string value of the given key.

**Parameters:**
- `key` (String) - the key
- `def` (String) - the default value

**Returns:**
- the value or the default value if the key doesn't exist

#### getBoolean

```java
default boolean getBoolean(String key, boolean def)
```

Gets the boolean value of the given key.

**Parameters:**
- `key` (String) - the key
- `def` (boolean) - the default value

**Returns:**
- the boolean value, `false` if the value is not `"true"` or the default value if the key doesn't exist

#### getInt

```java
default int getInt(String key, int def)
```

Gets the integer value of the given key.

**Parameters:**
- `key` (String) - the key
- `def` (int) - the default value

**Returns:**
- the value or the default value if the key doesn't exist

**Throws:**
- `NumberFormatException` - if the value is not an integer

#### getDouble

```java
default double getDouble(String key, double def)
```

Gets the double value of the given key.

**Parameters:**
- `key` (String) - the key
- `def` (double) - the default value

**Returns:**
- the value or the default value if the key doesn't exist

**Throws:**
- `NumberFormatException` - if the value is not a double
```

--------------------------------

### createAudioPlayer(AudioChannel, OpusEncoder, short[])

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatServerApi.html

Creates a new audio player with the given audio channel, encoder, and initial audio data.

```APIDOC
## [CREATE] createAudioPlayer(AudioChannel, OpusEncoder, short[])

### Description
Creates a new audio player.

### Method
CREATE

### Parameters
#### Parameters
- **audioChannel** (AudioChannel) - The audio channel to play audio on
- **encoder** (OpusEncoder) - The Opus encoder to use
- **audio** (short[]) - The initial audio data

### Returns
AudioPlayer - The created audio player
```

--------------------------------

### getVolume(UUID uuid)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/config/VolumeConfigAccessor.html

Method to get the volume of a player by UUID.

```APIDOC
## getVolume(UUID uuid)

### Description
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`.

### Method
`double getVolume(UUID uuid)`

### Parameters
- `uuid` (UUID) - Required - The UUID of the player

### Returns
- `double` - The volume of the player

### Throws
- `NullPointerException` - if the UUID is null
```

--------------------------------

### createMp3Decoder(InputStream inputStream)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatApi.html

Creates a new MP3 decoder. Not available for Bukkit; always returns null.

```APIDOC
## createMp3Decoder(InputStream inputStream)

### Description
Creates a new MP3 decoder. **NOTE**: This is not available for Bukkit! It will always return null.

### Parameters
- `inputStream` (InputStream) - the input stream to read the mp3 from

### Returns
Mp3Decoder - the mp3 decoder or null if the decoder could not be initialized or is not available
```

--------------------------------

### VoicechatServerStartingEvent - Interface in de.maxhenkel.voicechat.api.events

Source: https://voicechat.modrepo.de/index-all.html

Event emitted when the voice chat server is starting.

```APIDOC
## VoicechatServerStartingEvent

### Description
Event emitted when the voice chat server is starting.

```

--------------------------------

### VoicechatServerStartedEvent - Interface in de.maxhenkel.voicechat.api.events

Source: https://voicechat.modrepo.de/index-all.html

Event emitted when the voice chat server has started.

```APIDOC
## VoicechatServerStartedEvent

### Description
Event emitted when the voice chat server has started.

```

--------------------------------

### getServerConfig() - VoicechatServerApi

Source: https://voicechat.modrepo.de/index-all.html

Retrieves the server configuration.

```APIDOC
## getServerConfig()

### Description
Returns the server configuration object.

### Method
GET

### Interface
de.maxhenkel.voicechat.api.VoicechatServerApi

### Returns
- **ServerConfig** - The server configuration.
```

--------------------------------

### getValue(String) - ConfigAccessor

Source: https://voicechat.modrepo.de/index-all.html

Gets the raw value of a given key from the configuration.

```APIDOC
## getValue(String key)

### Description
Gets the raw value of the given key from the configuration.

### Method
GET

### Interface
de.maxhenkel.voicechat.api.config.ConfigAccessor

### Parameters
- **key** (String) - Required - The configuration key.

### Returns
- **Object** - The raw value.
```

--------------------------------

### StaticSoundPacket Interface

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/packets/StaticSoundPacket.html

Documentation for the StaticSoundPacket interface, including its purpose, inheritance, nested builder class, and inherited methods.

```APIDOC
## StaticSoundPacket

### Description
The receiver of this event will hear the sound non-directional. This is what is basically used for group chats.

### Interface
`public interface StaticSoundPacket extends SoundPacket`

### Superinterfaces
- `ConvertablePacket`
- `Packet`
- `SoundPacket`

### Nested Classes
- `static interface StaticSoundPacket.Builder<T extends StaticSoundPacket.Builder<T>>` - A builder to build a static sound packet.

### Inherited Methods
#### From interface ConvertablePacket
- `entitySoundPacketBuilder`
- `locationalSoundPacketBuilder`
- `staticSoundPacketBuilder`
- `toEntitySoundPacket`
- `toLocationalSoundPacket`
- `toStaticSoundPacket`

#### From interface SoundPacket
- `getCategory`
- `getChannelId`
- `getOpusEncodedData`
- `getSender`
- `getSequenceNumber`
```

--------------------------------

### fromServerPlayer(Object serverPlayer)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatApi.html

Creates a player object from an actual player.

```APIDOC
## fromServerPlayer(Object serverPlayer)

### Description
Creates a player object from an actual player.

### Parameters
- `serverPlayer` (Object) - the player implementation of your mod/plugin loader

### Returns
ServerPlayer - the player
```

--------------------------------

### LocationalSoundPacket.Builder

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/packets/LocationalSoundPacket.html

A builder interface to build a locational sound packet.

```APIDOC
## LocationalSoundPacket.Builder<T extends LocationalSoundPacket.Builder<T>>

### Description
A builder to build a locational sound packet.

### Type Parameters
- **T** - The builder type (self-referential generic).
```

--------------------------------

### VoicechatDisableEvent - Interface in de.maxhenkel.voicechat.api.events

Source: https://voicechat.modrepo.de/index-all.html

This event is emitted on the client when the voice chat is getting enabled/disabled.

```APIDOC
## VoicechatDisableEvent

### Description
This event is emitted on the client when the voice chat is getting enabled/disabled.

```

--------------------------------

### CreateOpenALContextEvent

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/CreateOpenALContextEvent.html

This code snippet documents the CreateOpenALContextEvent interface, including its two methods: getContext() and getDevice().

```APIDOC
## CreateOpenALContextEvent

### Description
This event is emitted when the voice chat's OpenAL context is created. It provides access to the OpenAL context and device handles.

### Methods

#### getContext

```java
long getContext()
```

Returns the OpenAL context.

#### getDevice

```java
long getDevice()
```

Returns the OpenAL device.

```

--------------------------------

### getPlayersInRange(ServerLevel, Position, double)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatServerApi.html

A convenience method to get all players in the range of a specific location.

```APIDOC
## getPlayersInRange

### Description
A convenience method to get all players in the range of a specific location.

### Method
getPlayersInRange

### Parameters
- **level** (ServerLevel) - Required - the world
- **pos** (Position) - Required - the location
- **range** (double) - Required - the range

### Returns
- **Collection<ServerPlayer>** - all players in the provided location
```

--------------------------------

### build()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/audiolistener/PlayerAudioListener.Builder.html

Builds the PlayerAudioListener instance. Throws IllegalStateException if the player or listener is not set.

```APIDOC
## build()

### Description
Builds the PlayerAudioListener instance. This method should be called after setting the player and packet listener.

### Method
build

### Returns
- `PlayerAudioListener` - the built listener

### Throws
- `IllegalStateException` - if the player or the listener is not set

```

--------------------------------

### getPlayersInRange(ServerLevel, Position, double, Predicate)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatServerApi.html

A convenience method to get all players in the range of a specific location.

```APIDOC
## getPlayersInRange

### Description
A convenience method to get all players in the range of a specific location.

### Method
getPlayersInRange

### Parameters
- **level** (ServerLevel) - Required - the world
- **pos** (Position) - Required - the location
- **range** (double) - Required - the range
- **filter** (Predicate<ServerPlayer>) - Required - the filter to exclude specific players

### Returns
- **Collection<ServerPlayer>** - all players in the provided location
```

--------------------------------

### getServerLevel()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/ServerLevel.html

Documentation for the getServerLevel method of the ServerLevel interface.

```APIDOC
## getServerLevel()

### Description
Returns the actual level object.

### Method
`Object getServerLevel()`

### Returns
- **Object** - The actual level object

```

--------------------------------

### setDisabled(boolean disabled)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatConnection.html

Sets the player's disabled state. This only works for players without the mod installed.

```APIDOC
## setDisabled(boolean disabled)

### Description
Sets the player's disabled state. This only works for players without the mod installed.

### Method
`void setDisabled(boolean disabled)`

### Parameters
- `disabled` (boolean) - if the player should have the voice chat disabled icon.
```

--------------------------------

### isTalking()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatClientApi.html

Does the same as isTalking(UUID) with null as the player UUID.

```APIDOC
## isTalking()

### Description
Does the same as isTalking(UUID) with null as the player UUID.

### Method
isTalking

### Returns
- **boolean** - Whether the player is talking.
```

--------------------------------

### registerVolumeCategory

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatServerApi.html

Registers a volume category. This will get synchronized to all connected clients and all future clients that will connect. A category can be created with `VoicechatApi.volumeCategoryBuilder()`. The category can be unregistered with `unregisterVolumeCategory(VolumeCategory)`.

```APIDOC
## registerVolumeCategory

### Description
Registers a volume category. This will get synchronized to all connected clients and all future clients that will connect. A category can be created with `VoicechatApi.volumeCategoryBuilder()`. The category can be unregistered with `unregisterVolumeCategory(VolumeCategory)`.

### Method
registerVolumeCategory

### Parameters
- **category** (VolumeCategory) - Required - the category to register
```

--------------------------------

### StaticSoundPacket.Builder<T>

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/packets/StaticSoundPacket.Builder.html

A builder interface for constructing static sound packets. Extends SoundPacket.Builder with type parameter T for fluent self-returning methods.

```APIDOC
## StaticSoundPacket.Builder<T>

### Description
A builder to build a static sound packet. Extends `SoundPacket.Builder<T, StaticSoundPacket>`.

### Type Parameters
- `T` - the builder itself

### All Superinterfaces
- `SoundPacket.Builder<T, StaticSoundPacket>`

### Enclosing interface
- `StaticSoundPacket`

### Methods inherited from interface SoundPacket.Builder
- `build`
- `category`
- `channelId`
- `opusEncodedData`
- `sender`
- `sequenceNumber`
```

--------------------------------

### setConnected(boolean connected)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatConnection.html

Sets whether the player should be shown as connected to voice chat. This only works for players without the mod installed. The disconnected state resets if the actual state changes or the player reconnects.

```APIDOC
## setConnected(boolean connected)

### Description
Sets whether the player should be shown as connected to voice chat. This only works for players without the mod installed. The disconnected state resets if the actual state changes or the player reconnects.

### Method
`void setConnected(boolean connected)`

### Parameters
- `connected` (boolean) - if the player should be shown as connected to voice chat.
```

--------------------------------

### getSource

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/OpenALSoundEvent.html

Returns the OpenAL source.

```APIDOC
## getSource

### Description
Returns the OpenAL source.

### Method
N/A (Interface method)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **int** (int) - The OpenAL source.

#### Response Example
```json
{
  "source": 0
}
```
```

--------------------------------

### createStaticAudioChannel(UUID)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatClientApi.html

Creates a client side static audio channel.

```APIDOC
## createStaticAudioChannel(UUID)

### Description
Creates a client side static audio channel.

### Method
createStaticAudioChannel

### Parameters
- **uuid** (UUID) - Required - The UUID of the audio channel.

### Returns
- **ClientStaticAudioChannel** - The created client static audio channel.
```

--------------------------------

### createPacket()

Source: https://voicechat.modrepo.de/index-all.html

Creates a sound packet that can be converted to any type.

```APIDOC
## createPacket()

### Description
Creates a sound packet that can be converted to any type.
```

--------------------------------

### getConnection

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/JoinGroupEvent.html

Returns the connection of the player.

```APIDOC
## getConnection

### Description
Returns the connection of the player.

### Method
N/A (Interface method)

### Endpoint
N/A

### Parameters
None

### Returns
- **connection** (VoicechatConnection) - The connection of the player.

### Throws
None

### Example
```java
VoicechatConnection connection = event.getConnection();
```
```

--------------------------------

### VoiceHostEvent Interface

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/VoiceHostEvent.html

Documentation for the VoiceHostEvent interface, including its methods and parameters.

```APIDOC
## Interface VoiceHostEvent

### Description
This event is fired when a player connects to the voice chat server. It allows overwriting the voice host that is sent to the client.

### Methods

#### getVoiceHost
```java
String getVoiceHost()
```
Returns the voice host string.

#### setVoiceHost
```java
void setVoiceHost(String voiceHost)
```
Overwrites voice chats voice host - This is sent to the client and used by it to connect to the server.

**Parameters:**
- `voiceHost` (String) - the voice host string

#### getPlayer
```java
ServerPlayer getPlayer()
```
Returns the player that is connecting.

### Inherited Methods
- From `Event`: `cancel`, `isCancellable`, `isCancelled`
- From `ServerEvent`: `getVoicechat`
```

--------------------------------

### getClientConfig()

Source: https://voicechat.modrepo.de/index-all.html

Method in interface de.maxhenkel.voicechat.api.VoicechatClientApi

```APIDOC
## getClientConfig()

### Description
Returns the client configuration.

### Method
N/A (Java method)

### Endpoint
N/A

### Parameters
None

### Response
- **ClientConfiguration** - The client configuration.
```

--------------------------------

### build() - PlayerAudioListener.Builder

Source: https://voicechat.modrepo.de/index-all.html

Builds the PlayerAudioListener instance. This method is part of the PlayerAudioListener.Builder interface.

```APIDOC
## build()

### Description
Builds the PlayerAudioListener instance.

### Method
build

### Returns
PlayerAudioListener
```

--------------------------------

### OpenALSoundEvent

Source: https://voicechat.modrepo.de/index-all.html

Documentation for the OpenALSoundEvent interface and its sub-events, emitted for every audio chunk for every audio channel.

```APIDOC
## [EVENT] OpenALSoundEvent

### Description
This event is emitted for every audio chunk for every audio channel.

### Event
OpenALSoundEvent

### Interface
`de.maxhenkel.voicechat.api.events.OpenALSoundEvent`

### Sub-events
- **OpenALSoundEvent.Post** - This event is emitted after all OpenAL calls by the voice chat and the audio is added to the buffer queue.
- **OpenALSoundEvent.Pre** - This event is emitted before any OpenAL calls were made by the voice chat.

```

--------------------------------

### build() - VolumeCategory.Builder

Source: https://voicechat.modrepo.de/index-all.html

Builds the VolumeCategory instance. This method is part of the VolumeCategory.Builder interface.

```APIDOC
## build()

### Description
Builds the VolumeCategory instance.

### Method
build

### Returns
VolumeCategory
```

--------------------------------

### getDevice()

Source: https://voicechat.modrepo.de/index-all.html

Method in interface de.maxhenkel.voicechat.api.events.CreateOpenALContextEvent

```APIDOC
## getDevice()

### Description
Returns the OpenAL device associated with the event.

### Method
N/A (Java method)

### Endpoint
N/A

### Parameters
None

### Response
- **ALDevice** - The OpenAL device.
```

--------------------------------

### createLocationalAudioChannel

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatClientApi.html

Creates a client-side locational audio channel.

```APIDOC
## ClientLocationalAudioChannel createLocationalAudioChannel(UUID uuid, Position position)

### Description
Creates a client-side locational audio channel.

### Parameters
- **uuid** (UUID) - Required - The ID of the channel.
- **position** (Position) - Required - The position of the channel.

### Returns
- **ClientLocationalAudioChannel** - The audio channel.
```

--------------------------------

### getClientConfig()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatClientApi.html

Returns the client configuration accessor.

```APIDOC
## getClientConfig()

### Description
Returns the client configuration accessor.

### Method
getClientConfig

### Returns
- **ConfigAccessor** - The client configuration accessor.
```

--------------------------------

### VoicechatApi.fromServerPlayer(Object)

Source: https://voicechat.modrepo.de/index-all.html

Converts a platform-specific player object to the API player representation.

```APIDOC
## fromServerPlayer(Object)

### Description
Creates a player object from an actual player.

### Method
fromServerPlayer(Object)

### Parameters
- **player** (Object) - Required - The actual player object.

```

--------------------------------

### createMp3Encoder(AudioFormat audioFormat, int bitrate, int quality, OutputStream outputStream)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatApi.html

Creates a new MP3 encoder. Not available for Bukkit; always returns null.

```APIDOC
## createMp3Encoder(AudioFormat audioFormat, int bitrate, int quality, OutputStream outputStream)

### Description
Creates a new MP3 encoder. **NOTE**: This is not available for Bukkit! It will always return null.

### Parameters
- `audioFormat` (AudioFormat) - the audio format
- `bitrate` (int) - the bitrate in kbps
- `quality` (int) - the quality from 0 (highest) to 9 (lowest)
- `outputStream` (OutputStream) - the output stream to write the mp3 to

### Returns
Mp3Encoder - the mp3 encoder or null if the encoder could not be initialized or is not available
```

--------------------------------

### getServerLevel()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/ServerPlayer.html

Returns the level of the player.

```APIDOC
## getServerLevel()

### Description
Returns the level of the player.

### Method
`ServerLevel getServerLevel()`

### Returns
- **ServerLevel** - The level of the player.
```

--------------------------------

### fromServerLevel(Object serverLevel)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatApi.html

Creates a level object from an actual level.

```APIDOC
## fromServerLevel(Object serverLevel)

### Description
Creates a level object from an actual level.

### Parameters
- `serverLevel` (Object) - the level implementation of your mod/plugin loader

### Returns
ServerLevel - the level
```

--------------------------------

### ConvertablePacket Interface

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/packets/ConvertablePacket.html

Documentation for the ConvertablePacket interface, including methods for converting packets to entity, locational, and static sound packets.

```APIDOC
## ConvertablePacket Interface

### Description
Interface for converting packets to different sound packet types.

### Methods

#### entitySoundPacketBuilder()

- **Return Type**: `EntitySoundPacket.Builder<?>`
- **Description**: Returns a builder to build an entity sound packet based on this packet.
- **Note**: Make sure to set `SoundPacket.Builder.channelId(UUID)` to avoid conflicts with other channels.

#### locationalSoundPacketBuilder()

- **Return Type**: `LocationalSoundPacket.Builder<?>`
- **Description**: Returns a builder to build a locational sound packet based on this packet.
- **Note**: Make sure to set `SoundPacket.Builder.channelId(UUID)` to avoid conflicts with other channels.

#### staticSoundPacketBuilder()

- **Return Type**: `StaticSoundPacket.Builder<?>`
- **Description**: Returns a builder to build a static sound packet based on this packet.
- **Note**: Make sure to set `SoundPacket.Builder.channelId(UUID)` to avoid conflicts with other channels.

#### toEntitySoundPacket(UUID entityUuid, boolean whispering) - Deprecated

- **Parameters**:
  - `entityUuid` (UUID) - The UUID of the entity.
  - `whispering` (boolean) - If the entity is whispering.
- **Return Type**: `EntitySoundPacket`
- **Description**: Converts this packet to an entity sound packet.
- **Throws**: `UnsupportedOperationException` - if called on a packet created by `VoicechatServerApi.createPacket()`.
- **Deprecated**: Use `entitySoundPacketBuilder()` instead.

#### toLocationalSoundPacket(Position position) - Deprecated

- **Parameters**:
  - `position` (Position) - The position of the audio.
- **Return Type**: `LocationalSoundPacket`
- **Description**: Converts this packet to a locational sound packet.
- **Throws**: `UnsupportedOperationException` - if called on a packet created by `VoicechatServerApi.createPacket()`.
- **Deprecated**: Use `locationalSoundPacketBuilder()` instead.

#### toStaticSoundPacket() - Deprecated

- **Return Type**: `StaticSoundPacket`
- **Description**: Converts this packet to a static sound packet.
- **Throws**: `UnsupportedOperationException` - if called on a packet created by `VoicechatServerApi.createPacket()`.
- **Deprecated**: Use `staticSoundPacketBuilder()` instead.
```

--------------------------------

### getDescription()

Source: https://voicechat.modrepo.de/index-all.html

Method in interface de.maxhenkel.voicechat.api.VolumeCategory

```APIDOC
## getDescription()

### Description
Returns the description of the volume category.

### Method
N/A (Java method)

### Endpoint
N/A

### Parameters
None

### Response
- **String** - The description.
```

--------------------------------

### ServerEvent Interface

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/ServerEvent.html

Documentation for the ServerEvent interface, including its method summary and method details.

```APIDOC
## ServerEvent Interface

### Description
Represents a server-side event in the Simple Voice Chat API. Provides access to the VoicechatServerApi instance.

### Methods

#### getVoicechat

```java
VoicechatServerApi getVoicechat()
```

**Returns:**
- `VoicechatServerApi` - the voice chat server API

### Inherited Methods

From interface `Event`:
- `cancel()`
- `isCancellable()`
- `isCancelled()`
```

--------------------------------

### getSocketImplementation()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/ClientVoicechatInitializationEvent.html

Returns the custom socket implementation or null to use voice chat's default one.

```APIDOC
## getSocketImplementation()

### Description
Returns the custom socket implementation or null to use voice chat's default one.

### Method
@Nullable ClientVoicechatSocket getSocketImplementation()

### Returns
- **ClientVoicechatSocket** - The custom socket implementation, or null to use the default.
```

--------------------------------

### ConvertablePacket.entitySoundPacketBuilder()

Source: https://voicechat.modrepo.de/index-all.html

Returns a builder for constructing entity sound packets.

```APIDOC
## entitySoundPacketBuilder()

### Description
Creates a builder for an entity sound packet. Note: Make sure to set `SoundPacket.Builder.channelId(UUID)` to avoid conflicts with other channels.

### Method
entitySoundPacketBuilder()

### Return Type
EntitySoundPacket.Builder

```

--------------------------------

### createAudioPlayer(AudioChannel, OpusEncoder, short[]) - Method in interface de.maxhenkel.voicechat.api.VoicechatServerApi

Source: https://voicechat.modrepo.de/index-all.html

Creates a new audio player.

```APIDOC
## createAudioPlayer(AudioChannel, OpusEncoder, short[])

### Description
Creates a new audio player.

### Method
createAudioPlayer(AudioChannel channel, OpusEncoder encoder, short[] data)

### Interface
de.maxhenkel.voicechat.api.VoicechatServerApi

### Parameters
- **channel** (AudioChannel) - Required - The audio channel to play on.
- **encoder** (OpusEncoder) - Required - The Opus encoder to use.
- **data** (short[]) - Required - The audio data to play.

```

--------------------------------

### createStaticAudioChannel(UUID, ServerLevel, VoicechatConnection)

Source: https://voicechat.modrepo.de/index-all.html

Creates a static audio channel. Deprecated.

```APIDOC
## createStaticAudioChannel(UUID, ServerLevel, VoicechatConnection) - Deprecated

### Description
Creates a static audio channel. Deprecated. Use `VoicechatServerApi.createStaticAudioChannel(UUID)` and add a target using `StaticAudioChannel.addTarget(VoicechatConnection)`.
```

--------------------------------

### encode(short[] samples)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/mp3/Mp3Encoder.html

Encodes the given PCM samples and writes the encoded MP3 data to the output stream provided when the encoder was created.

```APIDOC
## encode(short[] samples)

### Description
Encodes the given PCM samples and writes the encoded MP3 data to the output stream provided when the encoder was created.

### Method
`void encode(short[] samples) throws IOException`

### Parameters
- `samples` (short[]) - Required - The PCM samples to encode.

### Throws
- `IOException` - if an I/O error occurs.

```

--------------------------------

### decode()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/mp3/Mp3Decoder.html

Decodes the MP3 file and returns the decoded audio data as PCM samples.

```APIDOC
## decode()

### Description
Decodes the MP3 file and returns the decoded audio data as PCM samples.

### Method
`short[] decode() throws IOException`

### Returns
- `short[]` - the decoded audio data as PCM samples

### Throws
- `IOException` - if an I/O error occurs
```

--------------------------------

### StaticAudioChannel Methods

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/audiochannel/StaticAudioChannel.html

Methods for managing targets and group isolation on a static audio channel.

```APIDOC
## setBypassGroupIsolation(boolean bypassGroupIsolation)

### Description
Sets whether this audio channel should be received by targets in isolated groups.

### Method
void setBypassGroupIsolation(boolean bypassGroupIsolation)

### Parameters
- `bypassGroupIsolation` (boolean) - Required - if group isolation should be bypassed

### Returns
void
```

```APIDOC
## bypassesGroupIsolation()

### Description
Returns whether this audio channel is received by targets in isolated groups.

### Method
boolean bypassesGroupIsolation()

### Returns
boolean - if this audio channel is received by targets in isolated groups
```

```APIDOC
## addTarget(VoicechatConnection target)

### Description
Adds a target to the audio channel.

### Method
void addTarget(VoicechatConnection target)

### Parameters
- `target` (VoicechatConnection) - Required - the target to add

### Returns
void
```

```APIDOC
## removeTarget(VoicechatConnection target)

### Description
Removes a target from the audio channel.

### Method
void removeTarget(VoicechatConnection target)

### Parameters
- `target` (VoicechatConnection) - Required - the target to remove

### Returns
void
```

```APIDOC
## clearTargets()

### Description
Removes all targets from the audio channel.

### Method
void clearTargets()

### Parameters
None

### Returns
void
```

--------------------------------

### build() - SoundPacket.Builder

Source: https://voicechat.modrepo.de/index-all.html

Builds the packet. This method is part of the SoundPacket.Builder interface.

```APIDOC
## build()

### Description
Builds the packet.

### Method
build

### Returns
SoundPacket
```

--------------------------------

### play

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/audiochannel/ClientAudioChannel.html

Plays raw 16-bit PCM audio data on this audio channel.

```APIDOC
## play

### Description
Plays this audio data on this audio channel.

### Method
`void play(short[] rawAudio)`

### Parameters
- `rawAudio` (short[]) - Required - the raw 16 bit PCM audio frame

```

--------------------------------

### PlayerAudioListener Interface

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/audiolistener/PlayerAudioListener.html

Documentation for the PlayerAudioListener interface, including its method getPlayerUuid and inherited methods.

```APIDOC
## PlayerAudioListener Interface

### Description
This interface represents an audio listener that is associated with a specific player. It extends the `AudioListener` interface and provides a method to retrieve the UUID of the player being listened to.

### Methods

#### getPlayerUuid

**Signature:** `UUID getPlayerUuid()`

**Description:** Returns the UUID of the player that is listened to.

**Returns:**
- `UUID` - The UUID of the player that is listened to.

### Inherited Methods

From interface `AudioListener`:
- `getListenerId`
```

--------------------------------

### createAudioSender(VoicechatConnection) - Method in interface de.maxhenkel.voicechat.api.VoicechatServerApi

Source: https://voicechat.modrepo.de/index-all.html

Creates a new audio sender.

```APIDOC
## createAudioSender(VoicechatConnection)

### Description
Creates a new audio sender.

### Method
createAudioSender(VoicechatConnection connection)

### Interface
de.maxhenkel.voicechat.api.VoicechatServerApi

### Parameters
- **connection** (VoicechatConnection) - Required - The voice chat connection to send audio to.

```

--------------------------------

### getPosition()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/ClientReceiveSoundEvent.LocationalSound.html

Returns the position of the sound.

```APIDOC
## getPosition()

### Description
Returns the position of the sound.

### Method
`Position getPosition()`

### Returns
- **Position** - the position of the sound

```

--------------------------------

### Group.Builder build

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/Group.Builder.html

Builds the Group instance with the configured properties.

```APIDOC
## Group.Builder build

### Description
Builds the Group instance with the configured properties.

### Method
build

### Signature
`Group build()`

### Returns
- `Group` - the built group

### Throws
- `IllegalStateException` - if the name is not set or invalid

```

--------------------------------

### getBitrate()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/mp3/Mp3Decoder.html

Decodes the MP3 file if decode() has not been called before and returns the bitrate of the MP3 file.

```APIDOC
## getBitrate()

### Description
Decodes the MP3 file if `decode()` has not been called before and returns the bitrate of the MP3 file.

### Method
`int getBitrate() throws IOException`

### Returns
- `int` - the bitrate of the mp3 file

### Throws
- `IOException` - if an I/O error occurs
```

--------------------------------

### createAudioPlayer(AudioChannel, OpusEncoder, Supplier) - Method in interface de.maxhenkel.voicechat.api.VoicechatServerApi

Source: https://voicechat.modrepo.de/index-all.html

Creates a new audio player.

```APIDOC
## createAudioPlayer(AudioChannel, OpusEncoder, Supplier)

### Description
Creates a new audio player.

### Method
createAudioPlayer(AudioChannel channel, OpusEncoder encoder, Supplier<short[]> supplier)

### Interface
de.maxhenkel.voicechat.api.VoicechatServerApi

### Parameters
- **channel** (AudioChannel) - Required - The audio channel to play on.
- **encoder** (OpusEncoder) - Required - The Opus encoder to use.
- **supplier** (Supplier<short[]>) - Required - A supplier for audio data.

```

--------------------------------

### getCategory

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/OpenALSoundEvent.html

Returns the category of the sound.

```APIDOC
## getCategory

### Description
Returns the category of the sound.

### Method
N/A (Interface method)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **String** (String) - The category of the sound.

#### Response Example
```json
{
  "category": "music"
}
```
```

--------------------------------

### getRawAudio()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/ClientSoundEvent.html

Returns the unencoded audio data as a short array representing raw 16-bit PCM audio frames.

```APIDOC
## getRawAudio()

### Description
Returns the unencoded audio data that will be sent to the server.

### Method
`short[] getRawAudio()`

### Returns
- **short[]** - The raw 16-bit PCM audio frame. Returns an empty array in case of the end of transmission.

```

--------------------------------

### getConnection()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/PlayerStateChangedEvent.html

Returns the voice chat connection of the player, or null if not available.

```APIDOC
## getConnection()

### Description
Returns the voice chat connection of the player, or null if not available.

### Method
getConnection

### Returns
- **VoicechatConnection** (nullable) - the connection of the player, or null if not available.
```

--------------------------------

### playerAudioListenerBuilder() - VoicechatServerApi

Source: https://voicechat.modrepo.de/index-all.html

Creates a builder for PlayerAudioListener instances.

```APIDOC
## playerAudioListenerBuilder()

### Description
Returns a builder for creating PlayerAudioListener instances.

### Method
playerAudioListenerBuilder

### Parameters
None.

### Response
Returns a PlayerAudioListener.Builder.
```

--------------------------------

### encode(short[] rawAudio)

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/opus/OpusEncoder.html

Encodes 16-bit PCM audio with Opus and returns the encoded data.

```APIDOC
## [METHOD] encode

### Description
Encodes 16 bit PCM audio with opus.

### Method
encode

### Parameters
#### Parameters
- `rawAudio` (short[]) - Required - The raw 16 bit PCM audio

### Returns
byte[] - the opus encoded data

```

--------------------------------

### getSocketImplementation() - ClientVoicechatInitializationEvent

Source: https://voicechat.modrepo.de/index-all.html

Retrieves the socket implementation from the client initialization event.

```APIDOC
## getSocketImplementation()

### Description
Returns the socket implementation used by the client voicechat.

### Method
GET

### Interface
de.maxhenkel.voicechat.api.events.ClientVoicechatInitializationEvent

### Returns
- **SocketImplementation** - The socket implementation.
```

--------------------------------

### play(short[]) - ClientAudioChannel

Source: https://voicechat.modrepo.de/index-all.html

Plays audio data on a client audio channel.

```APIDOC
## play(short[])

### Description
Plays this audio data on this audio channel.

### Method
play

### Parameters
- **audioData** (short[]) - Required - The audio data to play.

### Response
No return value.
```

--------------------------------

### getVolumeConfig() - VoicechatClientApi

Source: https://voicechat.modrepo.de/index-all.html

Retrieves the volume configuration.

```APIDOC
## getVolumeConfig()

### Description
Returns the volume configuration accessor.

### Method
GET

### Interface
de.maxhenkel.voicechat.api.VoicechatClientApi

### Returns
- **VolumeConfigAccessor** - The volume configuration.
```

--------------------------------

### getAudioConverter()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatApi.html

Returns the audio converter.

```APIDOC
## getAudioConverter()

### Description
Returns the audio converter.

### Returns
AudioConverter - the audio converter
```

--------------------------------

### VoiceDistanceEvent

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/events/VoiceDistanceEvent.html

Documentation for the VoiceDistanceEvent interface, including its methods and inherited methods.

```APIDOC
## Interface VoiceDistanceEvent

### Description
This event is emitted after a microphone packet arrives at the server and the distance is processed. It can be used to modify the distance at which other players can hear this packet.

### Methods

#### getPacket

```java
MicrophonePacket getPacket()
```

Returns the microphone packet.

**Returns:**
- `MicrophonePacket` - the microphone packet

#### getSenderConnection

```java
VoicechatConnection getSenderConnection()
```

Returns the connection of the player.

**Returns:**
- `VoicechatConnection` - the connection of the player

#### getDistance

```java
float getDistance()
```

Returns either the default distance set on the server or the modified distance if another subscriber changed it already. If the player is whispering, this returns the whisper distance. The whisper state can be obtained by calling `getPacket()` and checking `MicrophonePacket.isWhispering()`.

**Returns:**
- `float` - the distance in blocks

#### setDistance

```java
void setDistance(float distance)
```

Sets the distance this player sends audio at. Note that this also includes the whisper distance if the player is whispering.

**Parameters:**
- `distance` (float) - the distance in blocks

### Inherited Methods

From `Event`:
- `cancel`
- `isCancellable`
- `isCancelled`

From `ServerEvent`:
- `getVoicechat`
```

--------------------------------

### getVolumeConfig()

Source: https://voicechat.modrepo.de/de/maxhenkel/voicechat/api/VoicechatClientApi.html

Returns the volume configuration accessor.

```APIDOC
## getVolumeConfig()

### Description
Returns the volume configuration accessor.

### Method
getVolumeConfig

### Returns
- **VolumeConfigAccessor** - The volume configuration accessor.
```
Tokens:
Raw