Package de.jcm.discordgamesdk

Class VoiceManager

java.lang.Object

de.jcm.discordgamesdk.VoiceManager

public class VoiceManager
extends Object

Manager to control voice settings for Lobby voice channels.

See Also:

• https://discord.com/developers/docs/game-sdk/discord-voice

Method Summary

Modifier and Type	Method	Description
VoiceInputMode	getInputMode()	Gets the current voice input mode of the user.
int	getLocalVolume(long userId)	Gets the local volume adjustment for the user with the given ID.
boolean	isLocalMute(long userId)	Checks if a user with a given ID is locally muted by the current user.
boolean	isSelfDeaf()	Gets whether the current user has deafened themselves.
boolean	isSelfMute()	Gets whether the current user has muted themselves.
void	setInputMode(VoiceInputMode inputMode)	Sets a new voice input mode for the current user.
void	setInputMode(VoiceInputMode inputMode, Consumer<Result> callback)	Sets a new voice input mode for the current user.
void	setLocalMute(long userId, boolean mute)	Locally mutes or unmutes the user with the given ID.
void	setLocalVolume(long userId, int volume)	Adjust the volume for a given user id locally.
void	setSelfDeaf(boolean selfDeaf)	Deafens or undeafens the current user (self deaf).
void	setSelfMute(boolean selfMute)	Mutes or unmutes the current user (self mute).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInputMode

public VoiceInputMode getInputMode()

Gets the current voice input mode of the user.

This method only returns a copy of the input mode. Modifying it will not affect the current voice input mode unless you use setInputMode(VoiceInputMode, Consumer).

Returns:

The current VoiceInputMode

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• setInputMode(VoiceInputMode, Consumer)
• https://discord.com/developers/docs/game-sdk/discord-voice#getinputmode

setInputMode

public void setInputMode(VoiceInputMode inputMode,
 Consumer<Result> callback)

Sets a new voice input mode for the current user.

Discord checks the validity of the VoiceInputMode.getShortcut() and e.g. removes illegal keys (no error is thrown). However, the plausibility is not checked, allowing shortcuts to contain the same key multiple times and to be composed of as many keys as you can fit into the string (max length is 255 bytes).

Parameters:

inputMode - The new voice input mode

callback - Callback to process the returned Result

See Also:

• setInputMode(VoiceInputMode)
• getInputMode()
• https://discord.com/developers/docs/game-sdk/discord-voice#setinputmode

setInputMode

public void setInputMode(VoiceInputMode inputMode)

Sets a new voice input mode for the current user.

The Core.DEFAULT_CALLBACK is used to handle the returned Result.

Parameters:

inputMode - The new voice input mode

See Also:

• setInputMode(VoiceInputMode, Consumer)
• getInputMode()
• https://discord.com/developers/docs/game-sdk/discord-voice#setinputmode

isSelfMute

public boolean isSelfMute()

Gets whether the current user has muted themselves.

Returns:

true if the current user is currently muted

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• setSelfMute(boolean)
• https://discord.com/developers/docs/game-sdk/discord-voice#isselfmute

setSelfMute

public void setSelfMute(boolean selfMute)

Mutes or unmutes the current user (self mute).

Parameters:

selfMute - true to mute, false to unmute

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• isSelfMute()
• https://discord.com/developers/docs/game-sdk/discord-voice#setselfmute

isSelfDeaf

public boolean isSelfDeaf()

Gets whether the current user has deafened themselves.

Returns:

true if the current user is currently deafened

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• setSelfDeaf(boolean)
• https://discord.com/developers/docs/game-sdk/discord-voice#isselfdeaf

setSelfDeaf

public void setSelfDeaf(boolean selfDeaf)

Deafens or undeafens the current user (self deaf).

Parameters:

selfDeaf - true to deafen, false to undeafen

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• isSelfDeaf()
• https://discord.com/developers/docs/game-sdk/discord-voice#setselfdeaf

isLocalMute

public boolean isLocalMute(long userId)

Checks if a user with a given ID is locally muted by the current user.

Parameters:

userId - ID of the user to check

Returns:

true if the user is locally muted

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• setLocalMute(long, boolean)
• https://discord.com/developers/docs/game-sdk/discord-voice#islocalmute

setLocalMute

public void setLocalMute(long userId,
 boolean mute)

Locally mutes or unmutes the user with the given ID.

Parameters:

userId - ID of the user to (un)mute

mute - true to mute the user, false to unmute the user

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• isLocalMute(long)
• https://discord.com/developers/docs/game-sdk/discord-voice#setlocalmute

getLocalVolume

public int getLocalVolume(long userId)

Gets the local volume adjustment for the user with the given ID.

A volume of 100 is default. A volume lower than that means that the volume for the given user is reduced (a volume of 0 means no sound at all). If the volume is higher than the default, it is boosted (up to 200 which is the maximal boost).

Parameters:

userId - ID of the user to get the volume adjustment for

Returns:

The volume adjustment in percent, an integer in percent between 0 and 200

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• setLocalVolume(long, int)
• https://discord.com/developers/docs/game-sdk/discord-voice#getlocalvolume

setLocalVolume

public void setLocalVolume(long userId,
 int volume)

Adjust the volume for a given user id locally.

A volume of 100 is default. A volume lower than that means that the volume for the given user is reduced (a volume of 0 means no sound at all). If the volume is higher than the default, it is boosted (up to 200 which is the maximal boost).

Parameters:

userId - ID of the user to adjust the volume for

volume - New volume adjustment in percent, an integer from 0 to 200

Throws:

GameSDKException - for a Result that is not Result.OK

See Also:

• getLocalVolume(long)
• https://discord.com/developers/docs/game-sdk/discord-voice#setlocalvolume