Skip to content

Commit

Permalink
GameSDK voice -> discord voice for disambiguation
Browse files Browse the repository at this point in the history
  • Loading branch information
@msciotti
msciotti committed Jun 5, 2019
1 parent 4f84f80 commit fa60f08
Show file tree
Hide file tree
Showing 2 changed files with 287 additions and 1 deletion.
286 changes: 286 additions & 0 deletions docs/game_sdk/Discord_Voice.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,286 @@
# Voice

> info
> Need help with the SDK? Talk to us at [dis.gd/devsupport](https://dis.gd/devsupport)
Discord's pride and joy is its voice chat. Well, ok, also its memes, but mostly the voice chat. Text and video chat are pretty great, too. And have you seen that store? Anyway.

If you want people playing your game to be able to talk with each other, this Voice manager can help you out! Note that the main functionality for voice in this SDK is not _only_ in this manager. Connecting players to a voice chat happens with [ConnectVoice](#DOCS_GAME_SDK_LOBBIES/connectvoice) in the Lobby manager, and robust voice settings work through [OpenVoiceSettings](#DOCS_GAME_SDK_OVERLAY/openvoicesettings) in the Overlay manager. The Voice manager handles a few fine-grain details like self muting/deafening, swapping between VAD/PTT voice modes, and setting a PTT key. It's a subset of the robust settings from the overlay call for those of you that prefer to build UI and control things from your own game.

## Data Models

###### InputModeType Enum

| name | value |
| ------------- | ----- |
| VoiceActivity | 0 |
| PushToTalk | 1 |

###### InputMode Struct

| name | type | description |
| -------- | ------------- | --------------------------------------------- |
| Type | InputModeType | set either VAD or PTT as the voice input mode |
| Shortcut | string | the PTT hotkey for the user |

###### Shortcut Keys

Keys can be mapped as a combination by adding a "+" between values, such as `"shift + 4"` or `"ctrl + v"`.

| key type | value |
| ------------- | --------------------------------------------------------- |
| Alphabetical | "a", "b", "c", etc. |
| Numerical | "1", "2", "3", etc. |
| Symbols | "-", "+", ".", "/", etc. |
| Function Keys | "f1", "f2", "f3", etc. |
| Gamepads | standard XInput api values - "GAMEPAD0", "GAMEPAD1", etc. |
| Enter | "enter" |
| Tab | "tab" |
| Spacebar | "space" |
| Backspace | "backspace" |
| Escape | "esc" |
| Meta | "meta" |
| Shift | "shift" |
| Caps Lock | "caps lock" |
| Alt | "alt" |
| Control | "ctrl" |
| Right Shift | "right shift" |
| Right Alt | "right alt" |
| Right Control | "right ctrl" |
| Right Meta | "right meta" |
| Page Up | "page up" |
| Page Down | "page down" |
| Scroll Lock | "scroll lock" |
| Print Screen | "print screen" |
| Rewind | "rewind" |
| Play | "play" |
| Fast Forward | "fast forward" |
| Delete | "del" |
| End | "end" |
| Insert | "insert" |
| Break | "break" |
| Home | "home" |
| Up Arrow | "up" |
| Down Arrow | "down" |
| Left Arrow | "left" |
| Right Arrow | "right" |

## GetInputMode

Get the current voice input mode for the user.

Returns a `Discord.InputMode`.

###### Parameters

None

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
var inputMode = voiceManager.GetInputMode();
Console.WriteLine("The current input mode is {0}. The current PTT hotkey is set to {1}", inputMode.Type, inputMode.Shortcut);
```

## SetInputMode

Sets a new voice input mode for the user. Refer to [Shortcut Keys](#DOCS_GAME_SDK_DISCORD_VOICE/data-models-shortcut-keys) for a table of valid values for shortcuts.

Returns a `Discord.Result` via callback.

###### Parameters

| name | type | description |
| --------- | --------- | ------------------------------- |
| inputMode | InputMode | the new input mode for the user |

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
var newMode = new Discord.InputMode()
{
Type = Discord.InputModeType.PushToTalk,
Shortcut = "ctrl"
};
voiceManager.SetInputMode(newMode, (res) =>
{
if (res == Discord.Result.Ok)
{
Console.WriteLine("New input mode set");
}
});
```

## IsSelfMute

Whether the connected user is currently muted.

Returns `bool`.

###### Parameters

None

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
if (voiceManager.IsSelfMute())
{
Console.WriteLine("You are muted");
}
```

## SetSelfMute

Mutes or unmutes the currently connected user.

Returns `void`.

###### Parameters

| name | type | description |
| ---- | ---- | ------------------------------- |
| mute | bool | true for mute, false for unmute |

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
if (voiceManager.IsSelfMute())
{
voiceManager.SetSelfMute(false);
Console.WriteLine("We automatically unmuted you");
}
```

## IsSelfDeaf

Whether the connected user is currently deafened.

Returns `bool`.

###### Parameters

None

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
if (voiceManager.IsSelfDeaf())
{
Console.WriteLine("You are deafened. You can't hear anyone!");
}
```

## SetSelfDeaf

Deafens or undefeans the currently connected user.

Returns `void`.

###### Parameters

| name | type | description |
| ---- | ---- | ------------------------------- |
| deaf | bool | true for mute, false for unmute |

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
if (voiceManager.IsSelfDeaf())
{
voiceManager.SetSelfDeaf(false);
Console.WriteLine("We automatically undeafened you. You can hear now!");
}
```

## IsLocalMute

Whether the given user is currently muted by the connected user.

Returns `bool`.

###### Parameters

| name | type | description |
| ------ | ----- | --------------------------- |
| userId | Int64 | the id of the user to check |

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
if (voiceManager.IsLocalMute(53908232506183680))
{
Console.WriteLine("User is locally muted");
}
```

## SetLocalMute

Mutes or unmutes the given user for the currently connected user.

Returns `void`.

###### Parameters

| name | type | description |
| ------ | ----- | ------------------------------- |
| userId | Int64 | the id of the user to mute |
| mute | bool | true for mute, false for unmute |

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
if (!voiceManager.IsLocalMute(53908232506183680))
{
voiceManager.SetLocalMute(53908232506183680, true);
Console.WriteLine("Muted that user for you");
}
```

## GetLocalVolume

Gets the local volume for a given user. This is the volume level at which the currently connected users hears the given user speak.

Returns `byte`.

###### Parameters

| name | type | description |
| ------ | ----- | --------------------------- |
| userId | Int64 | the id of the user to check |

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
var volume = voiceManager.GetLocalVolume(53908232506183680);
Console.WriteLine("User is at volume level {0}", volume);
```

## SetLocalVolume

Sets the local volume for a given user. This is the volume level at which the currently connected users hears the given user speak. Valid volume values are from `0` to `200`, with `100` being the default. Lower than `100` will be a reduced volume level from default, whereas over `100` will be a boosted volume level from default.

Returns `void`.

###### Parameters

| name | type | description |
| ------ | ----- | ------------------------------------------------- |
| userId | Int64 | the id of the user to change |
| volume | byte | the volume at which to set the user, `0` to `200` |

###### Example

```cs
var voiceManager = discord.GetVoiceManager();
voiceManager.SetLocalVolume(53908232506183680, 70);
```
2 changes: 1 addition & 1 deletion docs/game_sdk/SDK_Starter_Guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,4 @@ Oh, yeah. Pseudo Table of Contents:
- [Applications](#DOCS_GAME_SDK_APPLICATIONS/)
- [Overlay](#DOCS_GAME_SDK_OVERLAY/)
- [Store](#DOCS_GAME_SDK_STORE/)
- [Voice](#DOCS_GAME_SDK_VOICE/)
- [Voice](#DOCS_GAME_SDK_DISCORD_VOICE/)

0 comments on commit fa60f08

Please sign in to comment.