Interface OpenALSoundEvent

All Superinterfaces:

ClientEvent, Event

All Known Subinterfaces:

OpenALSoundEvent.Post, OpenALSoundEvent.Pre

public interface OpenALSoundEvent
extends ClientEvent

This event is emitted for every audio chunk for every audio channel. These events are meant to be used to modify OpenAL effects.
This specific event is emitted after the position of the sound is set, but before the any other OpenAL calls. Use OpenALSoundEvent.Pre or OpenALSoundEvent.Post get earlier or later events respectively.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OpenALSoundEvent.Post	This event is emitted after all OpenAL calls by the voice chat and the audio is added to the buffer queue.
static interface	OpenALSoundEvent.Pre	This event is emitted before any OpenAL calls were made by the voice chat.

Method Summary

Modifier and Type	Method	Description
String	getCategory()
UUID	getChannelId()	This returns null for non audio channel sounds, like microphone testing.
Position	getPosition()	Returns the position of the sound.
int	getSource()

Methods inherited from interface ClientEvent

getVoicechat

Methods inherited from interface Event

cancel, isCancellable, isCancelled

Method Details

getPosition

@Nullable
Position getPosition()

Returns the position of the sound. This returns null for static sounds.

Returns:

the position of the sound

getChannelId

@Nullable
UUID getChannelId()

This returns null for non audio channel sounds, like microphone testing.

Returns:

the unique ID of the audio channel

getSource

int getSource()

Returns:

the OpenAL source

getCategory

@Nullable
String getCategory()

Returns:

the category of the sound