aboutsummaryrefslogtreecommitdiff
path: root/discord/player.py
diff options
context:
space:
mode:
authorNCPlayz <[email protected]>2019-03-16 21:43:55 +0000
committerRapptz <[email protected]>2019-03-19 08:24:42 -0400
commitfb02191b80972a9cf7c3baa765cb3aa84c6f1cfa (patch)
tree7a0a5c9aaa5cc5bac26fc51caf4fdffbaee64c26 /discord/player.py
parentTake back ownership of files from aiohttp for retrying requests. (diff)
downloaddiscord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.tar.xz
discord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.zip
Organise documentation
Diffstat (limited to 'discord/player.py')
-rw-r--r--discord/player.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/discord/player.py b/discord/player.py
index 8ee3bd13..345edcbc 100644
--- a/discord/player.py
+++ b/discord/player.py
@@ -65,7 +65,7 @@ class AudioSource:
Returns
--------
- bytes
+ :class:`bytes`
A bytes like object that represents the PCM or Opus data.
"""
raise NotImplementedError
@@ -117,21 +117,21 @@ class FFmpegPCMAudio(AudioSource):
Parameters
------------
- source: Union[str, BinaryIO]
+ source: Union[:class:`str`, BinaryIO]
The input that ffmpeg will take and convert to PCM bytes.
If ``pipe`` is True then this is a file-like object that is
passed to the stdin of ffmpeg.
- executable: str
+ executable: :class:`str`
The executable name (and path) to use. Defaults to ``ffmpeg``.
- pipe: bool
+ pipe: :class:`bool`
If true, denotes that ``source`` parameter will be passed
to the stdin of ffmpeg. Defaults to ``False``.
stderr: Optional[BinaryIO]
A file-like object to pass to the Popen constructor.
Could also be an instance of ``subprocess.PIPE``.
- options: Optional[str]
+ options: Optional[:class:`str`]
Extra command line arguments to pass to ffmpeg after the ``-i`` flag.
- before_options: Optional[str]
+ before_options: Optional[:class:`str`]
Extra command line arguments to pass to ffmpeg before the ``-i`` flag.
Raises