diff options
Diffstat (limited to 'gst/debug')
-rw-r--r-- | gst/debug/gstpushfilesrc.c | 15 | ||||
-rw-r--r-- | gst/debug/gsttaginject.c | 4 | ||||
-rw-r--r-- | gst/debug/progressreport.c | 39 |
3 files changed, 24 insertions, 34 deletions
diff --git a/gst/debug/gstpushfilesrc.c b/gst/debug/gstpushfilesrc.c index 7ef5259c..47daa83e 100644 --- a/gst/debug/gstpushfilesrc.c +++ b/gst/debug/gstpushfilesrc.c @@ -19,26 +19,21 @@ /** * SECTION:element-pushfilesrc - * @short_description: Works like a filesrc, but only push-based (for debugging) * @see_also: filesrc * - * <refsect2> - * <para> * This element is only useful for debugging purposes. It implements an URI * protocol handler for the 'pushfile' protocol and behaves like a file source * element that cannot be activated in pull-mode. This makes it very easy to * debug demuxers or decoders that can operate both pull and push-based in * connection with the playbin element (which creates a source based on the * URI passed). - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch -m playbin uri=pushfile:///home/you/some/file.ogg - * </programlisting> - * This plays back the given file using playbin, with the demuxer operating + * ]| This plays back the given file using playbin, with the demuxer operating * push-based. - * </para> * </refsect2> */ @@ -156,6 +151,7 @@ gst_push_file_src_uri_get_type (void) { return GST_URI_SRC; } + static gchar ** gst_push_file_src_uri_get_protocols (void) { @@ -163,6 +159,7 @@ gst_push_file_src_uri_get_protocols (void) return protocols; } + static const gchar * gst_push_file_src_uri_get_uri (GstURIHandler * handler) { diff --git a/gst/debug/gsttaginject.c b/gst/debug/gsttaginject.c index 840aa2a4..3429fb14 100644 --- a/gst/debug/gsttaginject.c +++ b/gst/debug/gsttaginject.c @@ -23,12 +23,16 @@ * * Element that injects new metadata tags, but passes incomming data through * unmodified. + * + * <refsect2> + * <title>Example launch lines</title> * |[ * gst-launch audiotestsrc num-buffers=100 ! taginject tags="title=testsrc,artist=gstreamer" ! vorbisenc ! oggmux ! filesink location=test.ogg * ]| set title and artist * |[ * gst-launch audiotestsrc num-buffers=100 ! taginject tags="keywords=\"testone,audio\",title=\"audio testtone\"" ! vorbisenc ! oggmux ! filesink location=test.ogg * ]| set keywords and title demonstrating quoting of special chars + * </refsect2> */ #ifdef HAVE_CONFIG_H diff --git a/gst/debug/progressreport.c b/gst/debug/progressreport.c index e79f6fd9..8f2547b3 100644 --- a/gst/debug/progressreport.c +++ b/gst/debug/progressreport.c @@ -22,32 +22,26 @@ /** * SECTION:element-progressreport - * @short_description: Reports progress - * @see_also: * - * <refsect2> - * <para> * The progressreport element can be put into a pipeline to report progress, * which is done by doing upstream duration and position queries in regular * (real-time) intervals. Both the interval and the prefered query format - * can be specified via the "update-freq" and the "format" property. - * </para> - * <para> + * can be specified via the #GstProgressReport:update-freq and the + * #GstProgressReport:format property. + * * Element messages containing a "progress" structure are posted on the bus * whenever progress has been queried (since gst-plugins-good 0.10.6 only). - * </para> - * <para> + * * Since the element was originally designed for debugging purposes, it will * by default also print information about the current progress to the - * terminal. This can be prevented by setting the "silent" property to TRUE. - * </para> - * <para> + * terminal. This can be prevented by setting the #GstProgressReport:silent + * property to %TRUE. + * * This element is most useful in transcoding pipelines or other situations * where just querying the pipeline might not lead to the wanted result. For * progress in TIME format, the element is best placed in a 'raw stream' * section of the pipeline (or after any demuxers/decoders/parsers). - * </para> - * <para> + * * Three more things should be pointed out: firstly, the element will only * query progress when data flow happens. If data flow is stalled for some * reason, no progress messages will be posted. Secondly, there are other @@ -58,20 +52,15 @@ * take action when they receive an EOS message (since the progress reported * is in reference to an internal point of a pipeline and not the pipeline as * a whole). - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch -m filesrc location=foo.ogg ! decodebin ! progressreport update-freq=1 ! audioconvert ! audioresample ! autoaudiosink - * </programlisting> - * This shows a progress query where a duration is available. - * </para> - * <para> - * <programlisting> + * ]| This shows a progress query where a duration is available. + * |[ * gst-launch -m audiotestsrc ! progressreport update-freq=1 ! audioconvert ! autoaudiosink - * </programlisting> - * This shows a progress query where no duration is available. - * </para> + * ]| This shows a progress query where no duration is available. * </refsect2> */ |