From 46c499d02a6803421a04ef5ebb5f4077c968da3d Mon Sep 17 00:00:00 2001 From: wm4 Date: Sat, 10 Oct 2015 15:44:27 +0200 Subject: DOCS/client_api_examples/README: rewrite The new one is much more detailed. Also add part of it to the libmpv doxygen. --- libmpv/client.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'libmpv') 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 * ---------- * -- cgit v1.2.3