Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 5 | <title>GstMessage: GStreamer 1.0 Core Reference Manual</title> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 7 | <link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual"> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 8 | <link rel="up" href="libgstreamer.html" title="GStreamer Core Library"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 9 | <link rel="prev" href="GstMemory.html" title="GstMemory"> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 10 | <link rel="next" href="gstreamer-GstMeta.html" title="GstMeta"> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 11 | <meta name="generator" content="GTK-Doc V1.24 (XML mode)"> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 12 | <link rel="stylesheet" href="style.css" type="text/css"> |
| 13 | </head> |
| 14 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 15 | <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 16 | <td width="100%" align="left" class="shortcuts"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 17 | <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 | <a href="#GstMessage.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 19 | <a href="#GstMessage.object-hierarchy" class="shortcut">Object Hierarchy</a></span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 20 | </td> |
| 21 | <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 22 | <td><a accesskey="u" href="libgstreamer.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 23 | <td><a accesskey="p" href="GstMemory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 24 | <td><a accesskey="n" href="gstreamer-GstMeta.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 25 | </tr></table> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 26 | <div class="refentry"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 27 | <a name="GstMessage"></a><div class="titlepage"></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 28 | <div class="refnamediv"><table width="100%"><tr> |
| 29 | <td valign="top"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 30 | <h2><span class="refentrytitle"><a name="GstMessage.top_of_page"></a>GstMessage</span></h2> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 31 | <p>GstMessage — Lightweight objects to signal the application of |
| 32 | pipeline events</p> |
| 33 | </td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 34 | <td class="gallery_image" valign="top" align="right"></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 35 | </tr></table></div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 36 | <div class="refsect1"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 37 | <a name="GstMessage.functions"></a><h2>Functions</h2> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 38 | <div class="informaltable"><table width="100%" border="0"> |
| 39 | <colgroup> |
| 40 | <col width="150px" class="functions_return"> |
| 41 | <col class="functions_name"> |
| 42 | </colgroup> |
| 43 | <tbody> |
| 44 | <tr> |
| 45 | <td class="define_keyword">#define</td> |
| 46 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 47 | <a class="link" href="GstMessage.html#GST-MESSAGE-SRC:CAPS" title="GST_MESSAGE_SRC()">GST_MESSAGE_SRC</a><span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 48 | </td> |
| 49 | </tr> |
| 50 | <tr> |
| 51 | <td class="define_keyword">#define</td> |
| 52 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 53 | <a class="link" href="GstMessage.html#GST-MESSAGE-SRC-NAME:CAPS" title="GST_MESSAGE_SRC_NAME()">GST_MESSAGE_SRC_NAME</a><span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 54 | </td> |
| 55 | </tr> |
| 56 | <tr> |
| 57 | <td class="define_keyword">#define</td> |
| 58 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 59 | <a class="link" href="GstMessage.html#GST-MESSAGE-TIMESTAMP:CAPS" title="GST_MESSAGE_TIMESTAMP()">GST_MESSAGE_TIMESTAMP</a><span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 60 | </td> |
| 61 | </tr> |
| 62 | <tr> |
| 63 | <td class="define_keyword">#define</td> |
| 64 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 65 | <a class="link" href="GstMessage.html#GST-MESSAGE-SEQNUM:CAPS" title="GST_MESSAGE_SEQNUM()">GST_MESSAGE_SEQNUM</a><span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 66 | </td> |
| 67 | </tr> |
| 68 | <tr> |
| 69 | <td class="define_keyword">#define</td> |
| 70 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 71 | <a class="link" href="GstMessage.html#GST-MESSAGE-TYPE:CAPS" title="GST_MESSAGE_TYPE()">GST_MESSAGE_TYPE</a><span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 72 | </td> |
| 73 | </tr> |
| 74 | <tr> |
| 75 | <td class="define_keyword">#define</td> |
| 76 | <td class="function_name"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 77 | <a class="link" href="GstMessage.html#GST-MESSAGE-TYPE-IS-EXTENDED:CAPS" title="GST_MESSAGE_TYPE_IS_EXTENDED()">GST_MESSAGE_TYPE_IS_EXTENDED</a><span class="c_punctuation">()</span> |
| 78 | </td> |
| 79 | </tr> |
| 80 | <tr> |
| 81 | <td class="define_keyword">#define</td> |
| 82 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 83 | <a class="link" href="GstMessage.html#GST-MESSAGE-TYPE-NAME:CAPS" title="GST_MESSAGE_TYPE_NAME()">GST_MESSAGE_TYPE_NAME</a><span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 84 | </td> |
| 85 | </tr> |
| 86 | <tr> |
| 87 | <td class="function_type"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 88 | <a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 89 | </td> |
| 90 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 91 | <a class="link" href="GstMessage.html#gst-message-type-to-quark" title="gst_message_type_to_quark ()">gst_message_type_to_quark</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 92 | </td> |
| 93 | </tr> |
| 94 | <tr> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 95 | <td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 96 | </td> |
| 97 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 98 | <a class="link" href="GstMessage.html#gst-message-type-get-name" title="gst_message_type_get_name ()">gst_message_type_get_name</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 99 | </td> |
| 100 | </tr> |
| 101 | <tr> |
| 102 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 103 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 104 | </td> |
| 105 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 106 | <a class="link" href="GstMessage.html#gst-message-ref" title="gst_message_ref ()">gst_message_ref</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 107 | </td> |
| 108 | </tr> |
| 109 | <tr> |
| 110 | <td class="function_type"> |
| 111 | <span class="returnvalue">void</span> |
| 112 | </td> |
| 113 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 114 | <a class="link" href="GstMessage.html#gst-message-unref" title="gst_message_unref ()">gst_message_unref</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 115 | </td> |
| 116 | </tr> |
| 117 | <tr> |
| 118 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 119 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 120 | </td> |
| 121 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 122 | <a class="link" href="GstMessage.html#gst-message-copy" title="gst_message_copy ()">gst_message_copy</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 123 | </td> |
| 124 | </tr> |
| 125 | <tr> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 126 | <td class="function_type">const <a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 127 | </td> |
| 128 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 129 | <a class="link" href="GstMessage.html#gst-message-get-structure" title="gst_message_get_structure ()">gst_message_get_structure</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 130 | </td> |
| 131 | </tr> |
| 132 | <tr> |
| 133 | <td class="define_keyword">#define</td> |
| 134 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 135 | <a class="link" href="GstMessage.html#gst-message-make-writable" title="gst_message_make_writable()">gst_message_make_writable</a><span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 136 | </td> |
| 137 | </tr> |
| 138 | <tr> |
| 139 | <td class="function_type"> |
| 140 | <span class="returnvalue">guint32</span> |
| 141 | </td> |
| 142 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 143 | <a class="link" href="GstMessage.html#gst-message-get-seqnum" title="gst_message_get_seqnum ()">gst_message_get_seqnum</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 144 | </td> |
| 145 | </tr> |
| 146 | <tr> |
| 147 | <td class="function_type"> |
| 148 | <span class="returnvalue">void</span> |
| 149 | </td> |
| 150 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 151 | <a class="link" href="GstMessage.html#gst-message-set-seqnum" title="gst_message_set_seqnum ()">gst_message_set_seqnum</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 152 | </td> |
| 153 | </tr> |
| 154 | <tr> |
| 155 | <td class="function_type"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 156 | <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 157 | </td> |
| 158 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 159 | <a class="link" href="GstMessage.html#gst-message-has-name" title="gst_message_has_name ()">gst_message_has_name</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 160 | </td> |
| 161 | </tr> |
| 162 | <tr> |
| 163 | <td class="define_keyword">#define</td> |
| 164 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 165 | <a class="link" href="GstMessage.html#gst-message-is-writable" title="gst_message_is_writable()">gst_message_is_writable</a><span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 166 | </td> |
| 167 | </tr> |
| 168 | <tr> |
| 169 | <td class="function_type"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 170 | <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 171 | </td> |
| 172 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 173 | <a class="link" href="GstMessage.html#gst-message-replace" title="gst_message_replace ()">gst_message_replace</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 174 | </td> |
| 175 | </tr> |
| 176 | <tr> |
| 177 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 178 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 179 | </td> |
| 180 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 181 | <a class="link" href="GstMessage.html#gst-message-new-eos" title="gst_message_new_eos ()">gst_message_new_eos</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 182 | </td> |
| 183 | </tr> |
| 184 | <tr> |
| 185 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 186 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 187 | </td> |
| 188 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 189 | <a class="link" href="GstMessage.html#gst-message-new-error" title="gst_message_new_error ()">gst_message_new_error</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 190 | </td> |
| 191 | </tr> |
| 192 | <tr> |
| 193 | <td class="function_type"> |
| 194 | <span class="returnvalue">void</span> |
| 195 | </td> |
| 196 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 197 | <a class="link" href="GstMessage.html#gst-message-parse-error" title="gst_message_parse_error ()">gst_message_parse_error</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 198 | </td> |
| 199 | </tr> |
| 200 | <tr> |
| 201 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 202 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 203 | </td> |
| 204 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 205 | <a class="link" href="GstMessage.html#gst-message-new-warning" title="gst_message_new_warning ()">gst_message_new_warning</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 206 | </td> |
| 207 | </tr> |
| 208 | <tr> |
| 209 | <td class="function_type"> |
| 210 | <span class="returnvalue">void</span> |
| 211 | </td> |
| 212 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 213 | <a class="link" href="GstMessage.html#gst-message-parse-warning" title="gst_message_parse_warning ()">gst_message_parse_warning</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 214 | </td> |
| 215 | </tr> |
| 216 | <tr> |
| 217 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 218 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 219 | </td> |
| 220 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 221 | <a class="link" href="GstMessage.html#gst-message-new-info" title="gst_message_new_info ()">gst_message_new_info</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 222 | </td> |
| 223 | </tr> |
| 224 | <tr> |
| 225 | <td class="function_type"> |
| 226 | <span class="returnvalue">void</span> |
| 227 | </td> |
| 228 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 229 | <a class="link" href="GstMessage.html#gst-message-parse-info" title="gst_message_parse_info ()">gst_message_parse_info</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 230 | </td> |
| 231 | </tr> |
| 232 | <tr> |
| 233 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 234 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 235 | </td> |
| 236 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 237 | <a class="link" href="GstMessage.html#gst-message-new-tag" title="gst_message_new_tag ()">gst_message_new_tag</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 238 | </td> |
| 239 | </tr> |
| 240 | <tr> |
| 241 | <td class="function_type"> |
| 242 | <span class="returnvalue">void</span> |
| 243 | </td> |
| 244 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 245 | <a class="link" href="GstMessage.html#gst-message-parse-tag" title="gst_message_parse_tag ()">gst_message_parse_tag</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 246 | </td> |
| 247 | </tr> |
| 248 | <tr> |
| 249 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 250 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 251 | </td> |
| 252 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 253 | <a class="link" href="GstMessage.html#gst-message-new-buffering" title="gst_message_new_buffering ()">gst_message_new_buffering</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 254 | </td> |
| 255 | </tr> |
| 256 | <tr> |
| 257 | <td class="function_type"> |
| 258 | <span class="returnvalue">void</span> |
| 259 | </td> |
| 260 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 261 | <a class="link" href="GstMessage.html#gst-message-parse-buffering" title="gst_message_parse_buffering ()">gst_message_parse_buffering</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 262 | </td> |
| 263 | </tr> |
| 264 | <tr> |
| 265 | <td class="function_type"> |
| 266 | <span class="returnvalue">void</span> |
| 267 | </td> |
| 268 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 269 | <a class="link" href="GstMessage.html#gst-message-set-buffering-stats" title="gst_message_set_buffering_stats ()">gst_message_set_buffering_stats</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 270 | </td> |
| 271 | </tr> |
| 272 | <tr> |
| 273 | <td class="function_type"> |
| 274 | <span class="returnvalue">void</span> |
| 275 | </td> |
| 276 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 277 | <a class="link" href="GstMessage.html#gst-message-parse-buffering-stats" title="gst_message_parse_buffering_stats ()">gst_message_parse_buffering_stats</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 278 | </td> |
| 279 | </tr> |
| 280 | <tr> |
| 281 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 282 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 283 | </td> |
| 284 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 285 | <a class="link" href="GstMessage.html#gst-message-new-state-changed" title="gst_message_new_state_changed ()">gst_message_new_state_changed</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 286 | </td> |
| 287 | </tr> |
| 288 | <tr> |
| 289 | <td class="function_type"> |
| 290 | <span class="returnvalue">void</span> |
| 291 | </td> |
| 292 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 293 | <a class="link" href="GstMessage.html#gst-message-parse-state-changed" title="gst_message_parse_state_changed ()">gst_message_parse_state_changed</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 294 | </td> |
| 295 | </tr> |
| 296 | <tr> |
| 297 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 298 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 299 | </td> |
| 300 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 301 | <a class="link" href="GstMessage.html#gst-message-new-state-dirty" title="gst_message_new_state_dirty ()">gst_message_new_state_dirty</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 302 | </td> |
| 303 | </tr> |
| 304 | <tr> |
| 305 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 306 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 307 | </td> |
| 308 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 309 | <a class="link" href="GstMessage.html#gst-message-new-step-done" title="gst_message_new_step_done ()">gst_message_new_step_done</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 310 | </td> |
| 311 | </tr> |
| 312 | <tr> |
| 313 | <td class="function_type"> |
| 314 | <span class="returnvalue">void</span> |
| 315 | </td> |
| 316 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 317 | <a class="link" href="GstMessage.html#gst-message-parse-step-done" title="gst_message_parse_step_done ()">gst_message_parse_step_done</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 318 | </td> |
| 319 | </tr> |
| 320 | <tr> |
| 321 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 322 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 323 | </td> |
| 324 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 325 | <a class="link" href="GstMessage.html#gst-message-new-clock-provide" title="gst_message_new_clock_provide ()">gst_message_new_clock_provide</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 326 | </td> |
| 327 | </tr> |
| 328 | <tr> |
| 329 | <td class="function_type"> |
| 330 | <span class="returnvalue">void</span> |
| 331 | </td> |
| 332 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 333 | <a class="link" href="GstMessage.html#gst-message-parse-clock-provide" title="gst_message_parse_clock_provide ()">gst_message_parse_clock_provide</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 334 | </td> |
| 335 | </tr> |
| 336 | <tr> |
| 337 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 338 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 339 | </td> |
| 340 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 341 | <a class="link" href="GstMessage.html#gst-message-new-clock-lost" title="gst_message_new_clock_lost ()">gst_message_new_clock_lost</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 342 | </td> |
| 343 | </tr> |
| 344 | <tr> |
| 345 | <td class="function_type"> |
| 346 | <span class="returnvalue">void</span> |
| 347 | </td> |
| 348 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 349 | <a class="link" href="GstMessage.html#gst-message-parse-clock-lost" title="gst_message_parse_clock_lost ()">gst_message_parse_clock_lost</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 350 | </td> |
| 351 | </tr> |
| 352 | <tr> |
| 353 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 354 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 355 | </td> |
| 356 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 357 | <a class="link" href="GstMessage.html#gst-message-new-new-clock" title="gst_message_new_new_clock ()">gst_message_new_new_clock</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 358 | </td> |
| 359 | </tr> |
| 360 | <tr> |
| 361 | <td class="function_type"> |
| 362 | <span class="returnvalue">void</span> |
| 363 | </td> |
| 364 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 365 | <a class="link" href="GstMessage.html#gst-message-parse-new-clock" title="gst_message_parse_new_clock ()">gst_message_parse_new_clock</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 366 | </td> |
| 367 | </tr> |
| 368 | <tr> |
| 369 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 370 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 371 | </td> |
| 372 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 373 | <a class="link" href="GstMessage.html#gst-message-new-application" title="gst_message_new_application ()">gst_message_new_application</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 374 | </td> |
| 375 | </tr> |
| 376 | <tr> |
| 377 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 378 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 379 | </td> |
| 380 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 381 | <a class="link" href="GstMessage.html#gst-message-new-element" title="gst_message_new_element ()">gst_message_new_element</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 382 | </td> |
| 383 | </tr> |
| 384 | <tr> |
| 385 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 386 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 387 | </td> |
| 388 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 389 | <a class="link" href="GstMessage.html#gst-message-new-custom" title="gst_message_new_custom ()">gst_message_new_custom</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 390 | </td> |
| 391 | </tr> |
| 392 | <tr> |
| 393 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 394 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 395 | </td> |
| 396 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 397 | <a class="link" href="GstMessage.html#gst-message-new-segment-start" title="gst_message_new_segment_start ()">gst_message_new_segment_start</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 398 | </td> |
| 399 | </tr> |
| 400 | <tr> |
| 401 | <td class="function_type"> |
| 402 | <span class="returnvalue">void</span> |
| 403 | </td> |
| 404 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 405 | <a class="link" href="GstMessage.html#gst-message-parse-segment-start" title="gst_message_parse_segment_start ()">gst_message_parse_segment_start</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 406 | </td> |
| 407 | </tr> |
| 408 | <tr> |
| 409 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 410 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 411 | </td> |
| 412 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 413 | <a class="link" href="GstMessage.html#gst-message-new-segment-done" title="gst_message_new_segment_done ()">gst_message_new_segment_done</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 414 | </td> |
| 415 | </tr> |
| 416 | <tr> |
| 417 | <td class="function_type"> |
| 418 | <span class="returnvalue">void</span> |
| 419 | </td> |
| 420 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 421 | <a class="link" href="GstMessage.html#gst-message-parse-segment-done" title="gst_message_parse_segment_done ()">gst_message_parse_segment_done</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 422 | </td> |
| 423 | </tr> |
| 424 | <tr> |
| 425 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 426 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 427 | </td> |
| 428 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 429 | <a class="link" href="GstMessage.html#gst-message-new-duration-changed" title="gst_message_new_duration_changed ()">gst_message_new_duration_changed</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 430 | </td> |
| 431 | </tr> |
| 432 | <tr> |
| 433 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 434 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 435 | </td> |
| 436 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 437 | <a class="link" href="GstMessage.html#gst-message-new-latency" title="gst_message_new_latency ()">gst_message_new_latency</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 438 | </td> |
| 439 | </tr> |
| 440 | <tr> |
| 441 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 442 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 443 | </td> |
| 444 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 445 | <a class="link" href="GstMessage.html#gst-message-new-async-start" title="gst_message_new_async_start ()">gst_message_new_async_start</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 446 | </td> |
| 447 | </tr> |
| 448 | <tr> |
| 449 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 450 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 451 | </td> |
| 452 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 453 | <a class="link" href="GstMessage.html#gst-message-new-async-done" title="gst_message_new_async_done ()">gst_message_new_async_done</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 454 | </td> |
| 455 | </tr> |
| 456 | <tr> |
| 457 | <td class="function_type"> |
| 458 | <span class="returnvalue">void</span> |
| 459 | </td> |
| 460 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 461 | <a class="link" href="GstMessage.html#gst-message-parse-async-done" title="gst_message_parse_async_done ()">gst_message_parse_async_done</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 462 | </td> |
| 463 | </tr> |
| 464 | <tr> |
| 465 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 466 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 467 | </td> |
| 468 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 469 | <a class="link" href="GstMessage.html#gst-message-new-step-start" title="gst_message_new_step_start ()">gst_message_new_step_start</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 470 | </td> |
| 471 | </tr> |
| 472 | <tr> |
| 473 | <td class="function_type"> |
| 474 | <span class="returnvalue">void</span> |
| 475 | </td> |
| 476 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 477 | <a class="link" href="GstMessage.html#gst-message-parse-step-start" title="gst_message_parse_step_start ()">gst_message_parse_step_start</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 478 | </td> |
| 479 | </tr> |
| 480 | <tr> |
| 481 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 482 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 483 | </td> |
| 484 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 485 | <a class="link" href="GstMessage.html#gst-message-new-qos" title="gst_message_new_qos ()">gst_message_new_qos</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 486 | </td> |
| 487 | </tr> |
| 488 | <tr> |
| 489 | <td class="function_type"> |
| 490 | <span class="returnvalue">void</span> |
| 491 | </td> |
| 492 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 493 | <a class="link" href="GstMessage.html#gst-message-set-qos-values" title="gst_message_set_qos_values ()">gst_message_set_qos_values</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 494 | </td> |
| 495 | </tr> |
| 496 | <tr> |
| 497 | <td class="function_type"> |
| 498 | <span class="returnvalue">void</span> |
| 499 | </td> |
| 500 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 501 | <a class="link" href="GstMessage.html#gst-message-set-qos-stats" title="gst_message_set_qos_stats ()">gst_message_set_qos_stats</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 502 | </td> |
| 503 | </tr> |
| 504 | <tr> |
| 505 | <td class="function_type"> |
| 506 | <span class="returnvalue">void</span> |
| 507 | </td> |
| 508 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 509 | <a class="link" href="GstMessage.html#gst-message-parse-qos" title="gst_message_parse_qos ()">gst_message_parse_qos</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 510 | </td> |
| 511 | </tr> |
| 512 | <tr> |
| 513 | <td class="function_type"> |
| 514 | <span class="returnvalue">void</span> |
| 515 | </td> |
| 516 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 517 | <a class="link" href="GstMessage.html#gst-message-parse-qos-values" title="gst_message_parse_qos_values ()">gst_message_parse_qos_values</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 518 | </td> |
| 519 | </tr> |
| 520 | <tr> |
| 521 | <td class="function_type"> |
| 522 | <span class="returnvalue">void</span> |
| 523 | </td> |
| 524 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 525 | <a class="link" href="GstMessage.html#gst-message-parse-qos-stats" title="gst_message_parse_qos_stats ()">gst_message_parse_qos_stats</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 526 | </td> |
| 527 | </tr> |
| 528 | <tr> |
| 529 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 530 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 531 | </td> |
| 532 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 533 | <a class="link" href="GstMessage.html#gst-message-new-toc" title="gst_message_new_toc ()">gst_message_new_toc</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 534 | </td> |
| 535 | </tr> |
| 536 | <tr> |
| 537 | <td class="function_type"> |
| 538 | <span class="returnvalue">void</span> |
| 539 | </td> |
| 540 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 541 | <a class="link" href="GstMessage.html#gst-message-parse-toc" title="gst_message_parse_toc ()">gst_message_parse_toc</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 542 | </td> |
| 543 | </tr> |
| 544 | <tr> |
| 545 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 546 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 547 | </td> |
| 548 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 549 | <a class="link" href="GstMessage.html#gst-message-new-reset-time" title="gst_message_new_reset_time ()">gst_message_new_reset_time</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 550 | </td> |
| 551 | </tr> |
| 552 | <tr> |
| 553 | <td class="function_type"> |
| 554 | <span class="returnvalue">void</span> |
| 555 | </td> |
| 556 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 557 | <a class="link" href="GstMessage.html#gst-message-parse-reset-time" title="gst_message_parse_reset_time ()">gst_message_parse_reset_time</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 558 | </td> |
| 559 | </tr> |
| 560 | <tr> |
| 561 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 562 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 563 | </td> |
| 564 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 565 | <a class="link" href="GstMessage.html#gst-message-new-stream-start" title="gst_message_new_stream_start ()">gst_message_new_stream_start</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 566 | </td> |
| 567 | </tr> |
| 568 | <tr> |
| 569 | <td class="function_type"> |
| 570 | <span class="returnvalue">void</span> |
| 571 | </td> |
| 572 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 573 | <a class="link" href="GstMessage.html#gst-message-set-group-id" title="gst_message_set_group_id ()">gst_message_set_group_id</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 574 | </td> |
| 575 | </tr> |
| 576 | <tr> |
| 577 | <td class="function_type"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 578 | <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 579 | </td> |
| 580 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 581 | <a class="link" href="GstMessage.html#gst-message-parse-group-id" title="gst_message_parse_group_id ()">gst_message_parse_group_id</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 582 | </td> |
| 583 | </tr> |
| 584 | <tr> |
| 585 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 586 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 587 | </td> |
| 588 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 589 | <a class="link" href="GstMessage.html#gst-message-new-structure-change" title="gst_message_new_structure_change ()">gst_message_new_structure_change</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 590 | </td> |
| 591 | </tr> |
| 592 | <tr> |
| 593 | <td class="function_type"> |
| 594 | <span class="returnvalue">void</span> |
| 595 | </td> |
| 596 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 597 | <a class="link" href="GstMessage.html#gst-message-parse-structure-change" title="gst_message_parse_structure_change ()">gst_message_parse_structure_change</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 598 | </td> |
| 599 | </tr> |
| 600 | <tr> |
| 601 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 602 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 603 | </td> |
| 604 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 605 | <a class="link" href="GstMessage.html#gst-message-new-request-state" title="gst_message_new_request_state ()">gst_message_new_request_state</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 606 | </td> |
| 607 | </tr> |
| 608 | <tr> |
| 609 | <td class="function_type"> |
| 610 | <span class="returnvalue">void</span> |
| 611 | </td> |
| 612 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 613 | <a class="link" href="GstMessage.html#gst-message-parse-request-state" title="gst_message_parse_request_state ()">gst_message_parse_request_state</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 614 | </td> |
| 615 | </tr> |
| 616 | <tr> |
| 617 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 618 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 619 | </td> |
| 620 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 621 | <a class="link" href="GstMessage.html#gst-message-new-stream-status" title="gst_message_new_stream_status ()">gst_message_new_stream_status</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 622 | </td> |
| 623 | </tr> |
| 624 | <tr> |
| 625 | <td class="function_type"> |
| 626 | <span class="returnvalue">void</span> |
| 627 | </td> |
| 628 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 629 | <a class="link" href="GstMessage.html#gst-message-parse-stream-status" title="gst_message_parse_stream_status ()">gst_message_parse_stream_status</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 630 | </td> |
| 631 | </tr> |
| 632 | <tr> |
| 633 | <td class="function_type"> |
| 634 | <span class="returnvalue">void</span> |
| 635 | </td> |
| 636 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 637 | <a class="link" href="GstMessage.html#gst-message-set-stream-status-object" title="gst_message_set_stream_status_object ()">gst_message_set_stream_status_object</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 638 | </td> |
| 639 | </tr> |
| 640 | <tr> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 641 | <td class="function_type">const <a href="https://developer.gnome.org/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 642 | </td> |
| 643 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 644 | <a class="link" href="GstMessage.html#gst-message-get-stream-status-object" title="gst_message_get_stream_status_object ()">gst_message_get_stream_status_object</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 645 | </td> |
| 646 | </tr> |
| 647 | <tr> |
| 648 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 649 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 650 | </td> |
| 651 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 652 | <a class="link" href="GstMessage.html#gst-message-new-progress" title="gst_message_new_progress ()">gst_message_new_progress</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 653 | </td> |
| 654 | </tr> |
| 655 | <tr> |
| 656 | <td class="function_type"> |
| 657 | <span class="returnvalue">void</span> |
| 658 | </td> |
| 659 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 660 | <a class="link" href="GstMessage.html#gst-message-parse-progress" title="gst_message_parse_progress ()">gst_message_parse_progress</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 661 | </td> |
| 662 | </tr> |
| 663 | <tr> |
| 664 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 665 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 666 | </td> |
| 667 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 668 | <a class="link" href="GstMessage.html#gst-message-new-need-context" title="gst_message_new_need_context ()">gst_message_new_need_context</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 669 | </td> |
| 670 | </tr> |
| 671 | <tr> |
| 672 | <td class="function_type"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 673 | <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 674 | </td> |
| 675 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 676 | <a class="link" href="GstMessage.html#gst-message-parse-context-type" title="gst_message_parse_context_type ()">gst_message_parse_context_type</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 677 | </td> |
| 678 | </tr> |
| 679 | <tr> |
| 680 | <td class="function_type"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 681 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 682 | </td> |
| 683 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 684 | <a class="link" href="GstMessage.html#gst-message-new-have-context" title="gst_message_new_have_context ()">gst_message_new_have_context</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 685 | </td> |
| 686 | </tr> |
| 687 | <tr> |
| 688 | <td class="function_type"> |
| 689 | <span class="returnvalue">void</span> |
| 690 | </td> |
| 691 | <td class="function_name"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 692 | <a class="link" href="GstMessage.html#gst-message-parse-have-context" title="gst_message_parse_have_context ()">gst_message_parse_have_context</a> <span class="c_punctuation">()</span> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 693 | </td> |
| 694 | </tr> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 695 | <tr> |
| 696 | <td class="function_type"> |
| 697 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
| 698 | </td> |
| 699 | <td class="function_name"> |
| 700 | <a class="link" href="GstMessage.html#gst-message-new-device-added" title="gst_message_new_device_added ()">gst_message_new_device_added</a> <span class="c_punctuation">()</span> |
| 701 | </td> |
| 702 | </tr> |
| 703 | <tr> |
| 704 | <td class="function_type"> |
| 705 | <a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
| 706 | </td> |
| 707 | <td class="function_name"> |
| 708 | <a class="link" href="GstMessage.html#gst-message-new-device-removed" title="gst_message_new_device_removed ()">gst_message_new_device_removed</a> <span class="c_punctuation">()</span> |
| 709 | </td> |
| 710 | </tr> |
| 711 | <tr> |
| 712 | <td class="function_type"> |
| 713 | <span class="returnvalue">void</span> |
| 714 | </td> |
| 715 | <td class="function_name"> |
| 716 | <a class="link" href="GstMessage.html#gst-message-parse-device-added" title="gst_message_parse_device_added ()">gst_message_parse_device_added</a> <span class="c_punctuation">()</span> |
| 717 | </td> |
| 718 | </tr> |
| 719 | <tr> |
| 720 | <td class="function_type"> |
| 721 | <span class="returnvalue">void</span> |
| 722 | </td> |
| 723 | <td class="function_name"> |
| 724 | <a class="link" href="GstMessage.html#gst-message-parse-device-removed" title="gst_message_parse_device_removed ()">gst_message_parse_device_removed</a> <span class="c_punctuation">()</span> |
| 725 | </td> |
| 726 | </tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 727 | </tbody> |
| 728 | </table></div> |
| 729 | </div> |
| 730 | <div class="refsect1"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 731 | <a name="GstMessage.other"></a><h2>Types and Values</h2> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 732 | <div class="informaltable"><table width="100%" border="0"> |
| 733 | <colgroup> |
| 734 | <col width="150px" class="name"> |
| 735 | <col class="description"> |
| 736 | </colgroup> |
| 737 | <tbody> |
| 738 | <tr> |
| 739 | <td class="datatype_keyword">struct</td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 740 | <td class="function_name"><a class="link" href="GstMessage.html#GstMessage-struct" title="struct GstMessage">GstMessage</a></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 741 | </tr> |
| 742 | <tr> |
| 743 | <td class="datatype_keyword">enum</td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 744 | <td class="function_name"><a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType">GstMessageType</a></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 745 | </tr> |
| 746 | <tr> |
| 747 | <td class="datatype_keyword">enum</td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 748 | <td class="function_name"><a class="link" href="GstMessage.html#GstStructureChangeType" title="enum GstStructureChangeType">GstStructureChangeType</a></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 749 | </tr> |
| 750 | <tr> |
| 751 | <td class="datatype_keyword">enum</td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 752 | <td class="function_name"><a class="link" href="GstMessage.html#GstStreamStatusType" title="enum GstStreamStatusType">GstStreamStatusType</a></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 753 | </tr> |
| 754 | <tr> |
| 755 | <td class="datatype_keyword">enum</td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 756 | <td class="function_name"><a class="link" href="GstMessage.html#GstProgressType" title="enum GstProgressType">GstProgressType</a></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 757 | </tr> |
| 758 | </tbody> |
| 759 | </table></div> |
| 760 | </div> |
| 761 | <div class="refsect1"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 762 | <a name="GstMessage.object-hierarchy"></a><h2>Object Hierarchy</h2> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 763 | <pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-Boxed-Types.html">GBoxed</a> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 764 | <span class="lineart">╰──</span> GstMessage |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 765 | </pre> |
| 766 | </div> |
| 767 | <div class="refsect1"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 768 | <a name="GstMessage.includes"></a><h2>Includes</h2> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 769 | <pre class="synopsis">#include <gst/gst.h> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 770 | </pre> |
| 771 | </div> |
| 772 | <div class="refsect1"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 773 | <a name="GstMessage.description"></a><h2>Description</h2> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 774 | <p>Messages are implemented as a subclass of <a class="link" href="gstreamer-GstMiniObject.html#GstMiniObject" title="struct GstMiniObject"><span class="type">GstMiniObject</span></a> with a generic |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 775 | <a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> as the content. This allows for writing custom messages without |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 776 | requiring an API change while allowing a wide range of different types |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 777 | of messages.</p> |
| 778 | <p>Messages are posted by objects in the pipeline and are passed to the |
| 779 | application using the <a class="link" href="GstBus.html" title="GstBus"><span class="type">GstBus</span></a>.</p> |
| 780 | <p>The basic use pattern of posting a message on a <a class="link" href="GstBus.html" title="GstBus"><span class="type">GstBus</span></a> is as follows:</p> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 781 | <div class="informalexample"> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 782 | <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> |
| 783 | <tbody> |
| 784 | <tr> |
| 785 | <td class="listing_lines" align="right"><pre>1</pre></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 786 | <td class="listing_code"><pre class="programlisting"><span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstBus.html#gst-bus-post">gst_bus_post</a></span> <span class="gtkdoc opt">(</span>bus<span class="gtkdoc opt">,</span> <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstMessage.html#gst-message-new-eos">gst_message_new_eos</a></span><span class="gtkdoc opt">());</span></pre></td> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 787 | </tr> |
| 788 | </tbody> |
| 789 | </table> |
| 790 | </div> |
| 791 | |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 792 | <p></p> |
| 793 | <p>A <a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a> usually posts messages on the bus provided by the parent |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 794 | container using <a class="link" href="GstElement.html#gst-element-post-message" title="gst_element_post_message ()"><code class="function">gst_element_post_message()</code></a>.</p> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 795 | </div> |
| 796 | <div class="refsect1"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 797 | <a name="GstMessage.functions_details"></a><h2>Functions</h2> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 798 | <div class="refsect2"> |
| 799 | <a name="GST-MESSAGE-SRC:CAPS"></a><h3>GST_MESSAGE_SRC()</h3> |
| 800 | <pre class="programlisting">#define GST_MESSAGE_SRC(message) (GST_MESSAGE_CAST(message)->src) |
| 801 | </pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 802 | <p>Get the object that posted <em class="parameter"><code>message</code></em> |
| 803 | .</p> |
| 804 | <div class="refsect3"> |
| 805 | <a name="id-1.3.29.8.2.5"></a><h4>Parameters</h4> |
| 806 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 807 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 808 | <col width="150px" class="parameters_name"> |
| 809 | <col class="parameters_description"> |
| 810 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 811 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 812 | <tbody><tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 813 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 814 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 815 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 816 | </tr></tbody> |
| 817 | </table></div> |
| 818 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 819 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 820 | <hr> |
| 821 | <div class="refsect2"> |
| 822 | <a name="GST-MESSAGE-SRC-NAME:CAPS"></a><h3>GST_MESSAGE_SRC_NAME()</h3> |
| 823 | <pre class="programlisting">#define GST_MESSAGE_SRC_NAME(message)</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 824 | <p>Get the name of the object that posted <em class="parameter"><code>message</code></em> |
| 825 | . Returns "(NULL)" if |
| 826 | the message has no source object set.</p> |
| 827 | <div class="refsect3"> |
| 828 | <a name="id-1.3.29.8.3.5"></a><h4>Parameters</h4> |
| 829 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 830 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 831 | <col width="150px" class="parameters_name"> |
| 832 | <col class="parameters_description"> |
| 833 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 834 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 835 | <tbody><tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 836 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 837 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 838 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 839 | </tr></tbody> |
| 840 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 841 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 842 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 843 | <hr> |
| 844 | <div class="refsect2"> |
| 845 | <a name="GST-MESSAGE-TIMESTAMP:CAPS"></a><h3>GST_MESSAGE_TIMESTAMP()</h3> |
| 846 | <pre class="programlisting">#define GST_MESSAGE_TIMESTAMP(message) (GST_MESSAGE_CAST(message)->timestamp) |
| 847 | </pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 848 | <p>Get the timestamp of <em class="parameter"><code>message</code></em> |
| 849 | . This is the timestamp when the message |
| 850 | was created.</p> |
| 851 | <div class="refsect3"> |
| 852 | <a name="id-1.3.29.8.4.5"></a><h4>Parameters</h4> |
| 853 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 854 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 855 | <col width="150px" class="parameters_name"> |
| 856 | <col class="parameters_description"> |
| 857 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 858 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 859 | <tbody><tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 860 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 861 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 862 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 863 | </tr></tbody> |
| 864 | </table></div> |
| 865 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 866 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 867 | <hr> |
| 868 | <div class="refsect2"> |
| 869 | <a name="GST-MESSAGE-SEQNUM:CAPS"></a><h3>GST_MESSAGE_SEQNUM()</h3> |
| 870 | <pre class="programlisting">#define GST_MESSAGE_SEQNUM(message) (GST_MESSAGE_CAST(message)->seqnum) |
| 871 | </pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 872 | <p>Get the sequence number of <em class="parameter"><code>message</code></em> |
| 873 | .</p> |
| 874 | <div class="refsect3"> |
| 875 | <a name="id-1.3.29.8.5.5"></a><h4>Parameters</h4> |
| 876 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 877 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 878 | <col width="150px" class="parameters_name"> |
| 879 | <col class="parameters_description"> |
| 880 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 881 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 882 | <tbody><tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 883 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 884 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 885 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 886 | </tr></tbody> |
| 887 | </table></div> |
| 888 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 889 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 890 | <hr> |
| 891 | <div class="refsect2"> |
| 892 | <a name="GST-MESSAGE-TYPE:CAPS"></a><h3>GST_MESSAGE_TYPE()</h3> |
| 893 | <pre class="programlisting">#define GST_MESSAGE_TYPE(message) (GST_MESSAGE_CAST(message)->type) |
| 894 | </pre> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 895 | <p>Get the <a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType"><span class="type">GstMessageType</span></a> of <em class="parameter"><code>message</code></em> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 896 | .</p> |
| 897 | <div class="refsect3"> |
| 898 | <a name="id-1.3.29.8.6.5"></a><h4>Parameters</h4> |
| 899 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 900 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 901 | <col width="150px" class="parameters_name"> |
| 902 | <col class="parameters_description"> |
| 903 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 904 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 905 | <tbody><tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 906 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 907 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 908 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 909 | </tr></tbody> |
| 910 | </table></div> |
| 911 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 912 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 913 | <hr> |
| 914 | <div class="refsect2"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 915 | <a name="GST-MESSAGE-TYPE-IS-EXTENDED:CAPS"></a><h3>GST_MESSAGE_TYPE_IS_EXTENDED()</h3> |
| 916 | <pre class="programlisting">#define GST_MESSAGE_TYPE_IS_EXTENDED(message) (!!(GST_MESSAGE_CAST(message)->type & GST_MESSAGE_EXTENDED)) |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 917 | </pre> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 918 | <p>Check if the message is in the extended message group |
| 919 | (Since 1.4)</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 920 | <div class="refsect3"> |
| 921 | <a name="id-1.3.29.8.7.5"></a><h4>Parameters</h4> |
| 922 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 923 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 924 | <col width="150px" class="parameters_name"> |
| 925 | <col class="parameters_description"> |
| 926 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 927 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 928 | <tbody><tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 929 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 930 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 931 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 932 | </tr></tbody> |
| 933 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 934 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 935 | </div> |
| 936 | <hr> |
| 937 | <div class="refsect2"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 938 | <a name="GST-MESSAGE-TYPE-NAME:CAPS"></a><h3>GST_MESSAGE_TYPE_NAME()</h3> |
| 939 | <pre class="programlisting">#define GST_MESSAGE_TYPE_NAME(message) gst_message_type_get_name(GST_MESSAGE_TYPE(message)) |
| 940 | </pre> |
| 941 | <p>Get a constant string representation of the <a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType"><span class="type">GstMessageType</span></a> of <em class="parameter"><code>message</code></em> |
| 942 | .</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 943 | <div class="refsect3"> |
| 944 | <a name="id-1.3.29.8.8.5"></a><h4>Parameters</h4> |
| 945 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 946 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 947 | <col width="150px" class="parameters_name"> |
| 948 | <col class="parameters_description"> |
| 949 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 950 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 951 | <tbody><tr> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 952 | <td class="parameter_name"><p>message</p></td> |
| 953 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 954 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 955 | </tr></tbody> |
| 956 | </table></div> |
| 957 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 958 | </div> |
| 959 | <hr> |
| 960 | <div class="refsect2"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 961 | <a name="gst-message-type-to-quark"></a><h3>gst_message_type_to_quark ()</h3> |
| 962 | <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> |
| 963 | gst_message_type_to_quark (<em class="parameter"><code><a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType"><span class="type">GstMessageType</span></a> type</code></em>);</pre> |
| 964 | <p>Get the unique quark for the given message type.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 965 | <div class="refsect3"> |
| 966 | <a name="id-1.3.29.8.9.5"></a><h4>Parameters</h4> |
| 967 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 968 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 969 | <col width="150px" class="parameters_name"> |
| 970 | <col class="parameters_description"> |
| 971 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 972 | </colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 973 | <tbody><tr> |
| 974 | <td class="parameter_name"><p>type</p></td> |
| 975 | <td class="parameter_description"><p>the message type</p></td> |
| 976 | <td class="parameter_annotations"> </td> |
| 977 | </tr></tbody> |
| 978 | </table></div> |
| 979 | </div> |
| 980 | <div class="refsect3"> |
| 981 | <a name="id-1.3.29.8.9.6"></a><h4>Returns</h4> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 982 | <p> the quark associated with the message type</p> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 983 | </div> |
| 984 | </div> |
| 985 | <hr> |
| 986 | <div class="refsect2"> |
| 987 | <a name="gst-message-type-get-name"></a><h3>gst_message_type_get_name ()</h3> |
| 988 | <pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| 989 | gst_message_type_get_name (<em class="parameter"><code><a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType"><span class="type">GstMessageType</span></a> type</code></em>);</pre> |
| 990 | <p>Get a printable name for the given message type. Do not modify or free.</p> |
| 991 | <div class="refsect3"> |
| 992 | <a name="id-1.3.29.8.10.5"></a><h4>Parameters</h4> |
| 993 | <div class="informaltable"><table width="100%" border="0"> |
| 994 | <colgroup> |
| 995 | <col width="150px" class="parameters_name"> |
| 996 | <col class="parameters_description"> |
| 997 | <col width="200px" class="parameters_annotations"> |
| 998 | </colgroup> |
| 999 | <tbody><tr> |
| 1000 | <td class="parameter_name"><p>type</p></td> |
| 1001 | <td class="parameter_description"><p>the message type</p></td> |
| 1002 | <td class="parameter_annotations"> </td> |
| 1003 | </tr></tbody> |
| 1004 | </table></div> |
| 1005 | </div> |
| 1006 | <div class="refsect3"> |
| 1007 | <a name="id-1.3.29.8.10.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1008 | <p> a reference to the static name of the message.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1009 | </div> |
| 1010 | </div> |
| 1011 | <hr> |
| 1012 | <div class="refsect2"> |
| 1013 | <a name="gst-message-ref"></a><h3>gst_message_ref ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1014 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
| 1015 | gst_message_ref (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *msg</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1016 | <p>Convenience macro to increase the reference count of the message.</p> |
| 1017 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1018 | <a name="id-1.3.29.8.11.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1019 | <div class="informaltable"><table width="100%" border="0"> |
| 1020 | <colgroup> |
| 1021 | <col width="150px" class="parameters_name"> |
| 1022 | <col class="parameters_description"> |
| 1023 | <col width="200px" class="parameters_annotations"> |
| 1024 | </colgroup> |
| 1025 | <tbody><tr> |
| 1026 | <td class="parameter_name"><p>msg</p></td> |
| 1027 | <td class="parameter_description"><p>the message to ref</p></td> |
| 1028 | <td class="parameter_annotations"> </td> |
| 1029 | </tr></tbody> |
| 1030 | </table></div> |
| 1031 | </div> |
| 1032 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1033 | <a name="id-1.3.29.8.11.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1034 | <p> <em class="parameter"><code>msg</code></em> |
| 1035 | (for convenience when doing assignments)</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1036 | </div> |
| 1037 | </div> |
| 1038 | <hr> |
| 1039 | <div class="refsect2"> |
| 1040 | <a name="gst-message-unref"></a><h3>gst_message_unref ()</h3> |
| 1041 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1042 | gst_message_unref (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *msg</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1043 | <p>Convenience macro to decrease the reference count of the message, possibly |
| 1044 | freeing it.</p> |
| 1045 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1046 | <a name="id-1.3.29.8.12.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1047 | <div class="informaltable"><table width="100%" border="0"> |
| 1048 | <colgroup> |
| 1049 | <col width="150px" class="parameters_name"> |
| 1050 | <col class="parameters_description"> |
| 1051 | <col width="200px" class="parameters_annotations"> |
| 1052 | </colgroup> |
| 1053 | <tbody><tr> |
| 1054 | <td class="parameter_name"><p>msg</p></td> |
| 1055 | <td class="parameter_description"><p>the message to unref</p></td> |
| 1056 | <td class="parameter_annotations"> </td> |
| 1057 | </tr></tbody> |
| 1058 | </table></div> |
| 1059 | </div> |
| 1060 | </div> |
| 1061 | <hr> |
| 1062 | <div class="refsect2"> |
| 1063 | <a name="gst-message-copy"></a><h3>gst_message_copy ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1064 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
| 1065 | gst_message_copy (<em class="parameter"><code>const <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *msg</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1066 | <p>Creates a copy of the message. Returns a copy of the message.</p> |
| 1067 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1068 | <a name="id-1.3.29.8.13.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1069 | <div class="informaltable"><table width="100%" border="0"> |
| 1070 | <colgroup> |
| 1071 | <col width="150px" class="parameters_name"> |
| 1072 | <col class="parameters_description"> |
| 1073 | <col width="200px" class="parameters_annotations"> |
| 1074 | </colgroup> |
| 1075 | <tbody><tr> |
| 1076 | <td class="parameter_name"><p>msg</p></td> |
| 1077 | <td class="parameter_description"><p>the message to copy</p></td> |
| 1078 | <td class="parameter_annotations"> </td> |
| 1079 | </tr></tbody> |
| 1080 | </table></div> |
| 1081 | </div> |
| 1082 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1083 | <a name="id-1.3.29.8.13.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1084 | <p> a new copy of <em class="parameter"><code>msg</code></em> |
| 1085 | .</p> |
| 1086 | <p>MT safe. </p> |
| 1087 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1088 | </div> |
| 1089 | </div> |
| 1090 | <hr> |
| 1091 | <div class="refsect2"> |
| 1092 | <a name="gst-message-get-structure"></a><h3>gst_message_get_structure ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1093 | <pre class="programlisting">const <a class="link" href="GstStructure.html" title="GstStructure"><span class="returnvalue">GstStructure</span></a> * |
| 1094 | gst_message_get_structure (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1095 | <p>Access the structure of the message.</p> |
| 1096 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1097 | <a name="id-1.3.29.8.14.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1098 | <div class="informaltable"><table width="100%" border="0"> |
| 1099 | <colgroup> |
| 1100 | <col width="150px" class="parameters_name"> |
| 1101 | <col class="parameters_description"> |
| 1102 | <col width="200px" class="parameters_annotations"> |
| 1103 | </colgroup> |
| 1104 | <tbody><tr> |
| 1105 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1106 | <td class="parameter_description"><p>The <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1107 | <td class="parameter_annotations"> </td> |
| 1108 | </tr></tbody> |
| 1109 | </table></div> |
| 1110 | </div> |
| 1111 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1112 | <a name="id-1.3.29.8.14.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1113 | <p> The structure of the message. The structure is |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1114 | still owned by the message, which means that you should not free it and |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1115 | that the pointer becomes invalid when you free the message.</p> |
| 1116 | <p>MT safe. </p> |
| 1117 | <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> |
| 1118 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1119 | </div> |
| 1120 | <hr> |
| 1121 | <div class="refsect2"> |
| 1122 | <a name="gst-message-make-writable"></a><h3>gst_message_make_writable()</h3> |
| 1123 | <pre class="programlisting">#define gst_message_make_writable(msg) GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg))) |
| 1124 | </pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1125 | <p>Checks if a message is writable. If not, a writable copy is made and |
| 1126 | returned.</p> |
| 1127 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1128 | <a name="id-1.3.29.8.15.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1129 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1130 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1131 | <col width="150px" class="parameters_name"> |
| 1132 | <col class="parameters_description"> |
| 1133 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1134 | </colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1135 | <tbody><tr> |
| 1136 | <td class="parameter_name"><p>msg</p></td> |
| 1137 | <td class="parameter_description"><p> the message to make writable. </p></td> |
| 1138 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
| 1139 | </tr></tbody> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1140 | </table></div> |
| 1141 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1142 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1143 | <a name="id-1.3.29.8.15.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1144 | <p> a message (possibly a duplicate) that is writable.</p> |
| 1145 | <p>MT safe. </p> |
| 1146 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1147 | </div> |
| 1148 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1149 | <hr> |
| 1150 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1151 | <a name="gst-message-get-seqnum"></a><h3>gst_message_get_seqnum ()</h3> |
| 1152 | <pre class="programlisting"><span class="returnvalue">guint32</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1153 | gst_message_get_seqnum (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1154 | <p>Retrieve the sequence number of a message.</p> |
| 1155 | <p>Messages have ever-incrementing sequence numbers, which may also be set |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1156 | explicitly via <a class="link" href="GstMessage.html#gst-message-set-seqnum" title="gst_message_set_seqnum ()"><code class="function">gst_message_set_seqnum()</code></a>. Sequence numbers are typically used |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1157 | to indicate that a message corresponds to some other set of messages or |
| 1158 | events, for example a SEGMENT_DONE message corresponding to a SEEK event. It |
| 1159 | is considered good practice to make this correspondence when possible, though |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1160 | it is not required.</p> |
| 1161 | <p>Note that events and messages share the same sequence number incrementor; |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1162 | two events or messages will never have the same sequence number unless |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1163 | that correspondence was made explicitly.</p> |
| 1164 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1165 | <a name="id-1.3.29.8.16.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1166 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1167 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1168 | <col width="150px" class="parameters_name"> |
| 1169 | <col class="parameters_description"> |
| 1170 | <col width="200px" class="parameters_annotations"> |
| 1171 | </colgroup> |
| 1172 | <tbody><tr> |
| 1173 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1174 | <td class="parameter_description"><p>A <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1175 | <td class="parameter_annotations"> </td> |
| 1176 | </tr></tbody> |
| 1177 | </table></div> |
| 1178 | </div> |
| 1179 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1180 | <a name="id-1.3.29.8.16.8"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1181 | <p> The message's sequence number.</p> |
| 1182 | <p>MT safe.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1183 | </div> |
| 1184 | </div> |
| 1185 | <hr> |
| 1186 | <div class="refsect2"> |
| 1187 | <a name="gst-message-set-seqnum"></a><h3>gst_message_set_seqnum ()</h3> |
| 1188 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1189 | gst_message_set_seqnum (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1190 | <em class="parameter"><code><span class="type">guint32</span> seqnum</code></em>);</pre> |
| 1191 | <p>Set the sequence number of a message.</p> |
| 1192 | <p>This function might be called by the creator of a message to indicate that |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1193 | the message relates to other messages or events. See <a class="link" href="GstMessage.html#gst-message-get-seqnum" title="gst_message_get_seqnum ()"><code class="function">gst_message_get_seqnum()</code></a> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1194 | for more information.</p> |
| 1195 | <p>MT safe.</p> |
| 1196 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1197 | <a name="id-1.3.29.8.17.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1198 | <div class="informaltable"><table width="100%" border="0"> |
| 1199 | <colgroup> |
| 1200 | <col width="150px" class="parameters_name"> |
| 1201 | <col class="parameters_description"> |
| 1202 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1203 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1204 | <tbody> |
| 1205 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1206 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1207 | <td class="parameter_description"><p>A <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1208 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1209 | </tr> |
| 1210 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1211 | <td class="parameter_name"><p>seqnum</p></td> |
| 1212 | <td class="parameter_description"><p>A sequence number.</p></td> |
| 1213 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1214 | </tr> |
| 1215 | </tbody> |
| 1216 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1217 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1218 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1219 | <hr> |
| 1220 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1221 | <a name="gst-message-has-name"></a><h3>gst_message_has_name ()</h3> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1222 | <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1223 | gst_message_has_name (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1224 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1225 | <p>Checks if <em class="parameter"><code>message</code></em> |
| 1226 | has the given <em class="parameter"><code>name</code></em> |
| 1227 | . This function is usually used to |
| 1228 | check the name of a custom message.</p> |
| 1229 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1230 | <a name="id-1.3.29.8.18.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1231 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1232 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1233 | <col width="150px" class="parameters_name"> |
| 1234 | <col class="parameters_description"> |
| 1235 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1236 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1237 | <tbody> |
| 1238 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1239 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1240 | <td class="parameter_description"><p>The <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1241 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1242 | </tr> |
| 1243 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1244 | <td class="parameter_name"><p>name</p></td> |
| 1245 | <td class="parameter_description"><p>name to check</p></td> |
| 1246 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1247 | </tr> |
| 1248 | </tbody> |
| 1249 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1250 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1251 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1252 | <a name="id-1.3.29.8.18.6"></a><h4>Returns</h4> |
| 1253 | <p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>name</code></em> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1254 | matches the name of the message structure.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1255 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1256 | </div> |
| 1257 | <hr> |
| 1258 | <div class="refsect2"> |
| 1259 | <a name="gst-message-is-writable"></a><h3>gst_message_is_writable()</h3> |
| 1260 | <pre class="programlisting">#define gst_message_is_writable(msg) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (msg)) |
| 1261 | </pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1262 | <p>Tests if you can safely write into a message's structure or validly |
| 1263 | modify the seqnum and timestamp fields.</p> |
| 1264 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1265 | <a name="id-1.3.29.8.19.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1266 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1267 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1268 | <col width="150px" class="parameters_name"> |
| 1269 | <col class="parameters_description"> |
| 1270 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1271 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1272 | <tbody><tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1273 | <td class="parameter_name"><p>msg</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1274 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1275 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1276 | </tr></tbody> |
| 1277 | </table></div> |
| 1278 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1279 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1280 | <hr> |
| 1281 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1282 | <a name="gst-message-replace"></a><h3>gst_message_replace ()</h3> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1283 | <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1284 | gst_message_replace (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> **old_message</code></em>, |
| 1285 | <em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *new_message</code></em>);</pre> |
| 1286 | <p>Modifies a pointer to a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> to point to a different <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>. The |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1287 | modification is done atomically (so this is useful for ensuring thread safety |
| 1288 | in some cases), and the reference counts are updated appropriately (the old |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1289 | message is unreffed, the new one is reffed).</p> |
| 1290 | <p>Either <em class="parameter"><code>new_message</code></em> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1291 | or the <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> pointed to by <em class="parameter"><code>old_message</code></em> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1292 | may be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1293 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1294 | <a name="id-1.3.29.8.20.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1295 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1296 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1297 | <col width="150px" class="parameters_name"> |
| 1298 | <col class="parameters_description"> |
| 1299 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1300 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1301 | <tbody> |
| 1302 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1303 | <td class="parameter_name"><p>old_message</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1304 | <td class="parameter_description"><p> pointer to a |
| 1305 | pointer to a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> to be replaced. </p></td> |
| 1306 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1307 | </tr> |
| 1308 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1309 | <td class="parameter_name"><p>new_message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1310 | <td class="parameter_description"><p> pointer to a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> that will |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1311 | replace the message pointed to by <em class="parameter"><code>old_message</code></em> |
| 1312 | . </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1313 | <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 1314 | </tr> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1315 | </tbody> |
| 1316 | </table></div> |
| 1317 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1318 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1319 | <a name="id-1.3.29.8.20.7"></a><h4>Returns</h4> |
| 1320 | <p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>new_message</code></em> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1321 | was different from <em class="parameter"><code>old_message</code></em> |
| 1322 | </p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1323 | </div> |
| 1324 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1325 | <hr> |
| 1326 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1327 | <a name="gst-message-new-eos"></a><h3>gst_message_new_eos ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1328 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1329 | gst_message_new_eos (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>);</pre> |
| 1330 | <p>Create a new eos message. This message is generated and posted in |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1331 | the sink elements of a GstBin. The bin will only forward the EOS |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1332 | message to the application if all sinks have posted an EOS message.</p> |
| 1333 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1334 | <a name="id-1.3.29.8.21.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1335 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1336 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1337 | <col width="150px" class="parameters_name"> |
| 1338 | <col class="parameters_description"> |
| 1339 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1340 | </colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1341 | <tbody><tr> |
| 1342 | <td class="parameter_name"><p>src</p></td> |
| 1343 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 1344 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
| 1345 | </tr></tbody> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1346 | </table></div> |
| 1347 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1348 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1349 | <a name="id-1.3.29.8.21.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1350 | <p> The new eos message.</p> |
| 1351 | <p>MT safe. </p> |
| 1352 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1353 | </div> |
| 1354 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1355 | <hr> |
| 1356 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1357 | <a name="gst-message-new-error"></a><h3>gst_message_new_error ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1358 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1359 | gst_message_new_error (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1360 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>, |
| 1361 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *debug</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1362 | <p>Create a new error message. The message will copy <em class="parameter"><code>error</code></em> |
| 1363 | and |
| 1364 | <em class="parameter"><code>debug</code></em> |
| 1365 | . This message is posted by element when a fatal event |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1366 | occurred. The pipeline will probably (partially) stop. The application |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1367 | receiving this message should stop the pipeline.</p> |
| 1368 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1369 | <a name="id-1.3.29.8.22.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1370 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1371 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1372 | <col width="150px" class="parameters_name"> |
| 1373 | <col class="parameters_description"> |
| 1374 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1375 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1376 | <tbody> |
| 1377 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1378 | <td class="parameter_name"><p>src</p></td> |
| 1379 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 1380 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1381 | </tr> |
| 1382 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1383 | <td class="parameter_name"><p>error</p></td> |
| 1384 | <td class="parameter_description"><p> The GError for this message. </p></td> |
| 1385 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1386 | </tr> |
| 1387 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1388 | <td class="parameter_name"><p>debug</p></td> |
| 1389 | <td class="parameter_description"><p>A debugging string.</p></td> |
| 1390 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1391 | </tr> |
| 1392 | </tbody> |
| 1393 | </table></div> |
| 1394 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1395 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1396 | <a name="id-1.3.29.8.22.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1397 | <p> the new error message.</p> |
| 1398 | <p>MT safe. </p> |
| 1399 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1400 | </div> |
| 1401 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1402 | <hr> |
| 1403 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1404 | <a name="gst-message-parse-error"></a><h3>gst_message_parse_error ()</h3> |
| 1405 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1406 | gst_message_parse_error (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1407 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **gerror</code></em>, |
| 1408 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **debug</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1409 | <p>Extracts the GError and debug string from the GstMessage. The values returned |
| 1410 | in the output arguments are copies; the caller must free them when done.</p> |
| 1411 | <p>Typical usage of this function might be:</p> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 1412 | <div class="informalexample"> |
| 1413 | <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> |
| 1414 | <tbody> |
| 1415 | <tr> |
| 1416 | <td class="listing_lines" align="right"><pre>1 |
| 1417 | 2 |
| 1418 | 3 |
| 1419 | 4 |
| 1420 | 5 |
| 1421 | 6 |
| 1422 | 7 |
| 1423 | 8 |
| 1424 | 9 |
| 1425 | 10 |
| 1426 | 11 |
| 1427 | 12 |
| 1428 | 13 |
| 1429 | 14 |
| 1430 | 15 |
| 1431 | 16 |
| 1432 | 17</pre></td> |
| 1433 | <td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">...</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1434 | <span class="keyword">switch</span> <span class="gtkdoc opt">(</span><span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstMessage.html#GST-MESSAGE-TYPE:CAPS">GST_MESSAGE_TYPE</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">)) {</span> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 1435 | <span class="keyword">case</span> GST_MESSAGE_ERROR<span class="gtkdoc opt">: {</span> |
| 1436 | GError <span class="gtkdoc opt">*</span>err <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span> |
| 1437 | gchar <span class="gtkdoc opt">*</span>dbg_info <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span> |
| 1438 | |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1439 | <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstMessage.html#gst-message-parse-error">gst_message_parse_error</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">, &</span>err<span class="gtkdoc opt">, &</span>dbg_info<span class="gtkdoc opt">);</span> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1440 | <span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Warnings-and-Assertions.html#g-printerr">g_printerr</a></span> <span class="gtkdoc opt">(</span><span class="string">"ERROR from element %s: %s</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="gtkdoc opt">,</span> |
Sebastian Dröge | f4e033e | 2012-10-08 09:57:27 +0200 | [diff] [blame] | 1441 | <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html#GST-OBJECT-NAME:CAPS">GST_OBJECT_NAME</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">-></span>src<span class="gtkdoc opt">),</span> err<span class="gtkdoc opt">-></span>message<span class="gtkdoc opt">);</span> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1442 | <span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Warnings-and-Assertions.html#g-printerr">g_printerr</a></span> <span class="gtkdoc opt">(</span><span class="string">"Debugging info: %s</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="gtkdoc opt">, (</span>dbg_info<span class="gtkdoc opt">)</span> ? dbg_info <span class="gtkdoc opt">:</span> <span class="string">"none"</span><span class="gtkdoc opt">);</span> |
| 1443 | <span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#g-error-free">g_error_free</a></span> <span class="gtkdoc opt">(</span>err<span class="gtkdoc opt">);</span> |
| 1444 | <span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free">g_free</a></span> <span class="gtkdoc opt">(</span>dbg_info<span class="gtkdoc opt">);</span> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 1445 | <span class="keyword">break</span><span class="gtkdoc opt">;</span> |
| 1446 | <span class="gtkdoc opt">}</span> |
| 1447 | <span class="gtkdoc opt">...</span> |
| 1448 | <span class="gtkdoc opt">}</span> |
| 1449 | <span class="gtkdoc opt">...</span></pre></td> |
| 1450 | </tr> |
| 1451 | </tbody> |
| 1452 | </table> |
| 1453 | </div> |
| 1454 | |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1455 | <p></p> |
| 1456 | <p>MT safe.</p> |
| 1457 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1458 | <a name="id-1.3.29.8.23.9"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1459 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1460 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1461 | <col width="150px" class="parameters_name"> |
| 1462 | <col class="parameters_description"> |
| 1463 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1464 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1465 | <tbody> |
| 1466 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1467 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1468 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_ERROR.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1469 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1470 | </tr> |
| 1471 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1472 | <td class="parameter_name"><p>gerror</p></td> |
| 1473 | <td class="parameter_description"><p> location for the GError. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1474 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1475 | </tr> |
| 1476 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1477 | <td class="parameter_name"><p>debug</p></td> |
| 1478 | <td class="parameter_description"><p> location for the debug message, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1479 | or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 1480 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1481 | </tr> |
| 1482 | </tbody> |
| 1483 | </table></div> |
| 1484 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1485 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1486 | <hr> |
| 1487 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1488 | <a name="gst-message-new-warning"></a><h3>gst_message_new_warning ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1489 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1490 | gst_message_new_warning (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1491 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>, |
| 1492 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *debug</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1493 | <p>Create a new warning message. The message will make copies of <em class="parameter"><code>error</code></em> |
| 1494 | and |
| 1495 | <em class="parameter"><code>debug</code></em> |
| 1496 | .</p> |
| 1497 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1498 | <a name="id-1.3.29.8.24.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1499 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1500 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1501 | <col width="150px" class="parameters_name"> |
| 1502 | <col class="parameters_description"> |
| 1503 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1504 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1505 | <tbody> |
| 1506 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1507 | <td class="parameter_name"><p>src</p></td> |
| 1508 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 1509 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1510 | </tr> |
| 1511 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1512 | <td class="parameter_name"><p>error</p></td> |
| 1513 | <td class="parameter_description"><p> The GError for this message. </p></td> |
| 1514 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1515 | </tr> |
| 1516 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1517 | <td class="parameter_name"><p>debug</p></td> |
| 1518 | <td class="parameter_description"><p>A debugging string.</p></td> |
| 1519 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1520 | </tr> |
| 1521 | </tbody> |
| 1522 | </table></div> |
| 1523 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1524 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1525 | <a name="id-1.3.29.8.24.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1526 | <p> The new warning message.</p> |
| 1527 | <p>MT safe. </p> |
| 1528 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1529 | </div> |
| 1530 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1531 | <hr> |
| 1532 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1533 | <a name="gst-message-parse-warning"></a><h3>gst_message_parse_warning ()</h3> |
| 1534 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1535 | gst_message_parse_warning (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1536 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **gerror</code></em>, |
| 1537 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **debug</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1538 | <p>Extracts the GError and debug string from the GstMessage. The values returned |
| 1539 | in the output arguments are copies; the caller must free them when done.</p> |
| 1540 | <p>MT safe.</p> |
| 1541 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1542 | <a name="id-1.3.29.8.25.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1543 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1544 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1545 | <col width="150px" class="parameters_name"> |
| 1546 | <col class="parameters_description"> |
| 1547 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1548 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1549 | <tbody> |
| 1550 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1551 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1552 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_WARNING.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1553 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1554 | </tr> |
| 1555 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1556 | <td class="parameter_name"><p>gerror</p></td> |
| 1557 | <td class="parameter_description"><p> location for the GError. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1558 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1559 | </tr> |
| 1560 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1561 | <td class="parameter_name"><p>debug</p></td> |
| 1562 | <td class="parameter_description"><p> location for the debug message, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1563 | or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 1564 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1565 | </tr> |
| 1566 | </tbody> |
| 1567 | </table></div> |
| 1568 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1569 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1570 | <hr> |
| 1571 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1572 | <a name="gst-message-new-info"></a><h3>gst_message_new_info ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1573 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1574 | gst_message_new_info (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1575 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>, |
| 1576 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *debug</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1577 | <p>Create a new info message. The message will make copies of <em class="parameter"><code>error</code></em> |
| 1578 | and |
| 1579 | <em class="parameter"><code>debug</code></em> |
| 1580 | .</p> |
| 1581 | <p>MT safe.</p> |
| 1582 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1583 | <a name="id-1.3.29.8.26.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1584 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1585 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1586 | <col width="150px" class="parameters_name"> |
| 1587 | <col class="parameters_description"> |
| 1588 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1589 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1590 | <tbody> |
| 1591 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1592 | <td class="parameter_name"><p>src</p></td> |
| 1593 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 1594 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1595 | </tr> |
| 1596 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1597 | <td class="parameter_name"><p>error</p></td> |
| 1598 | <td class="parameter_description"><p> The GError for this message. </p></td> |
| 1599 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1600 | </tr> |
| 1601 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1602 | <td class="parameter_name"><p>debug</p></td> |
| 1603 | <td class="parameter_description"><p>A debugging string.</p></td> |
| 1604 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1605 | </tr> |
| 1606 | </tbody> |
| 1607 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1608 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1609 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1610 | <a name="id-1.3.29.8.26.7"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1611 | <p> the new info message. </p> |
| 1612 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1613 | </div> |
| 1614 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1615 | <hr> |
| 1616 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1617 | <a name="gst-message-parse-info"></a><h3>gst_message_parse_info ()</h3> |
| 1618 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1619 | gst_message_parse_info (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1620 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **gerror</code></em>, |
| 1621 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **debug</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1622 | <p>Extracts the GError and debug string from the GstMessage. The values returned |
| 1623 | in the output arguments are copies; the caller must free them when done.</p> |
| 1624 | <p>MT safe.</p> |
| 1625 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1626 | <a name="id-1.3.29.8.27.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1627 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1628 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1629 | <col width="150px" class="parameters_name"> |
| 1630 | <col class="parameters_description"> |
| 1631 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1632 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1633 | <tbody> |
| 1634 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1635 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1636 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_INFO.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1637 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1638 | </tr> |
| 1639 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1640 | <td class="parameter_name"><p>gerror</p></td> |
| 1641 | <td class="parameter_description"><p> location for the GError. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1642 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1643 | </tr> |
| 1644 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1645 | <td class="parameter_name"><p>debug</p></td> |
| 1646 | <td class="parameter_description"><p> location for the debug message, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1647 | or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 1648 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1649 | </tr> |
| 1650 | </tbody> |
| 1651 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1652 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1653 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1654 | <hr> |
| 1655 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1656 | <a name="gst-message-new-tag"></a><h3>gst_message_new_tag ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1657 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1658 | gst_message_new_tag (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1659 | <em class="parameter"><code><a class="link" href="GstTagList.html" title="GstTagList"><span class="type">GstTagList</span></a> *tag_list</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1660 | <p>Create a new tag message. The message will take ownership of the tag list. |
| 1661 | The message is posted by elements that discovered a new taglist.</p> |
| 1662 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1663 | <a name="id-1.3.29.8.28.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1664 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1665 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1666 | <col width="150px" class="parameters_name"> |
| 1667 | <col class="parameters_description"> |
| 1668 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1669 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1670 | <tbody> |
| 1671 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1672 | <td class="parameter_name"><p>src</p></td> |
| 1673 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 1674 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1675 | </tr> |
| 1676 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1677 | <td class="parameter_name"><p>tag_list</p></td> |
| 1678 | <td class="parameter_description"><p> the tag list for the message. </p></td> |
| 1679 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1680 | </tr> |
| 1681 | </tbody> |
| 1682 | </table></div> |
| 1683 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1684 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1685 | <a name="id-1.3.29.8.28.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1686 | <p> the new tag message.</p> |
| 1687 | <p>MT safe. </p> |
| 1688 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1689 | </div> |
| 1690 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1691 | <hr> |
| 1692 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1693 | <a name="gst-message-parse-tag"></a><h3>gst_message_parse_tag ()</h3> |
| 1694 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1695 | gst_message_parse_tag (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 1696 | <em class="parameter"><code><a class="link" href="GstTagList.html" title="GstTagList"><span class="type">GstTagList</span></a> **tag_list</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1697 | <p>Extracts the tag list from the GstMessage. The tag list returned in the |
| 1698 | output argument is a copy; the caller must free it when done.</p> |
| 1699 | <p>Typical usage of this function might be:</p> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 1700 | <div class="informalexample"> |
| 1701 | <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> |
| 1702 | <tbody> |
| 1703 | <tr> |
| 1704 | <td class="listing_lines" align="right"><pre>1 |
| 1705 | 2 |
| 1706 | 3 |
| 1707 | 4 |
| 1708 | 5 |
| 1709 | 6 |
| 1710 | 7 |
| 1711 | 8 |
| 1712 | 9 |
| 1713 | 10 |
| 1714 | 11 |
| 1715 | 12 |
| 1716 | 13 |
| 1717 | 14</pre></td> |
| 1718 | <td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">...</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1719 | <span class="keyword">switch</span> <span class="gtkdoc opt">(</span><span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstMessage.html#GST-MESSAGE-TYPE:CAPS">GST_MESSAGE_TYPE</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">)) {</span> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 1720 | <span class="keyword">case</span> GST_MESSAGE_TAG<span class="gtkdoc opt">: {</span> |
| 1721 | GstTagList <span class="gtkdoc opt">*</span>tags <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span> |
| 1722 | |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1723 | <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstMessage.html#gst-message-parse-tag">gst_message_parse_tag</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">, &</span>tags<span class="gtkdoc opt">);</span> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1724 | <span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span> <span class="gtkdoc opt">(</span><span class="string">"Got tags from element %s</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="gtkdoc opt">,</span> <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html#GST-OBJECT-NAME:CAPS">GST_OBJECT_NAME</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">-></span>src<span class="gtkdoc opt">));</span> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 1725 | <span class="function">handle_tags</span> <span class="gtkdoc opt">(</span>tags<span class="gtkdoc opt">);</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1726 | <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagList.html#gst-tag-list-unref">gst_tag_list_unref</a></span> <span class="gtkdoc opt">(</span>tags<span class="gtkdoc opt">);</span> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 1727 | <span class="keyword">break</span><span class="gtkdoc opt">;</span> |
| 1728 | <span class="gtkdoc opt">}</span> |
| 1729 | <span class="gtkdoc opt">...</span> |
| 1730 | <span class="gtkdoc opt">}</span> |
| 1731 | <span class="gtkdoc opt">...</span></pre></td> |
| 1732 | </tr> |
| 1733 | </tbody> |
| 1734 | </table> |
| 1735 | </div> |
| 1736 | |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1737 | <p></p> |
| 1738 | <p>MT safe.</p> |
| 1739 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1740 | <a name="id-1.3.29.8.29.9"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1741 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1742 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1743 | <col width="150px" class="parameters_name"> |
| 1744 | <col class="parameters_description"> |
| 1745 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1746 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1747 | <tbody> |
| 1748 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1749 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1750 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_TAG.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1751 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1752 | </tr> |
| 1753 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1754 | <td class="parameter_name"><p>tag_list</p></td> |
| 1755 | <td class="parameter_description"><p> return location for the tag-list. </p></td> |
| 1756 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out callee-allocates</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1757 | </tr> |
| 1758 | </tbody> |
| 1759 | </table></div> |
| 1760 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1761 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1762 | <hr> |
| 1763 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1764 | <a name="gst-message-new-buffering"></a><h3>gst_message_new_buffering ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1765 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1766 | gst_message_new_buffering (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1767 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> percent</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1768 | <p>Create a new buffering message. This message can be posted by an element that |
| 1769 | needs to buffer data before it can continue processing. <em class="parameter"><code>percent</code></em> |
| 1770 | should be a |
| 1771 | value between 0 and 100. A value of 100 means that the buffering completed.</p> |
| 1772 | <p>When <em class="parameter"><code>percent</code></em> |
| 1773 | is < 100 the application should PAUSE a PLAYING pipeline. When |
| 1774 | <em class="parameter"><code>percent</code></em> |
| 1775 | is 100, the application can set the pipeline (back) to PLAYING. |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1776 | The application must be prepared to receive BUFFERING messages in the |
| 1777 | PREROLLING state and may only set the pipeline to PLAYING after receiving a |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1778 | message with <em class="parameter"><code>percent</code></em> |
| 1779 | set to 100, which can happen after the pipeline |
| 1780 | completed prerolling.</p> |
| 1781 | <p>MT safe.</p> |
| 1782 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1783 | <a name="id-1.3.29.8.30.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1784 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1785 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1786 | <col width="150px" class="parameters_name"> |
| 1787 | <col class="parameters_description"> |
| 1788 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1789 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1790 | <tbody> |
| 1791 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1792 | <td class="parameter_name"><p>src</p></td> |
| 1793 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 1794 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1795 | </tr> |
| 1796 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1797 | <td class="parameter_name"><p>percent</p></td> |
| 1798 | <td class="parameter_description"><p>The buffering percent</p></td> |
| 1799 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1800 | </tr> |
| 1801 | </tbody> |
| 1802 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1803 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1804 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1805 | <a name="id-1.3.29.8.30.8"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1806 | <p> The new buffering message. </p> |
| 1807 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1808 | </div> |
| 1809 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1810 | <hr> |
| 1811 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1812 | <a name="gst-message-parse-buffering"></a><h3>gst_message_parse_buffering ()</h3> |
| 1813 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1814 | gst_message_parse_buffering (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1815 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *percent</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1816 | <p>Extracts the buffering percent from the GstMessage. see also |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1817 | <a class="link" href="GstMessage.html#gst-message-new-buffering" title="gst_message_new_buffering ()"><code class="function">gst_message_new_buffering()</code></a>.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1818 | <p>MT safe.</p> |
| 1819 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1820 | <a name="id-1.3.29.8.31.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1821 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1822 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1823 | <col width="150px" class="parameters_name"> |
| 1824 | <col class="parameters_description"> |
| 1825 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1826 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1827 | <tbody> |
| 1828 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1829 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1830 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_BUFFERING.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1831 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1832 | </tr> |
| 1833 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1834 | <td class="parameter_name"><p>percent</p></td> |
| 1835 | <td class="parameter_description"><p> Return location for the percent. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1836 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1837 | </tr> |
| 1838 | </tbody> |
| 1839 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1840 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1841 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1842 | <hr> |
| 1843 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1844 | <a name="gst-message-set-buffering-stats"></a><h3>gst_message_set_buffering_stats ()</h3> |
| 1845 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1846 | gst_message_set_buffering_stats (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 1847 | <em class="parameter"><code><a class="link" href="GstQuery.html#GstBufferingMode" title="enum GstBufferingMode"><span class="type">GstBufferingMode</span></a> mode</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1848 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> avg_in</code></em>, |
| 1849 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> avg_out</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1850 | <em class="parameter"><code><span class="type">gint64</span> buffering_left</code></em>);</pre> |
| 1851 | <p>Configures the buffering stats values in <em class="parameter"><code>message</code></em> |
| 1852 | .</p> |
| 1853 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1854 | <a name="id-1.3.29.8.32.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1855 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1856 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1857 | <col width="150px" class="parameters_name"> |
| 1858 | <col class="parameters_description"> |
| 1859 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1860 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1861 | <tbody> |
| 1862 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1863 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1864 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_BUFFERING.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1865 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1866 | </tr> |
| 1867 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1868 | <td class="parameter_name"><p>mode</p></td> |
| 1869 | <td class="parameter_description"><p>a buffering mode </p></td> |
| 1870 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1871 | </tr> |
| 1872 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1873 | <td class="parameter_name"><p>avg_in</p></td> |
| 1874 | <td class="parameter_description"><p>the average input rate</p></td> |
| 1875 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1876 | </tr> |
| 1877 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1878 | <td class="parameter_name"><p>avg_out</p></td> |
| 1879 | <td class="parameter_description"><p>the average output rate</p></td> |
| 1880 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1881 | </tr> |
| 1882 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1883 | <td class="parameter_name"><p>buffering_left</p></td> |
| 1884 | <td class="parameter_description"><p>amount of buffering time left in milliseconds</p></td> |
| 1885 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1886 | </tr> |
| 1887 | </tbody> |
| 1888 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1889 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1890 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1891 | <hr> |
| 1892 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1893 | <a name="gst-message-parse-buffering-stats"></a><h3>gst_message_parse_buffering_stats ()</h3> |
| 1894 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1895 | gst_message_parse_buffering_stats (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 1896 | <em class="parameter"><code><a class="link" href="GstQuery.html#GstBufferingMode" title="enum GstBufferingMode"><span class="type">GstBufferingMode</span></a> *mode</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1897 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *avg_in</code></em>, |
| 1898 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *avg_out</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1899 | <em class="parameter"><code><span class="type">gint64</span> *buffering_left</code></em>);</pre> |
| 1900 | <p>Extracts the buffering stats values from <em class="parameter"><code>message</code></em> |
| 1901 | .</p> |
| 1902 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1903 | <a name="id-1.3.29.8.33.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1904 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1905 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1906 | <col width="150px" class="parameters_name"> |
| 1907 | <col class="parameters_description"> |
| 1908 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1909 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1910 | <tbody> |
| 1911 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1912 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1913 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_BUFFERING.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1914 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1915 | </tr> |
| 1916 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1917 | <td class="parameter_name"><p>mode</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1918 | <td class="parameter_description"><p> a buffering mode, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 1919 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1920 | </tr> |
| 1921 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1922 | <td class="parameter_name"><p>avg_in</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1923 | <td class="parameter_description"><p> the average input rate, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 1924 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1925 | </tr> |
| 1926 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1927 | <td class="parameter_name"><p>avg_out</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1928 | <td class="parameter_description"><p> the average output rate, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 1929 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1930 | </tr> |
| 1931 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1932 | <td class="parameter_name"><p>buffering_left</p></td> |
| 1933 | <td class="parameter_description"><p> amount of buffering time left in |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1934 | milliseconds, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 1935 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1936 | </tr> |
| 1937 | </tbody> |
| 1938 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1939 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1940 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1941 | <hr> |
| 1942 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1943 | <a name="gst-message-new-state-changed"></a><h3>gst_message_new_state_changed ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1944 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1945 | gst_message_new_state_changed (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 1946 | <em class="parameter"><code><a class="link" href="GstElement.html#GstState" title="enum GstState"><span class="type">GstState</span></a> oldstate</code></em>, |
| 1947 | <em class="parameter"><code><a class="link" href="GstElement.html#GstState" title="enum GstState"><span class="type">GstState</span></a> newstate</code></em>, |
| 1948 | <em class="parameter"><code><a class="link" href="GstElement.html#GstState" title="enum GstState"><span class="type">GstState</span></a> pending</code></em>);</pre> |
| 1949 | <p>Create a state change message. This message is posted whenever an element |
| 1950 | changed its state.</p> |
| 1951 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1952 | <a name="id-1.3.29.8.34.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1953 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1954 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1955 | <col width="150px" class="parameters_name"> |
| 1956 | <col class="parameters_description"> |
| 1957 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 1958 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1959 | <tbody> |
| 1960 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1961 | <td class="parameter_name"><p>src</p></td> |
| 1962 | <td class="parameter_description"><p> the object originating the message. </p></td> |
| 1963 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1964 | </tr> |
| 1965 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1966 | <td class="parameter_name"><p>oldstate</p></td> |
| 1967 | <td class="parameter_description"><p>the previous state</p></td> |
| 1968 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1969 | </tr> |
| 1970 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1971 | <td class="parameter_name"><p>newstate</p></td> |
| 1972 | <td class="parameter_description"><p>the new (current) state</p></td> |
| 1973 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1974 | </tr> |
| 1975 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1976 | <td class="parameter_name"><p>pending</p></td> |
| 1977 | <td class="parameter_description"><p>the pending (target) state</p></td> |
| 1978 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1979 | </tr> |
| 1980 | </tbody> |
| 1981 | </table></div> |
| 1982 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1983 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 1984 | <a name="id-1.3.29.8.34.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1985 | <p> the new state change message.</p> |
| 1986 | <p>MT safe. </p> |
| 1987 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 1988 | </div> |
| 1989 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 1990 | <hr> |
| 1991 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1992 | <a name="gst-message-parse-state-changed"></a><h3>gst_message_parse_state_changed ()</h3> |
| 1993 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 1994 | gst_message_parse_state_changed (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 1995 | <em class="parameter"><code><a class="link" href="GstElement.html#GstState" title="enum GstState"><span class="type">GstState</span></a> *oldstate</code></em>, |
| 1996 | <em class="parameter"><code><a class="link" href="GstElement.html#GstState" title="enum GstState"><span class="type">GstState</span></a> *newstate</code></em>, |
| 1997 | <em class="parameter"><code><a class="link" href="GstElement.html#GstState" title="enum GstState"><span class="type">GstState</span></a> *pending</code></em>);</pre> |
| 1998 | <p>Extracts the old and new states from the GstMessage.</p> |
| 1999 | <p>Typical usage of this function might be:</p> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 2000 | <div class="informalexample"> |
| 2001 | <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> |
| 2002 | <tbody> |
| 2003 | <tr> |
| 2004 | <td class="listing_lines" align="right"><pre>1 |
| 2005 | 2 |
| 2006 | 3 |
| 2007 | 4 |
| 2008 | 5 |
| 2009 | 6 |
| 2010 | 7 |
| 2011 | 8 |
| 2012 | 9 |
| 2013 | 10 |
| 2014 | 11 |
| 2015 | 12 |
| 2016 | 13 |
| 2017 | 14 |
| 2018 | 15</pre></td> |
| 2019 | <td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">...</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2020 | <span class="keyword">switch</span> <span class="gtkdoc opt">(</span><span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstMessage.html#GST-MESSAGE-TYPE:CAPS">GST_MESSAGE_TYPE</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">)) {</span> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 2021 | <span class="keyword">case</span> GST_MESSAGE_STATE_CHANGED<span class="gtkdoc opt">: {</span> |
| 2022 | GstState old_state<span class="gtkdoc opt">,</span> new_state<span class="gtkdoc opt">;</span> |
| 2023 | |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2024 | <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstMessage.html#gst-message-parse-state-changed">gst_message_parse_state_changed</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">, &</span>old_state<span class="gtkdoc opt">, &</span>new_state<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2025 | <span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span> <span class="gtkdoc opt">(</span><span class="string">"Element %s changed state from %s to %s.</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="gtkdoc opt">,</span> |
Sebastian Dröge | f4e033e | 2012-10-08 09:57:27 +0200 | [diff] [blame] | 2026 | <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html#GST-OBJECT-NAME:CAPS">GST_OBJECT_NAME</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">-></span>src<span class="gtkdoc opt">),</span> |
| 2027 | <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#gst-element-state-get-name">gst_element_state_get_name</a></span> <span class="gtkdoc opt">(</span>old_state<span class="gtkdoc opt">),</span> |
| 2028 | <span class="function"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#gst-element-state-get-name">gst_element_state_get_name</a></span> <span class="gtkdoc opt">(</span>new_state<span class="gtkdoc opt">));</span> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 2029 | <span class="keyword">break</span><span class="gtkdoc opt">;</span> |
| 2030 | <span class="gtkdoc opt">}</span> |
| 2031 | <span class="gtkdoc opt">...</span> |
| 2032 | <span class="gtkdoc opt">}</span> |
| 2033 | <span class="gtkdoc opt">...</span></pre></td> |
| 2034 | </tr> |
| 2035 | </tbody> |
| 2036 | </table> |
| 2037 | </div> |
| 2038 | |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2039 | <p></p> |
| 2040 | <p>MT safe.</p> |
| 2041 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2042 | <a name="id-1.3.29.8.35.9"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2043 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2044 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2045 | <col width="150px" class="parameters_name"> |
| 2046 | <col class="parameters_description"> |
| 2047 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2048 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2049 | <tbody> |
| 2050 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2051 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2052 | <td class="parameter_description"><p>a valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_STATE_CHANGED</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2053 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2054 | </tr> |
| 2055 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2056 | <td class="parameter_name"><p>oldstate</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2057 | <td class="parameter_description"><p> the previous state, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2058 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2059 | </tr> |
| 2060 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2061 | <td class="parameter_name"><p>newstate</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2062 | <td class="parameter_description"><p> the new (current) state, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2063 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2064 | </tr> |
| 2065 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2066 | <td class="parameter_name"><p>pending</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2067 | <td class="parameter_description"><p> the pending (target) state, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2068 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2069 | </tr> |
| 2070 | </tbody> |
| 2071 | </table></div> |
| 2072 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2073 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2074 | <hr> |
| 2075 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2076 | <a name="gst-message-new-state-dirty"></a><h3>gst_message_new_state_dirty ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2077 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2078 | gst_message_new_state_dirty (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>);</pre> |
| 2079 | <p>Create a state dirty message. This message is posted whenever an element |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2080 | changed its state asynchronously and is used internally to update the |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2081 | states of container objects.</p> |
| 2082 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2083 | <a name="id-1.3.29.8.36.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2084 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2085 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2086 | <col width="150px" class="parameters_name"> |
| 2087 | <col class="parameters_description"> |
| 2088 | <col width="200px" class="parameters_annotations"> |
| 2089 | </colgroup> |
| 2090 | <tbody><tr> |
| 2091 | <td class="parameter_name"><p>src</p></td> |
| 2092 | <td class="parameter_description"><p> the object originating the message. </p></td> |
| 2093 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
| 2094 | </tr></tbody> |
| 2095 | </table></div> |
| 2096 | </div> |
| 2097 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2098 | <a name="id-1.3.29.8.36.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2099 | <p> the new state dirty message.</p> |
| 2100 | <p>MT safe. </p> |
| 2101 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2102 | </div> |
| 2103 | </div> |
| 2104 | <hr> |
| 2105 | <div class="refsect2"> |
| 2106 | <a name="gst-message-new-step-done"></a><h3>gst_message_new_step_done ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2107 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2108 | gst_message_new_step_done (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 2109 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>, |
| 2110 | <em class="parameter"><code><span class="type">guint64</span> amount</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2111 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> rate</code></em>, |
| 2112 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> flush</code></em>, |
| 2113 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> intermediate</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2114 | <em class="parameter"><code><span class="type">guint64</span> duration</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2115 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> eos</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2116 | <p>This message is posted by elements when they complete a part, when <em class="parameter"><code>intermediate</code></em> |
| 2117 | set |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2118 | to <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, or a complete step operation.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2119 | <p><em class="parameter"><code>duration</code></em> |
| 2120 | will contain the amount of time (in GST_FORMAT_TIME) of the stepped |
| 2121 | <em class="parameter"><code>amount</code></em> |
| 2122 | of media in format <em class="parameter"><code>format</code></em> |
| 2123 | .</p> |
| 2124 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2125 | <a name="id-1.3.29.8.37.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2126 | <div class="informaltable"><table width="100%" border="0"> |
| 2127 | <colgroup> |
| 2128 | <col width="150px" class="parameters_name"> |
| 2129 | <col class="parameters_description"> |
| 2130 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2131 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2132 | <tbody> |
| 2133 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2134 | <td class="parameter_name"><p>src</p></td> |
| 2135 | <td class="parameter_description"><p>The object originating the message.</p></td> |
| 2136 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2137 | </tr> |
| 2138 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2139 | <td class="parameter_name"><p>format</p></td> |
| 2140 | <td class="parameter_description"><p>the format of <em class="parameter"><code>amount</code></em> |
| 2141 | </p></td> |
| 2142 | <td class="parameter_annotations"> </td> |
| 2143 | </tr> |
| 2144 | <tr> |
| 2145 | <td class="parameter_name"><p>amount</p></td> |
| 2146 | <td class="parameter_description"><p>the amount of stepped data</p></td> |
| 2147 | <td class="parameter_annotations"> </td> |
| 2148 | </tr> |
| 2149 | <tr> |
| 2150 | <td class="parameter_name"><p>rate</p></td> |
| 2151 | <td class="parameter_description"><p>the rate of the stepped amount</p></td> |
| 2152 | <td class="parameter_annotations"> </td> |
| 2153 | </tr> |
| 2154 | <tr> |
| 2155 | <td class="parameter_name"><p>flush</p></td> |
| 2156 | <td class="parameter_description"><p>is this an flushing step</p></td> |
| 2157 | <td class="parameter_annotations"> </td> |
| 2158 | </tr> |
| 2159 | <tr> |
| 2160 | <td class="parameter_name"><p>intermediate</p></td> |
| 2161 | <td class="parameter_description"><p>is this an intermediate step</p></td> |
| 2162 | <td class="parameter_annotations"> </td> |
| 2163 | </tr> |
| 2164 | <tr> |
| 2165 | <td class="parameter_name"><p>duration</p></td> |
| 2166 | <td class="parameter_description"><p>the duration of the data</p></td> |
| 2167 | <td class="parameter_annotations"> </td> |
| 2168 | </tr> |
| 2169 | <tr> |
| 2170 | <td class="parameter_name"><p>eos</p></td> |
| 2171 | <td class="parameter_description"><p>the step caused EOS</p></td> |
| 2172 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2173 | </tr> |
| 2174 | </tbody> |
| 2175 | </table></div> |
| 2176 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2177 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2178 | <a name="id-1.3.29.8.37.7"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2179 | <p> the new step_done message.</p> |
| 2180 | <p>MT safe. </p> |
| 2181 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2182 | </div> |
| 2183 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2184 | <hr> |
| 2185 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2186 | <a name="gst-message-parse-step-done"></a><h3>gst_message_parse_step_done ()</h3> |
| 2187 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2188 | gst_message_parse_step_done (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2189 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> *format</code></em>, |
| 2190 | <em class="parameter"><code><span class="type">guint64</span> *amount</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2191 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *rate</code></em>, |
| 2192 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *flush</code></em>, |
| 2193 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *intermediate</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2194 | <em class="parameter"><code><span class="type">guint64</span> *duration</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2195 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *eos</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2196 | <p>Extract the values the step_done message.</p> |
| 2197 | <p>MT safe.</p> |
| 2198 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2199 | <a name="id-1.3.29.8.38.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2200 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2201 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2202 | <col width="150px" class="parameters_name"> |
| 2203 | <col class="parameters_description"> |
| 2204 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2205 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2206 | <tbody> |
| 2207 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2208 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2209 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_STEP_DONE.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2210 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2211 | </tr> |
| 2212 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2213 | <td class="parameter_name"><p>format</p></td> |
| 2214 | <td class="parameter_description"><p> result location for the format. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2215 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2216 | </tr> |
| 2217 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2218 | <td class="parameter_name"><p>amount</p></td> |
| 2219 | <td class="parameter_description"><p> result location for the amount. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2220 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2221 | </tr> |
| 2222 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2223 | <td class="parameter_name"><p>rate</p></td> |
| 2224 | <td class="parameter_description"><p> result location for the rate. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2225 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2226 | </tr> |
| 2227 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2228 | <td class="parameter_name"><p>flush</p></td> |
| 2229 | <td class="parameter_description"><p> result location for the flush flag. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2230 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2231 | </tr> |
| 2232 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2233 | <td class="parameter_name"><p>intermediate</p></td> |
| 2234 | <td class="parameter_description"><p> result location for the intermediate flag. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2235 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2236 | </tr> |
| 2237 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2238 | <td class="parameter_name"><p>duration</p></td> |
| 2239 | <td class="parameter_description"><p> result location for the duration. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2240 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2241 | </tr> |
| 2242 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2243 | <td class="parameter_name"><p>eos</p></td> |
| 2244 | <td class="parameter_description"><p> result location for the EOS flag. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2245 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2246 | </tr> |
| 2247 | </tbody> |
| 2248 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2249 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2250 | </div> |
| 2251 | <hr> |
| 2252 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2253 | <a name="gst-message-new-clock-provide"></a><h3>gst_message_new_clock_provide ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2254 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2255 | gst_message_new_clock_provide (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 2256 | <em class="parameter"><code><a class="link" href="GstClock.html" title="GstClock"><span class="type">GstClock</span></a> *clock</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2257 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> ready</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2258 | <p>Create a clock provide message. This message is posted whenever an |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2259 | element is ready to provide a clock or lost its ability to provide |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2260 | a clock (maybe because it paused or became EOS).</p> |
| 2261 | <p>This message is mainly used internally to manage the clock |
| 2262 | selection.</p> |
| 2263 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2264 | <a name="id-1.3.29.8.39.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2265 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2266 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2267 | <col width="150px" class="parameters_name"> |
| 2268 | <col class="parameters_description"> |
| 2269 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2270 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2271 | <tbody> |
| 2272 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2273 | <td class="parameter_name"><p>src</p></td> |
| 2274 | <td class="parameter_description"><p> the object originating the message. </p></td> |
| 2275 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2276 | </tr> |
| 2277 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2278 | <td class="parameter_name"><p>clock</p></td> |
| 2279 | <td class="parameter_description"><p> the clock it provides. </p></td> |
| 2280 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2281 | </tr> |
| 2282 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2283 | <td class="parameter_name"><p>ready</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2284 | <td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the sender can provide a clock</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2285 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2286 | </tr> |
| 2287 | </tbody> |
| 2288 | </table></div> |
| 2289 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2290 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2291 | <a name="id-1.3.29.8.39.7"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2292 | <p> the new provide clock message.</p> |
| 2293 | <p>MT safe. </p> |
| 2294 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2295 | </div> |
| 2296 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2297 | <hr> |
| 2298 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2299 | <a name="gst-message-parse-clock-provide"></a><h3>gst_message_parse_clock_provide ()</h3> |
| 2300 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2301 | gst_message_parse_clock_provide (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2302 | <em class="parameter"><code><a class="link" href="GstClock.html" title="GstClock"><span class="type">GstClock</span></a> **clock</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2303 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *ready</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2304 | <p>Extracts the clock and ready flag from the GstMessage. |
| 2305 | The clock object returned remains valid until the message is freed.</p> |
| 2306 | <p>MT safe.</p> |
| 2307 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2308 | <a name="id-1.3.29.8.40.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2309 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2310 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2311 | <col width="150px" class="parameters_name"> |
| 2312 | <col class="parameters_description"> |
| 2313 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2314 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2315 | <tbody> |
| 2316 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2317 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2318 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_CLOCK_PROVIDE.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2319 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2320 | </tr> |
| 2321 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2322 | <td class="parameter_name"><p>clock</p></td> |
| 2323 | <td class="parameter_description"><p> a pointer to hold a clock |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2324 | object, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2325 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2326 | </tr> |
| 2327 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2328 | <td class="parameter_name"><p>ready</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2329 | <td class="parameter_description"><p> a pointer to hold the ready flag, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2330 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2331 | </tr> |
| 2332 | </tbody> |
| 2333 | </table></div> |
| 2334 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2335 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2336 | <hr> |
| 2337 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2338 | <a name="gst-message-new-clock-lost"></a><h3>gst_message_new_clock_lost ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2339 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2340 | gst_message_new_clock_lost (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 2341 | <em class="parameter"><code><a class="link" href="GstClock.html" title="GstClock"><span class="type">GstClock</span></a> *clock</code></em>);</pre> |
| 2342 | <p>Create a clock lost message. This message is posted whenever the |
| 2343 | clock is not valid anymore.</p> |
| 2344 | <p>If this message is posted by the pipeline, the pipeline will |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2345 | select a new clock again when it goes to PLAYING. It might therefore |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2346 | be needed to set the pipeline to PAUSED and PLAYING again.</p> |
| 2347 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2348 | <a name="id-1.3.29.8.41.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2349 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2350 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2351 | <col width="150px" class="parameters_name"> |
| 2352 | <col class="parameters_description"> |
| 2353 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2354 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2355 | <tbody> |
| 2356 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2357 | <td class="parameter_name"><p>src</p></td> |
| 2358 | <td class="parameter_description"><p> the object originating the message. </p></td> |
| 2359 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2360 | </tr> |
| 2361 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2362 | <td class="parameter_name"><p>clock</p></td> |
| 2363 | <td class="parameter_description"><p> the clock that was lost. </p></td> |
| 2364 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2365 | </tr> |
| 2366 | </tbody> |
| 2367 | </table></div> |
| 2368 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2369 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2370 | <a name="id-1.3.29.8.41.7"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2371 | <p> The new clock lost message.</p> |
| 2372 | <p>MT safe. </p> |
| 2373 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2374 | </div> |
| 2375 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2376 | <hr> |
| 2377 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2378 | <a name="gst-message-parse-clock-lost"></a><h3>gst_message_parse_clock_lost ()</h3> |
| 2379 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2380 | gst_message_parse_clock_lost (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2381 | <em class="parameter"><code><a class="link" href="GstClock.html" title="GstClock"><span class="type">GstClock</span></a> **clock</code></em>);</pre> |
| 2382 | <p>Extracts the lost clock from the GstMessage. |
| 2383 | The clock object returned remains valid until the message is freed.</p> |
| 2384 | <p>MT safe.</p> |
| 2385 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2386 | <a name="id-1.3.29.8.42.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2387 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2388 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2389 | <col width="150px" class="parameters_name"> |
| 2390 | <col class="parameters_description"> |
| 2391 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2392 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2393 | <tbody> |
| 2394 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2395 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2396 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_CLOCK_LOST.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2397 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2398 | </tr> |
| 2399 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2400 | <td class="parameter_name"><p>clock</p></td> |
| 2401 | <td class="parameter_description"><p> a pointer to hold the lost clock. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2402 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2403 | </tr> |
| 2404 | </tbody> |
| 2405 | </table></div> |
| 2406 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2407 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2408 | <hr> |
| 2409 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2410 | <a name="gst-message-new-new-clock"></a><h3>gst_message_new_new_clock ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2411 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2412 | gst_message_new_new_clock (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 2413 | <em class="parameter"><code><a class="link" href="GstClock.html" title="GstClock"><span class="type">GstClock</span></a> *clock</code></em>);</pre> |
| 2414 | <p>Create a new clock message. This message is posted whenever the |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2415 | pipeline selects a new clock for the pipeline.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2416 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2417 | <a name="id-1.3.29.8.43.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2418 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2419 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2420 | <col width="150px" class="parameters_name"> |
| 2421 | <col class="parameters_description"> |
| 2422 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2423 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2424 | <tbody> |
| 2425 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2426 | <td class="parameter_name"><p>src</p></td> |
| 2427 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 2428 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2429 | </tr> |
| 2430 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2431 | <td class="parameter_name"><p>clock</p></td> |
| 2432 | <td class="parameter_description"><p> the new selected clock. </p></td> |
| 2433 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2434 | </tr> |
| 2435 | </tbody> |
| 2436 | </table></div> |
| 2437 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2438 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2439 | <a name="id-1.3.29.8.43.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2440 | <p> The new new clock message.</p> |
| 2441 | <p>MT safe. </p> |
| 2442 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2443 | </div> |
| 2444 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2445 | <hr> |
| 2446 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2447 | <a name="gst-message-parse-new-clock"></a><h3>gst_message_parse_new_clock ()</h3> |
| 2448 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2449 | gst_message_parse_new_clock (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2450 | <em class="parameter"><code><a class="link" href="GstClock.html" title="GstClock"><span class="type">GstClock</span></a> **clock</code></em>);</pre> |
| 2451 | <p>Extracts the new clock from the GstMessage. |
| 2452 | The clock object returned remains valid until the message is freed.</p> |
| 2453 | <p>MT safe.</p> |
| 2454 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2455 | <a name="id-1.3.29.8.44.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2456 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2457 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2458 | <col width="150px" class="parameters_name"> |
| 2459 | <col class="parameters_description"> |
| 2460 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2461 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2462 | <tbody> |
| 2463 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2464 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2465 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_NEW_CLOCK.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2466 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2467 | </tr> |
| 2468 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2469 | <td class="parameter_name"><p>clock</p></td> |
| 2470 | <td class="parameter_description"><p> a pointer to hold the selected |
| 2471 | new clock. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2472 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2473 | </tr> |
| 2474 | </tbody> |
| 2475 | </table></div> |
| 2476 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2477 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2478 | <hr> |
| 2479 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2480 | <a name="gst-message-new-application"></a><h3>gst_message_new_application ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2481 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2482 | gst_message_new_application (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2483 | <em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2484 | <p>Create a new application-typed message. GStreamer will never create these |
| 2485 | messages; they are a gift from us to you. Enjoy.</p> |
| 2486 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2487 | <a name="id-1.3.29.8.45.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2488 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2489 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2490 | <col width="150px" class="parameters_name"> |
| 2491 | <col class="parameters_description"> |
| 2492 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2493 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2494 | <tbody> |
| 2495 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2496 | <td class="parameter_name"><p>src</p></td> |
| 2497 | <td class="parameter_description"><p> the object originating the message. </p></td> |
| 2498 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2499 | </tr> |
| 2500 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2501 | <td class="parameter_name"><p>structure</p></td> |
| 2502 | <td class="parameter_description"><p> the structure for the message. The message |
| 2503 | will take ownership of the structure. </p></td> |
| 2504 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2505 | </tr> |
| 2506 | </tbody> |
| 2507 | </table></div> |
| 2508 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2509 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2510 | <a name="id-1.3.29.8.45.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2511 | <p> The new application message.</p> |
| 2512 | <p>MT safe. </p> |
| 2513 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2514 | </div> |
| 2515 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2516 | <hr> |
| 2517 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2518 | <a name="gst-message-new-element"></a><h3>gst_message_new_element ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2519 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2520 | gst_message_new_element (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2521 | <em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2522 | <p>Create a new element-specific message. This is meant as a generic way of |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2523 | allowing one-way communication from an element to an application, for example |
| 2524 | "the firewire cable was unplugged". The format of the message should be |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2525 | documented in the element's documentation. The structure field can be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2526 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2527 | <a name="id-1.3.29.8.46.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2528 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2529 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2530 | <col width="150px" class="parameters_name"> |
| 2531 | <col class="parameters_description"> |
| 2532 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2533 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2534 | <tbody> |
| 2535 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2536 | <td class="parameter_name"><p>src</p></td> |
| 2537 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 2538 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2539 | </tr> |
| 2540 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2541 | <td class="parameter_name"><p>structure</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2542 | <td class="parameter_description"><p> The structure for the |
| 2543 | message. The message will take ownership of the structure. </p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2544 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2545 | </tr> |
| 2546 | </tbody> |
| 2547 | </table></div> |
| 2548 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2549 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2550 | <a name="id-1.3.29.8.46.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2551 | <p> The new element message.</p> |
| 2552 | <p>MT safe. </p> |
| 2553 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2554 | </div> |
| 2555 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2556 | <hr> |
| 2557 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2558 | <a name="gst-message-new-custom"></a><h3>gst_message_new_custom ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2559 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
| 2560 | gst_message_new_custom (<em class="parameter"><code><a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType"><span class="type">GstMessageType</span></a> type</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2561 | <em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2562 | <em class="parameter"><code><a class="link" href="GstStructure.html" title="GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2563 | <p>Create a new custom-typed message. This can be used for anything not |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2564 | handled by other message-specific functions to pass a message to the |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2565 | app. The structure field can be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2566 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2567 | <a name="id-1.3.29.8.47.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2568 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2569 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2570 | <col width="150px" class="parameters_name"> |
| 2571 | <col class="parameters_description"> |
| 2572 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2573 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2574 | <tbody> |
| 2575 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2576 | <td class="parameter_name"><p>type</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2577 | <td class="parameter_description"><p>The <a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType"><span class="type">GstMessageType</span></a> to distinguish messages</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2578 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2579 | </tr> |
| 2580 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2581 | <td class="parameter_name"><p>src</p></td> |
| 2582 | <td class="parameter_description"><p>The object originating the message.</p></td> |
| 2583 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2584 | </tr> |
| 2585 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2586 | <td class="parameter_name"><p>structure</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2587 | <td class="parameter_description"><p> the structure for the |
| 2588 | message. The message will take ownership of the structure. </p></td> |
| 2589 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2590 | </tr> |
| 2591 | </tbody> |
| 2592 | </table></div> |
| 2593 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2594 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2595 | <a name="id-1.3.29.8.47.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2596 | <p> The new message.</p> |
| 2597 | <p>MT safe. </p> |
| 2598 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2599 | </div> |
| 2600 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2601 | <hr> |
| 2602 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2603 | <a name="gst-message-new-segment-start"></a><h3>gst_message_new_segment_start ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2604 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2605 | gst_message_new_segment_start (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 2606 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>, |
| 2607 | <em class="parameter"><code><span class="type">gint64</span> position</code></em>);</pre> |
| 2608 | <p>Create a new segment message. This message is posted by elements that |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2609 | start playback of a segment as a result of a segment seek. This message |
| 2610 | is not received by the application but is used for maintenance reasons in |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2611 | container elements.</p> |
| 2612 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2613 | <a name="id-1.3.29.8.48.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2614 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2615 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2616 | <col width="150px" class="parameters_name"> |
| 2617 | <col class="parameters_description"> |
| 2618 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2619 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2620 | <tbody> |
| 2621 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2622 | <td class="parameter_name"><p>src</p></td> |
| 2623 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 2624 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2625 | </tr> |
| 2626 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2627 | <td class="parameter_name"><p>format</p></td> |
| 2628 | <td class="parameter_description"><p>The format of the position being played</p></td> |
| 2629 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2630 | </tr> |
| 2631 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2632 | <td class="parameter_name"><p>position</p></td> |
| 2633 | <td class="parameter_description"><p>The position of the segment being played</p></td> |
| 2634 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2635 | </tr> |
| 2636 | </tbody> |
| 2637 | </table></div> |
| 2638 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2639 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2640 | <a name="id-1.3.29.8.48.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2641 | <p> the new segment start message.</p> |
| 2642 | <p>MT safe. </p> |
| 2643 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2644 | </div> |
| 2645 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2646 | <hr> |
| 2647 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2648 | <a name="gst-message-parse-segment-start"></a><h3>gst_message_parse_segment_start ()</h3> |
| 2649 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2650 | gst_message_parse_segment_start (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2651 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> *format</code></em>, |
| 2652 | <em class="parameter"><code><span class="type">gint64</span> *position</code></em>);</pre> |
| 2653 | <p>Extracts the position and format from the segment start message.</p> |
| 2654 | <p>MT safe.</p> |
| 2655 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2656 | <a name="id-1.3.29.8.49.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2657 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2658 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2659 | <col width="150px" class="parameters_name"> |
| 2660 | <col class="parameters_description"> |
| 2661 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2662 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2663 | <tbody> |
| 2664 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2665 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2666 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_SEGMENT_START.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2667 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2668 | </tr> |
| 2669 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2670 | <td class="parameter_name"><p>format</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2671 | <td class="parameter_description"><p> Result location for the format, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2672 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2673 | </tr> |
| 2674 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2675 | <td class="parameter_name"><p>position</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2676 | <td class="parameter_description"><p> Result location for the position, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2677 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2678 | </tr> |
| 2679 | </tbody> |
| 2680 | </table></div> |
| 2681 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2682 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2683 | <hr> |
| 2684 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2685 | <a name="gst-message-new-segment-done"></a><h3>gst_message_new_segment_done ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2686 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2687 | gst_message_new_segment_done (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 2688 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>, |
| 2689 | <em class="parameter"><code><span class="type">gint64</span> position</code></em>);</pre> |
| 2690 | <p>Create a new segment done message. This message is posted by elements that |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2691 | finish playback of a segment as a result of a segment seek. This message |
| 2692 | is received by the application after all elements that posted a segment_start |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2693 | have posted the segment_done.</p> |
| 2694 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2695 | <a name="id-1.3.29.8.50.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2696 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2697 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2698 | <col width="150px" class="parameters_name"> |
| 2699 | <col class="parameters_description"> |
| 2700 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2701 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2702 | <tbody> |
| 2703 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2704 | <td class="parameter_name"><p>src</p></td> |
| 2705 | <td class="parameter_description"><p> the object originating the message. </p></td> |
| 2706 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2707 | </tr> |
| 2708 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2709 | <td class="parameter_name"><p>format</p></td> |
| 2710 | <td class="parameter_description"><p>The format of the position being done</p></td> |
| 2711 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2712 | </tr> |
| 2713 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2714 | <td class="parameter_name"><p>position</p></td> |
| 2715 | <td class="parameter_description"><p>The position of the segment being done</p></td> |
| 2716 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2717 | </tr> |
| 2718 | </tbody> |
| 2719 | </table></div> |
| 2720 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2721 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2722 | <a name="id-1.3.29.8.50.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2723 | <p> the new segment done message.</p> |
| 2724 | <p>MT safe. </p> |
| 2725 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2726 | </div> |
| 2727 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2728 | <hr> |
| 2729 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2730 | <a name="gst-message-parse-segment-done"></a><h3>gst_message_parse_segment_done ()</h3> |
| 2731 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2732 | gst_message_parse_segment_done (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2733 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> *format</code></em>, |
| 2734 | <em class="parameter"><code><span class="type">gint64</span> *position</code></em>);</pre> |
| 2735 | <p>Extracts the position and format from the segment done message.</p> |
| 2736 | <p>MT safe.</p> |
| 2737 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2738 | <a name="id-1.3.29.8.51.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2739 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2740 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2741 | <col width="150px" class="parameters_name"> |
| 2742 | <col class="parameters_description"> |
| 2743 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2744 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2745 | <tbody> |
| 2746 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2747 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2748 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_SEGMENT_DONE.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2749 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2750 | </tr> |
| 2751 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2752 | <td class="parameter_name"><p>format</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2753 | <td class="parameter_description"><p> Result location for the format, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2754 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2755 | </tr> |
| 2756 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2757 | <td class="parameter_name"><p>position</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2758 | <td class="parameter_description"><p> Result location for the position, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2759 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2760 | </tr> |
| 2761 | </tbody> |
| 2762 | </table></div> |
| 2763 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2764 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2765 | <hr> |
| 2766 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2767 | <a name="gst-message-new-duration-changed"></a><h3>gst_message_new_duration_changed ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2768 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2769 | gst_message_new_duration_changed (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>);</pre> |
| 2770 | <p>Create a new duration changed message. This message is posted by elements |
Sebastian Dröge | e0655f9 | 2012-09-14 09:01:22 +0200 | [diff] [blame] | 2771 | that know the duration of a stream when the duration changes. This message |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2772 | is received by bins and is used to calculate the total duration of a |
| 2773 | pipeline. Elements may post a duration message with a duration of |
| 2774 | GST_CLOCK_TIME_NONE to indicate that the duration has changed and the |
| 2775 | cached duration should be discarded. The new duration can then be |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2776 | retrieved via a query.</p> |
| 2777 | <div class="refsect3"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2778 | <a name="id-1.3.29.8.52.5"></a><h4>Parameters</h4> |
| 2779 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2780 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2781 | <col width="150px" class="parameters_name"> |
| 2782 | <col class="parameters_description"> |
| 2783 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2784 | </colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2785 | <tbody><tr> |
| 2786 | <td class="parameter_name"><p>src</p></td> |
| 2787 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 2788 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
| 2789 | </tr></tbody> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2790 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2791 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2792 | <div class="refsect3"> |
| 2793 | <a name="id-1.3.29.8.52.6"></a><h4>Returns</h4> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2794 | <p> The new duration-changed message.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2795 | <p>MT safe. </p> |
| 2796 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2797 | </div> |
| 2798 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2799 | <hr> |
| 2800 | <div class="refsect2"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2801 | <a name="gst-message-new-latency"></a><h3>gst_message_new_latency ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2802 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2803 | gst_message_new_latency (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>);</pre> |
| 2804 | <p>This message can be posted by elements when their latency requirements have |
| 2805 | changed.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2806 | <div class="refsect3"> |
| 2807 | <a name="id-1.3.29.8.53.5"></a><h4>Parameters</h4> |
| 2808 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2809 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2810 | <col width="150px" class="parameters_name"> |
| 2811 | <col class="parameters_description"> |
| 2812 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2813 | </colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2814 | <tbody><tr> |
| 2815 | <td class="parameter_name"><p>src</p></td> |
| 2816 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 2817 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
| 2818 | </tr></tbody> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2819 | </table></div> |
| 2820 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2821 | <div class="refsect3"> |
| 2822 | <a name="id-1.3.29.8.53.6"></a><h4>Returns</h4> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2823 | <p> The new latency message.</p> |
| 2824 | <p>MT safe. </p> |
| 2825 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2826 | </div> |
| 2827 | </div> |
| 2828 | <hr> |
| 2829 | <div class="refsect2"> |
| 2830 | <a name="gst-message-new-async-start"></a><h3>gst_message_new_async_start ()</h3> |
| 2831 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
| 2832 | gst_message_new_async_start (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>);</pre> |
| 2833 | <p>This message is posted by elements when they start an ASYNC state change.</p> |
| 2834 | <div class="refsect3"> |
| 2835 | <a name="id-1.3.29.8.54.5"></a><h4>Parameters</h4> |
| 2836 | <div class="informaltable"><table width="100%" border="0"> |
| 2837 | <colgroup> |
| 2838 | <col width="150px" class="parameters_name"> |
| 2839 | <col class="parameters_description"> |
| 2840 | <col width="200px" class="parameters_annotations"> |
| 2841 | </colgroup> |
| 2842 | <tbody><tr> |
| 2843 | <td class="parameter_name"><p>src</p></td> |
| 2844 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 2845 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
| 2846 | </tr></tbody> |
| 2847 | </table></div> |
| 2848 | </div> |
| 2849 | <div class="refsect3"> |
| 2850 | <a name="id-1.3.29.8.54.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2851 | <p> The new async_start message.</p> |
| 2852 | <p>MT safe. </p> |
| 2853 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2854 | </div> |
| 2855 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2856 | <hr> |
| 2857 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2858 | <a name="gst-message-new-async-done"></a><h3>gst_message_new_async_done ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2859 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2860 | gst_message_new_async_done (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 2861 | <em class="parameter"><code><a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a> running_time</code></em>);</pre> |
| 2862 | <p>The message is posted when elements completed an ASYNC state change. |
| 2863 | <em class="parameter"><code>running_time</code></em> |
| 2864 | contains the time of the desired running_time when this |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 2865 | elements goes to PLAYING. A value of <a class="link" href="GstClock.html#GST-CLOCK-TIME-NONE:CAPS" title="GST_CLOCK_TIME_NONE"><span class="type">GST_CLOCK_TIME_NONE</span></a> for <em class="parameter"><code>running_time</code></em> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2866 | |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 2867 | means that the element has no clock interaction and thus doesn't care about |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2868 | the running_time of the pipeline.</p> |
| 2869 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2870 | <a name="id-1.3.29.8.55.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2871 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2872 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2873 | <col width="150px" class="parameters_name"> |
| 2874 | <col class="parameters_description"> |
| 2875 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2876 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2877 | <tbody> |
| 2878 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2879 | <td class="parameter_name"><p>src</p></td> |
| 2880 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 2881 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2882 | </tr> |
| 2883 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2884 | <td class="parameter_name"><p>running_time</p></td> |
| 2885 | <td class="parameter_description"><p>the desired running_time</p></td> |
| 2886 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2887 | </tr> |
| 2888 | </tbody> |
| 2889 | </table></div> |
| 2890 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2891 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2892 | <a name="id-1.3.29.8.55.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2893 | <p> The new async_done message.</p> |
| 2894 | <p>MT safe. </p> |
| 2895 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 2896 | </div> |
| 2897 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2898 | <hr> |
| 2899 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2900 | <a name="gst-message-parse-async-done"></a><h3>gst_message_parse_async_done ()</h3> |
| 2901 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2902 | gst_message_parse_async_done (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2903 | <em class="parameter"><code><a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a> *running_time</code></em>);</pre> |
| 2904 | <p>Extract the running_time from the async_done message.</p> |
| 2905 | <p>MT safe.</p> |
| 2906 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2907 | <a name="id-1.3.29.8.56.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2908 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2909 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2910 | <col width="150px" class="parameters_name"> |
| 2911 | <col class="parameters_description"> |
| 2912 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2913 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2914 | <tbody> |
| 2915 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2916 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2917 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_ASYNC_DONE.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2918 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2919 | </tr> |
| 2920 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2921 | <td class="parameter_name"><p>running_time</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2922 | <td class="parameter_description"><p> Result location for the running_time or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 2923 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2924 | </tr> |
| 2925 | </tbody> |
| 2926 | </table></div> |
| 2927 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2928 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2929 | <hr> |
| 2930 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2931 | <a name="gst-message-new-step-start"></a><h3>gst_message_new_step_start ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2932 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2933 | gst_message_new_step_start (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2934 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> active</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2935 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>, |
| 2936 | <em class="parameter"><code><span class="type">guint64</span> amount</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2937 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> rate</code></em>, |
| 2938 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> flush</code></em>, |
| 2939 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> intermediate</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2940 | <p>This message is posted by elements when they accept or activate a new step |
| 2941 | event for <em class="parameter"><code>amount</code></em> |
| 2942 | in <em class="parameter"><code>format</code></em> |
| 2943 | . </p> |
| 2944 | <p><em class="parameter"><code>active</code></em> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2945 | is set to <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> when the element accepted the new step event and has |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2946 | queued it for execution in the streaming threads.</p> |
| 2947 | <p><em class="parameter"><code>active</code></em> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2948 | is set to <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when the element has activated the step operation and |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2949 | is now ready to start executing the step in the streaming thread. After this |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 2950 | message is emitted, the application can queue a new step operation in the |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2951 | element.</p> |
| 2952 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 2953 | <a name="id-1.3.29.8.57.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2954 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2955 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2956 | <col width="150px" class="parameters_name"> |
| 2957 | <col class="parameters_description"> |
| 2958 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 2959 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2960 | <tbody> |
| 2961 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2962 | <td class="parameter_name"><p>src</p></td> |
| 2963 | <td class="parameter_description"><p>The object originating the message.</p></td> |
| 2964 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2965 | </tr> |
| 2966 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2967 | <td class="parameter_name"><p>active</p></td> |
| 2968 | <td class="parameter_description"><p>if the step is active or queued</p></td> |
| 2969 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2970 | </tr> |
| 2971 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2972 | <td class="parameter_name"><p>format</p></td> |
| 2973 | <td class="parameter_description"><p>the format of <em class="parameter"><code>amount</code></em> |
| 2974 | </p></td> |
| 2975 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2976 | </tr> |
| 2977 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2978 | <td class="parameter_name"><p>amount</p></td> |
| 2979 | <td class="parameter_description"><p>the amount of stepped data</p></td> |
| 2980 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2981 | </tr> |
| 2982 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2983 | <td class="parameter_name"><p>rate</p></td> |
| 2984 | <td class="parameter_description"><p>the rate of the stepped amount</p></td> |
| 2985 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2986 | </tr> |
| 2987 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2988 | <td class="parameter_name"><p>flush</p></td> |
| 2989 | <td class="parameter_description"><p>is this an flushing step</p></td> |
| 2990 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2991 | </tr> |
| 2992 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 2993 | <td class="parameter_name"><p>intermediate</p></td> |
| 2994 | <td class="parameter_description"><p>is this an intermediate step</p></td> |
| 2995 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2996 | </tr> |
| 2997 | </tbody> |
| 2998 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 2999 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3000 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3001 | <a name="id-1.3.29.8.57.8"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3002 | <p> The new step_start message. </p> |
| 3003 | <p>MT safe. </p> |
| 3004 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 3005 | </div> |
| 3006 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3007 | <hr> |
| 3008 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3009 | <a name="gst-message-parse-step-start"></a><h3>gst_message_parse_step_start ()</h3> |
| 3010 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3011 | gst_message_parse_step_start (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3012 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *active</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3013 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> *format</code></em>, |
| 3014 | <em class="parameter"><code><span class="type">guint64</span> *amount</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3015 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *rate</code></em>, |
| 3016 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *flush</code></em>, |
| 3017 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *intermediate</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3018 | <p>Extract the values from step_start message.</p> |
| 3019 | <p>MT safe.</p> |
| 3020 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3021 | <a name="id-1.3.29.8.58.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3022 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3023 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3024 | <col width="150px" class="parameters_name"> |
| 3025 | <col class="parameters_description"> |
| 3026 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3027 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3028 | <tbody> |
| 3029 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3030 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3031 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_STEP_DONE.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3032 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3033 | </tr> |
| 3034 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3035 | <td class="parameter_name"><p>active</p></td> |
| 3036 | <td class="parameter_description"><p> result location for the active flag. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3037 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3038 | </tr> |
| 3039 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3040 | <td class="parameter_name"><p>format</p></td> |
| 3041 | <td class="parameter_description"><p> result location for the format. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3042 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3043 | </tr> |
| 3044 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3045 | <td class="parameter_name"><p>amount</p></td> |
| 3046 | <td class="parameter_description"><p> result location for the amount. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3047 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3048 | </tr> |
| 3049 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3050 | <td class="parameter_name"><p>rate</p></td> |
| 3051 | <td class="parameter_description"><p> result location for the rate. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3052 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3053 | </tr> |
| 3054 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3055 | <td class="parameter_name"><p>flush</p></td> |
| 3056 | <td class="parameter_description"><p> result location for the flush flag. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3057 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3058 | </tr> |
| 3059 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3060 | <td class="parameter_name"><p>intermediate</p></td> |
| 3061 | <td class="parameter_description"><p> result location for the intermediate flag. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3062 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3063 | </tr> |
| 3064 | </tbody> |
| 3065 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3066 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3067 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3068 | <hr> |
| 3069 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3070 | <a name="gst-message-new-qos"></a><h3>gst_message_new_qos ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3071 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3072 | gst_message_new_qos (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3073 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> live</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3074 | <em class="parameter"><code><span class="type">guint64</span> running_time</code></em>, |
| 3075 | <em class="parameter"><code><span class="type">guint64</span> stream_time</code></em>, |
| 3076 | <em class="parameter"><code><span class="type">guint64</span> timestamp</code></em>, |
| 3077 | <em class="parameter"><code><span class="type">guint64</span> duration</code></em>);</pre> |
| 3078 | <p>A QOS message is posted on the bus whenever an element decides to drop a |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3079 | buffer because of QoS reasons or whenever it changes its processing strategy |
| 3080 | because of QoS reasons (quality adjustments such as processing at lower |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3081 | accuracy).</p> |
| 3082 | <p>This message can be posted by an element that performs synchronisation against the |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3083 | clock (live) or it could be dropped by an element that performs QoS because of QOS |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3084 | events received from a downstream element (!live).</p> |
| 3085 | <p><em class="parameter"><code>running_time</code></em> |
| 3086 | , <em class="parameter"><code>stream_time</code></em> |
| 3087 | , <em class="parameter"><code>timestamp</code></em> |
| 3088 | , <em class="parameter"><code>duration</code></em> |
| 3089 | should be set to the |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3090 | respective running-time, stream-time, timestamp and duration of the (dropped) |
| 3091 | buffer that generated the QoS event. Values can be left to |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3092 | GST_CLOCK_TIME_NONE when unknown.</p> |
| 3093 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3094 | <a name="id-1.3.29.8.59.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3095 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3096 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3097 | <col width="150px" class="parameters_name"> |
| 3098 | <col class="parameters_description"> |
| 3099 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3100 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3101 | <tbody> |
| 3102 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3103 | <td class="parameter_name"><p>src</p></td> |
| 3104 | <td class="parameter_description"><p>The object originating the message.</p></td> |
| 3105 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3106 | </tr> |
| 3107 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3108 | <td class="parameter_name"><p>live</p></td> |
| 3109 | <td class="parameter_description"><p>if the message was generated by a live element</p></td> |
| 3110 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3111 | </tr> |
| 3112 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3113 | <td class="parameter_name"><p>running_time</p></td> |
| 3114 | <td class="parameter_description"><p>the running time of the buffer that generated the message</p></td> |
| 3115 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3116 | </tr> |
| 3117 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3118 | <td class="parameter_name"><p>stream_time</p></td> |
| 3119 | <td class="parameter_description"><p>the stream time of the buffer that generated the message</p></td> |
| 3120 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3121 | </tr> |
| 3122 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3123 | <td class="parameter_name"><p>timestamp</p></td> |
| 3124 | <td class="parameter_description"><p>the timestamps of the buffer that generated the message</p></td> |
| 3125 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3126 | </tr> |
| 3127 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3128 | <td class="parameter_name"><p>duration</p></td> |
| 3129 | <td class="parameter_description"><p>the duration of the buffer that generated the message</p></td> |
| 3130 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3131 | </tr> |
| 3132 | </tbody> |
| 3133 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3134 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3135 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3136 | <a name="id-1.3.29.8.59.8"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3137 | <p> The new qos message.</p> |
| 3138 | <p>MT safe. </p> |
| 3139 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 3140 | </div> |
| 3141 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3142 | <hr> |
| 3143 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3144 | <a name="gst-message-set-qos-values"></a><h3>gst_message_set_qos_values ()</h3> |
| 3145 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3146 | gst_message_set_qos_values (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3147 | <em class="parameter"><code><span class="type">gint64</span> jitter</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3148 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> proportion</code></em>, |
| 3149 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> quality</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3150 | <p>Set the QoS values that have been calculated/analysed from the QoS data</p> |
| 3151 | <p>MT safe.</p> |
| 3152 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3153 | <a name="id-1.3.29.8.60.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3154 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3155 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3156 | <col width="150px" class="parameters_name"> |
| 3157 | <col class="parameters_description"> |
| 3158 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3159 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3160 | <tbody> |
| 3161 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3162 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3163 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_QOS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3164 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3165 | </tr> |
| 3166 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3167 | <td class="parameter_name"><p>jitter</p></td> |
| 3168 | <td class="parameter_description"><p>The difference of the running-time against the deadline.</p></td> |
| 3169 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3170 | </tr> |
| 3171 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3172 | <td class="parameter_name"><p>proportion</p></td> |
| 3173 | <td class="parameter_description"><p>Long term prediction of the ideal rate relative to normal rate |
| 3174 | to get optimal quality.</p></td> |
| 3175 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3176 | </tr> |
| 3177 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3178 | <td class="parameter_name"><p>quality</p></td> |
| 3179 | <td class="parameter_description"><p>An element dependent integer value that specifies the current |
| 3180 | quality level of the element. The default maximum quality is 1000000.</p></td> |
| 3181 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3182 | </tr> |
| 3183 | </tbody> |
| 3184 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3185 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3186 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3187 | <hr> |
| 3188 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3189 | <a name="gst-message-set-qos-stats"></a><h3>gst_message_set_qos_stats ()</h3> |
| 3190 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3191 | gst_message_set_qos_stats (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3192 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> format</code></em>, |
| 3193 | <em class="parameter"><code><span class="type">guint64</span> processed</code></em>, |
| 3194 | <em class="parameter"><code><span class="type">guint64</span> dropped</code></em>);</pre> |
| 3195 | <p>Set the QoS stats representing the history of the current continuous pipeline |
| 3196 | playback period.</p> |
| 3197 | <p>When <em class="parameter"><code>format</code></em> |
| 3198 | is <em class="parameter"><code>GST_FORMAT_UNDEFINED</code></em> |
| 3199 | both <em class="parameter"><code>dropped</code></em> |
| 3200 | and <em class="parameter"><code>processed</code></em> |
| 3201 | are |
| 3202 | invalid. Values of -1 for either <em class="parameter"><code>processed</code></em> |
| 3203 | or <em class="parameter"><code>dropped</code></em> |
| 3204 | mean unknown values.</p> |
| 3205 | <p>MT safe.</p> |
| 3206 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3207 | <a name="id-1.3.29.8.61.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3208 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3209 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3210 | <col width="150px" class="parameters_name"> |
| 3211 | <col class="parameters_description"> |
| 3212 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3213 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3214 | <tbody> |
| 3215 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3216 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3217 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_QOS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3218 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3219 | </tr> |
| 3220 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3221 | <td class="parameter_name"><p>format</p></td> |
| 3222 | <td class="parameter_description"><p>Units of the 'processed' and 'dropped' fields. Video sinks and video |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3223 | filters will use GST_FORMAT_BUFFERS (frames). Audio sinks and audio filters |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3224 | will likely use GST_FORMAT_DEFAULT (samples).</p></td> |
| 3225 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3226 | </tr> |
| 3227 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3228 | <td class="parameter_name"><p>processed</p></td> |
| 3229 | <td class="parameter_description"><p>Total number of units correctly processed since the last state |
| 3230 | change to READY or a flushing operation.</p></td> |
| 3231 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3232 | </tr> |
| 3233 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3234 | <td class="parameter_name"><p>dropped</p></td> |
| 3235 | <td class="parameter_description"><p>Total number of units dropped since the last state change to READY |
| 3236 | or a flushing operation.</p></td> |
| 3237 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3238 | </tr> |
| 3239 | </tbody> |
| 3240 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3241 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3242 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3243 | <hr> |
| 3244 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3245 | <a name="gst-message-parse-qos"></a><h3>gst_message_parse_qos ()</h3> |
| 3246 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3247 | gst_message_parse_qos (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3248 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *live</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3249 | <em class="parameter"><code><span class="type">guint64</span> *running_time</code></em>, |
| 3250 | <em class="parameter"><code><span class="type">guint64</span> *stream_time</code></em>, |
| 3251 | <em class="parameter"><code><span class="type">guint64</span> *timestamp</code></em>, |
| 3252 | <em class="parameter"><code><span class="type">guint64</span> *duration</code></em>);</pre> |
| 3253 | <p>Extract the timestamps and live status from the QoS message.</p> |
| 3254 | <p>The returned values give the running_time, stream_time, timestamp and |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3255 | duration of the dropped buffer. Values of GST_CLOCK_TIME_NONE mean unknown |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3256 | values.</p> |
| 3257 | <p>MT safe.</p> |
| 3258 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3259 | <a name="id-1.3.29.8.62.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3260 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3261 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3262 | <col width="150px" class="parameters_name"> |
| 3263 | <col class="parameters_description"> |
| 3264 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3265 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3266 | <tbody> |
| 3267 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3268 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3269 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_QOS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3270 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3271 | </tr> |
| 3272 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3273 | <td class="parameter_name"><p>live</p></td> |
| 3274 | <td class="parameter_description"><p> if the message was generated by a live element. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3275 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3276 | </tr> |
| 3277 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3278 | <td class="parameter_name"><p>running_time</p></td> |
| 3279 | <td class="parameter_description"><p> the running time of the buffer that |
| 3280 | generated the message. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3281 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3282 | </tr> |
| 3283 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3284 | <td class="parameter_name"><p>stream_time</p></td> |
| 3285 | <td class="parameter_description"><p> the stream time of the buffer that |
| 3286 | generated the message. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3287 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3288 | </tr> |
| 3289 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3290 | <td class="parameter_name"><p>timestamp</p></td> |
| 3291 | <td class="parameter_description"><p> the timestamps of the buffer that |
| 3292 | generated the message. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3293 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3294 | </tr> |
| 3295 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3296 | <td class="parameter_name"><p>duration</p></td> |
| 3297 | <td class="parameter_description"><p> the duration of the buffer that |
| 3298 | generated the message. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3299 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3300 | </tr> |
| 3301 | </tbody> |
| 3302 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3303 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3304 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3305 | <hr> |
| 3306 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3307 | <a name="gst-message-parse-qos-values"></a><h3>gst_message_parse_qos_values ()</h3> |
| 3308 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3309 | gst_message_parse_qos_values (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3310 | <em class="parameter"><code><span class="type">gint64</span> *jitter</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3311 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *proportion</code></em>, |
| 3312 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *quality</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3313 | <p>Extract the QoS values that have been calculated/analysed from the QoS data</p> |
| 3314 | <p>MT safe.</p> |
| 3315 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3316 | <a name="id-1.3.29.8.63.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3317 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3318 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3319 | <col width="150px" class="parameters_name"> |
| 3320 | <col class="parameters_description"> |
| 3321 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3322 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3323 | <tbody> |
| 3324 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3325 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3326 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_QOS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3327 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3328 | </tr> |
| 3329 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3330 | <td class="parameter_name"><p>jitter</p></td> |
| 3331 | <td class="parameter_description"><p> The difference of the running-time against |
| 3332 | the deadline. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3333 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3334 | </tr> |
| 3335 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3336 | <td class="parameter_name"><p>proportion</p></td> |
| 3337 | <td class="parameter_description"><p> Long term prediction of the ideal rate |
| 3338 | relative to normal rate to get optimal quality. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3339 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3340 | </tr> |
| 3341 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3342 | <td class="parameter_name"><p>quality</p></td> |
| 3343 | <td class="parameter_description"><p> An element dependent integer value that |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3344 | specifies the current quality level of the element. The default |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3345 | maximum quality is 1000000. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3346 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3347 | </tr> |
| 3348 | </tbody> |
| 3349 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3350 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3351 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3352 | <hr> |
| 3353 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3354 | <a name="gst-message-parse-qos-stats"></a><h3>gst_message_parse_qos_stats ()</h3> |
| 3355 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3356 | gst_message_parse_qos_stats (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3357 | <em class="parameter"><code><a class="link" href="gstreamer-GstFormat.html#GstFormat" title="enum GstFormat"><span class="type">GstFormat</span></a> *format</code></em>, |
| 3358 | <em class="parameter"><code><span class="type">guint64</span> *processed</code></em>, |
| 3359 | <em class="parameter"><code><span class="type">guint64</span> *dropped</code></em>);</pre> |
| 3360 | <p>Extract the QoS stats representing the history of the current continuous |
| 3361 | pipeline playback period.</p> |
| 3362 | <p>When <em class="parameter"><code>format</code></em> |
| 3363 | is <em class="parameter"><code>GST_FORMAT_UNDEFINED</code></em> |
| 3364 | both <em class="parameter"><code>dropped</code></em> |
| 3365 | and <em class="parameter"><code>processed</code></em> |
| 3366 | are |
| 3367 | invalid. Values of -1 for either <em class="parameter"><code>processed</code></em> |
| 3368 | or <em class="parameter"><code>dropped</code></em> |
| 3369 | mean unknown values.</p> |
| 3370 | <p>MT safe.</p> |
| 3371 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3372 | <a name="id-1.3.29.8.64.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3373 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3374 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3375 | <col width="150px" class="parameters_name"> |
| 3376 | <col class="parameters_description"> |
| 3377 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3378 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3379 | <tbody> |
| 3380 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3381 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3382 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_QOS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3383 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3384 | </tr> |
| 3385 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3386 | <td class="parameter_name"><p>format</p></td> |
| 3387 | <td class="parameter_description"><p> Units of the 'processed' and 'dropped' fields. |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3388 | Video sinks and video filters will use GST_FORMAT_BUFFERS (frames). |
| 3389 | Audio sinks and audio filters will likely use GST_FORMAT_DEFAULT |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3390 | (samples). </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3391 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3392 | </tr> |
| 3393 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3394 | <td class="parameter_name"><p>processed</p></td> |
| 3395 | <td class="parameter_description"><p> Total number of units correctly processed |
| 3396 | since the last state change to READY or a flushing operation. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3397 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3398 | </tr> |
| 3399 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3400 | <td class="parameter_name"><p>dropped</p></td> |
| 3401 | <td class="parameter_description"><p> Total number of units dropped since the last |
| 3402 | state change to READY or a flushing operation. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3403 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3404 | </tr> |
| 3405 | </tbody> |
| 3406 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3407 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3408 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3409 | <hr> |
| 3410 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3411 | <a name="gst-message-new-toc"></a><h3>gst_message_new_toc ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3412 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3413 | gst_message_new_toc (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3414 | <em class="parameter"><code><a class="link" href="GstToc.html" title="GstToc"><span class="type">GstToc</span></a> *toc</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3415 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> updated</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3416 | <p>Create a new TOC message. The message is posted by elements |
| 3417 | that discovered or updated a TOC.</p> |
| 3418 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3419 | <a name="id-1.3.29.8.65.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3420 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3421 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3422 | <col width="150px" class="parameters_name"> |
| 3423 | <col class="parameters_description"> |
| 3424 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3425 | </colgroup> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3426 | <tbody> |
| 3427 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3428 | <td class="parameter_name"><p>src</p></td> |
| 3429 | <td class="parameter_description"><p>the object originating the message.</p></td> |
| 3430 | <td class="parameter_annotations"> </td> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3431 | </tr> |
| 3432 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3433 | <td class="parameter_name"><p>toc</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3434 | <td class="parameter_description"><p> <a class="link" href="GstToc.html" title="GstToc"><span class="type">GstToc</span></a> structure for the message. </p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3435 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3436 | </tr> |
| 3437 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3438 | <td class="parameter_name"><p>updated</p></td> |
| 3439 | <td class="parameter_description"><p>whether TOC was updated or not.</p></td> |
| 3440 | <td class="parameter_annotations"> </td> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3441 | </tr> |
| 3442 | </tbody> |
| 3443 | </table></div> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3444 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3445 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3446 | <a name="id-1.3.29.8.65.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3447 | <p> a new TOC message.</p> |
| 3448 | <p>MT safe. </p> |
| 3449 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 3450 | </div> |
| 3451 | </div> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3452 | <hr> |
| 3453 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3454 | <a name="gst-message-parse-toc"></a><h3>gst_message_parse_toc ()</h3> |
| 3455 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3456 | gst_message_parse_toc (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 3457 | <em class="parameter"><code><a class="link" href="GstToc.html" title="GstToc"><span class="type">GstToc</span></a> **toc</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3458 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *updated</code></em>);</pre> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3459 | <p>Extract the TOC from the <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>. The TOC returned in the |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3460 | output argument is a copy; the caller must free it with |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3461 | <a class="link" href="GstToc.html#gst-toc-unref" title="gst_toc_unref()"><code class="function">gst_toc_unref()</code></a> when done.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3462 | <p>MT safe.</p> |
| 3463 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3464 | <a name="id-1.3.29.8.66.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3465 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3466 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3467 | <col width="150px" class="parameters_name"> |
| 3468 | <col class="parameters_description"> |
| 3469 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3470 | </colgroup> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3471 | <tbody> |
| 3472 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3473 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3474 | <td class="parameter_description"><p>a valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_TOC.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3475 | <td class="parameter_annotations"> </td> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3476 | </tr> |
| 3477 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3478 | <td class="parameter_name"><p>toc</p></td> |
| 3479 | <td class="parameter_description"><p> return location for the TOC. </p></td> |
| 3480 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3481 | </tr> |
| 3482 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3483 | <td class="parameter_name"><p>updated</p></td> |
| 3484 | <td class="parameter_description"><p> return location for the updated flag. </p></td> |
| 3485 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3486 | </tr> |
| 3487 | </tbody> |
| 3488 | </table></div> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3489 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3490 | </div> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3491 | <hr> |
| 3492 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3493 | <a name="gst-message-new-reset-time"></a><h3>gst_message_new_reset_time ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3494 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3495 | gst_message_new_reset_time (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 3496 | <em class="parameter"><code><a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a> running_time</code></em>);</pre> |
| 3497 | <p>This message is posted when the pipeline running-time should be reset to |
| 3498 | <em class="parameter"><code>running_time</code></em> |
| 3499 | , like after a flushing seek.</p> |
| 3500 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3501 | <a name="id-1.3.29.8.67.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3502 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3503 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3504 | <col width="150px" class="parameters_name"> |
| 3505 | <col class="parameters_description"> |
| 3506 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3507 | </colgroup> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3508 | <tbody> |
| 3509 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3510 | <td class="parameter_name"><p>src</p></td> |
| 3511 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 3512 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3513 | </tr> |
| 3514 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3515 | <td class="parameter_name"><p>running_time</p></td> |
| 3516 | <td class="parameter_description"><p>the requested running-time</p></td> |
| 3517 | <td class="parameter_annotations"> </td> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3518 | </tr> |
| 3519 | </tbody> |
| 3520 | </table></div> |
| 3521 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3522 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3523 | <a name="id-1.3.29.8.67.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3524 | <p> The new reset_time message.</p> |
| 3525 | <p>MT safe. </p> |
| 3526 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 3527 | </div> |
| 3528 | </div> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3529 | <hr> |
| 3530 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3531 | <a name="gst-message-parse-reset-time"></a><h3>gst_message_parse_reset_time ()</h3> |
| 3532 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3533 | gst_message_parse_reset_time (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3534 | <em class="parameter"><code><a class="link" href="GstClock.html#GstClockTime" title="GstClockTime"><span class="type">GstClockTime</span></a> *running_time</code></em>);</pre> |
| 3535 | <p>Extract the running-time from the RESET_TIME message.</p> |
| 3536 | <p>MT safe.</p> |
| 3537 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3538 | <a name="id-1.3.29.8.68.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3539 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3540 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3541 | <col width="150px" class="parameters_name"> |
| 3542 | <col class="parameters_description"> |
| 3543 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3544 | </colgroup> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3545 | <tbody> |
| 3546 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3547 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3548 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_RESET_TIME.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3549 | <td class="parameter_annotations"> </td> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3550 | </tr> |
| 3551 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3552 | <td class="parameter_name"><p>running_time</p></td> |
| 3553 | <td class="parameter_description"><p> Result location for the running_time or |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3554 | <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 3555 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Sebastian Dröge | d1f921c | 2012-08-08 18:10:27 +0200 | [diff] [blame] | 3556 | </tr> |
| 3557 | </tbody> |
| 3558 | </table></div> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3559 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3560 | </div> |
Olivier Naudan | 5439976 | 2012-04-13 09:08:41 -0400 | [diff] [blame] | 3561 | <hr> |
| 3562 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3563 | <a name="gst-message-new-stream-start"></a><h3>gst_message_new_stream_start ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3564 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3565 | gst_message_new_stream_start (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>);</pre> |
| 3566 | <p>Create a new stream_start message. This message is generated and posted in |
Sebastian Dröge | e0655f9 | 2012-09-14 09:01:22 +0200 | [diff] [blame] | 3567 | the sink elements of a GstBin. The bin will only forward the STREAM_START |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3568 | message to the application if all sinks have posted an STREAM_START message.</p> |
| 3569 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3570 | <a name="id-1.3.29.8.69.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3571 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3572 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3573 | <col width="150px" class="parameters_name"> |
| 3574 | <col class="parameters_description"> |
| 3575 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3576 | </colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3577 | <tbody><tr> |
| 3578 | <td class="parameter_name"><p>src</p></td> |
| 3579 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 3580 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
| 3581 | </tr></tbody> |
Sebastian Dröge | e0655f9 | 2012-09-14 09:01:22 +0200 | [diff] [blame] | 3582 | </table></div> |
| 3583 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3584 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3585 | <a name="id-1.3.29.8.69.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3586 | <p> The new stream_start message.</p> |
| 3587 | <p>MT safe. </p> |
| 3588 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 3589 | </div> |
| 3590 | </div> |
Sebastian Dröge | e0655f9 | 2012-09-14 09:01:22 +0200 | [diff] [blame] | 3591 | <hr> |
| 3592 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3593 | <a name="gst-message-set-group-id"></a><h3>gst_message_set_group_id ()</h3> |
| 3594 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3595 | gst_message_set_group_id (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3596 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group_id</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3597 | <p>Sets the group id on the stream-start message.</p> |
| 3598 | <p>All streams that have the same group id are supposed to be played |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3599 | together, i.e. all streams inside a container file should have the |
| 3600 | same group id but different stream ids. The group id should change |
| 3601 | each time the stream is started, resulting in different group ids |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3602 | each time a file is played for example.</p> |
| 3603 | <p>MT safe.</p> |
| 3604 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3605 | <a name="id-1.3.29.8.70.7"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3606 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3607 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3608 | <col width="150px" class="parameters_name"> |
| 3609 | <col class="parameters_description"> |
| 3610 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3611 | </colgroup> |
| 3612 | <tbody> |
| 3613 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3614 | <td class="parameter_name"><p>message</p></td> |
| 3615 | <td class="parameter_description"><p>the message</p></td> |
| 3616 | <td class="parameter_annotations"> </td> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3617 | </tr> |
| 3618 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3619 | <td class="parameter_name"><p>group_id</p></td> |
| 3620 | <td class="parameter_description"><p>the group id</p></td> |
| 3621 | <td class="parameter_annotations"> </td> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3622 | </tr> |
| 3623 | </tbody> |
| 3624 | </table></div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3625 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 3626 | <p class="since">Since: 1.2</p> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3627 | </div> |
| 3628 | <hr> |
| 3629 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3630 | <a name="gst-message-parse-group-id"></a><h3>gst_message_parse_group_id ()</h3> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3631 | <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3632 | gst_message_parse_group_id (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3633 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *group_id</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3634 | <p>Extract the group from the STREAM_START message.</p> |
| 3635 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3636 | <a name="id-1.3.29.8.71.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3637 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3638 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3639 | <col width="150px" class="parameters_name"> |
| 3640 | <col class="parameters_description"> |
| 3641 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3642 | </colgroup> |
| 3643 | <tbody> |
| 3644 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3645 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3646 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_STREAM_START.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3647 | <td class="parameter_annotations"> </td> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3648 | </tr> |
| 3649 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3650 | <td class="parameter_name"><p>group_id</p></td> |
| 3651 | <td class="parameter_description"><p> Result location for the group id or |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3652 | <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 3653 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3654 | </tr> |
| 3655 | </tbody> |
| 3656 | </table></div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3657 | </div> |
| 3658 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3659 | <a name="id-1.3.29.8.71.6"></a><h4>Returns</h4> |
| 3660 | <p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the message had a group id set, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3661 | <p>MT safe.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3662 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 3663 | <p class="since">Since: 1.2</p> |
Sebastian Dröge | ab458c2 | 2013-07-30 08:18:47 +0200 | [diff] [blame] | 3664 | </div> |
| 3665 | <hr> |
| 3666 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3667 | <a name="gst-message-new-structure-change"></a><h3>gst_message_new_structure_change ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3668 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3669 | gst_message_new_structure_change (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3670 | <em class="parameter"><code><a class="link" href="GstMessage.html#GstStructureChangeType" title="enum GstStructureChangeType"><span class="type">GstStructureChangeType</span></a> type</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3671 | <em class="parameter"><code><a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a> *owner</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3672 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> busy</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3673 | <p>Create a new structure change message. This message is posted when the |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3674 | structure of a pipeline is in the process of being changed, for example |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3675 | when pads are linked or unlinked.</p> |
| 3676 | <p><em class="parameter"><code>src</code></em> |
| 3677 | should be the sinkpad that unlinked or linked.</p> |
| 3678 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3679 | <a name="id-1.3.29.8.72.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3680 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3681 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3682 | <col width="150px" class="parameters_name"> |
| 3683 | <col class="parameters_description"> |
| 3684 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3685 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3686 | <tbody> |
| 3687 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3688 | <td class="parameter_name"><p>src</p></td> |
| 3689 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 3690 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3691 | </tr> |
| 3692 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3693 | <td class="parameter_name"><p>type</p></td> |
| 3694 | <td class="parameter_description"><p>The change type.</p></td> |
| 3695 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3696 | </tr> |
| 3697 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3698 | <td class="parameter_name"><p>owner</p></td> |
| 3699 | <td class="parameter_description"><p> The owner element of <em class="parameter"><code>src</code></em> |
| 3700 | . </p></td> |
| 3701 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3702 | </tr> |
| 3703 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3704 | <td class="parameter_name"><p>busy</p></td> |
| 3705 | <td class="parameter_description"><p>Whether the structure change is busy.</p></td> |
| 3706 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3707 | </tr> |
| 3708 | </tbody> |
| 3709 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3710 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3711 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3712 | <a name="id-1.3.29.8.72.7"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3713 | <p> the new structure change message.</p> |
| 3714 | <p>MT safe. </p> |
| 3715 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 3716 | </div> |
| 3717 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3718 | <hr> |
| 3719 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3720 | <a name="gst-message-parse-structure-change"></a><h3>gst_message_parse_structure_change ()</h3> |
| 3721 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3722 | gst_message_parse_structure_change (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 3723 | <em class="parameter"><code><a class="link" href="GstMessage.html#GstStructureChangeType" title="enum GstStructureChangeType"><span class="type">GstStructureChangeType</span></a> *type</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3724 | <em class="parameter"><code><a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a> **owner</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3725 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *busy</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3726 | <p>Extracts the change type and completion status from the GstMessage.</p> |
| 3727 | <p>MT safe.</p> |
| 3728 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3729 | <a name="id-1.3.29.8.73.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3730 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3731 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3732 | <col width="150px" class="parameters_name"> |
| 3733 | <col class="parameters_description"> |
| 3734 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3735 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3736 | <tbody> |
| 3737 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3738 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3739 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_STRUCTURE_CHANGE.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3740 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3741 | </tr> |
| 3742 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3743 | <td class="parameter_name"><p>type</p></td> |
| 3744 | <td class="parameter_description"><p> A pointer to hold the change type. </p></td> |
| 3745 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3746 | </tr> |
| 3747 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3748 | <td class="parameter_name"><p>owner</p></td> |
| 3749 | <td class="parameter_description"><p> The owner element of the |
| 3750 | message source. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3751 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3752 | </tr> |
| 3753 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3754 | <td class="parameter_name"><p>busy</p></td> |
| 3755 | <td class="parameter_description"><p> a pointer to hold whether the change is in |
| 3756 | progress or has been completed. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3757 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3758 | </tr> |
| 3759 | </tbody> |
| 3760 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3761 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3762 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3763 | <hr> |
| 3764 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3765 | <a name="gst-message-new-request-state"></a><h3>gst_message_new_request_state ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3766 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3767 | gst_message_new_request_state (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 3768 | <em class="parameter"><code><a class="link" href="GstElement.html#GstState" title="enum GstState"><span class="type">GstState</span></a> state</code></em>);</pre> |
| 3769 | <p>This message can be posted by elements when they want to have their state |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3770 | changed. A typical use case would be an audio server that wants to pause the |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3771 | pipeline because a higher priority stream is being played.</p> |
| 3772 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3773 | <a name="id-1.3.29.8.74.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3774 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3775 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3776 | <col width="150px" class="parameters_name"> |
| 3777 | <col class="parameters_description"> |
| 3778 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3779 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3780 | <tbody> |
| 3781 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3782 | <td class="parameter_name"><p>src</p></td> |
| 3783 | <td class="parameter_description"><p> the object originating the message. </p></td> |
| 3784 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3785 | </tr> |
| 3786 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3787 | <td class="parameter_name"><p>state</p></td> |
| 3788 | <td class="parameter_description"><p>The new requested state</p></td> |
| 3789 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3790 | </tr> |
| 3791 | </tbody> |
| 3792 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3793 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3794 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3795 | <a name="id-1.3.29.8.74.6"></a><h4>Returns</h4> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3796 | <p> the new request state message.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3797 | <p>MT safe. </p> |
| 3798 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 3799 | </div> |
| 3800 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3801 | <hr> |
| 3802 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3803 | <a name="gst-message-parse-request-state"></a><h3>gst_message_parse_request_state ()</h3> |
| 3804 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3805 | gst_message_parse_request_state (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3806 | <em class="parameter"><code><a class="link" href="GstElement.html#GstState" title="enum GstState"><span class="type">GstState</span></a> *state</code></em>);</pre> |
| 3807 | <p>Extract the requested state from the request_state message.</p> |
| 3808 | <p>MT safe.</p> |
| 3809 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3810 | <a name="id-1.3.29.8.75.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3811 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3812 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3813 | <col width="150px" class="parameters_name"> |
| 3814 | <col class="parameters_description"> |
| 3815 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3816 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3817 | <tbody> |
| 3818 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3819 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3820 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_REQUEST_STATE.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3821 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3822 | </tr> |
| 3823 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3824 | <td class="parameter_name"><p>state</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3825 | <td class="parameter_description"><p> Result location for the requested state or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 3826 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3827 | </tr> |
| 3828 | </tbody> |
| 3829 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3830 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3831 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3832 | <hr> |
| 3833 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3834 | <a name="gst-message-new-stream-status"></a><h3>gst_message_new_stream_status ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3835 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3836 | gst_message_new_stream_status (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3837 | <em class="parameter"><code><a class="link" href="GstMessage.html#GstStreamStatusType" title="enum GstStreamStatusType"><span class="type">GstStreamStatusType</span></a> type</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3838 | <em class="parameter"><code><a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a> *owner</code></em>);</pre> |
| 3839 | <p>Create a new stream status message. This message is posted when a streaming |
| 3840 | thread is created/destroyed or when the state changed.</p> |
| 3841 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3842 | <a name="id-1.3.29.8.76.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3843 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3844 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3845 | <col width="150px" class="parameters_name"> |
| 3846 | <col class="parameters_description"> |
| 3847 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3848 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3849 | <tbody> |
| 3850 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3851 | <td class="parameter_name"><p>src</p></td> |
| 3852 | <td class="parameter_description"><p>The object originating the message.</p></td> |
| 3853 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3854 | </tr> |
| 3855 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3856 | <td class="parameter_name"><p>type</p></td> |
| 3857 | <td class="parameter_description"><p>The stream status type.</p></td> |
| 3858 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3859 | </tr> |
| 3860 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3861 | <td class="parameter_name"><p>owner</p></td> |
| 3862 | <td class="parameter_description"><p> the owner element of <em class="parameter"><code>src</code></em> |
| 3863 | . </p></td> |
| 3864 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3865 | </tr> |
| 3866 | </tbody> |
| 3867 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3868 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3869 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3870 | <a name="id-1.3.29.8.76.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3871 | <p> the new stream status message.</p> |
| 3872 | <p>MT safe. </p> |
| 3873 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 3874 | </div> |
| 3875 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3876 | <hr> |
| 3877 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3878 | <a name="gst-message-parse-stream-status"></a><h3>gst_message_parse_stream_status ()</h3> |
| 3879 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3880 | gst_message_parse_stream_status (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 3881 | <em class="parameter"><code><a class="link" href="GstMessage.html#GstStreamStatusType" title="enum GstStreamStatusType"><span class="type">GstStreamStatusType</span></a> *type</code></em>, |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3882 | <em class="parameter"><code><a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a> **owner</code></em>);</pre> |
| 3883 | <p>Extracts the stream status type and owner the GstMessage. The returned |
| 3884 | owner remains valid for as long as the reference to <em class="parameter"><code>message</code></em> |
| 3885 | is valid and |
| 3886 | should thus not be unreffed.</p> |
| 3887 | <p>MT safe.</p> |
| 3888 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3889 | <a name="id-1.3.29.8.77.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3890 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3891 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3892 | <col width="150px" class="parameters_name"> |
| 3893 | <col class="parameters_description"> |
| 3894 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3895 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3896 | <tbody> |
| 3897 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3898 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3899 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_STREAM_STATUS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3900 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3901 | </tr> |
| 3902 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3903 | <td class="parameter_name"><p>type</p></td> |
| 3904 | <td class="parameter_description"><p> A pointer to hold the status type. </p></td> |
| 3905 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3906 | </tr> |
| 3907 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3908 | <td class="parameter_name"><p>owner</p></td> |
| 3909 | <td class="parameter_description"><p> The owner element of the message source. </p></td> |
| 3910 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3911 | </tr> |
| 3912 | </tbody> |
| 3913 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3914 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3915 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3916 | <hr> |
| 3917 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3918 | <a name="gst-message-set-stream-status-object"></a><h3>gst_message_set_stream_status_object ()</h3> |
| 3919 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3920 | gst_message_set_stream_status_object (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3921 | <em class="parameter"><code>const <a href="https://developer.gnome.org/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *object</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3922 | <p>Configures the object handling the streaming thread. This is usually a |
| 3923 | GstTask object but other objects might be added in the future.</p> |
| 3924 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3925 | <a name="id-1.3.29.8.78.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3926 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3927 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3928 | <col width="150px" class="parameters_name"> |
| 3929 | <col class="parameters_description"> |
| 3930 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3931 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3932 | <tbody> |
| 3933 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3934 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3935 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_STREAM_STATUS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3936 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3937 | </tr> |
| 3938 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3939 | <td class="parameter_name"><p>object</p></td> |
| 3940 | <td class="parameter_description"><p>the object controlling the streaming</p></td> |
| 3941 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3942 | </tr> |
| 3943 | </tbody> |
| 3944 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3945 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3946 | </div> |
| 3947 | <hr> |
| 3948 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3949 | <a name="gst-message-get-stream-status-object"></a><h3>gst_message_get_stream_status_object ()</h3> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3950 | <pre class="programlisting">const <a href="https://developer.gnome.org/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3951 | gst_message_get_stream_status_object (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3952 | <p>Extracts the object managing the streaming thread from <em class="parameter"><code>message</code></em> |
| 3953 | .</p> |
| 3954 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3955 | <a name="id-1.3.29.8.79.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3956 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3957 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3958 | <col width="150px" class="parameters_name"> |
| 3959 | <col class="parameters_description"> |
| 3960 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 3961 | </colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3962 | <tbody><tr> |
| 3963 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3964 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_STREAM_STATUS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3965 | <td class="parameter_annotations"> </td> |
| 3966 | </tr></tbody> |
| 3967 | </table></div> |
| 3968 | </div> |
| 3969 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3970 | <a name="id-1.3.29.8.79.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3971 | <p> a GValue containing the object that manages the streaming thread. |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 3972 | This object is usually of type GstTask but other types can be added in the |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3973 | future. The object remains valid as long as <em class="parameter"><code>message</code></em> |
| 3974 | is valid.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3975 | </div> |
| 3976 | </div> |
| 3977 | <hr> |
| 3978 | <div class="refsect2"> |
| 3979 | <a name="gst-message-new-progress"></a><h3>gst_message_new_progress ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3980 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3981 | gst_message_new_progress (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 3982 | <em class="parameter"><code><a class="link" href="GstMessage.html#GstProgressType" title="enum GstProgressType"><span class="type">GstProgressType</span></a> type</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3983 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *code</code></em>, |
| 3984 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3985 | <p>Progress messages are posted by elements when they use an asynchronous task |
| 3986 | to perform actions triggered by a state change.</p> |
| 3987 | <p><em class="parameter"><code>code</code></em> |
| 3988 | contains a well defined string describing the action. |
| 3989 | <em class="parameter"><code>test</code></em> |
| 3990 | should contain a user visible string detailing the current action.</p> |
| 3991 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 3992 | <a name="id-1.3.29.8.80.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 3993 | <div class="informaltable"><table width="100%" border="0"> |
| 3994 | <colgroup> |
| 3995 | <col width="150px" class="parameters_name"> |
| 3996 | <col class="parameters_description"> |
| 3997 | <col width="200px" class="parameters_annotations"> |
| 3998 | </colgroup> |
| 3999 | <tbody> |
| 4000 | <tr> |
| 4001 | <td class="parameter_name"><p>src</p></td> |
| 4002 | <td class="parameter_description"><p>The object originating the message.</p></td> |
| 4003 | <td class="parameter_annotations"> </td> |
| 4004 | </tr> |
| 4005 | <tr> |
| 4006 | <td class="parameter_name"><p>type</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4007 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html#GstProgressType" title="enum GstProgressType"><span class="type">GstProgressType</span></a></p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4008 | <td class="parameter_annotations"> </td> |
| 4009 | </tr> |
| 4010 | <tr> |
| 4011 | <td class="parameter_name"><p>code</p></td> |
| 4012 | <td class="parameter_description"><p>a progress code</p></td> |
| 4013 | <td class="parameter_annotations"> </td> |
| 4014 | </tr> |
| 4015 | <tr> |
| 4016 | <td class="parameter_name"><p>text</p></td> |
| 4017 | <td class="parameter_description"><p>free, user visible text describing the progress</p></td> |
| 4018 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4019 | </tr> |
| 4020 | </tbody> |
| 4021 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4022 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4023 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4024 | <a name="id-1.3.29.8.80.7"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4025 | <p> The new qos message. </p> |
| 4026 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 4027 | </div> |
| 4028 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4029 | <hr> |
| 4030 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4031 | <a name="gst-message-parse-progress"></a><h3>gst_message_parse_progress ()</h3> |
| 4032 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4033 | gst_message_parse_progress (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 4034 | <em class="parameter"><code><a class="link" href="GstMessage.html#GstProgressType" title="enum GstProgressType"><span class="type">GstProgressType</span></a> *type</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4035 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **code</code></em>, |
| 4036 | <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **text</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4037 | <p>Parses the progress <em class="parameter"><code>type</code></em> |
| 4038 | , <em class="parameter"><code>code</code></em> |
| 4039 | and <em class="parameter"><code>text</code></em> |
| 4040 | .</p> |
| 4041 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4042 | <a name="id-1.3.29.8.81.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4043 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4044 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4045 | <col width="150px" class="parameters_name"> |
| 4046 | <col class="parameters_description"> |
| 4047 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4048 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4049 | <tbody> |
| 4050 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4051 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4052 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_PROGRESS.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4053 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4054 | </tr> |
| 4055 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4056 | <td class="parameter_name"><p>type</p></td> |
| 4057 | <td class="parameter_description"><p> location for the type. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4058 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4059 | </tr> |
| 4060 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4061 | <td class="parameter_name"><p>code</p></td> |
| 4062 | <td class="parameter_description"><p> location for the code. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4063 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4064 | </tr> |
| 4065 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4066 | <td class="parameter_name"><p>text</p></td> |
| 4067 | <td class="parameter_description"><p> location for the text. </p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4068 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4069 | </tr> |
| 4070 | </tbody> |
| 4071 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4072 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4073 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4074 | <hr> |
| 4075 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4076 | <a name="gst-message-new-need-context"></a><h3>gst_message_new_need_context ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4077 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4078 | gst_message_new_need_context (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4079 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *context_type</code></em>);</pre> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4080 | <p>This message is posted when an element needs a specific <a class="link" href="GstContext.html" title="GstContext"><span class="type">GstContext</span></a>.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4081 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4082 | <a name="id-1.3.29.8.82.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4083 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4084 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4085 | <col width="150px" class="parameters_name"> |
| 4086 | <col class="parameters_description"> |
| 4087 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4088 | </colgroup> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4089 | <tbody> |
| 4090 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4091 | <td class="parameter_name"><p>src</p></td> |
| 4092 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 4093 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4094 | </tr> |
| 4095 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4096 | <td class="parameter_name"><p>context_type</p></td> |
| 4097 | <td class="parameter_description"><p>The context type that is needed</p></td> |
| 4098 | <td class="parameter_annotations"> </td> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4099 | </tr> |
| 4100 | </tbody> |
| 4101 | </table></div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4102 | </div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4103 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4104 | <a name="id-1.3.29.8.82.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4105 | <p> The new need-context message.</p> |
| 4106 | <p>MT safe. </p> |
| 4107 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4108 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4109 | <p class="since">Since: 1.2</p> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4110 | </div> |
| 4111 | <hr> |
| 4112 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4113 | <a name="gst-message-parse-context-type"></a><h3>gst_message_parse_context_type ()</h3> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4114 | <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4115 | gst_message_parse_context_type (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4116 | <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **context_type</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4117 | <p>Parse a context type from an existing GST_MESSAGE_NEED_CONTEXT message.</p> |
| 4118 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4119 | <a name="id-1.3.29.8.83.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4120 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4121 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4122 | <col width="150px" class="parameters_name"> |
| 4123 | <col class="parameters_description"> |
| 4124 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4125 | </colgroup> |
| 4126 | <tbody> |
| 4127 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4128 | <td class="parameter_name"><p>message</p></td> |
| 4129 | <td class="parameter_description"><p>a GST_MESSAGE_NEED_CONTEXT type message</p></td> |
| 4130 | <td class="parameter_annotations"> </td> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4131 | </tr> |
| 4132 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4133 | <td class="parameter_name"><p>context_type</p></td> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4134 | <td class="parameter_description"><p> the context type, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 4135 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4136 | </tr> |
| 4137 | </tbody> |
| 4138 | </table></div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4139 | </div> |
| 4140 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4141 | <a name="id-1.3.29.8.83.6"></a><h4>Returns</h4> |
| 4142 | <p> a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> indicating if the parsing succeeded.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4143 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4144 | <p class="since">Since: 1.2</p> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4145 | </div> |
| 4146 | <hr> |
| 4147 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4148 | <a name="gst-message-new-have-context"></a><h3>gst_message_new_have_context ()</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4149 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4150 | gst_message_new_have_context (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4151 | <em class="parameter"><code><a class="link" href="GstContext.html" title="GstContext"><span class="type">GstContext</span></a> *context</code></em>);</pre> |
| 4152 | <p>This message is posted when an element has a new local <a class="link" href="GstContext.html" title="GstContext"><span class="type">GstContext</span></a>.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4153 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4154 | <a name="id-1.3.29.8.84.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4155 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4156 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4157 | <col width="150px" class="parameters_name"> |
| 4158 | <col class="parameters_description"> |
| 4159 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4160 | </colgroup> |
| 4161 | <tbody> |
| 4162 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4163 | <td class="parameter_name"><p>src</p></td> |
| 4164 | <td class="parameter_description"><p> The object originating the message. </p></td> |
| 4165 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4166 | </tr> |
| 4167 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4168 | <td class="parameter_name"><p>context</p></td> |
| 4169 | <td class="parameter_description"><p> the context. </p></td> |
| 4170 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4171 | </tr> |
| 4172 | </tbody> |
| 4173 | </table></div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4174 | </div> |
| 4175 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4176 | <a name="id-1.3.29.8.84.6"></a><h4>Returns</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4177 | <p> The new have-context message.</p> |
| 4178 | <p>MT safe. </p> |
| 4179 | <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 4180 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4181 | <p class="since">Since: 1.2</p> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4182 | </div> |
| 4183 | <hr> |
| 4184 | <div class="refsect2"> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4185 | <a name="gst-message-parse-have-context"></a><h3>gst_message_parse_have_context ()</h3> |
| 4186 | <pre class="programlisting"><span class="returnvalue">void</span> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4187 | gst_message_parse_have_context (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 4188 | <em class="parameter"><code><a class="link" href="GstContext.html" title="GstContext"><span class="type">GstContext</span></a> **context</code></em>);</pre> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4189 | <p>Extract the context from the HAVE_CONTEXT message.</p> |
| 4190 | <p>MT safe.</p> |
| 4191 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4192 | <a name="id-1.3.29.8.85.6"></a><h4>Parameters</h4> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4193 | <div class="informaltable"><table width="100%" border="0"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4194 | <colgroup> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4195 | <col width="150px" class="parameters_name"> |
| 4196 | <col class="parameters_description"> |
| 4197 | <col width="200px" class="parameters_annotations"> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4198 | </colgroup> |
| 4199 | <tbody> |
| 4200 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4201 | <td class="parameter_name"><p>message</p></td> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4202 | <td class="parameter_description"><p>A valid <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type GST_MESSAGE_HAVE_CONTEXT.</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4203 | <td class="parameter_annotations"> </td> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4204 | </tr> |
| 4205 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4206 | <td class="parameter_name"><p>context</p></td> |
| 4207 | <td class="parameter_description"><p> Result location for the |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4208 | context or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 4209 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4210 | </tr> |
| 4211 | </tbody> |
| 4212 | </table></div> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4213 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4214 | <p class="since">Since: 1.2</p> |
Sebastian Dröge | 01f2367 | 2013-07-14 10:55:08 +0200 | [diff] [blame] | 4215 | </div> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4216 | <hr> |
| 4217 | <div class="refsect2"> |
| 4218 | <a name="gst-message-new-device-added"></a><h3>gst_message_new_device_added ()</h3> |
| 4219 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
| 4220 | gst_message_new_device_added (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 4221 | <em class="parameter"><code><a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a> *device</code></em>);</pre> |
| 4222 | <p>Creates a new device-added message. The device-added message is produced by |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4223 | <a class="link" href="gstreamer-GstDeviceProvider.html#GstDeviceProvider" title="struct GstDeviceProvider"><span class="type">GstDeviceProvider</span></a> or a <a class="link" href="gstreamer-GstDeviceMonitor.html#GstDeviceMonitor" title="struct GstDeviceMonitor"><span class="type">GstDeviceMonitor</span></a>. They announce the appearance |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4224 | of monitored devices.</p> |
| 4225 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4226 | <a name="id-1.3.29.8.86.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4227 | <div class="informaltable"><table width="100%" border="0"> |
| 4228 | <colgroup> |
| 4229 | <col width="150px" class="parameters_name"> |
| 4230 | <col class="parameters_description"> |
| 4231 | <col width="200px" class="parameters_annotations"> |
| 4232 | </colgroup> |
| 4233 | <tbody> |
| 4234 | <tr> |
| 4235 | <td class="parameter_name"><p>src</p></td> |
| 4236 | <td class="parameter_description"><p>The <a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> that created the message</p></td> |
| 4237 | <td class="parameter_annotations"> </td> |
| 4238 | </tr> |
| 4239 | <tr> |
| 4240 | <td class="parameter_name"><p>device</p></td> |
| 4241 | <td class="parameter_description"><p> The new <a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a>. </p></td> |
| 4242 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
| 4243 | </tr> |
| 4244 | </tbody> |
| 4245 | </table></div> |
| 4246 | </div> |
| 4247 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4248 | <a name="id-1.3.29.8.86.6"></a><h4>Returns</h4> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4249 | <p> a newly allocated <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4250 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4251 | <p class="since">Since: 1.4</p> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4252 | </div> |
| 4253 | <hr> |
| 4254 | <div class="refsect2"> |
| 4255 | <a name="gst-message-new-device-removed"></a><h3>gst_message_new_device_removed ()</h3> |
| 4256 | <pre class="programlisting"><a class="link" href="GstMessage.html" title="GstMessage"><span class="returnvalue">GstMessage</span></a> * |
| 4257 | gst_message_new_device_removed (<em class="parameter"><code><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *src</code></em>, |
| 4258 | <em class="parameter"><code><a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a> *device</code></em>);</pre> |
| 4259 | <p>Creates a new device-removed message. The device-removed message is produced |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4260 | by <a class="link" href="gstreamer-GstDeviceProvider.html#GstDeviceProvider" title="struct GstDeviceProvider"><span class="type">GstDeviceProvider</span></a> or a <a class="link" href="gstreamer-GstDeviceMonitor.html#GstDeviceMonitor" title="struct GstDeviceMonitor"><span class="type">GstDeviceMonitor</span></a>. They announce the |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4261 | disappearance of monitored devices.</p> |
| 4262 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4263 | <a name="id-1.3.29.8.87.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4264 | <div class="informaltable"><table width="100%" border="0"> |
| 4265 | <colgroup> |
| 4266 | <col width="150px" class="parameters_name"> |
| 4267 | <col class="parameters_description"> |
| 4268 | <col width="200px" class="parameters_annotations"> |
| 4269 | </colgroup> |
| 4270 | <tbody> |
| 4271 | <tr> |
| 4272 | <td class="parameter_name"><p>src</p></td> |
| 4273 | <td class="parameter_description"><p>The <a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> that created the message</p></td> |
| 4274 | <td class="parameter_annotations"> </td> |
| 4275 | </tr> |
| 4276 | <tr> |
| 4277 | <td class="parameter_name"><p>device</p></td> |
| 4278 | <td class="parameter_description"><p> The removed <a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a>. </p></td> |
| 4279 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
| 4280 | </tr> |
| 4281 | </tbody> |
| 4282 | </table></div> |
| 4283 | </div> |
| 4284 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4285 | <a name="id-1.3.29.8.87.6"></a><h4>Returns</h4> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4286 | <p> a newly allocated <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a></p> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4287 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4288 | <p class="since">Since: 1.4</p> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4289 | </div> |
| 4290 | <hr> |
| 4291 | <div class="refsect2"> |
| 4292 | <a name="gst-message-parse-device-added"></a><h3>gst_message_parse_device_added ()</h3> |
| 4293 | <pre class="programlisting"><span class="returnvalue">void</span> |
| 4294 | gst_message_parse_device_added (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 4295 | <em class="parameter"><code><a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a> **device</code></em>);</pre> |
| 4296 | <p>Parses a device-added message. The device-added message is produced by |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4297 | <a class="link" href="gstreamer-GstDeviceProvider.html#GstDeviceProvider" title="struct GstDeviceProvider"><span class="type">GstDeviceProvider</span></a> or a <a class="link" href="gstreamer-GstDeviceMonitor.html#GstDeviceMonitor" title="struct GstDeviceMonitor"><span class="type">GstDeviceMonitor</span></a>. It announces the appearance |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4298 | of monitored devices.</p> |
| 4299 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4300 | <a name="id-1.3.29.8.88.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4301 | <div class="informaltable"><table width="100%" border="0"> |
| 4302 | <colgroup> |
| 4303 | <col width="150px" class="parameters_name"> |
| 4304 | <col class="parameters_description"> |
| 4305 | <col width="200px" class="parameters_annotations"> |
| 4306 | </colgroup> |
| 4307 | <tbody> |
| 4308 | <tr> |
| 4309 | <td class="parameter_name"><p>message</p></td> |
| 4310 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type <a class="link" href="GstMessage.html#GST-MESSAGE-DEVICE-ADDED:CAPS"><code class="literal">GST_MESSAGE_DEVICE_ADDED</code></a></p></td> |
| 4311 | <td class="parameter_annotations"> </td> |
| 4312 | </tr> |
| 4313 | <tr> |
| 4314 | <td class="parameter_name"><p>device</p></td> |
| 4315 | <td class="parameter_description"><p> A location where to store a |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4316 | pointer to the new <a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 4317 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4318 | </tr> |
| 4319 | </tbody> |
| 4320 | </table></div> |
| 4321 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4322 | <p class="since">Since: 1.4</p> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4323 | </div> |
| 4324 | <hr> |
| 4325 | <div class="refsect2"> |
| 4326 | <a name="gst-message-parse-device-removed"></a><h3>gst_message_parse_device_removed ()</h3> |
| 4327 | <pre class="programlisting"><span class="returnvalue">void</span> |
| 4328 | gst_message_parse_device_removed (<em class="parameter"><code><a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> *message</code></em>, |
| 4329 | <em class="parameter"><code><a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a> **device</code></em>);</pre> |
| 4330 | <p>Parses a device-removed message. The device-removed message is produced by |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4331 | <a class="link" href="gstreamer-GstDeviceProvider.html#GstDeviceProvider" title="struct GstDeviceProvider"><span class="type">GstDeviceProvider</span></a> or a <a class="link" href="gstreamer-GstDeviceMonitor.html#GstDeviceMonitor" title="struct GstDeviceMonitor"><span class="type">GstDeviceMonitor</span></a>. It announces the |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4332 | disappearance of monitored devices.</p> |
| 4333 | <div class="refsect3"> |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4334 | <a name="id-1.3.29.8.89.5"></a><h4>Parameters</h4> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4335 | <div class="informaltable"><table width="100%" border="0"> |
| 4336 | <colgroup> |
| 4337 | <col width="150px" class="parameters_name"> |
| 4338 | <col class="parameters_description"> |
| 4339 | <col width="200px" class="parameters_annotations"> |
| 4340 | </colgroup> |
| 4341 | <tbody> |
| 4342 | <tr> |
| 4343 | <td class="parameter_name"><p>message</p></td> |
| 4344 | <td class="parameter_description"><p>a <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a> of type <a class="link" href="GstMessage.html#GST-MESSAGE-DEVICE-REMOVED:CAPS"><code class="literal">GST_MESSAGE_DEVICE_REMOVED</code></a></p></td> |
| 4345 | <td class="parameter_annotations"> </td> |
| 4346 | </tr> |
| 4347 | <tr> |
| 4348 | <td class="parameter_name"><p>device</p></td> |
| 4349 | <td class="parameter_description"><p> A location where to store a |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4350 | pointer to the removed <a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> |
| 4351 | <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4352 | </tr> |
| 4353 | </tbody> |
| 4354 | </table></div> |
| 4355 | </div> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4356 | <p class="since">Since: 1.4</p> |
Sebastian Dröge | 5856dec | 2014-06-22 17:18:02 +0200 | [diff] [blame] | 4357 | </div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4358 | </div> |
| 4359 | <div class="refsect1"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4360 | <a name="GstMessage.other_details"></a><h2>Types and Values</h2> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4361 | <div class="refsect2"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4362 | <a name="GstMessage-struct"></a><h3>struct GstMessage</h3> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4363 | <pre class="programlisting">struct GstMessage { |
| 4364 | GstMiniObject mini_object; |
| 4365 | |
| 4366 | GstMessageType type; |
| 4367 | guint64 timestamp; |
| 4368 | GstObject *src; |
| 4369 | guint32 seqnum; |
| 4370 | }; |
| 4371 | </pre> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4372 | <p>A <a class="link" href="GstMessage.html" title="GstMessage"><span class="type">GstMessage</span></a>.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4373 | <div class="refsect3"> |
| 4374 | <a name="id-1.3.29.9.2.5"></a><h4>Members</h4> |
| 4375 | <div class="informaltable"><table width="100%" border="0"> |
| 4376 | <colgroup> |
| 4377 | <col width="300px" class="struct_members_name"> |
| 4378 | <col class="struct_members_description"> |
| 4379 | <col width="200px" class="struct_members_annotations"> |
| 4380 | </colgroup> |
| 4381 | <tbody> |
| 4382 | <tr> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4383 | <td class="struct_member_name"><p><a class="link" href="gstreamer-GstMiniObject.html#GstMiniObject" title="struct GstMiniObject"><span class="type">GstMiniObject</span></a> <em class="structfield"><code><a name="GstMessage-struct.mini-object"></a>mini_object</code></em>;</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4384 | <td class="struct_member_description"><p>the parent structure</p></td> |
| 4385 | <td class="struct_member_annotations"> </td> |
| 4386 | </tr> |
| 4387 | <tr> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4388 | <td class="struct_member_name"><p><a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType"><span class="type">GstMessageType</span></a> <em class="structfield"><code><a name="GstMessage-struct.type"></a>type</code></em>;</p></td> |
| 4389 | <td class="struct_member_description"><p>the <a class="link" href="GstMessage.html#GstMessageType" title="enum GstMessageType"><span class="type">GstMessageType</span></a> of the message</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4390 | <td class="struct_member_annotations"> </td> |
| 4391 | </tr> |
| 4392 | <tr> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4393 | <td class="struct_member_name"><p><span class="type">guint64</span> <em class="structfield"><code><a name="GstMessage-struct.timestamp"></a>timestamp</code></em>;</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4394 | <td class="struct_member_description"><p>the timestamp of the message</p></td> |
| 4395 | <td class="struct_member_annotations"> </td> |
| 4396 | </tr> |
| 4397 | <tr> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4398 | <td class="struct_member_name"><p><a class="link" href="GstObject.html" title="GstObject"><span class="type">GstObject</span></a> *<em class="structfield"><code><a name="GstMessage-struct.src"></a>src</code></em>;</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4399 | <td class="struct_member_description"><p>the src of the message</p></td> |
| 4400 | <td class="struct_member_annotations"> </td> |
| 4401 | </tr> |
| 4402 | <tr> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4403 | <td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GstMessage-struct.seqnum"></a>seqnum</code></em>;</p></td> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4404 | <td class="struct_member_description"><p>the sequence number of the message</p></td> |
| 4405 | <td class="struct_member_annotations"> </td> |
| 4406 | </tr> |
| 4407 | </tbody> |
| 4408 | </table></div> |
| 4409 | </div> |
| 4410 | </div> |
| 4411 | <hr> |
| 4412 | <div class="refsect2"> |
| 4413 | <a name="GstMessageType"></a><h3>enum GstMessageType</h3> |
| 4414 | <p>The different message types that are available.</p> |
| 4415 | <div class="refsect3"> |
| 4416 | <a name="id-1.3.29.9.3.4"></a><h4>Members</h4> |
| 4417 | <div class="informaltable"><table width="100%" border="0"> |
| 4418 | <colgroup> |
| 4419 | <col width="300px" class="enum_members_name"> |
| 4420 | <col class="enum_members_description"> |
| 4421 | <col width="200px" class="enum_members_annotations"> |
| 4422 | </colgroup> |
| 4423 | <tbody> |
| 4424 | <tr> |
| 4425 | <td class="enum_member_name"><p><a name="GST-MESSAGE-UNKNOWN:CAPS"></a>GST_MESSAGE_UNKNOWN</p></td> |
| 4426 | <td class="enum_member_description"> |
| 4427 | <p>an undefined message</p> |
| 4428 | </td> |
| 4429 | <td class="enum_member_annotations"> </td> |
| 4430 | </tr> |
| 4431 | <tr> |
| 4432 | <td class="enum_member_name"><p><a name="GST-MESSAGE-EOS:CAPS"></a>GST_MESSAGE_EOS</p></td> |
| 4433 | <td class="enum_member_description"> |
| 4434 | <p>end-of-stream reached in a pipeline. The application will |
| 4435 | only receive this message in the PLAYING state and every time it sets a |
| 4436 | pipeline to PLAYING that is in the EOS state. The application can perform a |
| 4437 | flushing seek in the pipeline, which will undo the EOS state again.</p> |
| 4438 | </td> |
| 4439 | <td class="enum_member_annotations"> </td> |
| 4440 | </tr> |
| 4441 | <tr> |
| 4442 | <td class="enum_member_name"><p><a name="GST-MESSAGE-ERROR:CAPS"></a>GST_MESSAGE_ERROR</p></td> |
| 4443 | <td class="enum_member_description"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4444 | <p>an error occurred. When the application receives an error |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4445 | message it should stop playback of the pipeline and not assume that more |
| 4446 | data will be played.</p> |
| 4447 | </td> |
| 4448 | <td class="enum_member_annotations"> </td> |
| 4449 | </tr> |
| 4450 | <tr> |
| 4451 | <td class="enum_member_name"><p><a name="GST-MESSAGE-WARNING:CAPS"></a>GST_MESSAGE_WARNING</p></td> |
| 4452 | <td class="enum_member_description"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4453 | <p>a warning occurred.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4454 | </td> |
| 4455 | <td class="enum_member_annotations"> </td> |
| 4456 | </tr> |
| 4457 | <tr> |
| 4458 | <td class="enum_member_name"><p><a name="GST-MESSAGE-INFO:CAPS"></a>GST_MESSAGE_INFO</p></td> |
| 4459 | <td class="enum_member_description"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4460 | <p>an info message occurred</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4461 | </td> |
| 4462 | <td class="enum_member_annotations"> </td> |
| 4463 | </tr> |
| 4464 | <tr> |
| 4465 | <td class="enum_member_name"><p><a name="GST-MESSAGE-TAG:CAPS"></a>GST_MESSAGE_TAG</p></td> |
| 4466 | <td class="enum_member_description"> |
| 4467 | <p>a tag was found.</p> |
| 4468 | </td> |
| 4469 | <td class="enum_member_annotations"> </td> |
| 4470 | </tr> |
| 4471 | <tr> |
| 4472 | <td class="enum_member_name"><p><a name="GST-MESSAGE-BUFFERING:CAPS"></a>GST_MESSAGE_BUFFERING</p></td> |
| 4473 | <td class="enum_member_description"> |
| 4474 | <p>the pipeline is buffering. When the application |
| 4475 | receives a buffering message in the PLAYING state for a non-live pipeline it |
| 4476 | must PAUSE the pipeline until the buffering completes, when the percentage |
| 4477 | field in the message is 100%. For live pipelines, no action must be |
| 4478 | performed and the buffering percentage can be used to inform the user about |
| 4479 | the progress.</p> |
| 4480 | </td> |
| 4481 | <td class="enum_member_annotations"> </td> |
| 4482 | </tr> |
| 4483 | <tr> |
| 4484 | <td class="enum_member_name"><p><a name="GST-MESSAGE-STATE-CHANGED:CAPS"></a>GST_MESSAGE_STATE_CHANGED</p></td> |
| 4485 | <td class="enum_member_description"> |
| 4486 | <p>a state change happened</p> |
| 4487 | </td> |
| 4488 | <td class="enum_member_annotations"> </td> |
| 4489 | </tr> |
| 4490 | <tr> |
| 4491 | <td class="enum_member_name"><p><a name="GST-MESSAGE-STATE-DIRTY:CAPS"></a>GST_MESSAGE_STATE_DIRTY</p></td> |
| 4492 | <td class="enum_member_description"> |
| 4493 | <p>an element changed state in a streaming thread. |
| 4494 | This message is deprecated.</p> |
| 4495 | </td> |
| 4496 | <td class="enum_member_annotations"> </td> |
| 4497 | </tr> |
| 4498 | <tr> |
| 4499 | <td class="enum_member_name"><p><a name="GST-MESSAGE-STEP-DONE:CAPS"></a>GST_MESSAGE_STEP_DONE</p></td> |
| 4500 | <td class="enum_member_description"> |
| 4501 | <p>a stepping operation finished.</p> |
| 4502 | </td> |
| 4503 | <td class="enum_member_annotations"> </td> |
| 4504 | </tr> |
| 4505 | <tr> |
| 4506 | <td class="enum_member_name"><p><a name="GST-MESSAGE-CLOCK-PROVIDE:CAPS"></a>GST_MESSAGE_CLOCK_PROVIDE</p></td> |
| 4507 | <td class="enum_member_description"> |
| 4508 | <p>an element notifies its capability of providing |
| 4509 | a clock. This message is used internally and |
| 4510 | never forwarded to the application.</p> |
| 4511 | </td> |
| 4512 | <td class="enum_member_annotations"> </td> |
| 4513 | </tr> |
| 4514 | <tr> |
| 4515 | <td class="enum_member_name"><p><a name="GST-MESSAGE-CLOCK-LOST:CAPS"></a>GST_MESSAGE_CLOCK_LOST</p></td> |
| 4516 | <td class="enum_member_description"> |
| 4517 | <p>The current clock as selected by the pipeline became |
| 4518 | unusable. The pipeline will select a new clock on |
| 4519 | the next PLAYING state change. The application |
| 4520 | should set the pipeline to PAUSED and back to |
| 4521 | PLAYING when this message is received.</p> |
| 4522 | </td> |
| 4523 | <td class="enum_member_annotations"> </td> |
| 4524 | </tr> |
| 4525 | <tr> |
| 4526 | <td class="enum_member_name"><p><a name="GST-MESSAGE-NEW-CLOCK:CAPS"></a>GST_MESSAGE_NEW_CLOCK</p></td> |
| 4527 | <td class="enum_member_description"> |
| 4528 | <p>a new clock was selected in the pipeline.</p> |
| 4529 | </td> |
| 4530 | <td class="enum_member_annotations"> </td> |
| 4531 | </tr> |
| 4532 | <tr> |
| 4533 | <td class="enum_member_name"><p><a name="GST-MESSAGE-STRUCTURE-CHANGE:CAPS"></a>GST_MESSAGE_STRUCTURE_CHANGE</p></td> |
| 4534 | <td class="enum_member_description"> |
| 4535 | <p>the structure of the pipeline changed. This |
| 4536 | message is used internally and never forwarded to the application.</p> |
| 4537 | </td> |
| 4538 | <td class="enum_member_annotations"> </td> |
| 4539 | </tr> |
| 4540 | <tr> |
| 4541 | <td class="enum_member_name"><p><a name="GST-MESSAGE-STREAM-STATUS:CAPS"></a>GST_MESSAGE_STREAM_STATUS</p></td> |
| 4542 | <td class="enum_member_description"> |
| 4543 | <p>status about a stream, emitted when it starts, |
| 4544 | stops, errors, etc..</p> |
| 4545 | </td> |
| 4546 | <td class="enum_member_annotations"> </td> |
| 4547 | </tr> |
| 4548 | <tr> |
| 4549 | <td class="enum_member_name"><p><a name="GST-MESSAGE-APPLICATION:CAPS"></a>GST_MESSAGE_APPLICATION</p></td> |
| 4550 | <td class="enum_member_description"> |
| 4551 | <p>message posted by the application, possibly |
| 4552 | via an application-specific element.</p> |
| 4553 | </td> |
| 4554 | <td class="enum_member_annotations"> </td> |
| 4555 | </tr> |
| 4556 | <tr> |
| 4557 | <td class="enum_member_name"><p><a name="GST-MESSAGE-ELEMENT:CAPS"></a>GST_MESSAGE_ELEMENT</p></td> |
| 4558 | <td class="enum_member_description"> |
| 4559 | <p>element-specific message, see the specific element's |
| 4560 | documentation</p> |
| 4561 | </td> |
| 4562 | <td class="enum_member_annotations"> </td> |
| 4563 | </tr> |
| 4564 | <tr> |
| 4565 | <td class="enum_member_name"><p><a name="GST-MESSAGE-SEGMENT-START:CAPS"></a>GST_MESSAGE_SEGMENT_START</p></td> |
| 4566 | <td class="enum_member_description"> |
| 4567 | <p>pipeline started playback of a segment. This |
| 4568 | message is used internally and never forwarded to the application.</p> |
| 4569 | </td> |
| 4570 | <td class="enum_member_annotations"> </td> |
| 4571 | </tr> |
| 4572 | <tr> |
| 4573 | <td class="enum_member_name"><p><a name="GST-MESSAGE-SEGMENT-DONE:CAPS"></a>GST_MESSAGE_SEGMENT_DONE</p></td> |
| 4574 | <td class="enum_member_description"> |
| 4575 | <p>pipeline completed playback of a segment. This |
| 4576 | message is forwarded to the application after all elements that posted |
| 4577 | <em class="parameter"><code>GST_MESSAGE_SEGMENT_START</code></em> |
| 4578 | posted a GST_MESSAGE_SEGMENT_DONE message.</p> |
| 4579 | </td> |
| 4580 | <td class="enum_member_annotations"> </td> |
| 4581 | </tr> |
| 4582 | <tr> |
| 4583 | <td class="enum_member_name"><p><a name="GST-MESSAGE-DURATION-CHANGED:CAPS"></a>GST_MESSAGE_DURATION_CHANGED</p></td> |
| 4584 | <td class="enum_member_description"> |
| 4585 | <p>The duration of a pipeline changed. The |
| 4586 | application can get the new duration with a duration query.</p> |
| 4587 | </td> |
| 4588 | <td class="enum_member_annotations"> </td> |
| 4589 | </tr> |
| 4590 | <tr> |
| 4591 | <td class="enum_member_name"><p><a name="GST-MESSAGE-LATENCY:CAPS"></a>GST_MESSAGE_LATENCY</p></td> |
| 4592 | <td class="enum_member_description"> |
| 4593 | <p>Posted by elements when their latency changes. The |
| 4594 | application should recalculate and distribute a new latency.</p> |
| 4595 | </td> |
| 4596 | <td class="enum_member_annotations"> </td> |
| 4597 | </tr> |
| 4598 | <tr> |
| 4599 | <td class="enum_member_name"><p><a name="GST-MESSAGE-ASYNC-START:CAPS"></a>GST_MESSAGE_ASYNC_START</p></td> |
| 4600 | <td class="enum_member_description"> |
| 4601 | <p>Posted by elements when they start an ASYNC |
| 4602 | <a class="link" href="GstElement.html#GstStateChange" title="enum GstStateChange"><span class="type">GstStateChange</span></a>. This message is not forwarded to the application but is used |
| 4603 | internally.</p> |
| 4604 | </td> |
| 4605 | <td class="enum_member_annotations"> </td> |
| 4606 | </tr> |
| 4607 | <tr> |
| 4608 | <td class="enum_member_name"><p><a name="GST-MESSAGE-ASYNC-DONE:CAPS"></a>GST_MESSAGE_ASYNC_DONE</p></td> |
| 4609 | <td class="enum_member_description"> |
| 4610 | <p>Posted by elements when they complete an ASYNC |
| 4611 | <a class="link" href="GstElement.html#GstStateChange" title="enum GstStateChange"><span class="type">GstStateChange</span></a>. The application will only receive this message from the toplevel |
| 4612 | pipeline.</p> |
| 4613 | </td> |
| 4614 | <td class="enum_member_annotations"> </td> |
| 4615 | </tr> |
| 4616 | <tr> |
| 4617 | <td class="enum_member_name"><p><a name="GST-MESSAGE-REQUEST-STATE:CAPS"></a>GST_MESSAGE_REQUEST_STATE</p></td> |
| 4618 | <td class="enum_member_description"> |
| 4619 | <p>Posted by elements when they want the pipeline to |
| 4620 | change state. This message is a suggestion to the application which can |
| 4621 | decide to perform the state change on (part of) the pipeline.</p> |
| 4622 | </td> |
| 4623 | <td class="enum_member_annotations"> </td> |
| 4624 | </tr> |
| 4625 | <tr> |
| 4626 | <td class="enum_member_name"><p><a name="GST-MESSAGE-STEP-START:CAPS"></a>GST_MESSAGE_STEP_START</p></td> |
| 4627 | <td class="enum_member_description"> |
| 4628 | <p>A stepping operation was started.</p> |
| 4629 | </td> |
| 4630 | <td class="enum_member_annotations"> </td> |
| 4631 | </tr> |
| 4632 | <tr> |
| 4633 | <td class="enum_member_name"><p><a name="GST-MESSAGE-QOS:CAPS"></a>GST_MESSAGE_QOS</p></td> |
| 4634 | <td class="enum_member_description"> |
| 4635 | <p>A buffer was dropped or an element changed its processing |
| 4636 | strategy for Quality of Service reasons.</p> |
| 4637 | </td> |
| 4638 | <td class="enum_member_annotations"> </td> |
| 4639 | </tr> |
| 4640 | <tr> |
| 4641 | <td class="enum_member_name"><p><a name="GST-MESSAGE-PROGRESS:CAPS"></a>GST_MESSAGE_PROGRESS</p></td> |
| 4642 | <td class="enum_member_description"> |
| 4643 | <p>A progress message.</p> |
| 4644 | </td> |
| 4645 | <td class="enum_member_annotations"> </td> |
| 4646 | </tr> |
| 4647 | <tr> |
| 4648 | <td class="enum_member_name"><p><a name="GST-MESSAGE-TOC:CAPS"></a>GST_MESSAGE_TOC</p></td> |
| 4649 | <td class="enum_member_description"> |
| 4650 | <p>A new table of contents (TOC) was found or previously found TOC |
| 4651 | was updated.</p> |
| 4652 | </td> |
| 4653 | <td class="enum_member_annotations"> </td> |
| 4654 | </tr> |
| 4655 | <tr> |
| 4656 | <td class="enum_member_name"><p><a name="GST-MESSAGE-RESET-TIME:CAPS"></a>GST_MESSAGE_RESET_TIME</p></td> |
| 4657 | <td class="enum_member_description"> |
| 4658 | <p>Message to request resetting the pipeline's |
| 4659 | running time from the pipeline. This is an internal message which |
| 4660 | applications will likely never receive.</p> |
| 4661 | </td> |
| 4662 | <td class="enum_member_annotations"> </td> |
| 4663 | </tr> |
| 4664 | <tr> |
| 4665 | <td class="enum_member_name"><p><a name="GST-MESSAGE-STREAM-START:CAPS"></a>GST_MESSAGE_STREAM_START</p></td> |
| 4666 | <td class="enum_member_description"> |
| 4667 | <p>Message indicating start of a new stream. Useful |
| 4668 | e.g. when using playbin in gapless playback mode, to get notified when |
| 4669 | the next title actually starts playing (which will be some time after |
| 4670 | the URI for the next title has been set).</p> |
| 4671 | </td> |
| 4672 | <td class="enum_member_annotations"> </td> |
| 4673 | </tr> |
| 4674 | <tr> |
| 4675 | <td class="enum_member_name"><p><a name="GST-MESSAGE-NEED-CONTEXT:CAPS"></a>GST_MESSAGE_NEED_CONTEXT</p></td> |
| 4676 | <td class="enum_member_description"> |
| 4677 | <p>Message indicating that an element wants a specific context (Since 1.2)</p> |
| 4678 | </td> |
| 4679 | <td class="enum_member_annotations"> </td> |
| 4680 | </tr> |
| 4681 | <tr> |
| 4682 | <td class="enum_member_name"><p><a name="GST-MESSAGE-HAVE-CONTEXT:CAPS"></a>GST_MESSAGE_HAVE_CONTEXT</p></td> |
| 4683 | <td class="enum_member_description"> |
| 4684 | <p>Message indicating that an element created a context (Since 1.2)</p> |
| 4685 | </td> |
| 4686 | <td class="enum_member_annotations"> </td> |
| 4687 | </tr> |
| 4688 | <tr> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4689 | <td class="enum_member_name"><p><a name="GST-MESSAGE-EXTENDED:CAPS"></a>GST_MESSAGE_EXTENDED</p></td> |
| 4690 | <td class="enum_member_description"> |
| 4691 | <p>Message is an extended message type (see below). |
| 4692 | These extended message IDs can't be used directly with mask-based API |
| 4693 | like <a class="link" href="GstBus.html#gst-bus-poll" title="gst_bus_poll ()"><code class="function">gst_bus_poll()</code></a> or <a class="link" href="GstBus.html#gst-bus-timed-pop-filtered" title="gst_bus_timed_pop_filtered ()"><code class="function">gst_bus_timed_pop_filtered()</code></a>, but you can still |
| 4694 | filter for GST_MESSAGE_EXTENDED and then check the result for the |
| 4695 | specific type. (Since 1.4)</p> |
| 4696 | </td> |
| 4697 | <td class="enum_member_annotations"> </td> |
| 4698 | </tr> |
| 4699 | <tr> |
| 4700 | <td class="enum_member_name"><p><a name="GST-MESSAGE-DEVICE-ADDED:CAPS"></a>GST_MESSAGE_DEVICE_ADDED</p></td> |
| 4701 | <td class="enum_member_description"> |
| 4702 | <p>Message indicating a <a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a> was added to |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4703 | a <a class="link" href="gstreamer-GstDeviceProvider.html#GstDeviceProvider" title="struct GstDeviceProvider"><span class="type">GstDeviceProvider</span></a> (Since 1.4)</p> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4704 | </td> |
| 4705 | <td class="enum_member_annotations"> </td> |
| 4706 | </tr> |
| 4707 | <tr> |
| 4708 | <td class="enum_member_name"><p><a name="GST-MESSAGE-DEVICE-REMOVED:CAPS"></a>GST_MESSAGE_DEVICE_REMOVED</p></td> |
| 4709 | <td class="enum_member_description"> |
| 4710 | <p>Message indicating a <a class="link" href="gstreamer-GstDevice.html#GstDevice" title="struct GstDevice"><span class="type">GstDevice</span></a> was removed |
Sebastian Dröge | 570fd49 | 2015-03-16 19:05:29 +0100 | [diff] [blame] | 4711 | from a <a class="link" href="gstreamer-GstDeviceProvider.html#GstDeviceProvider" title="struct GstDeviceProvider"><span class="type">GstDeviceProvider</span></a> (Since 1.4)</p> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4712 | </td> |
| 4713 | <td class="enum_member_annotations"> </td> |
| 4714 | </tr> |
| 4715 | <tr> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4716 | <td class="enum_member_name"><p><a name="GST-MESSAGE-ANY:CAPS"></a>GST_MESSAGE_ANY</p></td> |
| 4717 | <td class="enum_member_description"> |
| 4718 | <p>mask for all of the above messages.</p> |
| 4719 | </td> |
| 4720 | <td class="enum_member_annotations"> </td> |
| 4721 | </tr> |
| 4722 | </tbody> |
| 4723 | </table></div> |
| 4724 | </div> |
| 4725 | </div> |
| 4726 | <hr> |
| 4727 | <div class="refsect2"> |
| 4728 | <a name="GstStructureChangeType"></a><h3>enum GstStructureChangeType</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4729 | <p>The type of a <a class="link" href="GstMessage.html#GST-MESSAGE-STRUCTURE-CHANGE:CAPS"><code class="literal">GST_MESSAGE_STRUCTURE_CHANGE</code></a>.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4730 | <div class="refsect3"> |
| 4731 | <a name="id-1.3.29.9.4.4"></a><h4>Members</h4> |
| 4732 | <div class="informaltable"><table width="100%" border="0"> |
| 4733 | <colgroup> |
| 4734 | <col width="300px" class="enum_members_name"> |
| 4735 | <col class="enum_members_description"> |
| 4736 | <col width="200px" class="enum_members_annotations"> |
| 4737 | </colgroup> |
| 4738 | <tbody> |
| 4739 | <tr> |
| 4740 | <td class="enum_member_name"><p><a name="GST-STRUCTURE-CHANGE-TYPE-PAD-LINK:CAPS"></a>GST_STRUCTURE_CHANGE_TYPE_PAD_LINK</p></td> |
| 4741 | <td class="enum_member_description"> |
| 4742 | <p>Pad linking is starting or done.</p> |
| 4743 | </td> |
| 4744 | <td class="enum_member_annotations"> </td> |
| 4745 | </tr> |
| 4746 | <tr> |
| 4747 | <td class="enum_member_name"><p><a name="GST-STRUCTURE-CHANGE-TYPE-PAD-UNLINK:CAPS"></a>GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK</p></td> |
| 4748 | <td class="enum_member_description"> |
| 4749 | <p>Pad unlinking is starting or done.</p> |
| 4750 | </td> |
| 4751 | <td class="enum_member_annotations"> </td> |
| 4752 | </tr> |
| 4753 | </tbody> |
| 4754 | </table></div> |
| 4755 | </div> |
| 4756 | </div> |
| 4757 | <hr> |
| 4758 | <div class="refsect2"> |
| 4759 | <a name="GstStreamStatusType"></a><h3>enum GstStreamStatusType</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4760 | <p>The type of a <a class="link" href="GstMessage.html#GST-MESSAGE-STREAM-STATUS:CAPS"><code class="literal">GST_MESSAGE_STREAM_STATUS</code></a>. The stream status messages inform the |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4761 | application of new streaming threads and their status.</p> |
| 4762 | <div class="refsect3"> |
| 4763 | <a name="id-1.3.29.9.5.4"></a><h4>Members</h4> |
| 4764 | <div class="informaltable"><table width="100%" border="0"> |
| 4765 | <colgroup> |
| 4766 | <col width="300px" class="enum_members_name"> |
| 4767 | <col class="enum_members_description"> |
| 4768 | <col width="200px" class="enum_members_annotations"> |
| 4769 | </colgroup> |
| 4770 | <tbody> |
| 4771 | <tr> |
| 4772 | <td class="enum_member_name"><p><a name="GST-STREAM-STATUS-TYPE-CREATE:CAPS"></a>GST_STREAM_STATUS_TYPE_CREATE</p></td> |
| 4773 | <td class="enum_member_description"> |
| 4774 | <p>A new thread need to be created.</p> |
| 4775 | </td> |
| 4776 | <td class="enum_member_annotations"> </td> |
| 4777 | </tr> |
| 4778 | <tr> |
| 4779 | <td class="enum_member_name"><p><a name="GST-STREAM-STATUS-TYPE-ENTER:CAPS"></a>GST_STREAM_STATUS_TYPE_ENTER</p></td> |
| 4780 | <td class="enum_member_description"> |
| 4781 | <p>a thread entered its loop function</p> |
| 4782 | </td> |
| 4783 | <td class="enum_member_annotations"> </td> |
| 4784 | </tr> |
| 4785 | <tr> |
| 4786 | <td class="enum_member_name"><p><a name="GST-STREAM-STATUS-TYPE-LEAVE:CAPS"></a>GST_STREAM_STATUS_TYPE_LEAVE</p></td> |
| 4787 | <td class="enum_member_description"> |
| 4788 | <p>a thread left its loop function</p> |
| 4789 | </td> |
| 4790 | <td class="enum_member_annotations"> </td> |
| 4791 | </tr> |
| 4792 | <tr> |
| 4793 | <td class="enum_member_name"><p><a name="GST-STREAM-STATUS-TYPE-DESTROY:CAPS"></a>GST_STREAM_STATUS_TYPE_DESTROY</p></td> |
| 4794 | <td class="enum_member_description"> |
| 4795 | <p>a thread is destroyed</p> |
| 4796 | </td> |
| 4797 | <td class="enum_member_annotations"> </td> |
| 4798 | </tr> |
| 4799 | <tr> |
| 4800 | <td class="enum_member_name"><p><a name="GST-STREAM-STATUS-TYPE-START:CAPS"></a>GST_STREAM_STATUS_TYPE_START</p></td> |
| 4801 | <td class="enum_member_description"> |
| 4802 | <p>a thread is started</p> |
| 4803 | </td> |
| 4804 | <td class="enum_member_annotations"> </td> |
| 4805 | </tr> |
| 4806 | <tr> |
| 4807 | <td class="enum_member_name"><p><a name="GST-STREAM-STATUS-TYPE-PAUSE:CAPS"></a>GST_STREAM_STATUS_TYPE_PAUSE</p></td> |
| 4808 | <td class="enum_member_description"> |
| 4809 | <p>a thread is paused</p> |
| 4810 | </td> |
| 4811 | <td class="enum_member_annotations"> </td> |
| 4812 | </tr> |
| 4813 | <tr> |
| 4814 | <td class="enum_member_name"><p><a name="GST-STREAM-STATUS-TYPE-STOP:CAPS"></a>GST_STREAM_STATUS_TYPE_STOP</p></td> |
| 4815 | <td class="enum_member_description"> |
| 4816 | <p>a thread is stopped</p> |
| 4817 | </td> |
| 4818 | <td class="enum_member_annotations"> </td> |
| 4819 | </tr> |
| 4820 | </tbody> |
| 4821 | </table></div> |
| 4822 | </div> |
| 4823 | </div> |
| 4824 | <hr> |
| 4825 | <div class="refsect2"> |
| 4826 | <a name="GstProgressType"></a><h3>enum GstProgressType</h3> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4827 | <p>The type of a <a class="link" href="GstMessage.html#GST-MESSAGE-PROGRESS:CAPS"><code class="literal">GST_MESSAGE_PROGRESS</code></a>. The progress messages inform the |
| 4828 | application of the status of asynchronous tasks.</p> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4829 | <div class="refsect3"> |
| 4830 | <a name="id-1.3.29.9.6.4"></a><h4>Members</h4> |
| 4831 | <div class="informaltable"><table width="100%" border="0"> |
| 4832 | <colgroup> |
| 4833 | <col width="300px" class="enum_members_name"> |
| 4834 | <col class="enum_members_description"> |
| 4835 | <col width="200px" class="enum_members_annotations"> |
| 4836 | </colgroup> |
| 4837 | <tbody> |
| 4838 | <tr> |
| 4839 | <td class="enum_member_name"><p><a name="GST-PROGRESS-TYPE-START:CAPS"></a>GST_PROGRESS_TYPE_START</p></td> |
| 4840 | <td class="enum_member_description"> |
| 4841 | <p>A new task started.</p> |
| 4842 | </td> |
| 4843 | <td class="enum_member_annotations"> </td> |
| 4844 | </tr> |
| 4845 | <tr> |
| 4846 | <td class="enum_member_name"><p><a name="GST-PROGRESS-TYPE-CONTINUE:CAPS"></a>GST_PROGRESS_TYPE_CONTINUE</p></td> |
| 4847 | <td class="enum_member_description"> |
| 4848 | <p>A task completed and a new one continues.</p> |
| 4849 | </td> |
| 4850 | <td class="enum_member_annotations"> </td> |
| 4851 | </tr> |
| 4852 | <tr> |
| 4853 | <td class="enum_member_name"><p><a name="GST-PROGRESS-TYPE-COMPLETE:CAPS"></a>GST_PROGRESS_TYPE_COMPLETE</p></td> |
| 4854 | <td class="enum_member_description"> |
| 4855 | <p>A task completed.</p> |
| 4856 | </td> |
| 4857 | <td class="enum_member_annotations"> </td> |
| 4858 | </tr> |
| 4859 | <tr> |
| 4860 | <td class="enum_member_name"><p><a name="GST-PROGRESS-TYPE-CANCELED:CAPS"></a>GST_PROGRESS_TYPE_CANCELED</p></td> |
| 4861 | <td class="enum_member_description"> |
| 4862 | <p>A task was canceled.</p> |
| 4863 | </td> |
| 4864 | <td class="enum_member_annotations"> </td> |
| 4865 | </tr> |
| 4866 | <tr> |
| 4867 | <td class="enum_member_name"><p><a name="GST-PROGRESS-TYPE-ERROR:CAPS"></a>GST_PROGRESS_TYPE_ERROR</p></td> |
| 4868 | <td class="enum_member_description"> |
| 4869 | <p>A task caused an error. An error message is also |
| 4870 | posted on the bus.</p> |
| 4871 | </td> |
| 4872 | <td class="enum_member_annotations"> </td> |
| 4873 | </tr> |
| 4874 | </tbody> |
| 4875 | </table></div> |
| 4876 | </div> |
| 4877 | </div> |
| 4878 | </div> |
| 4879 | <div class="refsect1"> |
Sebastian Dröge | 71fa795 | 2014-05-03 17:39:29 +0200 | [diff] [blame] | 4880 | <a name="GstMessage.see-also"></a><h2>See Also</h2> |
Sebastian Dröge | 1adbba7 | 2014-04-18 15:23:46 +0200 | [diff] [blame] | 4881 | <p><a class="link" href="GstBus.html" title="GstBus"><span class="type">GstBus</span></a>, <a class="link" href="gstreamer-GstMiniObject.html#GstMiniObject" title="struct GstMiniObject"><span class="type">GstMiniObject</span></a>, <a class="link" href="GstElement.html" title="GstElement"><span class="type">GstElement</span></a></p> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4882 | </div> |
| 4883 | </div> |
| 4884 | <div class="footer"> |
Sebastian Dröge | 1ac0c8e | 2015-06-07 09:41:47 +0200 | [diff] [blame^] | 4885 | <hr>Generated by GTK-Doc V1.24</div> |
Nicolas Dechesne | beb4320 | 2011-09-30 00:54:14 +0200 | [diff] [blame] | 4886 | </body> |
| 4887 | </html> |