Package de.jcm.discordgamesdk.voice

Class VoiceInputMode

java.lang.Object

de.jcm.discordgamesdk.voice.VoiceInputMode

public class VoiceInputMode
extends Object

Structure representing an input configuration for Discord voice chat.

See Also:

• VoiceManager.getInputMode()
• VoiceManager.setInputMode(VoiceInputMode, Consumer)
• https://discord.com/developers/docs/game-sdk/discord-voice#data-models-inputmode-struct

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VoiceInputMode.InputModeType	The type of an input mode specifying how voice transmission is activated.

Constructor Summary

Constructors

Constructor	Description
VoiceInputMode(VoiceInputMode.InputModeType type, String shortcut)	Constructs a new input mode with a type (VAD or PTT) and a hotkey for PTT.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getShortcut()	Gets the shortcut for VoiceInputMode.InputModeType.PUSH_TO_TALK.
VoiceInputMode.InputModeType	getType()	Gets the type of this input mode.
int	hashCode()
void	setShortcut(String shortcut)	Sets the shortcut for VoiceInputMode.InputModeType.PUSH_TO_TALK.
void	setType(VoiceInputMode.InputModeType type)	Sets the type of this input mode.
String	toString()	Creates a simple string representation of this input mode containing: the type (getType()) the shortcut (getShortcut())

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VoiceInputMode

public VoiceInputMode(VoiceInputMode.InputModeType type,
 String shortcut)

Constructs a new input mode with a type (VAD or PTT) and a hotkey for PTT.

Parameters:

type - The type of the input mode

shortcut - The shortcut for VoiceInputMode.InputModeType.PUSH_TO_TALK

Method Details

getType

public VoiceInputMode.InputModeType getType()

Gets the type of this input mode.

Returns:

An VoiceInputMode.InputModeType

See Also:

• setType(InputModeType)

setType

public void setType(VoiceInputMode.InputModeType type)

Sets the type of this input mode.

This does not directly affect the input mode currently set in Discord. You need to set it using VoiceManager.setInputMode(VoiceInputMode, Consumer).

Parameters:

type - The new VoiceInputMode.InputModeType

See Also:

• getType()

getShortcut

public String getShortcut()

Gets the shortcut for VoiceInputMode.InputModeType.PUSH_TO_TALK.

Key combinations can be expressed by concatenating two or more key names with a '+', e.g. "shift + p" or "ctrl + 5".

Returns:

A shortcut string in the format further described in the documentation, max. 255 bytes

See Also:

• setShortcut(String)
• https://discord.com/developers/docs/game-sdk/discord-voice#data-models-shortcut-keys

setShortcut

public void setShortcut(String shortcut)

Sets the shortcut for VoiceInputMode.InputModeType.PUSH_TO_TALK.

Key combinations can be expressed by concatenating two or more key names with a '+', e.g. "shift + p" or "ctrl + 5".

This does not directly affect the input mode currently set in Discord. You need to set it using VoiceManager.setInputMode(VoiceInputMode, Consumer).

Parameters:

shortcut - A new shortcut string in the format further described in the documentation, max. 255 bytes

See Also:

• getShortcut()
• https://discord.com/developers/docs/game-sdk/discord-voice#data-models-shortcut-keys

toString

public String toString()

Creates a simple string representation of this input mode containing:

• the type (getType())
• the shortcut (getShortcut())

It is not recommended to use this method for serialization. It is only intended for debugging.

The methods uses the plain fields rather than the named getter methods. Overriding those will hence not change to return value of this method.

Overrides:

toString in class Object

Returns:

A string representation of this input mode.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

• Objects.equals(Object, Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Objects.hash(Object...)