mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-23 02:01:12 +00:00
add note to docs about GDP versioning; remove tmpl file
Original commit message from CVS: add note to docs about GDP versioning; remove tmpl file
This commit is contained in:
parent
59766b4cd3
commit
d58668de37
2 changed files with 6 additions and 266 deletions
|
@ -1,266 +0,0 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
|
||||
|
||||
<!-- ##### 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>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GstDPVersion ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GST_DP_VERSION_0_2:
|
||||
@GST_DP_VERSION_1_0:
|
||||
|
||||
<!-- ##### MACRO GST_DP_VERSION_MAJOR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DP_VERSION_MINOR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_dp_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstDPHeaderFromBufferFunction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@flags:
|
||||
@length:
|
||||
@header:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstDPPacketFromCapsFunction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@flags:
|
||||
@length:
|
||||
@header:
|
||||
@payload:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstDPPacketFromEventFunction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@flags:
|
||||
@length:
|
||||
@header:
|
||||
@payload:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstDPPacketizer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@version:
|
||||
@header_from_buffer:
|
||||
@packet_from_caps:
|
||||
@packet_from_event:
|
||||
|
||||
<!-- ##### FUNCTION gst_dp_packetizer_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@version:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_dp_packetizer_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@packetizer:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_dp_crc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@length:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### 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:
|
||||
|
||||
|
|
@ -42,6 +42,12 @@
|
|||
* stream. This implies that there will always be a caps packet before any
|
||||
* buffer packets.
|
||||
*
|
||||
* The versioning of the protocol is independent of GStreamer's version.
|
||||
* The major number gets incremented, and the minor reset, for incompatible
|
||||
* changes. The minor number gets incremented for compatible changes that
|
||||
* allow clients who do not completely understand the newer protocol version
|
||||
* to still decode what they do understand.
|
||||
*
|
||||
* Version 0.2 serializes only a small subset of all events, with a custom
|
||||
* payload for each type. Also, all GDP streams start with the initial caps
|
||||
* packet.
|
||||
|
|
Loading…
Reference in a new issue