diff --git a/README.md b/README.md index 243f3aad..6d9ff8e5 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,16 @@ -# GtkPlayer -A pre-made GJS Media Player widget powered by GStreamer with OpenGL rendering. +# Clapper +A GNOME media player built using [GJS](https://gitlab.gnome.org/GNOME/gjs) and powered by [GStreamer](https://gstreamer.freedesktop.org) with [OpenGL](https://www.opengl.org) rendering. Can also be used as a pre-made widget for [Gtk](https://www.gtk.org) apps. -Required GStreamer elements: -* [gtkglsink](https://gstreamer.freedesktop.org/documentation/gtk/gtkglsink.html) -* [glsinkbin](https://gstreamer.freedesktop.org/documentation/opengl/glsinkbin.html) +WORK IN PROGRESS + +## Requirements +Clapper uses these `GStreamer` elements: +* [gtkglsink](https://gstreamer.freedesktop.org/documentation/gtk/gtkglsink.html) +* [glsinkbin](https://gstreamer.freedesktop.org/documentation/opengl/glsinkbin.html) Other required plugins (codecs) depend on video format. -To use VAAPI make sure you have `gstreamer1-vaapi` installed. Verify with: +To use `VAAPI` make sure you have `gstreamer1-vaapi` installed. Verify with: ```shell gst-inspect-1.0 vaapi ``` diff --git a/gex.json b/gex.json index ea0e524c..446bc128 100644 --- a/gex.json +++ b/gex.json @@ -1,6 +1,6 @@ { - "name": "GtkPlayer", + "name": "clapper", "files": [ - "GtkPlayer.js" + "src/player.js" ] } diff --git a/GtkPlayer.js b/src/player.js similarity index 100% rename from GtkPlayer.js rename to src/player.js