New API

[longnguyen2004]

The new API that I promised

Functions added (names are changeable, feel free to suggest):

• prepareStream: Take the input (a file path or a Readable stream) and use ffmpeg to create a Matroska media stream compatible with this library
  • Returns the ffmpeg instance and the output stream
  • All media related option (width, height, frame rate, bit rate, etc.) goes here
  • Compared to streamLivestreamVideo, the ffmpeg instance is returned back to user code, and the user is free to do whatever they want with it
• playStream: Take the input stream and set up the muxer, packetizer and stream settings
  • All streaming related option (stream type: "Go Live" or camera, RTCP sender report, encryption type) goes here
  • Auto-detection and setup of the stream parameters (width, height, frame rate, video codec)
  • Voice states are completely managed by this function, the user doesn't need to juggle a bunch of internal functions.

Typical use case:

import { NewApi } from "@dank074/discord-video-stream";

// ...
let playback;
try {
  await streamer.joinVoice(guildId, channelId);

  if (streamer.client.user!.voice!.channel instanceof StageChannel)
    await streamer.client.user!.voice!.setSuppressed(false);

  const { command, output } = NewApi.prepareStream(url, {
    height: 1080,
    bitrateVideo: 5000,
    bitrateVideoMax: 10000,
    // other media settings
  });
  playback = command;

  await NewApi.playStream(output, streamer, {
    forceChacha20Encryption: true
  });

  // To end the stream prematurely, do playback.kill("SIGTERM")
}

Due to the need to keep backwards compatibility with streamLivestreamVideo, there are a few places that I'm not completely happy with (updatePacketizer being one of them). Once the old API is removed then we can do more cleanup. Please report if there are any breakage of the old API, since I might have missed something.