[21004] | 1 | <!-- ##### SECTION Title ##### --> |
---|
| 2 | gstdataprotocol |
---|
| 3 | |
---|
| 4 | <!-- ##### SECTION Short_Description ##### --> |
---|
| 5 | implements GStreamer Data Protocol to serialize buffers, caps and events. |
---|
| 6 | |
---|
| 7 | <!-- ##### SECTION Long_Description ##### --> |
---|
| 8 | <para> |
---|
| 9 | This helper library provides serialization of GstBuffer, GstCaps and |
---|
| 10 | GstEvent structures. |
---|
| 11 | </para> |
---|
| 12 | |
---|
| 13 | <para> |
---|
| 14 | This serialization can be useful when GStreamer needs to interface with |
---|
| 15 | the outside world to transport data between different GStreamer pipelines. |
---|
| 16 | The connections with the outside world generally don't have mechanisms |
---|
| 17 | to transport properties of these structures. |
---|
| 18 | </para> |
---|
| 19 | <para> |
---|
| 20 | For example, transporting buffers across named pipes doesn't keep the |
---|
| 21 | buffer size. Network elements that transport GStreamer data across |
---|
| 22 | network connections also need a protocol to do this. |
---|
| 23 | </para> |
---|
| 24 | |
---|
| 25 | <!-- ##### SECTION See_Also ##### --> |
---|
| 26 | <para> |
---|
| 27 | #GstBuffer, #GstCaps, #GstEvent |
---|
| 28 | </para> |
---|
| 29 | |
---|
| 30 | <!-- ##### ENUM GstDPHeaderFlag ##### --> |
---|
| 31 | <para> |
---|
| 32 | |
---|
| 33 | </para> |
---|
| 34 | |
---|
| 35 | @GST_DP_HEADER_FLAG_NONE: |
---|
| 36 | @GST_DP_HEADER_FLAG_CRC_HEADER: |
---|
| 37 | @GST_DP_HEADER_FLAG_CRC_PAYLOAD: |
---|
| 38 | @GST_DP_HEADER_FLAG_CRC: |
---|
| 39 | |
---|
| 40 | <!-- ##### ENUM GstDPPayloadType ##### --> |
---|
| 41 | <para> |
---|
| 42 | |
---|
| 43 | </para> |
---|
| 44 | |
---|
| 45 | @GST_DP_PAYLOAD_NONE: |
---|
| 46 | @GST_DP_PAYLOAD_BUFFER: |
---|
| 47 | @GST_DP_PAYLOAD_CAPS: |
---|
| 48 | @GST_DP_PAYLOAD_EVENT_NONE: |
---|
| 49 | |
---|
| 50 | <!-- ##### FUNCTION gst_dp_header_payload_length ##### --> |
---|
| 51 | <para> |
---|
| 52 | |
---|
| 53 | </para> |
---|
| 54 | |
---|
| 55 | @header: |
---|
| 56 | @Returns: |
---|
| 57 | |
---|
| 58 | |
---|
| 59 | <!-- ##### FUNCTION gst_dp_header_payload_type ##### --> |
---|
| 60 | <para> |
---|
| 61 | |
---|
| 62 | </para> |
---|
| 63 | |
---|
| 64 | @header: |
---|
| 65 | @Returns: |
---|
| 66 | |
---|
| 67 | |
---|
| 68 | <!-- ##### FUNCTION gst_dp_header_from_buffer ##### --> |
---|
| 69 | <para> |
---|
| 70 | |
---|
| 71 | </para> |
---|
| 72 | |
---|
| 73 | @buffer: |
---|
| 74 | @flags: |
---|
| 75 | @length: |
---|
| 76 | @header: |
---|
| 77 | @Returns: |
---|
| 78 | |
---|
| 79 | |
---|
| 80 | <!-- ##### FUNCTION gst_dp_packet_from_caps ##### --> |
---|
| 81 | <para> |
---|
| 82 | |
---|
| 83 | </para> |
---|
| 84 | |
---|
| 85 | @caps: |
---|
| 86 | @flags: |
---|
| 87 | @length: |
---|
| 88 | @header: |
---|
| 89 | @payload: |
---|
| 90 | @Returns: |
---|
| 91 | |
---|
| 92 | |
---|
| 93 | <!-- ##### FUNCTION gst_dp_packet_from_event ##### --> |
---|
| 94 | <para> |
---|
| 95 | |
---|
| 96 | </para> |
---|
| 97 | |
---|
| 98 | @event: |
---|
| 99 | @flags: |
---|
| 100 | @length: |
---|
| 101 | @header: |
---|
| 102 | @payload: |
---|
| 103 | @Returns: |
---|
| 104 | |
---|
| 105 | |
---|
| 106 | <!-- ##### FUNCTION gst_dp_buffer_from_header ##### --> |
---|
| 107 | <para> |
---|
| 108 | |
---|
| 109 | </para> |
---|
| 110 | |
---|
| 111 | @header_length: |
---|
| 112 | @header: |
---|
| 113 | @Returns: |
---|
| 114 | |
---|
| 115 | |
---|
| 116 | <!-- ##### FUNCTION gst_dp_caps_from_packet ##### --> |
---|
| 117 | <para> |
---|
| 118 | |
---|
| 119 | </para> |
---|
| 120 | |
---|
| 121 | @header_length: |
---|
| 122 | @header: |
---|
| 123 | @payload: |
---|
| 124 | @Returns: |
---|
| 125 | |
---|
| 126 | |
---|
| 127 | <!-- ##### FUNCTION gst_dp_event_from_packet ##### --> |
---|
| 128 | <para> |
---|
| 129 | |
---|
| 130 | </para> |
---|
| 131 | |
---|
| 132 | @header_length: |
---|
| 133 | @header: |
---|
| 134 | @payload: |
---|
| 135 | @Returns: |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | <!-- ##### FUNCTION gst_dp_validate_header ##### --> |
---|
| 139 | <para> |
---|
| 140 | |
---|
| 141 | </para> |
---|
| 142 | |
---|
| 143 | @header_length: |
---|
| 144 | @header: |
---|
| 145 | @Returns: |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | <!-- ##### FUNCTION gst_dp_validate_payload ##### --> |
---|
| 149 | <para> |
---|
| 150 | |
---|
| 151 | </para> |
---|
| 152 | |
---|
| 153 | @header_length: |
---|
| 154 | @header: |
---|
| 155 | @payload: |
---|
| 156 | @Returns: |
---|
| 157 | |
---|
| 158 | |
---|
| 159 | <!-- ##### FUNCTION gst_dp_validate_packet ##### --> |
---|
| 160 | <para> |
---|
| 161 | |
---|
| 162 | </para> |
---|
| 163 | |
---|
| 164 | @header_length: |
---|
| 165 | @header: |
---|
| 166 | @payload: |
---|
| 167 | @Returns: |
---|
| 168 | |
---|
| 169 | |
---|