fraujulian/Discord-Audio-Stream
1
0
Fork 0
Code Issues Pull Requests Actions Releases Activity

Updated README.md; Changed scripts in ci;

Browse Source
This commit is contained in:
Lechner Julian - FrauJulian
2025-10-10 18:05:20 +02:00
parent 36bfd035e9
commit 0a0bb40020
3 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/Build-Rollout.yml
+3 -3
View File
@@ -15,10 +15,10 @@ jobs:
- name: Checkout Repository - name: Checkout Repository
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: use NodeJS v22.16.0 - name: use NodeJS v22.12.0
uses: actions/setup-node@v4 uses: actions/setup-node@v4
with: with:
node-version: '22.16.0' node-version: '22.12.0'
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
always-auth: true always-auth: true
@@ -31,7 +31,7 @@ jobs:
run: npm install run: npm install
- name: run Rollout Build - name: run Rollout Build
run: npm run rolloutBuild run: npm run build
- name: Publish Library - name: Publish Library
run: npm publish run: npm publish
.github/workflows/Build-Validation.yml
+1 -1
View File
@@ -20,4 +20,4 @@ jobs:
run: npm install run: npm install
- name: run Rollout Build - name: run Rollout Build
run: npm run rolloutBuild run: npm run build
README.md
+12 -12
View File
@@ -61,15 +61,15 @@ or (with parameters)
```js ```js
let audioManager = new AudioManager( let audioManager = new AudioManager(
{ {
VoiceChannelId: 0, //voice channel id where to play music VoiceChannelId: 0, //voice channel id where to play music
GuildId: 0, //guild id GuildId: 0, //guild id
VoiceAdapter: 0, //guild VoiceAdapter VoiceAdapter: 0, //guild VoiceAdapter
}, },
{ {
ResourceType: '', //resource type like link or file ResourceType: '', //resource type like link or file
Resource: '', //auto play link or file name Resource: '', //auto play link or file name
}, },
); );
``` ```
@@ -78,7 +78,7 @@ let audioManager = new AudioManager(
#### Properties #### Properties
| Callable with | Type | Description | | Callable with | Type | Description |
|-------------------|------------------------------|-------------------------------------------------| | ----------------- | ---------------------------- | ----------------------------------------------- |
| `VoiceConnection` | **VoiceConnection** | VoiceConnection instance from discord.js/voice. | | `VoiceConnection` | **VoiceConnection** | VoiceConnection instance from discord.js/voice. |
| `AudioPlayer` | **AudioPlayer** | AudioPlayer instance from discord.js/voice. | | `AudioPlayer` | **AudioPlayer** | AudioPlayer instance from discord.js/voice. |
| `AudioResource` | **AudioResource** | AudioResource instance from discord.js/voice. | | `AudioResource` | **AudioResource** | AudioResource instance from discord.js/voice. |
@@ -88,7 +88,7 @@ let audioManager = new AudioManager(
#### Methods #### Methods
| Callable with | Parameters | Return type | Description | | | Callable with | Parameters | Return type | Description | |
|--------------------------------|---------------------------------------------------------|-------------|---------------------------------------------------------------|----------------------------------------| | ------------------------------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------- | -------------------------------------- |
| `OverrideVoiceConnectionData` | `connectionData` (type of **VoiceConnectionDataModel**) | void | Method to override global connectionData variable. | | | `OverrideVoiceConnectionData` | `connectionData` (type of **VoiceConnectionDataModel**) | void | Method to override global connectionData variable. | |
| `OverrideVoiceAudioDataModel` | `audioData` (type of **VoiceAudioDataModel**) | void | Method to override global audioData 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. | | | `OverrideRenewInMs` | `renewInMs` (type of int, default value is 5400000) | void | Method to override global renewInMs variable. | |
@@ -108,7 +108,7 @@ let audioManager = new AudioManager(
- [**VoiceConnection** by discord.js/voice](https://github.com/discordjs/discord.js/blob/main/packages/voice/src/VoiceConnection.ts#L166) - [**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) - [**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) - [**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) - [**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) - [**VoiceAudioDataModel** by discord-audio-stream](https://github.com/FrauJulian/Discord-Audio-Stream/blob/main/src/Models/VoiceAudioDataModel.d.ts#L1)
## 📋 Contributors: ## 📋 Contributors: