From: <tho...@fr...> - 2006-02-06 15:34:31
|
CVS Root: /cvs/gstreamer Module: gst-plugins-good Changes by: thomasvs Date: Mon Feb 06 2006 07:31:29 PST Log message: adding docs for multiudpsink Modified files: . : ChangeLog docs/plugins : Makefile.am gst-plugins-good-plugins-docs.sgml gst-plugins-good-plugins-sections.txt gst/udp : gstmultiudpsink.c Links: http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-good/ChangeLog.diff?r1=1.2128&r2=1.2129 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-good/docs/plugins/Makefile.am.diff?r1=1.13&r2=1.14 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-good/docs/plugins/gst-plugins-good-plugins-docs.sgml.diff?r1=1.14&r2=1.15 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-good/docs/plugins/gst-plugins-good-plugins-sections.txt.diff?r1=1.11&r2=1.12 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-good/gst/udp/gstmultiudpsink.c.diff?r1=1.9&r2=1.10 ====Begin Diffs==== Index: ChangeLog =================================================================== RCS file: /cvs/gstreamer/gst-plugins-good/ChangeLog,v retrieving revision 1.2128 retrieving revision 1.2129 diff -u -d -r1.2128 -r1.2129 --- ChangeLog 6 Feb 2006 15:28:56 -0000 1.2128 +++ ChangeLog 6 Feb 2006 15:31:16 -0000 1.2129 @@ -1,5 +1,14 @@ 2006-02-06 Thomas Vander Stichele <thomas at apestaart dot org> + * docs/plugins/Makefile.am: + * docs/plugins/gst-plugins-good-plugins-docs.sgml: + * docs/plugins/gst-plugins-good-plugins-sections.txt: + * gst/udp/gstmultiudpsink.c: (gst_multiudpsink_class_init), + (gst_multiudpsink_get_stats): + adding docs for multiudpsink + +2006-02-06 Thomas Vander Stichele <thomas at apestaart dot org> * gst/level/gstlevel.c: (gst_level_transform_ip): peak below decay is not necessarily an error, so don't ERROR log Index: Makefile.am RCS file: /cvs/gstreamer/gst-plugins-good/docs/plugins/Makefile.am,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- Makefile.am 6 Feb 2006 11:34:23 -0000 1.13 +++ Makefile.am 6 Feb 2006 15:31:16 -0000 1.14 @@ -85,6 +85,7 @@ $(top_srcdir)/ext/flac/gstflacdec.h \ $(top_srcdir)/gst/multipart/multipartmux.c \ $(top_srcdir)/gst/multipart/multipartdemux.c \ + $(top_srcdir)/gst/udp/gstmultiudpsink.h \ $(top_srcdir)/gst/videomixer/videomixer.c # example code that needs to be converted to xml and placed in xml/ Index: gst-plugins-good-plugins-docs.sgml RCS file: /cvs/gstreamer/gst-plugins-good/docs/plugins/gst-plugins-good-plugins-docs.sgml,v retrieving revision 1.15 diff -u -d -r1.14 -r1.15 --- gst-plugins-good-plugins-docs.sgml 6 Feb 2006 11:34:23 -0000 1.14 +++ gst-plugins-good-plugins-docs.sgml 6 Feb 2006 15:31:16 -0000 1.15 @@ -21,8 +21,7 @@ <xi:include href="xml/element-goom.xml" /> <xi:include href="xml/element-id3demux.xml" /> <xi:include href="xml/element-level.xml" /> - <xi:include href="xml/element-sunaudiomixer.xml" /> - <xi:include href="xml/element-sunaudiosink.xml" /> + <xi:include href="xml/element-multiudpsink.xml" /> <xi:include href="xml/element-multipartmux.xml" /> <xi:include href="xml/element-multipartdemux.xml" /> <xi:include href="xml/element-videomixer.xml" /> @@ -66,7 +65,6 @@ <xi:include href="xml/plugin-shout2send.xml" /> <xi:include href="xml/plugin-smpte.xml" /> <xi:include href="xml/plugin-speex.xml" /> - <xi:include href="xml/plugin-sunaudio.xml" /> <xi:include href="xml/plugin-udp.xml" /> <xi:include href="xml/plugin-videobox.xml" /> <xi:include href="xml/plugin-videoflip.xml" /> Index: gst-plugins-good-plugins-sections.txt RCS file: /cvs/gstreamer/gst-plugins-good/docs/plugins/gst-plugins-good-plugins-sections.txt,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- gst-plugins-good-plugins-sections.txt 6 Feb 2006 11:34:23 -0000 1.11 +++ gst-plugins-good-plugins-sections.txt 6 Feb 2006 15:31:16 -0000 1.12 @@ -87,6 +87,14 @@ </SECTION> <SECTION> +<FILE>element-multiudpsink</FILE> +GstMultiUDPSink +<TITLE>multiudpsink</TITLE> +<SUBSECTION Standard> +GstMultiUDPSinkClass +</SECTION> +<SECTION> <FILE>element-videomixer</FILE> GstVideoMixer GstVideoMixerBackground Index: gstmultiudpsink.c RCS file: /cvs/gstreamer/gst-plugins-good/gst/udp/gstmultiudpsink.c,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- gstmultiudpsink.c 23 Jan 2006 09:59:03 -0000 1.9 +++ gstmultiudpsink.c 6 Feb 2006 15:31:16 -0000 1.10 @@ -17,6 +17,19 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-multiupdsink + * @see_also: udpsink, multifdsink + * + * <refsect2> + * <para> + * multiudpsink is a network sink that sends UDP packets to multiple + * clients. + * It can be combined with rtp payload encoders to implement RTP streaming. + * </para> + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -134,11 +147,23 @@ gobject_class->get_property = gst_multiudpsink_get_property; gobject_class->finalize = gst_multiudpsink_finalize; + /** + * GstMultiUDPSink::add: + * @gstmultiudpsink: the sink on which the signal is emitted + * @host: the hostname/IP address of the client to add + * @port: the port of the client to add + */ gst_multiudpsink_signals[SIGNAL_ADD] = g_signal_new ("add", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, add), NULL, NULL, gst_udp_marshal_VOID__STRING_INT, G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT); + * GstMultiUDPSink::remove: + * @host: the hostname/IP address of the client to remove + * @port: the port of the client to remove gst_multiudpsink_signals[SIGNAL_REMOVE] = g_signal_new ("remove", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, remove), @@ -148,17 +173,37 @@ g_signal_new ("clear", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, clear), NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); + * GstMultiUDPSink::get-stats: + * @host: the hostname/IP address of the client to get stats on + * @port: the port of the client to get stats on + * + * @returns: a GValueArray of uint64: bytes_sent, packets_sent, + * connect_time (in epoch seconds), disconnect_time (in epoch seconds) gst_multiudpsink_signals[SIGNAL_GET_STATS] = g_signal_new ("get-stats", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, get_stats), NULL, NULL, gst_udp_marshal_BOXED__STRING_INT, G_TYPE_VALUE_ARRAY, 2, - + * GstMultiUDPSink::client-added: + * @gstmultiudpsink: the sink emitting the signal + * @host: the hostname/IP address of the added client + * @port: the port of the added client gst_multiudpsink_signals[SIGNAL_CLIENT_ADDED] = g_signal_new ("client-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, client_added), + * GstMultiUDPSink::client-removed: + * @host: the hostname/IP address of the removed client + * @port: the port of the removed client gst_multiudpsink_signals[SIGNAL_CLIENT_REMOVED] = g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, @@ -434,6 +479,8 @@ g_mutex_unlock (sink->client_lock); } +/* FIXME: what's the point of this signal/method ? It frees client structure + * data without removing them from the sink */ void gst_multiudpsink_clear (GstMultiUDPSink * sink) { @@ -466,7 +513,7 @@ client = (GstUDPClient *) find->data; - /* Result is a value array of (bytes_sent, packets_sent, + /* Result is a value array of (bytes_sent, packets_sent, * connect_time, disconnect_time), all as uint64 */ result = g_value_array_new (4); |