summaryrefslogtreecommitdiffstats
path: root/tools/gst-visualise.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'tools/gst-visualise.1.in')
-rw-r--r--tools/gst-visualise.1.in35
1 files changed, 35 insertions, 0 deletions
diff --git a/tools/gst-visualise.1.in b/tools/gst-visualise.1.in
new file mode 100644
index 00000000..f61446ec
--- /dev/null
+++ b/tools/gst-visualise.1.in
@@ -0,0 +1,35 @@
+.TH "GStreamer" "1" "February 2002" "" ""
+.SH "NAME"
+gst\-visualise \- Run a GStreamer pipeline to display an audio visualisation
+.SH "SYNOPSIS"
+\fBgst\-visualise\fR \fI[visualiser]\fR
+.SH "DESCRIPTION"
+.LP
+\fIgst\-visualise\fP is a tool that is used to run a basic \fIGStreamer\fP pipeline, to display a graphical visualisation of an audio stream.
+
+By default, the audio stream is read from ESD (the Enlightened Sound Daemon),
+but this can be changed by setting the AUDIOSRC parameter in ~/.gst. For
+example, you might set "AUDIOSRC=osssrc" to display a visualisation of the
+sound input to your soundcard.
+
+You can select a visualiser by providing a parameter naming the visualiser.
+For example:
+
+ gst\-visualise synaesthesia
+
+will use the synaesthesia plugin. If no visualiser is named, the VISUALIZER
+property in ~/.gst will be used. If this is not specified either, the goom
+visualiser will be used.
+
+The videosink to use to display the visualisation will be read from the
+VIDEOSINK parameter in ~/.gst, defaulting to sdlvideosink.
+
+.SH "SEE ALSO"
+.BR gst\-launch\-ext (1),
+.BR gst\-guilaunch (1),
+.BR gst\-complete (1),
+.BR gst\-register (1),
+.BR gst\-inspect (1),
+.BR gst\-launch (1),
+.SH "AUTHOR"
+The GStreamer team at http://gstreamer.net/