summaryrefslogtreecommitdiffstats
path: root/libmpv
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2015-10-10 15:44:27 +0200
committerwm4 <wm4@nowhere>2015-10-10 15:44:27 +0200
commit46c499d02a6803421a04ef5ebb5f4077c968da3d (patch)
treeb888249557a4b7ca215257973c55baf9c9fd5065 /libmpv
parentdbbde6161d939a1e97e67a5d4c802eff315efed9 (diff)
downloadmpv-46c499d02a6803421a04ef5ebb5f4077c968da3d.tar.bz2
mpv-46c499d02a6803421a04ef5ebb5f4077c968da3d.tar.xz
DOCS/client_api_examples/README: rewrite
The new one is much more detailed. Also add part of it to the libmpv doxygen.
Diffstat (limited to 'libmpv')
-rw-r--r--libmpv/client.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/libmpv/client.h b/libmpv/client.h
index af583d9571..fb4f379626 100644
--- a/libmpv/client.h
+++ b/libmpv/client.h
@@ -49,6 +49,22 @@ extern "C" {
* 2) Using mpv as a library with mpv_create(). This basically allows embedding
* mpv in other applications.
*
+ * Documentation
+ * -------------
+ *
+ * The libmpv C API is documented directly in this header. Note that most
+ * actual interaction with this player is done through
+ * options/commands/properties, which can be accessed through this API.
+ * Essentially everything is done with them, including loading a file,
+ * retrieving playback progress, and so on.
+ *
+ * These are documented elsewhere:
+ * * http://mpv.io/manual/master/#options
+ * * http://mpv.io/manual/master/#list-of-input-commands
+ * * http://mpv.io/manual/master/#properties
+ *
+ * You can also look at the examples in DOCS/client_api_examples/.
+ *
* Event loop
* ----------
*