@gabrielmaialva33/discord-video-stream
TypeScript icon, indicating that this package has built-in type declarations

1.1.3 • Public • Published


Live
VideoStream lib for Discord

An open-source Discord lib to stream videos on voice channels.

waka License GitHub top language GitHub language count Repository size GitHub last commit Maia


About   |    Features   |    Implementation   |    Requirements   |    Usage   |    FAQS   


🔖 About

This project implements the custom Discord UDP protocol for sending media. Since Discord is likely change their custom protocol, this library is subject to break at any point. An effort will be made to keep this library up to date with the latest Discord protocol, but it is not guranteed.

For better stability it is recommended to use WebRTC protocol instead since Discord is forced to adhere to spec, which means that the non-signaling code is guaranteed to work.


🚀 Features

  • Playing vp8 or h264 video in a voice channel (go live, or webcam video)
  • Playing opus audio in a voice channel

🚧 Implementation

What I implemented and what I did not.

Video codecs

  • [x] VP8
  • [ ] VP9
  • [x] H.264
  • [x] H.265

Packet types

  • [x] RTP (sending of realtime data)
  • [ ] RTX (retransmission)

Connection types

  • [x] Regular Voice Connection
  • [x] Go live

Extras

Extensions supported by Discord (taken from the webrtc sdp exchange)


💻 Requirements

  • FFmpeg is required for the usage of this package. If you are on linux you can easily install ffmpeg from your distribution's package manager.

      $ sudo apt-get install ffmpeg
  • discord.js-selfbot-v13 is required for the usage of this package. If you are on linux you can easily install discord.js-selfbot-v13 from your

      $ pnpm add discord.js-selfbot-v13

📦 Usage

Create a new client, and patch its events to listen for voice gateway events:

import { Client } from 'discord.js-selfbot-v13'
import { Streamer } from '@gabrielmaialva33/discord-video-stream'

const streamer = new Streamer(new Client())
await streamer.client.login('TOKEN HERE')

Make client join a voice channel and create a stream:

await streamer.joinVoice('GUILD ID HERE', 'CHANNEL ID HERE')
const udp = await streamer.createStream()

Start sending media over the udp connection:

udp.mediaConnection.setSpeaking(true)
udp.mediaConnection.setVideoStatus(true)
try {
  const res = await streamLivestreamVideo('DIRECT VIDEO URL OR READABLE STREAM HERE', udp)

  console.log('Finished playing video ' + res)
} catch (e) {
  console.log(e)
} finally {
  udp.mediaConnection.setSpeaking(false)
  udp.mediaConnection.setVideoStatus(false)
}

⬇️ **FAQS

  • Can I stream on existing voice connection (CAM) and in a go-live connection simultaneously?

Yes, just send the media packets over both udp connections. The voice gateway expects you to signal when a user turns on their camera, so make sure you signal using client.signalVideo(guildId, channelId, true) before you start sending cam media packets.

  • Does this library work with bot tokens?

No, Discord blocks video from bots which is why this library uses a selfbot library as peer dependency. You must use a user token


📝 License

This project is under the MIT license. MIT ❤️


🚀 Contributors

Maia
Maia

Made with ❤️ by Maia 👋🏽 Get in touch!

Liked? Leave a little star to help the project ⭐



© 2017-present Maia

Package Sidebar

Install

npm i @gabrielmaialva33/discord-video-stream

Weekly Downloads

51

Version

1.1.3

License

ISC

Unpacked Size

145 kB

Total Files

75

Last publish

Collaborators

  • gabrielmaialva33