gstreamer/docs/libs/tmpl/gstdataprotocol.sgml
Andy Wingo 5b77a67125 check/gst/gstutils.c: New file.
Original commit message from CVS:
2005-09-21  Andy Wingo  <wingo@pobox.com>

* check/gst/gstutils.c: New file.
(test_buffer_probe_n_times): A simple buffer probe test. More to
come, foolios.

* gst/gstutils.c (gst_pad_add_buffer_probe): Connect to
have-data::buffer, not have-data.
(gst_pad_add_event_probe): Likewise for have-data::event.
(gst_pad_add_data_probe): More docs. The part about 'resolving the
peer' isn't quite right yet though.
(gst_pad_remove_buffer_probe, gst_pad_remove_event_probe)
(gst_pad_remove_data_probe): Change to take the guint handler_id
as their arg, not the function+data, which is more glib-like.

* gst/gstpad.c (gst_pad_emit_have_data_signal): Add a detail to
the signal emission to indicate if the data is a buffer or an
event.
(gst_pad_get_type): Initialize buffer and event quarks.
(gst_pad_class_init): have-data is now a detailed signal, yes it
is.
2005-09-21 12:21:10 +00:00

200 lines
2.8 KiB
Text

<!-- ##### SECTION Title ##### -->
gstdataprotocol
<!-- ##### SECTION Short_Description ##### -->
implements GStreamer Data Protocol to serialize buffers, caps and events.
<!-- ##### SECTION Long_Description ##### -->
<para>
This helper library provides serialization of GstBuffer, GstCaps and
GstEvent structures.
</para>
<para>
This serialization can be useful when GStreamer needs to interface with
the outside world to transport data between different GStreamer pipelines.
The connections with the outside world generally don't have mechanisms
to transport properties of these structures.
</para>
<para>
For example, transporting buffers across named pipes doesn't keep the
buffer size. Network elements that transport GStreamer data across
network connections also need a protocol to do this.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstBuffer, #GstCaps, #GstEvent
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GstDPHeaderFlag ##### -->
<para>
</para>
@GST_DP_HEADER_FLAG_NONE:
@GST_DP_HEADER_FLAG_CRC_HEADER:
@GST_DP_HEADER_FLAG_CRC_PAYLOAD:
@GST_DP_HEADER_FLAG_CRC:
<!-- ##### ENUM GstDPPayloadType ##### -->
<para>
</para>
@GST_DP_PAYLOAD_NONE:
@GST_DP_PAYLOAD_BUFFER:
@GST_DP_PAYLOAD_CAPS:
@GST_DP_PAYLOAD_EVENT_NONE:
<!-- ##### MACRO GST_DP_HEADER_LENGTH ##### -->
<para>
</para>
<!-- ##### MACRO GST_DP_VERSION_MAJOR ##### -->
<para>
</para>
<!-- ##### MACRO GST_DP_VERSION_MINOR ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_dp_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_dp_header_payload_length ##### -->
<para>
</para>
@header:
@Returns:
<!-- ##### FUNCTION gst_dp_header_payload_type ##### -->
<para>
</para>
@header:
@Returns:
<!-- ##### FUNCTION gst_dp_header_from_buffer ##### -->
<para>
</para>
@buffer:
@flags:
@length:
@header:
@Returns:
<!-- ##### FUNCTION gst_dp_packet_from_caps ##### -->
<para>
</para>
@caps:
@flags:
@length:
@header:
@payload:
@Returns:
<!-- ##### FUNCTION gst_dp_packet_from_event ##### -->
<para>
</para>
@event:
@flags:
@length:
@header:
@payload:
@Returns:
<!-- ##### FUNCTION gst_dp_buffer_from_header ##### -->
<para>
</para>
@header_length:
@header:
@Returns:
<!-- ##### FUNCTION gst_dp_caps_from_packet ##### -->
<para>
</para>
@header_length:
@header:
@payload:
@Returns:
<!-- ##### FUNCTION gst_dp_event_from_packet ##### -->
<para>
</para>
@header_length:
@header:
@payload:
@Returns:
<!-- ##### FUNCTION gst_dp_validate_header ##### -->
<para>
</para>
@header_length:
@header:
@Returns:
<!-- ##### FUNCTION gst_dp_validate_payload ##### -->
<para>
</para>
@header_length:
@header:
@payload:
@Returns:
<!-- ##### FUNCTION gst_dp_validate_packet ##### -->
<para>
</para>
@header_length:
@header:
@payload:
@Returns: