Restructure documentation layout
@@ -25,6 +25,7 @@ Style consistencies:
|
|||||||
|
|
||||||
* Use a ruler set at 70 characters
|
* Use a ruler set at 70 characters
|
||||||
* Links should use long syntax
|
* Links should use long syntax
|
||||||
|
* Pages should be short and concise, not broad and long
|
||||||
|
|
||||||
Example of long link syntax:
|
Example of long link syntax:
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
@@ -1,17 +1,18 @@
|
|||||||
|
|
||||||
- name: Installing
|
|
||||||
href: installing.md
|
|
||||||
- name: Getting Started
|
- name: Getting Started
|
||||||
href: intro.md
|
items:
|
||||||
- name: Terminology
|
- name: Installation
|
||||||
href: terminology.md
|
href: getting_started/installing.md
|
||||||
- name: Logging
|
- name: Your First Bot
|
||||||
href: logging.md
|
href: getting_started/intro.md
|
||||||
- name: Commands
|
- name: Terminology
|
||||||
href: commands.md
|
href: getting_started/terminology.md
|
||||||
|
- name: Basic Concepts
|
||||||
|
items:
|
||||||
|
- name: Logging Data
|
||||||
|
href: concepts/logging.md
|
||||||
|
- name: Working with Events
|
||||||
|
href: concepts/events.md
|
||||||
|
- name: Entities
|
||||||
|
- name: The Command Service
|
||||||
- name: Voice
|
- name: Voice
|
||||||
href: voice.md
|
- name: Migrating from 0.9
|
||||||
- name: Events
|
|
||||||
href: events.md
|
|
||||||
- name: Code Samples
|
|
||||||
href: samples.md
|
|
||||||
@@ -1,24 +1,13 @@
|
|||||||
# Voice
|
---
|
||||||
|
title: Sending Voice
|
||||||
|
---
|
||||||
|
|
||||||
**Information on this page is subject to change!**
|
**Information on this page is subject to change!**
|
||||||
|
|
||||||
>[!WARNING]
|
>[!WARNING]
|
||||||
>Audio in 1.0 is incomplete. Most of the below documentation is untested.
|
>Audio in 1.0 is in progress
|
||||||
|
|
||||||
## Installation
|
## Installing
|
||||||
|
|
||||||
To use Audio, you must first configure your [DiscordSocketClient]
|
|
||||||
with Audio support.
|
|
||||||
|
|
||||||
In your [DiscordSocketConfig], set `AudioMode` to the appropriate
|
|
||||||
[AudioMode] for your bot. For most bots, you will only need to use
|
|
||||||
`AudioMode.Outgoing`.
|
|
||||||
|
|
||||||
[DiscordSocketClient]: xref:Discord.WebSocket.DiscordSocketClient
|
|
||||||
[DiscordSocketConfig]: xref:Discord.WebSocket.DiscordSocketConfig
|
|
||||||
[AudioMode]: xref:Discord.Audio.AudioMode
|
|
||||||
|
|
||||||
### Dependencies
|
|
||||||
|
|
||||||
Audio requires two native libraries, `libsodium` and `opus`.
|
Audio requires two native libraries, `libsodium` and `opus`.
|
||||||
Both of these libraries must be placed in the runtime directory of your
|
Both of these libraries must be placed in the runtime directory of your
|
||||||
@@ -1,8 +1,6 @@
|
|||||||
|
|
||||||
- name: Guides
|
- name: Guides
|
||||||
href: guides/
|
href: guides/
|
||||||
- name: Migrating
|
|
||||||
href: migrating.md
|
|
||||||
- name: API Documentation
|
- name: API Documentation
|
||||||
href: api/
|
href: api/
|
||||||
homepage: api/index.md
|
homepage: api/index.md
|
||||||
|
|||||||