gst_plugins_base/gst/tcp/gsttcp.h
changeset 16 8e837d1bf446
parent 0 0e761a78d257
child 30 7e817e7e631c
--- a/gst_plugins_base/gst/tcp/gsttcp.h	Wed Mar 24 17:58:42 2010 -0500
+++ b/gst_plugins_base/gst/tcp/gsttcp.h	Wed Mar 24 18:04:17 2010 -0500
@@ -34,6 +34,20 @@
 
 G_BEGIN_DECLS
 
+/**
+ * GstTCPProtocol:
+ * @GST_TCP_PROTOCOL_NONE: Raw data transmission
+ * @GST_TCP_PROTOCOL_GDP: #GstBuffers are wrapped and sent/received using the
+ *      GDP protocol.
+ *
+ * This enum is provided by the tcp/multifd elements to configure the format of
+ * data transmission/reception.
+ *
+ * The GDP protocol wraps data buffers in a header that also carries format
+ * information and timestamps. The None value indicates the data is
+ * sent/received as-is. In that case, format information and timestamping
+ * must be transmitted separately, or implicit in the bytestream itself.
+ */
 typedef enum
 {
   GST_TCP_PROTOCOL_NONE,