summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjaseg <code@jaseg.net>2020-04-01 14:27:27 +0200
committerGitHub <noreply@github.com>2020-04-01 14:27:27 +0200
commit4eb105a75128a630868b8204ce2fa50252fc9bff (patch)
tree39b4a067008ddab70aa61d8d614f0c7ba325099e
parentc1df201b26bb1481e273bbb5043d483106ede191 (diff)
downloadpython-mpv-4eb105a75128a630868b8204ce2fa50252fc9bff.tar.gz
python-mpv-4eb105a75128a630868b8204ce2fa50252fc9bff.tar.bz2
python-mpv-4eb105a75128a630868b8204ce2fa50252fc9bff.zip
Add some high-level API information to README
-rw-r--r--README.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 6856fad..2cf347c 100644
--- a/README.rst
+++ b/README.rst
@@ -62,6 +62,9 @@ Usage
import mpv
player = mpv.MPV(ytdl=True)
player.play('https://youtu.be/DOmdB7D-pUU')
+ player.wait_for_playback()
+
+python-mpv mostly exposes mpv's built-in API to python, adding only some porcelain on top. Most "`input commands <https://mpv.io/manual/master/#list-of-input-commands>`_" are mapped to methods of the MPV class. Check out these methods and their docstrings in `the source <https://github.com/jaseg/python-mpv/blob/master/mpv.py>`__ for things you can do. Additional controls and status information are exposed through `MPV properties <https://mpv.io/manual/master/#properties>`_. These can be accessed like ``player.metadata``, ``player.fullscreen`` and ``player.loop_playlist``.
Threading
~~~~~~~~~