matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Documentation fixes for opus bindings.

Browse Source
This commit is contained in:
Rapptz
2015-12-08 16:22:01 -05:00
parent 6217076cbf
commit 9deb7796a5
2 changed files with 21 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
discord/opus.py
View File

@@ -80,25 +80,33 @@ def load_opus(name):
"""Loads the libopus shared library for use with voice. """Loads the libopus shared library for use with voice.
If this function is not called then the library uses the function If this function is not called then the library uses the function
``ctypes.util.find_library`` and then loads that one if available. `ctypes.util.find_library <find_library>` and then loads that one
if available.
.. find_library: https://docs.python.org/3.5/library/ctypes.html#finding-shared-libraries
Not loading a library leads to voice not working. Not loading a library leads to voice not working.
This function propagates the exceptions thrown. This function propagates the exceptions thrown.
.. warning:: Warning
--------
The bitness of the library must match the bitness of your python
interpreter. If the library is 64-bit then your python interpreter
must be 64-bit as well. Usually if there's a mismatch in bitness then
the load will throw an exception.
The bitness of the library must match the bitness of your python Note
interpreter. If the library is 64-bit then your python interpreter ----
must be 64-bit as well. Usually if there's a mismatch in bitness then On Windows, the .dll extension is not necessary. However, on Linux
the load will throw an exception. the full extension is required to load the library, e.g. ``libopus.so.1``.
On Linux however, `find_library`_ will usually find the library automatically
without you having to call this.
.. note:: Parameters
----------
On Windows, the .dll extension is not necessary. However, on Linux name: str
the full extension is required to load the library, e.g. ``libopus.so.1``. The filename of the shared library.
:param name: The filename of the shared library.
""" """
global _lib global _lib
_lib = libopus_loader(name) _lib = libopus_loader(name)

1
docs/api.rst
View File

@@ -457,3 +457,4 @@ The following exceptions are thrown by the library.
.. autoexception:: GatewayNotFound .. autoexception:: GatewayNotFound
.. autoexception:: OpusError