https://github.com/discordjs/voice

Implementation of the Discord Voice API for discord.js and other JS/TS libraries
https://github.com/discordjs/voice

audio discord discord-bot discordjs hacktoberfest tcp udp voice voip

Last synced: 3 months ago
JSON representation

Implementation of the Discord Voice API for discord.js and other JS/TS libraries

• Host: GitHub
• URL: https://github.com/discordjs/voice
• Owner: discordjs
• License: apache-2.0
• Archived: true
• Created: 2020-12-16T12:08:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-07-12T18:05:58.000Z (over 1 year ago)
• Last Synced: 2024-04-14T06:44:57.624Z (8 months ago)
• Topics: audio, discord, discord-bot, discordjs, hacktoberfest, tcp, udp, voice, voip
• Language: TypeScript
• Homepage:
• Size: 2.05 MB
• Stars: 325
• Watchers: 8
• Forks: 111
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• discord-api-libs - voice - Implementation of the Discord Voice API for discord.js and other JS/TS libraries (Libraries / TypeScript)

README

        


	


	


		

	

	


		


		

		

		

		

		

		

	



## About

An implementation of the Discord Voice API for Node.js, written in TypeScript.

**Features:**

- Send and receive* audio in Discord voice-based channels

- A strong focus on reliability and predictable behaviour

- Horizontal scalability and libraries other than [discord.js](https://discord.js.org/) are supported with custom adapters

- A robust audio processing system that can handle a wide range of audio sources

\**Audio receive is not documented by Discord so stable support is not guaranteed*

## Installation

**Node.js 16.0.0 or newer is required.**

```sh-session

npm install @discordjs/voice

yarn add @discordjs/voice

pnpm add @discordjs/voice

```

## Dependencies

This library has several optional dependencies to support a variety

of different platforms. Install one dependency from each of the

categories shown below. The dependencies are listed in order of

preference for performance. If you can't install one of the options,

try installing another.

**Encryption Libraries (npm install):**

- `sodium`: ^3.0.2

- `tweetnacl`: ^1.0.3

- `libsodium-wrappers`: ^0.7.9

**Opus Libraries (npm install):**

- `@discordjs/opus`: ^0.4.0

- `opusscript`: ^0.0.7

**FFmpeg:**

- [`FFmpeg`](https://ffmpeg.org/) (installed and added to environment)

- `ffmpeg-static`: ^4.2.7 (npm install)

## Links

- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website))

- [Documentation](https://discord.js.org/#/docs/voice)

- [Examples](https://github.com/discordjs/voice/tree/main/examples)

- [discord.js Discord server](https://discord.gg/djs)

- [GitHub](https://github.com/discordjs/voice)

- [npm](https://www.npmjs.com/package/@discordjs/voice)

## Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the

[documentation](https://discord.js.org/#/docs/voice).  

See [the contribution guide](https://github.com/discordjs/voice/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR.

## Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle

nudge in the right direction, please don't hesitate to join our official [discord.js Server](https://discord.gg/djs).