summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjaseg <code@jaseg.net>2016-08-07 19:42:20 +0200
committerjaseg <code@jaseg.net>2016-08-07 19:49:37 +0200
commit1bde43a4d81b60b93b5bdabcb3b33d3272b71cc7 (patch)
tree764a170db31a7b62f38942209c3017ce3bfa0ae1 /README.md
parent1acc39885fa503b09006c3467e0cccb8254295d6 (diff)
downloadpython-mpv-1bde43a4d81b60b93b5bdabcb3b33d3272b71cc7.tar.gz
python-mpv-1bde43a4d81b60b93b5bdabcb3b33d3272b71cc7.tar.bz2
python-mpv-1bde43a4d81b60b93b5bdabcb3b33d3272b71cc7.zip
Update README with more instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 41 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2ac2e8f..bbdac86 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,44 @@
python-mpv
==========
-python-mpv is a ctypes-based python interface to the mpv media player. It gives you more or less full control of all features of the player, just as the lua interface does.
+python-mpv is a ctypes-based python interface to the mpv media player. It gives you more or less full control of all
+features of the player, just as the lua interface does.
+
+Installation
+============
+```bash
+wget -O mpv.py https://raw.githubusercontent.com/jaseg/python-mpv/master/mpv.py
+```
+
+Seriously though, part of the idea of this being all in one handy file is that you can just copy it into your project.
+That also means you don't need to be afraid of customizing it, as it's really not a lot of code.
+
+Usage
+=====
+```python
+import mpv
+player = mpv.MPV(ytdl=True)
+player.play('https://youtu.be/DOmdB7D-pUU')
+```
+
+Advanced Usage
+==============
+```python
+#!/usr/bin/env python3
+import mpv
+
+def my_log(loglevel, component, message):
+ print('[{}] {}: {}'.format(loglevel, component, message))
+
+player = mpv.MPV(log_handler=my_log, ytdl=True)
+
+player.observe_property('time-pos', lambda _property, pos: print('Now playing at {:.2f}s'.format(pos)))
+player.fullscreen = True
+player.loop = 'inf'
+
+player.play('https://youtu.be/DLzxrzFCyOs')
+player.wait_for_playback()
+
+del player
+
+```