summaryrefslogtreecommitdiffstats
path: root/ext/aalib/gstaasink.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/aalib/gstaasink.c')
-rw-r--r--ext/aalib/gstaasink.c23
1 files changed, 23 insertions, 0 deletions
diff --git a/ext/aalib/gstaasink.c b/ext/aalib/gstaasink.c
index a633b2db..8ecc90b7 100644
--- a/ext/aalib/gstaasink.c
+++ b/ext/aalib/gstaasink.c
@@ -16,6 +16,29 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:element-aasink
+ * @see_also: #GstCACASink
+ *
+ * <refsect2>
+ * <para>
+ * Displays video as b/w ascii art.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink
+ * </programlisting>
+ * This pipeline renders a video to ascii art into a separate window.
+ * </para>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink driver=curses
+ * </programlisting>
+ * This pipeline renders a video to ascii art into the current terminal.
+ * </para>
+ * </refsect2>
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"