dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-06-18 14:11:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs_voiceconnection.rst

Browse source
This commit is contained in:
Aaron Scherer 2016-02-09 09:42:37 -08:00
parent b84af789c6
commit 9ff798a8bc
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs_voiceconnection.rst
View file

@ -64,7 +64,7 @@ Plays a file to the voice channel. The file can be in practically any format; if
In addition to a file path local to your computer, it can also accept a URL, however this is not recommended as the entire content of the URL will be read before any playback starts.
This can cause delays from seconds to minutes - you can use `playRawStream` with a Stream obtained from the URL instead.
The `options` object can be used to control playback properties, currently, it currently allows setting the seek (in seconds), and setting the volume using the `volume` property, which can be in any of the following formats:
The `options` object can be used to control playback properties, currently, it currently allows setting the seek (in seconds) using the `seek` property, and the volume using the `volume` property, which can be in any of the following formats:
- A number representing the linear change in volume; 1 is equal to no change, 0 is completely silent, 0.5 is half the regular volume and 2 is double the regular volume.
- A string representing the linear change in volume, if this is more convenient for you.