summaryrefslogtreecommitdiffstats
path: root/DOCS/client_api_examples/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'DOCS/client_api_examples/README.md')
-rw-r--r--DOCS/client_api_examples/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/DOCS/client_api_examples/README.md b/DOCS/client_api_examples/README.md
new file mode 100644
index 0000000000..9de90a6748
--- /dev/null
+++ b/DOCS/client_api_examples/README.md
@@ -0,0 +1,30 @@
+Client API examples
+===================
+
+All these examples use the mpv client API through libmpv.
+
+cocoa
+-----
+
+Shows how to embed the mpv video window in Objective-C/Cocoa.
+
+qml
+---
+
+Shows how to use mpv's OpenGL video renderer in QtQuick2 with QML.
+
+qml_direct
+----------
+
+Alternative example, which typically avoids a FBO indirection. Might be
+slightly faster, but is less flexible and harder to use.
+
+qt
+--
+
+Shows how to embed the mpv video window in Qt (using normal desktop widgets).
+
+simple
+------
+
+Very primitive terminal-only example. Shows some most basic API usage.