Package de.maxhenkel.voicechat.api

Interface VoicechatApi

All Known Subinterfaces:

VoicechatClientApi, VoicechatServerApi

public interface VoicechatApi

Method Summary

Modifier and Type	Method	Description
OpusDecoder	createDecoder()	Creates a new opus decoder.
OpusEncoder	createEncoder()	Creates a new opus encoder.
OpusEncoder	createEncoder(OpusEncoderMode mode)	Creates a new opus encoder.
Mp3Decoder	createMp3Decoder(InputStream inputStream)	NOTE: This is not available for Bukkit! It will always return null.
Mp3Encoder	createMp3Encoder(AudioFormat audioFormat, int bitrate, int quality, OutputStream outputStream)	NOTE: This is not available for Bukkit! It will always return null.
Position	createPosition(double x, double y, double z)	Creates a new position object.
Entity	fromEntity(Object entity)	Creates an entity object from an actual entity.
ServerLevel	fromServerLevel(Object serverLevel)	Creates a level object from an actual level.
ServerPlayer	fromServerPlayer(Object serverPlayer)	Creates a player object from an actual player.
AudioConverter	getAudioConverter()
double	getVoiceChatDistance()	NOTE: Voice chat plugins can change this.
VolumeCategory.Builder	volumeCategoryBuilder()	Don't forget to register your category with VoicechatServerApi.registerVolumeCategory(VolumeCategory) or VoicechatClientApi.registerClientVolumeCategory(VolumeCategory)

Method Details

createEncoder

OpusEncoder createEncoder()

Creates a new opus encoder. Note that the encoder needs to be closed after you are finished using it.

createEncoder

OpusEncoder createEncoder(OpusEncoderMode mode)

Creates a new opus encoder. Note that the encoder needs to be closed after you are finished using it.

Parameters:

mode - the opus encoder mode

Returns:

the opus encoder

createDecoder

OpusDecoder createDecoder()

Creates a new opus decoder. Note that the decoder needs to be closed after you are finished using it.

Returns:

the opus decoder

createMp3Encoder

@Nullable
Mp3Encoder createMp3Encoder(AudioFormat audioFormat,
 int bitrate,
 int quality,
 OutputStream outputStream)

NOTE: This is not available for Bukkit! It will always return null.

Parameters:

audioFormat - the audio format

bitrate - the bitrate in kbps

quality - the quality from 0 (highest) to 9 (lowest)

outputStream - the output stream to write the mp3 to

Returns:

the mp3 encoder or null if the encoder could not be initialized or is not available

createMp3Decoder

@Nullable
Mp3Decoder createMp3Decoder(InputStream inputStream)

NOTE: This is not available for Bukkit! It will always return null.

Parameters:

inputStream - the input stream to read the mp3 from

Returns:

the mp3 decoder or null if the decoder could not be initialized or is not available

getAudioConverter

AudioConverter getAudioConverter()

Returns:

the audio converter

fromEntity

Entity fromEntity(Object entity)

Creates an entity object from an actual entity.

Parameters:

entity - the entity implementation of your mod/plugin loader

Returns:

the entity object

fromServerLevel

ServerLevel fromServerLevel(Object serverLevel)

Creates a level object from an actual level.

Parameters:

serverLevel - the level implementation of your mod/plugin loader

Returns:

the level

fromServerPlayer

ServerPlayer fromServerPlayer(Object serverPlayer)

Creates a player object from an actual player.

Parameters:

serverPlayer - the player implementation of your mod/plugin loader

Returns:

the player

createPosition

Position createPosition(double x,
 double y,
 double z)

Creates a new position object.

Parameters:

x - the X position

y - the Y position

z - the Z position

Returns:

the position with the provided coordinates

volumeCategoryBuilder

VolumeCategory.Builder volumeCategoryBuilder()

Don't forget to register your category with VoicechatServerApi.registerVolumeCategory(VolumeCategory) or VoicechatClientApi.registerClientVolumeCategory(VolumeCategory)

Returns:

a builder to build a category

getVoiceChatDistance

double getVoiceChatDistance()

NOTE: Voice chat plugins can change this. This is only the default value. This value might not be correct if you are not connected to a server.

Returns:

the default distance, audio from voice chat is heard from