From 9cf73bdd8f18505269fa4b6d1d80127945e735b1 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 28 Jan 2009 17:46:06 +0200 Subject: Update and add documentation for plugins with deps (ext). Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out. --- ext/soup/gstsouphttpsrc.c | 59 ++++++++++++++++------------------------------- 1 file changed, 20 insertions(+), 39 deletions(-) (limited to 'ext/soup') diff --git a/ext/soup/gstsouphttpsrc.c b/ext/soup/gstsouphttpsrc.c index ad7433c1..580d06b6 100644 --- a/ext/soup/gstsouphttpsrc.c +++ b/ext/soup/gstsouphttpsrc.c @@ -14,65 +14,48 @@ /** * SECTION:element-souphttpsrc - * @short_description: Read from an HTTP/HTTPS/WebDAV/Icecast/Shoutcast - * location. * - * - * * This plugin reads data from a remote location specified by a URI. * Supported protocols are 'http', 'https'. - * - * + * * An HTTP proxy must be specified by its URL. * If the "http_proxy" environment variable is set, its value is used. * If built with libsoup's GNOME integration features, the GNOME proxy * configuration will be used, or failing that, proxy autodetection. - * The element-souphttpsrc::proxy property can be used to override the - * default. - * - * - * In case the element-souphttpsrc::iradio-mode property is set and the - * location is an HTTP resource, souphttpsrc will send special Icecast HTTP - * headers to the server to request additional Icecast meta-information. If - * the server is not an Icecast server, it will behave as if the - * element-souphttpsrc::iradio-mode property were not set. If it is, - * souphttpsrc will output data with a media type of application/x-icy, - * in which case you will need to use the #ICYDemux element as follow-up - * element to extract the Icecast metadata and to determine the underlying - * media type. - * - * - * Example pipeline: - * + * The #GstSoupHTTPSrc:proxy property can be used to override the default. + * + * In case the #GstSoupHTTPSrc:iradio-mode property is set and the location is + * an HTTP resource, souphttpsrc will send special Icecast HTTP headers to the + * server to request additional Icecast meta-information. + * If the server is not an Icecast server, it will behave as if the + * #GstSoupHTTPSrc:iradio-mode property were not set. If it is, souphttpsrc will + * output data with a media type of application/x-icy, in which case you will + * need to use the #ICYDemux element as follow-up element to extract the Icecast + * metadata and to determine the underlying media type. + * + * + * Example launch line + * |[ * gst-launch -v souphttpsrc location=https://some.server.org/index.html * ! filesink location=/home/joe/server.html - * - * The above pipeline reads a web page from a server using the HTTPS protocol + * ]| The above pipeline reads a web page from a server using the HTTPS protocol * and writes it to a local file. - * - * - * Another example pipeline: - * + * |[ * gst-launch -v souphttpsrc user-agent="FooPlayer 0.99 beta" * automatic-redirect=false proxy=http://proxy.intranet.local:8080 * location=http://music.foobar.com/demo.mp3 ! mad ! audioconvert * ! audioresample ! alsasink - * - * The above pipeline will read and decode and play an mp3 file from a + * ]| The above pipeline will read and decode and play an mp3 file from a * web server using the HTTP protocol. If the server sends redirects, * the request fails instead of following the redirect. The specified * HTTP proxy server is used. The User-Agent HTTP request header * is set to a custom string instead of "GStreamer souphttpsrc." - * - * - * Yet another example pipeline: - * + * |[ * gst-launch -v souphttpsrc location=http://10.11.12.13/mjpeg * do-timestamp=true ! multipartdemux * ! image/jpeg,width=640,height=480 ! matroskamux * ! filesink location=mjpeg.mkv - * - * The above pipeline reads a motion JPEG stream from an IP camera + * ]| The above pipeline reads a motion JPEG stream from an IP camera * using the HTTP protocol, encoded as mime/multipart image/jpeg * parts, and writes a Matroska motion JPEG file. The width and * height properties are set in the caps to provide the Matroska @@ -81,9 +64,7 @@ * These are used by the mime/multipart demultiplexer to emit timestamps * on the JPEG-encoded video frame buffers. This allows the Matroska * multiplexer to timestamp the frames in the resulting file. - * * - * */ #ifdef HAVE_CONFIG_H -- cgit