dfx 0.0.1 → 0.0.2

package/discord-api-docs/docs/game_sdk/Discord_Voice.md

@@ -1,289 +0,0 @@
-# Voice
-
-> info
-> Need help with the SDK? Talk to us in the [Discord Developers Server](https://discord.gg/discord-developers)!
-
-> danger
-> Selling SKUs on Discord is now deprecated, and will be discontinued on March 1, 2022. [Read here for more info.](https://support-dev.discord.com/hc/en-us/articles/4414590563479)
-
-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);
-```

package/discord-api-docs/docs/game_sdk/Images.md

@@ -1,196 +0,0 @@
-# Images
-
-> info
-> Need help with the SDK? Talk to us in the [Discord Developers Server](https://discord.gg/discord-developers)!
-
-> danger
-> Selling SKUs on Discord is now deprecated, and will be discontinued on March 1, 2022. [Read here for more info.](https://support-dev.discord.com/hc/en-us/articles/4414590563479)
-
-Discord is like a book; it's better with pictures. The image manager helps you fetch image data for images in Discord, including user's avatars. They worked hard to pick out those photos and gifs. Show them you care, too.
-
-## Data Models
-
-###### ImageDimensions Struct
-
-| name   | type   | description             |
-| ------ | ------ | ----------------------- |
-| Width  | UInt32 | the width of the image  |
-| Height | UInt32 | the height of the image |
-
-###### ImageType Enum
-
-| value | description              |
-| ----- | ------------------------ |
-| User  | image is a user's avatar |
-
-###### ImageHandle Struct
-
-| name | type      | description                                     |
-| ---- | --------- | ----------------------------------------------- |
-| Type | ImageType | the source of the image                         |
-| Id   | Int64     | the id of the user whose avatar you want to get |
-| Size | UInt32    | the resolution at which you want the image      |
-
-## Fetch
-
-Prepares an image to later retrieve data about it.
-
-Returns a `Discord.Result` and `Discord.ImageHandle` via callback.
-
-###### Parameters
-
-| name    | type        | description                                                 |
-| ------- | ----------- | ----------------------------------------------------------- |
-| handle  | ImageHandle | contains the desired userId and size for the returned image |
-| refresh | bool        | whether to use cached data for fetch anew                   |
-
-###### Example
-
-```cs
-var handle = new Discord.ImageHandle()
-{
-  Id = 53908232506183680,
-  Size = 1024
-};
-
-imageManager.Fetch(handle, false, (result, returnedHandle) =>
-{
-  if (result == Discord.Result.Ok)
-  {
-    var data = imageManager.GetData(returnedHandle);
-    // Do stuff with the byte[] data
-  }
-});
-```
-
-## GetDimensions
-
-Gets the dimensions for the given user's avatar's source image.
-
-Returns `Discord.ImageDimensions`.
-
-###### Parameters
-
-| name   | type        | description                                                 |
-| ------ | ----------- | ----------------------------------------------------------- |
-| handle | ImageHandle | contains the desired userId and size for the returned image |
-
-###### Example
-
-```cs
-var handle = new Discord.ImageHandle()
-{
-  Id = 53908232506183680,
-  Size = 1024
-};
-var dimensions =  imageManager.GetDimensions(handle);
-```
-
-## GetData
-
-Gets the image data for a given user's avatar. In C#, this is overloaded by a helper function that will directly return a `byte[]` with the image data in it. In C++/C, this function reads image data into a passed pointer of defined size.
-
-###### Parameters
-
-| name   | type        | description                                   |
-| ------ | ----------- | --------------------------------------------- |
-| handle | ImageHandle | the image handle from the `Fetch()` callback  |
-| data   | uint8_t\*   | a buffer to read image data into (C++/C only) |
-| size   | uint        | the size of the buffer (C++/C only)           |
-
-###### Example
-
-```cs
-var handle = new Discord.ImageHandle()
-{
-  Id = 53908232506183680,
-  Size = 1024
-};
-
-imageManager.Fetch(handle, false, (result, handle) =>
-{
-  if (result == Discord.Result.Ok)
-  {
-    var data = imageManager.GetData(handle);
-    // Do stuff with data now
-  }
-});
-```
-
-###### Example Cpp
-
-```cpp
-core->ImageManager().Fetch(
-    handle, true, [&state](discord::Result res, discord::ImageHandle handle) {
-        if (res == discord::Result::Ok) {
-            discord::ImageDimensions dims{};
-            state.core->ImageManager().GetDimensions(handle, &dims);
-            std::cout << "Fetched " << dims.GetWidth() << "x" << dims.GetHeight()
-                      << " avatar!\n";
-
-            std::vector<uint8_t> data;
-            data.reserve(dims.GetWidth() * dims.GetHeight() * 4);
-            uint8_t* d = data.data();
-            state.core->ImageManager().GetData(handle, d, data.size());
-        }
-    }
-);
-```
-
-## GetTexture
-
-> warn
-> This is only exposed in Unity
-
-Gets the `Texture2D` for a given user's avatar for use within a Unity environment.
-
-Returns a `Texture2D`.
-
-###### Parameters
-
-| name   | type        | description                                  |
-| ------ | ----------- | -------------------------------------------- |
-| handle | ImageHandle | the image handle from the `Fetch()` callback |
-
-###### Example
-
-```cs
-var handle = new Discord.ImageHandle()
-{
-  Id = 53908232506183680,
-  Size = 1024
-};
-
-imageManager.Fetch(handle, false, (result, handle) =>
-{
-  if (result == Discord.Result.Ok)
-  {
-    var texture = imageManager.GetTexture(handle);
-    // Do stuff with texture now
-  }
-});
-```
-
-## Example: User's Avatar Data
-
-```cs
-var discord = new Discord.Discord(clientId, Discord.CreateFlags.Default);
-
-// Request user's avatar data. Sizes can be powers of 2 between 16 and 2048
-imageManager.Fetch(Discord.ImageHandle.User(53908232506183680, 128), (result, handle) =>
-{
-  {
-    if (result == Discord.Result.Ok)
-    {
-      // If you are working in Unity, you can also use GetTexture()
-      // Which is only exposed for Unity builds
-      // These return raw RGBA.
-      var data = imageManager.GetData(handle);
-    }
-    else
-    {
-      Console.WriteLine("image error {0}", handle.Id);
-    }
-  }
-};
-```