From 36bfd035e9447234b8937888e306936d57f70f0c Mon Sep 17 00:00:00 2001 From: Lechner Julian - FrauJulian Date: Fri, 10 Oct 2025 18:01:10 +0200 Subject: [PATCH] Updated README.md --- README.md | 71 +++++++++++++++++++++++++------------------------------ 1 file changed, 32 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 8e046f5..ed1126e 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Please create an [issue](https://github.com/FrauJulian/DiscordAudioStreamNPM/iss > **Supported package managers:** npm, yarn, pnpm, bun #### Recommended: + ```bash npm install discord-audio-stream @snazzah/davey @discordjs/opus yarn add discord-audio-stream @snazzah/davey @discordjs/opus @@ -60,15 +61,15 @@ or (with parameters) ```js let audioManager = new AudioManager( - { - VoiceChannelId: 0, //voice channel id where to play music - GuildId: 0, //guild id - VoiceAdapter: 0, //guild VoiceAdapter - }, - { - ResourceType: '', //resource type like link or file - Resource: '', //auto play link or file name - }, + { + VoiceChannelId: 0, //voice channel id where to play music + GuildId: 0, //guild id + VoiceAdapter: 0, //guild VoiceAdapter + }, + { + ResourceType: '', //resource type like link or file + Resource: '', //auto play link or file name + }, ); ``` @@ -77,7 +78,7 @@ let audioManager = new AudioManager( #### Properties | Callable with | Type | Description | -| ----------------- | ---------------------------- | ----------------------------------------------- | +|-------------------|------------------------------|-------------------------------------------------| | `VoiceConnection` | **VoiceConnection** | VoiceConnection instance from discord.js/voice. | | `AudioPlayer` | **AudioPlayer** | AudioPlayer instance from discord.js/voice. | | `AudioResource` | **AudioResource** | AudioResource instance from discord.js/voice. | @@ -86,42 +87,34 @@ let audioManager = new AudioManager( #### Methods -| Callable with | Parameters | Return type | Description | -| ------------------------------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------- | -------------------------------------- | -| `OverrideVoiceConnectionData` | `connectionData` (type of **VoiceConnectionDataModel**) | void | Method to override global connectionData variable. | -| `OverrideVoiceAudioDataModel` | `audioData` (type of **VoiceAudioDataModel**) | void | Method to override global audioData variable. | -| `OverrideRenewInMs` | `renewInMs` (type of int, default value is 5400000) | void | Method to override global renewInMs variable. | -| `CreateConnection` | `isRenew` (type of boolean, default value is false) | void | Method to join the voice connection. | -| `PlayAudioOnConnection` | | void | Method to play audio on the existing voice connection. | -| `PauseAudio` | | void | Method to pause the audio. | -| `ResumeAudio` | | void | Method to resume the audio. | -| `StopAudioOnConnection` | | void | Method to stop the audio without destroying voice connection. | -| `CreateConnectionAndPlayAudio` | | void | Method to join the voice connection and play audio. | -| `DestroyConnection` | | void | Method to destroy the voice connection. | -| `Dispose` | | void | Dispose all data in object. | +| Callable with | Parameters | Return type | Description | | +|--------------------------------|---------------------------------------------------------|-------------|---------------------------------------------------------------|----------------------------------------| +| `OverrideVoiceConnectionData` | `connectionData` (type of **VoiceConnectionDataModel**) | void | Method to override global connectionData variable. | | +| `OverrideVoiceAudioDataModel` | `audioData` (type of **VoiceAudioDataModel**) | void | Method to override global audioData variable. | | +| `OverrideRenewInMs` | `renewInMs` (type of int, default value is 5400000) | void | Method to override global renewInMs variable. | | +| `CreateConnection` | `isRenew` (type of boolean, default value is false) | void | Method to join the voice connection. | | +| `PlayAudioOnConnection` | | void | Method to play audio on the existing voice connection. | | +| `PauseAudio` | | void | Method to pause the audio. | | +| `ResumeAudio` | | void | Method to resume the audio. | | +| `StopAudioOnConnection` | | void | Method to stop the audio without destroying voice connection. | | +| `CreateConnectionAndPlayAudio` | | void | Method to join the voice connection and play audio. | | +| `DestroyConnection` | | void | Method to destroy the voice connection. | | +| `Dispose` | | void | Dispose all data in object. | | | `SetVolume` | `volume` (type of number, 0 - 100 percent) | void | Method to set the audio volume. | Method to set the volume of the audio. | -| `SetMaxListeners` | `maxListeners` (type of number) | void | Method to set the max listeners of the audio stream. | +| `SetMaxListeners` | `maxListeners` (type of number) | void | Method to set the max listeners of the audio stream. | | ##### Types History -- [**VoiceConnection - ** by discord.js/voice](https://github.com/discordjs/discord.js/blob/main/packages/voice/src/VoiceConnection.ts#L166) -- [**AudioPlayer - ** by discord.js/voice](https://github.com/discordjs/discord.js/blob/main/packages/voice/src/audio/AudioPlayer.ts#L155) -- [**AudioResource - ** by discord.js/voice](https://github.com/discordjs/discord.js/blob/main/packages/voice/src/audio/AudioResource.ts#L44) -- [**VoiceConnectionDataModel - **](https://github.com/FrauJulian/Discord-Audio-Stream/blob/main/src/Models/VoiceConnectionDataModel.d.ts#L3) (custom - type) -- [**VoiceAudioDataModel - **](https://github.com/FrauJulian/Discord-Audio-Stream/blob/main/src/Models/VoiceAudioDataModel.d.ts#L1) (custom type) +- [**VoiceConnection** by discord.js/voice](https://github.com/discordjs/discord.js/blob/main/packages/voice/src/VoiceConnection.ts#L166) +- [**AudioPlayer** by discord.js/voice](https://github.com/discordjs/discord.js/blob/main/packages/voice/src/audio/AudioPlayer.ts#L155) +- [**AudioResource** by discord.js/voice](https://github.com/discordjs/discord.js/blob/main/packages/voice/src/audio/AudioResource.ts#L44) +- [**VoiceConnectionDataModel** by discord-audio-stream](https://github.com/FrauJulian/Discord-Audio-Stream/blob/main/src/Models/VoiceConnectionDataModel.d.ts#L3) +- [**VoiceAudioDataModel** by discord-audio-stream](https://github.com/FrauJulian/Discord-Audio-Stream/blob/main/src/Models/VoiceAudioDataModel.d.ts#L1) -## 📋 Credits: +## 📋 Contributors: -~ [**FrauJulian**](https://fraujulian.xyz/). +~ [**FrauJulian - Julian Lechner**](https://fraujulian.xyz/). ## 🤝 Enjoy the package? Give it a star ⭐ on [github](https://github.com/FrauJulian/discord-audio-stream)! - -### Greetings from Austria! ⛰️