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"> 5<title>GstNavigation: GStreamer Base Plugins 1.0 Library Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual"> 8<link rel="up" href="gstreamer-video.html" title="Video Library"> 9<link rel="prev" href="gst-plugins-base-libs-GstVideo-Codec-utility-function.html" title="GstVideo Codec utility function"> 10<link rel="next" href="gst-plugins-base-libs-GstVideo-Ancillary.html" title="GstVideo Ancillary"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#GstNavigation.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#GstNavigation.object-hierarchy" class="shortcut">Object Hierarchy</a></span> 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="gstreamer-video.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 23<td><a accesskey="p" href="gst-plugins-base-libs-GstVideo-Codec-utility-function.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 24<td><a accesskey="n" href="gst-plugins-base-libs-GstVideo-Ancillary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 25</tr></table> 26<div class="refentry"> 27<a name="GstNavigation"></a><div class="titlepage"></div> 28<div class="refnamediv"><table width="100%"><tr> 29<td valign="top"> 30<h2><span class="refentrytitle"><a name="GstNavigation.top_of_page"></a>GstNavigation</span></h2> 31<p>GstNavigation — Interface for creating, sending and parsing navigation 32events.</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="GstNavigation.functions"></a><h2>Functions</h2> 38<div class="informaltable"><table class="informaltable" 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="function_type"> 46<span class="returnvalue">void</span> 47</td> 48<td class="function_name"> 49<a class="link" href="GstNavigation.html#gst-navigation-send-event" title="gst_navigation_send_event ()">gst_navigation_send_event</a> <span class="c_punctuation">()</span> 50</td> 51</tr> 52<tr> 53<td class="function_type"> 54<span class="returnvalue">void</span> 55</td> 56<td class="function_name"> 57<a class="link" href="GstNavigation.html#gst-navigation-send-key-event" title="gst_navigation_send_key_event ()">gst_navigation_send_key_event</a> <span class="c_punctuation">()</span> 58</td> 59</tr> 60<tr> 61<td class="function_type"> 62<span class="returnvalue">void</span> 63</td> 64<td class="function_name"> 65<a class="link" href="GstNavigation.html#gst-navigation-send-mouse-event" title="gst_navigation_send_mouse_event ()">gst_navigation_send_mouse_event</a> <span class="c_punctuation">()</span> 66</td> 67</tr> 68<tr> 69<td class="function_type"> 70<span class="returnvalue">void</span> 71</td> 72<td class="function_name"> 73<a class="link" href="GstNavigation.html#gst-navigation-send-command" title="gst_navigation_send_command ()">gst_navigation_send_command</a> <span class="c_punctuation">()</span> 74</td> 75</tr> 76<tr> 77<td class="function_type"> 78<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 79</td> 80<td class="function_name"> 81<a class="link" href="GstNavigation.html#gst-navigation-event-parse-command" title="gst_navigation_event_parse_command ()">gst_navigation_event_parse_command</a> <span class="c_punctuation">()</span> 82</td> 83</tr> 84<tr> 85<td class="function_type"> 86<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 87</td> 88<td class="function_name"> 89<a class="link" href="GstNavigation.html#gst-navigation-event-parse-key-event" title="gst_navigation_event_parse_key_event ()">gst_navigation_event_parse_key_event</a> <span class="c_punctuation">()</span> 90</td> 91</tr> 92<tr> 93<td class="function_type"> 94<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 95</td> 96<td class="function_name"> 97<a class="link" href="GstNavigation.html#gst-navigation-event-parse-mouse-button-event" title="gst_navigation_event_parse_mouse_button_event ()">gst_navigation_event_parse_mouse_button_event</a> <span class="c_punctuation">()</span> 98</td> 99</tr> 100<tr> 101<td class="function_type"> 102<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 103</td> 104<td class="function_name"> 105<a class="link" href="GstNavigation.html#gst-navigation-event-parse-mouse-move-event" title="gst_navigation_event_parse_mouse_move_event ()">gst_navigation_event_parse_mouse_move_event</a> <span class="c_punctuation">()</span> 106</td> 107</tr> 108<tr> 109<td class="function_type"> 110<a class="link" href="GstNavigation.html#GstNavigationMessageType" title="enum GstNavigationMessageType"><span class="returnvalue">GstNavigationMessageType</span></a> 111</td> 112<td class="function_name"> 113<a class="link" href="GstNavigation.html#gst-navigation-message-get-type" title="gst_navigation_message_get_type ()">gst_navigation_message_get_type</a> <span class="c_punctuation">()</span> 114</td> 115</tr> 116<tr> 117<td class="function_type"> 118<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="returnvalue">GstMessage</span></a> * 119</td> 120<td class="function_name"> 121<a class="link" href="GstNavigation.html#gst-navigation-message-new-angles-changed" title="gst_navigation_message_new_angles_changed ()">gst_navigation_message_new_angles_changed</a> <span class="c_punctuation">()</span> 122</td> 123</tr> 124<tr> 125<td class="function_type"> 126<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="returnvalue">GstMessage</span></a> * 127</td> 128<td class="function_name"> 129<a class="link" href="GstNavigation.html#gst-navigation-message-new-commands-changed" title="gst_navigation_message_new_commands_changed ()">gst_navigation_message_new_commands_changed</a> <span class="c_punctuation">()</span> 130</td> 131</tr> 132<tr> 133<td class="function_type"> 134<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="returnvalue">GstMessage</span></a> * 135</td> 136<td class="function_name"> 137<a class="link" href="GstNavigation.html#gst-navigation-message-new-event" title="gst_navigation_message_new_event ()">gst_navigation_message_new_event</a> <span class="c_punctuation">()</span> 138</td> 139</tr> 140<tr> 141<td class="function_type"> 142<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="returnvalue">GstMessage</span></a> * 143</td> 144<td class="function_name"> 145<a class="link" href="GstNavigation.html#gst-navigation-message-new-mouse-over" title="gst_navigation_message_new_mouse_over ()">gst_navigation_message_new_mouse_over</a> <span class="c_punctuation">()</span> 146</td> 147</tr> 148<tr> 149<td class="function_type"> 150<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 151</td> 152<td class="function_name"> 153<a class="link" href="GstNavigation.html#gst-navigation-message-parse-angles-changed" title="gst_navigation_message_parse_angles_changed ()">gst_navigation_message_parse_angles_changed</a> <span class="c_punctuation">()</span> 154</td> 155</tr> 156<tr> 157<td class="function_type"> 158<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 159</td> 160<td class="function_name"> 161<a class="link" href="GstNavigation.html#gst-navigation-message-parse-event" title="gst_navigation_message_parse_event ()">gst_navigation_message_parse_event</a> <span class="c_punctuation">()</span> 162</td> 163</tr> 164<tr> 165<td class="function_type"> 166<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 167</td> 168<td class="function_name"> 169<a class="link" href="GstNavigation.html#gst-navigation-message-parse-mouse-over" title="gst_navigation_message_parse_mouse_over ()">gst_navigation_message_parse_mouse_over</a> <span class="c_punctuation">()</span> 170</td> 171</tr> 172<tr> 173<td class="function_type"> 174<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="returnvalue">GstQuery</span></a> * 175</td> 176<td class="function_name"> 177<a class="link" href="GstNavigation.html#gst-navigation-query-new-angles" title="gst_navigation_query_new_angles ()">gst_navigation_query_new_angles</a> <span class="c_punctuation">()</span> 178</td> 179</tr> 180<tr> 181<td class="function_type"> 182<a class="link" href="GstNavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType"><span class="returnvalue">GstNavigationQueryType</span></a> 183</td> 184<td class="function_name"> 185<a class="link" href="GstNavigation.html#gst-navigation-query-get-type" title="gst_navigation_query_get_type ()">gst_navigation_query_get_type</a> <span class="c_punctuation">()</span> 186</td> 187</tr> 188<tr> 189<td class="function_type"> 190<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="returnvalue">GstQuery</span></a> * 191</td> 192<td class="function_name"> 193<a class="link" href="GstNavigation.html#gst-navigation-query-new-commands" title="gst_navigation_query_new_commands ()">gst_navigation_query_new_commands</a> <span class="c_punctuation">()</span> 194</td> 195</tr> 196<tr> 197<td class="function_type"> 198<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 199</td> 200<td class="function_name"> 201<a class="link" href="GstNavigation.html#gst-navigation-query-parse-angles" title="gst_navigation_query_parse_angles ()">gst_navigation_query_parse_angles</a> <span class="c_punctuation">()</span> 202</td> 203</tr> 204<tr> 205<td class="function_type"> 206<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 207</td> 208<td class="function_name"> 209<a class="link" href="GstNavigation.html#gst-navigation-query-parse-commands-length" title="gst_navigation_query_parse_commands_length ()">gst_navigation_query_parse_commands_length</a> <span class="c_punctuation">()</span> 210</td> 211</tr> 212<tr> 213<td class="function_type"> 214<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 215</td> 216<td class="function_name"> 217<a class="link" href="GstNavigation.html#gst-navigation-query-parse-commands-nth" title="gst_navigation_query_parse_commands_nth ()">gst_navigation_query_parse_commands_nth</a> <span class="c_punctuation">()</span> 218</td> 219</tr> 220<tr> 221<td class="function_type"> 222<span class="returnvalue">void</span> 223</td> 224<td class="function_name"> 225<a class="link" href="GstNavigation.html#gst-navigation-query-set-angles" title="gst_navigation_query_set_angles ()">gst_navigation_query_set_angles</a> <span class="c_punctuation">()</span> 226</td> 227</tr> 228<tr> 229<td class="function_type"> 230<span class="returnvalue">void</span> 231</td> 232<td class="function_name"> 233<a class="link" href="GstNavigation.html#gst-navigation-query-set-commands" title="gst_navigation_query_set_commands ()">gst_navigation_query_set_commands</a> <span class="c_punctuation">()</span> 234</td> 235</tr> 236<tr> 237<td class="function_type"> 238<span class="returnvalue">void</span> 239</td> 240<td class="function_name"> 241<a class="link" href="GstNavigation.html#gst-navigation-query-set-commandsv" title="gst_navigation_query_set_commandsv ()">gst_navigation_query_set_commandsv</a> <span class="c_punctuation">()</span> 242</td> 243</tr> 244</tbody> 245</table></div> 246</div> 247<div class="refsect1"> 248<a name="GstNavigation.other"></a><h2>Types and Values</h2> 249<div class="informaltable"><table class="informaltable" width="100%" border="0"> 250<colgroup> 251<col width="150px" class="name"> 252<col class="description"> 253</colgroup> 254<tbody> 255<tr> 256<td class="datatype_keyword"> </td> 257<td class="function_name"><a class="link" href="GstNavigation.html#GstNavigation-struct" title="GstNavigation">GstNavigation</a></td> 258</tr> 259<tr> 260<td class="datatype_keyword">struct</td> 261<td class="function_name"><a class="link" href="GstNavigation.html#GstNavigationInterface" title="struct GstNavigationInterface">GstNavigationInterface</a></td> 262</tr> 263<tr> 264<td class="datatype_keyword">enum</td> 265<td class="function_name"><a class="link" href="GstNavigation.html#GstNavigationCommand" title="enum GstNavigationCommand">GstNavigationCommand</a></td> 266</tr> 267<tr> 268<td class="datatype_keyword">enum</td> 269<td class="function_name"><a class="link" href="GstNavigation.html#GstNavigationEventType" title="enum GstNavigationEventType">GstNavigationEventType</a></td> 270</tr> 271<tr> 272<td class="datatype_keyword">enum</td> 273<td class="function_name"><a class="link" href="GstNavigation.html#GstNavigationMessageType" title="enum GstNavigationMessageType">GstNavigationMessageType</a></td> 274</tr> 275<tr> 276<td class="datatype_keyword">enum</td> 277<td class="function_name"><a class="link" href="GstNavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType">GstNavigationQueryType</a></td> 278</tr> 279<tr> 280<td class="define_keyword">#define</td> 281<td class="function_name"><a class="link" href="GstNavigation.html#GST-NAVIGATION-COMMAND-DVD-ANGLE-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU">GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU</a></td> 282</tr> 283<tr> 284<td class="define_keyword">#define</td> 285<td class="function_name"><a class="link" href="GstNavigation.html#GST-NAVIGATION-COMMAND-DVD-AUDIO-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU">GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU</a></td> 286</tr> 287<tr> 288<td class="define_keyword">#define</td> 289<td class="function_name"><a class="link" href="GstNavigation.html#GST-NAVIGATION-COMMAND-DVD-CHAPTER-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU">GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU</a></td> 290</tr> 291<tr> 292<td class="define_keyword">#define</td> 293<td class="function_name"><a class="link" href="GstNavigation.html#GST-NAVIGATION-COMMAND-DVD-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_MENU">GST_NAVIGATION_COMMAND_DVD_MENU</a></td> 294</tr> 295<tr> 296<td class="define_keyword">#define</td> 297<td class="function_name"><a class="link" href="GstNavigation.html#GST-NAVIGATION-COMMAND-DVD-ROOT-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_ROOT_MENU">GST_NAVIGATION_COMMAND_DVD_ROOT_MENU</a></td> 298</tr> 299<tr> 300<td class="define_keyword">#define</td> 301<td class="function_name"><a class="link" href="GstNavigation.html#GST-NAVIGATION-COMMAND-DVD-SUBPICTURE-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU">GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU</a></td> 302</tr> 303<tr> 304<td class="define_keyword">#define</td> 305<td class="function_name"><a class="link" href="GstNavigation.html#GST-NAVIGATION-COMMAND-DVD-TITLE-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_TITLE_MENU">GST_NAVIGATION_COMMAND_DVD_TITLE_MENU</a></td> 306</tr> 307</tbody> 308</table></div> 309</div> 310<div class="refsect1"> 311<a name="GstNavigation.object-hierarchy"></a><h2>Object Hierarchy</h2> 312<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> 313 <span class="lineart">╰──</span> GstNavigation 314</pre> 315</div> 316<div class="refsect1"> 317<a name="GstNavigation.includes"></a><h2>Includes</h2> 318<pre class="synopsis">#include <gst/video/video.h> 319</pre> 320</div> 321<div class="refsect1"> 322<a name="GstNavigation.description"></a><h2>Description</h2> 323<p>The Navigation interface is used for creating and injecting navigation related 324events such as mouse button presses, cursor motion and key presses. The associated 325library also provides methods for parsing received events, and for sending and 326receiving navigation related bus events. One main usecase is DVD menu navigation.</p> 327<p>The main parts of the API are:</p> 328<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 329<li class="listitem"><p>The GstNavigation interface, implemented by elements which provide an application 330with the ability to create and inject navigation events into the pipeline.</p></li> 331<li class="listitem"><p>GstNavigation event handling API. GstNavigation events are created in response to 332calls on a GstNavigation interface implementation, and sent in the pipeline. Upstream 333elements can use the navigation event API functions to parse the contents of received 334messages.</p></li> 335<li class="listitem"><p>GstNavigation message handling API. GstNavigation messages may be sent on the message 336bus to inform applications of navigation related changes in the pipeline, such as the 337mouse moving over a clickable region, or the set of available angles changing.</p></li> 338</ul></div> 339<p>The GstNavigation message functions provide functions for creating and parsing 340custom bus messages for signaling GstNavigation changes.</p> 341</div> 342<div class="refsect1"> 343<a name="GstNavigation.functions_details"></a><h2>Functions</h2> 344<div class="refsect2"> 345<a name="gst-navigation-send-event"></a><h3>gst_navigation_send_event ()</h3> 346<pre class="programlisting"><span class="returnvalue">void</span> 347gst_navigation_send_event (<em class="parameter"><code><a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>, 348 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *structure</code></em>);</pre> 349</div> 350<hr> 351<div class="refsect2"> 352<a name="gst-navigation-send-key-event"></a><h3>gst_navigation_send_key_event ()</h3> 353<pre class="programlisting"><span class="returnvalue">void</span> 354gst_navigation_send_key_event (<em class="parameter"><code><a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>, 355 <em class="parameter"><code>const <span class="type">char</span> *event</code></em>, 356 <em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre> 357<div class="refsect3"> 358<a name="gst-navigation-send-key-event.parameters"></a><h4>Parameters</h4> 359<div class="informaltable"><table class="informaltable" width="100%" border="0"> 360<colgroup> 361<col width="150px" class="parameters_name"> 362<col class="parameters_description"> 363<col width="200px" class="parameters_annotations"> 364</colgroup> 365<tbody> 366<tr> 367<td class="parameter_name"><p>navigation</p></td> 368<td class="parameter_description"><p>The navigation interface instance</p></td> 369<td class="parameter_annotations"> </td> 370</tr> 371<tr> 372<td class="parameter_name"><p>event</p></td> 373<td class="parameter_description"><p>The type of the key event. Recognised values are "key-press" and 374"key-release"</p></td> 375<td class="parameter_annotations"> </td> 376</tr> 377<tr> 378<td class="parameter_name"><p>key</p></td> 379<td class="parameter_description"><p>Character representation of the key. This is typically as produced 380by XKeysymToString.</p></td> 381<td class="parameter_annotations"> </td> 382</tr> 383</tbody> 384</table></div> 385</div> 386</div> 387<hr> 388<div class="refsect2"> 389<a name="gst-navigation-send-mouse-event"></a><h3>gst_navigation_send_mouse_event ()</h3> 390<pre class="programlisting"><span class="returnvalue">void</span> 391gst_navigation_send_mouse_event (<em class="parameter"><code><a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>, 392 <em class="parameter"><code>const <span class="type">char</span> *event</code></em>, 393 <em class="parameter"><code><span class="type">int</span> button</code></em>, 394 <em class="parameter"><code><span class="type">double</span> x</code></em>, 395 <em class="parameter"><code><span class="type">double</span> y</code></em>);</pre> 396<p>Sends a mouse event to the navigation interface. Mouse event coordinates 397are sent relative to the display space of the related output area. This is 398usually the size in pixels of the window associated with the element 399implementing the <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> interface.</p> 400<div class="refsect3"> 401<a name="gst-navigation-send-mouse-event.parameters"></a><h4>Parameters</h4> 402<div class="informaltable"><table class="informaltable" width="100%" border="0"> 403<colgroup> 404<col width="150px" class="parameters_name"> 405<col class="parameters_description"> 406<col width="200px" class="parameters_annotations"> 407</colgroup> 408<tbody> 409<tr> 410<td class="parameter_name"><p>navigation</p></td> 411<td class="parameter_description"><p>The navigation interface instance</p></td> 412<td class="parameter_annotations"> </td> 413</tr> 414<tr> 415<td class="parameter_name"><p>event</p></td> 416<td class="parameter_description"><p>The type of mouse event, as a text string. Recognised values are 417"mouse-button-press", "mouse-button-release" and "mouse-move".</p></td> 418<td class="parameter_annotations"> </td> 419</tr> 420<tr> 421<td class="parameter_name"><p>button</p></td> 422<td class="parameter_description"><p>The button number of the button being pressed or released. Pass 0 423for mouse-move events.</p></td> 424<td class="parameter_annotations"> </td> 425</tr> 426<tr> 427<td class="parameter_name"><p>x</p></td> 428<td class="parameter_description"><p>The x coordinate of the mouse event.</p></td> 429<td class="parameter_annotations"> </td> 430</tr> 431<tr> 432<td class="parameter_name"><p>y</p></td> 433<td class="parameter_description"><p>The y coordinate of the mouse event.</p></td> 434<td class="parameter_annotations"> </td> 435</tr> 436</tbody> 437</table></div> 438</div> 439</div> 440<hr> 441<div class="refsect2"> 442<a name="gst-navigation-send-command"></a><h3>gst_navigation_send_command ()</h3> 443<pre class="programlisting"><span class="returnvalue">void</span> 444gst_navigation_send_command (<em class="parameter"><code><a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>, 445 <em class="parameter"><code><a class="link" href="GstNavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> command</code></em>);</pre> 446<p>Sends the indicated command to the navigation interface.</p> 447<div class="refsect3"> 448<a name="gst-navigation-send-command.parameters"></a><h4>Parameters</h4> 449<div class="informaltable"><table class="informaltable" width="100%" border="0"> 450<colgroup> 451<col width="150px" class="parameters_name"> 452<col class="parameters_description"> 453<col width="200px" class="parameters_annotations"> 454</colgroup> 455<tbody> 456<tr> 457<td class="parameter_name"><p>navigation</p></td> 458<td class="parameter_description"><p>The navigation interface instance</p></td> 459<td class="parameter_annotations"> </td> 460</tr> 461<tr> 462<td class="parameter_name"><p>command</p></td> 463<td class="parameter_description"><p>The command to issue</p></td> 464<td class="parameter_annotations"> </td> 465</tr> 466</tbody> 467</table></div> 468</div> 469</div> 470<hr> 471<div class="refsect2"> 472<a name="gst-navigation-event-parse-command"></a><h3>gst_navigation_event_parse_command ()</h3> 473<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 474gst_navigation_event_parse_command (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> *event</code></em>, 475 <em class="parameter"><code><a class="link" href="GstNavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *command</code></em>);</pre> 476<p>Inspect a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> command event and retrieve the enum value of the 477associated command.</p> 478<div class="refsect3"> 479<a name="gst-navigation-event-parse-command.parameters"></a><h4>Parameters</h4> 480<div class="informaltable"><table class="informaltable" width="100%" border="0"> 481<colgroup> 482<col width="150px" class="parameters_name"> 483<col class="parameters_description"> 484<col width="200px" class="parameters_annotations"> 485</colgroup> 486<tbody> 487<tr> 488<td class="parameter_name"><p>event</p></td> 489<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> to inspect.</p></td> 490<td class="parameter_annotations"> </td> 491</tr> 492<tr> 493<td class="parameter_name"><p>command</p></td> 494<td class="parameter_description"><p>Pointer to GstNavigationCommand to receive the 495type of the navigation event. </p></td> 496<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 497</tr> 498</tbody> 499</table></div> 500</div> 501<div class="refsect3"> 502<a name="gst-navigation-event-parse-command.returns"></a><h4>Returns</h4> 503<p> TRUE if the navigation command could be extracted, otherwise FALSE.</p> 504</div> 505</div> 506<hr> 507<div class="refsect2"> 508<a name="gst-navigation-event-parse-key-event"></a><h3>gst_navigation_event_parse_key_event ()</h3> 509<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 510gst_navigation_event_parse_key_event (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> *event</code></em>, 511 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **key</code></em>);</pre> 512<div class="refsect3"> 513<a name="gst-navigation-event-parse-key-event.parameters"></a><h4>Parameters</h4> 514<div class="informaltable"><table class="informaltable" width="100%" border="0"> 515<colgroup> 516<col width="150px" class="parameters_name"> 517<col class="parameters_description"> 518<col width="200px" class="parameters_annotations"> 519</colgroup> 520<tbody> 521<tr> 522<td class="parameter_name"><p>event</p></td> 523<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> to inspect.</p></td> 524<td class="parameter_annotations"> </td> 525</tr> 526<tr> 527<td class="parameter_name"><p>key</p></td> 528<td class="parameter_description"><p>A pointer to a location to receive 529the string identifying the key press. The returned string is owned by the 530event, and valid only until the event is unreffed. </p></td> 531<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> 532</tr> 533</tbody> 534</table></div> 535</div> 536</div> 537<hr> 538<div class="refsect2"> 539<a name="gst-navigation-event-parse-mouse-button-event"></a><h3>gst_navigation_event_parse_mouse_button_event ()</h3> 540<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 541gst_navigation_event_parse_mouse_button_event 542 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> *event</code></em>, 543 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *button</code></em>, 544 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>, 545 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>);</pre> 546<p>Retrieve the details of either a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> mouse button press event or 547a mouse button release event. Determine which type the event is using 548<code class="function">gst_navigation_event_get_type()</code> to retrieve the <a class="link" href="GstNavigation.html#GstNavigationEventType" title="enum GstNavigationEventType"><span class="type">GstNavigationEventType</span></a>.</p> 549<div class="refsect3"> 550<a name="gst-navigation-event-parse-mouse-button-event.parameters"></a><h4>Parameters</h4> 551<div class="informaltable"><table class="informaltable" width="100%" border="0"> 552<colgroup> 553<col width="150px" class="parameters_name"> 554<col class="parameters_description"> 555<col width="200px" class="parameters_annotations"> 556</colgroup> 557<tbody> 558<tr> 559<td class="parameter_name"><p>event</p></td> 560<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> to inspect.</p></td> 561<td class="parameter_annotations"> </td> 562</tr> 563<tr> 564<td class="parameter_name"><p>button</p></td> 565<td class="parameter_description"><p>Pointer to a gint that will receive the button 566number associated with the event. </p></td> 567<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 568</tr> 569<tr> 570<td class="parameter_name"><p>x</p></td> 571<td class="parameter_description"><p>Pointer to a gdouble to receive the x coordinate of the 572mouse button event. </p></td> 573<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 574</tr> 575<tr> 576<td class="parameter_name"><p>y</p></td> 577<td class="parameter_description"><p>Pointer to a gdouble to receive the y coordinate of the 578mouse button event. </p></td> 579<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 580</tr> 581</tbody> 582</table></div> 583</div> 584<div class="refsect3"> 585<a name="gst-navigation-event-parse-mouse-button-event.returns"></a><h4>Returns</h4> 586<p> TRUE if the button number and both coordinates could be extracted, 587otherwise FALSE.</p> 588</div> 589</div> 590<hr> 591<div class="refsect2"> 592<a name="gst-navigation-event-parse-mouse-move-event"></a><h3>gst_navigation_event_parse_mouse_move_event ()</h3> 593<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 594gst_navigation_event_parse_mouse_move_event 595 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> *event</code></em>, 596 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>, 597 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>);</pre> 598<p>Inspect a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> mouse movement event and extract the coordinates 599of the event.</p> 600<div class="refsect3"> 601<a name="gst-navigation-event-parse-mouse-move-event.parameters"></a><h4>Parameters</h4> 602<div class="informaltable"><table class="informaltable" width="100%" border="0"> 603<colgroup> 604<col width="150px" class="parameters_name"> 605<col class="parameters_description"> 606<col width="200px" class="parameters_annotations"> 607</colgroup> 608<tbody> 609<tr> 610<td class="parameter_name"><p>event</p></td> 611<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> to inspect.</p></td> 612<td class="parameter_annotations"> </td> 613</tr> 614<tr> 615<td class="parameter_name"><p>x</p></td> 616<td class="parameter_description"><p>Pointer to a gdouble to receive the x coordinate of the 617mouse movement. </p></td> 618<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 619</tr> 620<tr> 621<td class="parameter_name"><p>y</p></td> 622<td class="parameter_description"><p>Pointer to a gdouble to receive the y coordinate of the 623mouse movement. </p></td> 624<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 625</tr> 626</tbody> 627</table></div> 628</div> 629<div class="refsect3"> 630<a name="gst-navigation-event-parse-mouse-move-event.returns"></a><h4>Returns</h4> 631<p> TRUE if both coordinates could be extracted, otherwise FALSE.</p> 632</div> 633</div> 634<hr> 635<div class="refsect2"> 636<a name="gst-navigation-message-get-type"></a><h3>gst_navigation_message_get_type ()</h3> 637<pre class="programlisting"><a class="link" href="GstNavigation.html#GstNavigationMessageType" title="enum GstNavigationMessageType"><span class="returnvalue">GstNavigationMessageType</span></a> 638gst_navigation_message_get_type (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> *message</code></em>);</pre> 639<p>Check a bus message to see if it is a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> event, and return 640the <a class="link" href="GstNavigation.html#GstNavigationMessageType" title="enum GstNavigationMessageType"><span class="type">GstNavigationMessageType</span></a> identifying the type of the message if so.</p> 641<div class="refsect3"> 642<a name="gst-navigation-message-get-type.parameters"></a><h4>Parameters</h4> 643<div class="informaltable"><table class="informaltable" width="100%" border="0"> 644<colgroup> 645<col width="150px" class="parameters_name"> 646<col class="parameters_description"> 647<col width="200px" class="parameters_annotations"> 648</colgroup> 649<tbody><tr> 650<td class="parameter_name"><p>message</p></td> 651<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> to inspect.</p></td> 652<td class="parameter_annotations"> </td> 653</tr></tbody> 654</table></div> 655</div> 656<div class="refsect3"> 657<a name="gst-navigation-message-get-type.returns"></a><h4>Returns</h4> 658<p> The type of the <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a>, or 659<a class="link" href="GstNavigation.html#GST-NAVIGATION-MESSAGE-INVALID:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_INVALID</span></a> if the message is not a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> 660notification.</p> 661</div> 662</div> 663<hr> 664<div class="refsect2"> 665<a name="gst-navigation-message-new-angles-changed"></a><h3>gst_navigation_message_new_angles_changed ()</h3> 666<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="returnvalue">GstMessage</span></a> * 667gst_navigation_message_new_angles_changed 668 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct"><span class="type">GstObject</span></a> *src</code></em>, 669 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> cur_angle</code></em>, 670 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_angles</code></em>);</pre> 671<p>Creates a new <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> message with type 672<a class="link" href="GstNavigation.html#GST-NAVIGATION-MESSAGE-ANGLES-CHANGED:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_ANGLES_CHANGED</span></a> for notifying an application 673that the current angle, or current number of angles available in a 674multiangle video has changed.</p> 675<div class="refsect3"> 676<a name="gst-navigation-message-new-angles-changed.parameters"></a><h4>Parameters</h4> 677<div class="informaltable"><table class="informaltable" width="100%" border="0"> 678<colgroup> 679<col width="150px" class="parameters_name"> 680<col class="parameters_description"> 681<col width="200px" class="parameters_annotations"> 682</colgroup> 683<tbody> 684<tr> 685<td class="parameter_name"><p>src</p></td> 686<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct"><span class="type">GstObject</span></a> to set as source of the new message.</p></td> 687<td class="parameter_annotations"> </td> 688</tr> 689<tr> 690<td class="parameter_name"><p>cur_angle</p></td> 691<td class="parameter_description"><p>The currently selected angle.</p></td> 692<td class="parameter_annotations"> </td> 693</tr> 694<tr> 695<td class="parameter_name"><p>n_angles</p></td> 696<td class="parameter_description"><p>The number of viewing angles now available.</p></td> 697<td class="parameter_annotations"> </td> 698</tr> 699</tbody> 700</table></div> 701</div> 702<div class="refsect3"> 703<a name="gst-navigation-message-new-angles-changed.returns"></a><h4>Returns</h4> 704<p> The new <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a>.</p> 705</div> 706</div> 707<hr> 708<div class="refsect2"> 709<a name="gst-navigation-message-new-commands-changed"></a><h3>gst_navigation_message_new_commands_changed ()</h3> 710<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="returnvalue">GstMessage</span></a> * 711gst_navigation_message_new_commands_changed 712 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct"><span class="type">GstObject</span></a> *src</code></em>);</pre> 713<p>Creates a new <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> message with type 714<a class="link" href="GstNavigation.html#GST-NAVIGATION-MESSAGE-COMMANDS-CHANGED:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</span></a></p> 715<div class="refsect3"> 716<a name="gst-navigation-message-new-commands-changed.parameters"></a><h4>Parameters</h4> 717<div class="informaltable"><table class="informaltable" width="100%" border="0"> 718<colgroup> 719<col width="150px" class="parameters_name"> 720<col class="parameters_description"> 721<col width="200px" class="parameters_annotations"> 722</colgroup> 723<tbody><tr> 724<td class="parameter_name"><p>src</p></td> 725<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct"><span class="type">GstObject</span></a> to set as source of the new message.</p></td> 726<td class="parameter_annotations"> </td> 727</tr></tbody> 728</table></div> 729</div> 730<div class="refsect3"> 731<a name="gst-navigation-message-new-commands-changed.returns"></a><h4>Returns</h4> 732<p> The new <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a>.</p> 733</div> 734</div> 735<hr> 736<div class="refsect2"> 737<a name="gst-navigation-message-new-event"></a><h3>gst_navigation_message_new_event ()</h3> 738<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="returnvalue">GstMessage</span></a> * 739gst_navigation_message_new_event (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct"><span class="type">GstObject</span></a> *src</code></em>, 740 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> *event</code></em>);</pre> 741<p>Creates a new <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> message with type 742<a class="link" href="GstNavigation.html#GST-NAVIGATION-MESSAGE-EVENT:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_EVENT</span></a>.</p> 743<div class="refsect3"> 744<a name="gst-navigation-message-new-event.parameters"></a><h4>Parameters</h4> 745<div class="informaltable"><table class="informaltable" width="100%" border="0"> 746<colgroup> 747<col width="150px" class="parameters_name"> 748<col class="parameters_description"> 749<col width="200px" class="parameters_annotations"> 750</colgroup> 751<tbody> 752<tr> 753<td class="parameter_name"><p>src</p></td> 754<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct"><span class="type">GstObject</span></a> to set as source of the new message.</p></td> 755<td class="parameter_annotations"> </td> 756</tr> 757<tr> 758<td class="parameter_name"><p>event</p></td> 759<td class="parameter_description"><p>A navigation <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a>. </p></td> 760<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> 761</tr> 762</tbody> 763</table></div> 764</div> 765<div class="refsect3"> 766<a name="gst-navigation-message-new-event.returns"></a><h4>Returns</h4> 767<p> The new <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a>.</p> 768</div> 769<p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p> 770</div> 771<hr> 772<div class="refsect2"> 773<a name="gst-navigation-message-new-mouse-over"></a><h3>gst_navigation_message_new_mouse_over ()</h3> 774<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="returnvalue">GstMessage</span></a> * 775gst_navigation_message_new_mouse_over (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct"><span class="type">GstObject</span></a> *src</code></em>, 776 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> active</code></em>);</pre> 777<p>Creates a new <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> message with type 778<a class="link" href="GstNavigation.html#GST-NAVIGATION-MESSAGE-MOUSE-OVER:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_MOUSE_OVER</span></a>.</p> 779<div class="refsect3"> 780<a name="gst-navigation-message-new-mouse-over.parameters"></a><h4>Parameters</h4> 781<div class="informaltable"><table class="informaltable" width="100%" border="0"> 782<colgroup> 783<col width="150px" class="parameters_name"> 784<col class="parameters_description"> 785<col width="200px" class="parameters_annotations"> 786</colgroup> 787<tbody> 788<tr> 789<td class="parameter_name"><p>src</p></td> 790<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct"><span class="type">GstObject</span></a> to set as source of the new message.</p></td> 791<td class="parameter_annotations"> </td> 792</tr> 793<tr> 794<td class="parameter_name"><p>active</p></td> 795<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the mouse has entered a clickable area of the display. 796<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it over a non-clickable area.</p></td> 797<td class="parameter_annotations"> </td> 798</tr> 799</tbody> 800</table></div> 801</div> 802<div class="refsect3"> 803<a name="gst-navigation-message-new-mouse-over.returns"></a><h4>Returns</h4> 804<p> The new <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a>.</p> 805</div> 806</div> 807<hr> 808<div class="refsect2"> 809<a name="gst-navigation-message-parse-angles-changed"></a><h3>gst_navigation_message_parse_angles_changed ()</h3> 810<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 811gst_navigation_message_parse_angles_changed 812 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> *message</code></em>, 813 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *cur_angle</code></em>, 814 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_angles</code></em>);</pre> 815<p>Parse a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED 816and extract the <em class="parameter"><code>cur_angle</code></em> 817 and <em class="parameter"><code>n_angles</code></em> 818 parameters.</p> 819<div class="refsect3"> 820<a name="gst-navigation-message-parse-angles-changed.parameters"></a><h4>Parameters</h4> 821<div class="informaltable"><table class="informaltable" width="100%" border="0"> 822<colgroup> 823<col width="150px" class="parameters_name"> 824<col class="parameters_description"> 825<col width="200px" class="parameters_annotations"> 826</colgroup> 827<tbody> 828<tr> 829<td class="parameter_name"><p>message</p></td> 830<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> to inspect.</p></td> 831<td class="parameter_annotations"> </td> 832</tr> 833<tr> 834<td class="parameter_name"><p>cur_angle</p></td> 835<td class="parameter_description"><p>A pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> to receive the new 836current angle number, or NULL. </p></td> 837<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 838</tr> 839<tr> 840<td class="parameter_name"><p>n_angles</p></td> 841<td class="parameter_description"><p>A pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> to receive the new angle 842count, or NULL. </p></td> 843<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 844</tr> 845</tbody> 846</table></div> 847</div> 848<div class="refsect3"> 849<a name="gst-navigation-message-parse-angles-changed.returns"></a><h4>Returns</h4> 850<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the message could be successfully parsed. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</p> 851</div> 852</div> 853<hr> 854<div class="refsect2"> 855<a name="gst-navigation-message-parse-event"></a><h3>gst_navigation_message_parse_event ()</h3> 856<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 857gst_navigation_message_parse_event (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> *message</code></em>, 858 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> **event</code></em>);</pre> 859<p>Parse a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> message of type <a class="link" href="GstNavigation.html#GST-NAVIGATION-MESSAGE-EVENT:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_EVENT</span></a> 860and extract contained <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a>. The caller must unref the <em class="parameter"><code>event</code></em> 861 when done 862with it.</p> 863<div class="refsect3"> 864<a name="gst-navigation-message-parse-event.parameters"></a><h4>Parameters</h4> 865<div class="informaltable"><table class="informaltable" width="100%" border="0"> 866<colgroup> 867<col width="150px" class="parameters_name"> 868<col class="parameters_description"> 869<col width="200px" class="parameters_annotations"> 870</colgroup> 871<tbody> 872<tr> 873<td class="parameter_name"><p>message</p></td> 874<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> to inspect.</p></td> 875<td class="parameter_annotations"> </td> 876</tr> 877<tr> 878<td class="parameter_name"><p>event</p></td> 879<td class="parameter_description"><p>a pointer to a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstEvent.html#GstEvent-struct"><span class="type">GstEvent</span></a> to receive 880the contained navigation event. </p></td> 881<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> 882</tr> 883</tbody> 884</table></div> 885</div> 886<div class="refsect3"> 887<a name="gst-navigation-message-parse-event.returns"></a><h4>Returns</h4> 888<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the message could be successfully parsed. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</p> 889</div> 890<p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p> 891</div> 892<hr> 893<div class="refsect2"> 894<a name="gst-navigation-message-parse-mouse-over"></a><h3>gst_navigation_message_parse_mouse_over ()</h3> 895<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 896gst_navigation_message_parse_mouse_over 897 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> *message</code></em>, 898 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *active</code></em>);</pre> 899<p>Parse a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> message of type <a class="link" href="GstNavigation.html#GST-NAVIGATION-MESSAGE-MOUSE-OVER:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_MOUSE_OVER</span></a> 900and extract the active/inactive flag. If the mouse over event is marked 901active, it indicates that the mouse is over a clickable area.</p> 902<div class="refsect3"> 903<a name="gst-navigation-message-parse-mouse-over.parameters"></a><h4>Parameters</h4> 904<div class="informaltable"><table class="informaltable" width="100%" border="0"> 905<colgroup> 906<col width="150px" class="parameters_name"> 907<col class="parameters_description"> 908<col width="200px" class="parameters_annotations"> 909</colgroup> 910<tbody> 911<tr> 912<td class="parameter_name"><p>message</p></td> 913<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMessage.html#GstMessage-struct"><span class="type">GstMessage</span></a> to inspect.</p></td> 914<td class="parameter_annotations"> </td> 915</tr> 916<tr> 917<td class="parameter_name"><p>active</p></td> 918<td class="parameter_description"><p>A pointer to a gboolean to receive the 919active/inactive state, or NULL. </p></td> 920<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 921</tr> 922</tbody> 923</table></div> 924</div> 925<div class="refsect3"> 926<a name="gst-navigation-message-parse-mouse-over.returns"></a><h4>Returns</h4> 927<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the message could be successfully parsed. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</p> 928</div> 929</div> 930<hr> 931<div class="refsect2"> 932<a name="gst-navigation-query-new-angles"></a><h3>gst_navigation_query_new_angles ()</h3> 933<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="returnvalue">GstQuery</span></a> * 934gst_navigation_query_new_angles (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> 935<p>Create a new <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> angles query. When executed, it will 936query the pipeline for the set of currently available angles, which may be 937greater than one in a multiangle video.</p> 938<div class="refsect3"> 939<a name="gst-navigation-query-new-angles.returns"></a><h4>Returns</h4> 940<p> The new query.</p> 941</div> 942</div> 943<hr> 944<div class="refsect2"> 945<a name="gst-navigation-query-get-type"></a><h3>gst_navigation_query_get_type ()</h3> 946<pre class="programlisting"><a class="link" href="GstNavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType"><span class="returnvalue">GstNavigationQueryType</span></a> 947gst_navigation_query_get_type (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a> *query</code></em>);</pre> 948<p>Inspect a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a> and return the <a class="link" href="GstNavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType"><span class="type">GstNavigationQueryType</span></a> associated with 949it if it is a <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> query.</p> 950<div class="refsect3"> 951<a name="gst-navigation-query-get-type.parameters"></a><h4>Parameters</h4> 952<div class="informaltable"><table class="informaltable" width="100%" border="0"> 953<colgroup> 954<col width="150px" class="parameters_name"> 955<col class="parameters_description"> 956<col width="200px" class="parameters_annotations"> 957</colgroup> 958<tbody><tr> 959<td class="parameter_name"><p>query</p></td> 960<td class="parameter_description"><p>The query to inspect</p></td> 961<td class="parameter_annotations"> </td> 962</tr></tbody> 963</table></div> 964</div> 965<div class="refsect3"> 966<a name="gst-navigation-query-get-type.returns"></a><h4>Returns</h4> 967<p> The <a class="link" href="GstNavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType"><span class="type">GstNavigationQueryType</span></a> of the query, or 968<a class="link" href="GstNavigation.html#GST-NAVIGATION-QUERY-INVALID:CAPS"><span class="type">GST_NAVIGATION_QUERY_INVALID</span></a></p> 969</div> 970</div> 971<hr> 972<div class="refsect2"> 973<a name="gst-navigation-query-new-commands"></a><h3>gst_navigation_query_new_commands ()</h3> 974<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="returnvalue">GstQuery</span></a> * 975gst_navigation_query_new_commands (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> 976<p>Create a new <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> commands query. When executed, it will 977query the pipeline for the set of currently available commands.</p> 978<div class="refsect3"> 979<a name="gst-navigation-query-new-commands.returns"></a><h4>Returns</h4> 980<p> The new query.</p> 981</div> 982</div> 983<hr> 984<div class="refsect2"> 985<a name="gst-navigation-query-parse-angles"></a><h3>gst_navigation_query_parse_angles ()</h3> 986<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 987gst_navigation_query_parse_angles (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a> *query</code></em>, 988 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *cur_angle</code></em>, 989 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_angles</code></em>);</pre> 990<p>Parse the current angle number in the <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> angles <em class="parameter"><code>query</code></em> 991 into the 992<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> pointed to by the <em class="parameter"><code>cur_angle</code></em> 993 variable, and the number of available 994angles into the <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> pointed to by the <em class="parameter"><code>n_angles</code></em> 995 variable.</p> 996<div class="refsect3"> 997<a name="gst-navigation-query-parse-angles.parameters"></a><h4>Parameters</h4> 998<div class="informaltable"><table class="informaltable" width="100%" border="0"> 999<colgroup> 1000<col width="150px" class="parameters_name"> 1001<col class="parameters_description"> 1002<col width="200px" class="parameters_annotations"> 1003</colgroup> 1004<tbody> 1005<tr> 1006<td class="parameter_name"><p>query</p></td> 1007<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a></p></td> 1008<td class="parameter_annotations"> </td> 1009</tr> 1010<tr> 1011<td class="parameter_name"><p>cur_angle</p></td> 1012<td class="parameter_description"><p>Pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> into which to store the 1013currently selected angle value from the query, or NULL. </p></td> 1014<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 1015</tr> 1016<tr> 1017<td class="parameter_name"><p>n_angles</p></td> 1018<td class="parameter_description"><p>Pointer to a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> into which to store the 1019number of angles value from the query, or NULL. </p></td> 1020<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 1021</tr> 1022</tbody> 1023</table></div> 1024</div> 1025<div class="refsect3"> 1026<a name="gst-navigation-query-parse-angles.returns"></a><h4>Returns</h4> 1027<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the query could be successfully parsed. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</p> 1028</div> 1029</div> 1030<hr> 1031<div class="refsect2"> 1032<a name="gst-navigation-query-parse-commands-length"></a><h3>gst_navigation_query_parse_commands_length ()</h3> 1033<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1034gst_navigation_query_parse_commands_length 1035 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a> *query</code></em>, 1036 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_cmds</code></em>);</pre> 1037<p>Parse the number of commands in the <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> commands <em class="parameter"><code>query</code></em> 1038.</p> 1039<div class="refsect3"> 1040<a name="gst-navigation-query-parse-commands-length.parameters"></a><h4>Parameters</h4> 1041<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1042<colgroup> 1043<col width="150px" class="parameters_name"> 1044<col class="parameters_description"> 1045<col width="200px" class="parameters_annotations"> 1046</colgroup> 1047<tbody> 1048<tr> 1049<td class="parameter_name"><p>query</p></td> 1050<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a></p></td> 1051<td class="parameter_annotations"> </td> 1052</tr> 1053<tr> 1054<td class="parameter_name"><p>n_cmds</p></td> 1055<td class="parameter_description"><p>the number of commands in this query. </p></td> 1056<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 1057</tr> 1058</tbody> 1059</table></div> 1060</div> 1061<div class="refsect3"> 1062<a name="gst-navigation-query-parse-commands-length.returns"></a><h4>Returns</h4> 1063<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the query could be successfully parsed. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</p> 1064</div> 1065</div> 1066<hr> 1067<div class="refsect2"> 1068<a name="gst-navigation-query-parse-commands-nth"></a><h3>gst_navigation_query_parse_commands_nth ()</h3> 1069<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 1070gst_navigation_query_parse_commands_nth 1071 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a> *query</code></em>, 1072 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nth</code></em>, 1073 <em class="parameter"><code><a class="link" href="GstNavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *cmd</code></em>);</pre> 1074<p>Parse the <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> command query and retrieve the <em class="parameter"><code>nth</code></em> 1075 command from 1076it into <em class="parameter"><code>cmd</code></em> 1077. If the list contains less elements than <em class="parameter"><code>nth</code></em> 1078, <em class="parameter"><code>cmd</code></em> 1079 will be 1080set to <a class="link" href="GstNavigation.html#GST-NAVIGATION-COMMAND-INVALID:CAPS"><span class="type">GST_NAVIGATION_COMMAND_INVALID</span></a>.</p> 1081<div class="refsect3"> 1082<a name="gst-navigation-query-parse-commands-nth.parameters"></a><h4>Parameters</h4> 1083<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1084<colgroup> 1085<col width="150px" class="parameters_name"> 1086<col class="parameters_description"> 1087<col width="200px" class="parameters_annotations"> 1088</colgroup> 1089<tbody> 1090<tr> 1091<td class="parameter_name"><p>query</p></td> 1092<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a></p></td> 1093<td class="parameter_annotations"> </td> 1094</tr> 1095<tr> 1096<td class="parameter_name"><p>nth</p></td> 1097<td class="parameter_description"><p>the nth command to retrieve.</p></td> 1098<td class="parameter_annotations"> </td> 1099</tr> 1100<tr> 1101<td class="parameter_name"><p>cmd</p></td> 1102<td class="parameter_description"><p>a pointer to store the nth command into. </p></td> 1103<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 may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> 1104</tr> 1105</tbody> 1106</table></div> 1107</div> 1108<div class="refsect3"> 1109<a name="gst-navigation-query-parse-commands-nth.returns"></a><h4>Returns</h4> 1110<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the query could be successfully parsed. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</p> 1111</div> 1112</div> 1113<hr> 1114<div class="refsect2"> 1115<a name="gst-navigation-query-set-angles"></a><h3>gst_navigation_query_set_angles ()</h3> 1116<pre class="programlisting"><span class="returnvalue">void</span> 1117gst_navigation_query_set_angles (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a> *query</code></em>, 1118 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> cur_angle</code></em>, 1119 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_angles</code></em>);</pre> 1120<p>Set the <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> angles query result field in <em class="parameter"><code>query</code></em> 1121.</p> 1122<div class="refsect3"> 1123<a name="gst-navigation-query-set-angles.parameters"></a><h4>Parameters</h4> 1124<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1125<colgroup> 1126<col width="150px" class="parameters_name"> 1127<col class="parameters_description"> 1128<col width="200px" class="parameters_annotations"> 1129</colgroup> 1130<tbody> 1131<tr> 1132<td class="parameter_name"><p>query</p></td> 1133<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a></p></td> 1134<td class="parameter_annotations"> </td> 1135</tr> 1136<tr> 1137<td class="parameter_name"><p>cur_angle</p></td> 1138<td class="parameter_description"><p>the current viewing angle to set.</p></td> 1139<td class="parameter_annotations"> </td> 1140</tr> 1141<tr> 1142<td class="parameter_name"><p>n_angles</p></td> 1143<td class="parameter_description"><p>the number of viewing angles to set.</p></td> 1144<td class="parameter_annotations"> </td> 1145</tr> 1146</tbody> 1147</table></div> 1148</div> 1149</div> 1150<hr> 1151<div class="refsect2"> 1152<a name="gst-navigation-query-set-commands"></a><h3>gst_navigation_query_set_commands ()</h3> 1153<pre class="programlisting"><span class="returnvalue">void</span> 1154gst_navigation_query_set_commands (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a> *query</code></em>, 1155 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cmds</code></em>, 1156 <em class="parameter"><code>...</code></em>);</pre> 1157<p>Set the <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> command query result fields in <em class="parameter"><code>query</code></em> 1158. The number 1159of commands passed must be equal to <em class="parameter"><code>n_commands</code></em> 1160.</p> 1161<div class="refsect3"> 1162<a name="gst-navigation-query-set-commands.parameters"></a><h4>Parameters</h4> 1163<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1164<colgroup> 1165<col width="150px" class="parameters_name"> 1166<col class="parameters_description"> 1167<col width="200px" class="parameters_annotations"> 1168</colgroup> 1169<tbody> 1170<tr> 1171<td class="parameter_name"><p>query</p></td> 1172<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a></p></td> 1173<td class="parameter_annotations"> </td> 1174</tr> 1175<tr> 1176<td class="parameter_name"><p>n_cmds</p></td> 1177<td class="parameter_description"><p>the number of commands to set.</p></td> 1178<td class="parameter_annotations"> </td> 1179</tr> 1180<tr> 1181<td class="parameter_name"><p>...</p></td> 1182<td class="parameter_description"><p>A list of <em class="parameter"><code>GstNavigationCommand</code></em> 1183values, <em class="parameter"><code>n_cmds</code></em> 1184entries long.</p></td> 1185<td class="parameter_annotations"> </td> 1186</tr> 1187</tbody> 1188</table></div> 1189</div> 1190</div> 1191<hr> 1192<div class="refsect2"> 1193<a name="gst-navigation-query-set-commandsv"></a><h3>gst_navigation_query_set_commandsv ()</h3> 1194<pre class="programlisting"><span class="returnvalue">void</span> 1195gst_navigation_query_set_commandsv (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a> *query</code></em>, 1196 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cmds</code></em>, 1197 <em class="parameter"><code><a class="link" href="GstNavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *cmds</code></em>);</pre> 1198<p>Set the <a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> command query result fields in <em class="parameter"><code>query</code></em> 1199. The number 1200of commands passed must be equal to <em class="parameter"><code>n_commands</code></em> 1201.</p> 1202<div class="refsect3"> 1203<a name="gst-navigation-query-set-commandsv.parameters"></a><h4>Parameters</h4> 1204<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1205<colgroup> 1206<col width="150px" class="parameters_name"> 1207<col class="parameters_description"> 1208<col width="200px" class="parameters_annotations"> 1209</colgroup> 1210<tbody> 1211<tr> 1212<td class="parameter_name"><p>query</p></td> 1213<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstQuery.html#GstQuery-struct"><span class="type">GstQuery</span></a></p></td> 1214<td class="parameter_annotations"> </td> 1215</tr> 1216<tr> 1217<td class="parameter_name"><p>n_cmds</p></td> 1218<td class="parameter_description"><p>the number of commands to set.</p></td> 1219<td class="parameter_annotations"> </td> 1220</tr> 1221<tr> 1222<td class="parameter_name"><p>cmds</p></td> 1223<td class="parameter_description"><p>An array containing <em class="parameter"><code>n_cmds</code></em> 1224<em class="parameter"><code>GstNavigationCommand</code></em> 1225values. </p></td> 1226<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_cmds]</span></td> 1227</tr> 1228</tbody> 1229</table></div> 1230</div> 1231</div> 1232</div> 1233<div class="refsect1"> 1234<a name="GstNavigation.other_details"></a><h2>Types and Values</h2> 1235<div class="refsect2"> 1236<a name="GstNavigation-struct"></a><h3>GstNavigation</h3> 1237<pre class="programlisting">typedef struct _GstNavigation GstNavigation;</pre> 1238</div> 1239<hr> 1240<div class="refsect2"> 1241<a name="GstNavigationInterface"></a><h3>struct GstNavigationInterface</h3> 1242<pre class="programlisting">struct GstNavigationInterface { 1243 GTypeInterface iface; 1244 1245 /* virtual functions */ 1246 void (*send_event) (GstNavigation *navigation, GstStructure *structure); 1247}; 1248</pre> 1249<p>Navigation interface.</p> 1250<div class="refsect3"> 1251<a name="GstNavigationInterface.members"></a><h4>Members</h4> 1252<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1253<colgroup> 1254<col width="300px" class="struct_members_name"> 1255<col class="struct_members_description"> 1256<col width="200px" class="struct_members_annotations"> 1257</colgroup> 1258<tbody> 1259<tr> 1260<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GstNavigationInterface.iface"></a>iface</code></em>;</p></td> 1261<td class="struct_member_description"><p>the parent interface</p></td> 1262<td class="struct_member_annotations"> </td> 1263</tr> 1264<tr> 1265<td class="struct_member_name"><p><em class="structfield"><code><a name="GstNavigationInterface.send-event"></a>send_event</code></em> ()</p></td> 1266<td class="struct_member_description"><p>sending a navigation event</p></td> 1267<td class="struct_member_annotations"> </td> 1268</tr> 1269</tbody> 1270</table></div> 1271</div> 1272</div> 1273<hr> 1274<div class="refsect2"> 1275<a name="GstNavigationCommand"></a><h3>enum GstNavigationCommand</h3> 1276<p>A set of commands that may be issued to an element providing the 1277<a class="link" href="GstNavigation.html" title="GstNavigation"><span class="type">GstNavigation</span></a> interface. The available commands can be queried via 1278the <a class="link" href="GstNavigation.html#gst-navigation-query-new-commands" title="gst_navigation_query_new_commands ()"><code class="function">gst_navigation_query_new_commands()</code></a> query.</p> 1279<p>For convenience in handling DVD navigation, the MENU commands are aliased as: 1280 GST_NAVIGATION_COMMAND_DVD_MENU = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU1</code></em> 1281 1282 GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU2</code></em> 1283 1284 GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU3</code></em> 1285 1286 GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU4</code></em> 1287 1288 GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU5</code></em> 1289 1290 GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU6</code></em> 1291 1292 GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU7</code></em> 1293</p> 1294<div class="refsect3"> 1295<a name="GstNavigationCommand.members"></a><h4>Members</h4> 1296<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1297<colgroup> 1298<col width="300px" class="enum_members_name"> 1299<col class="enum_members_description"> 1300<col width="200px" class="enum_members_annotations"> 1301</colgroup> 1302<tbody> 1303<tr> 1304<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-INVALID:CAPS"></a>GST_NAVIGATION_COMMAND_INVALID</p></td> 1305<td class="enum_member_description"> 1306<p>An invalid command entry</p> 1307</td> 1308<td class="enum_member_annotations"> </td> 1309</tr> 1310<tr> 1311<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-MENU1:CAPS"></a>GST_NAVIGATION_COMMAND_MENU1</p></td> 1312<td class="enum_member_description"> 1313<p>Execute navigation menu command 1. For DVD, 1314this enters the DVD root menu, or exits back to the title from the menu.</p> 1315</td> 1316<td class="enum_member_annotations"> </td> 1317</tr> 1318<tr> 1319<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-MENU2:CAPS"></a>GST_NAVIGATION_COMMAND_MENU2</p></td> 1320<td class="enum_member_description"> 1321<p>Execute navigation menu command 2. For DVD, 1322this jumps to the DVD title menu.</p> 1323</td> 1324<td class="enum_member_annotations"> </td> 1325</tr> 1326<tr> 1327<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-MENU3:CAPS"></a>GST_NAVIGATION_COMMAND_MENU3</p></td> 1328<td class="enum_member_description"> 1329<p>Execute navigation menu command 3. For DVD, 1330this jumps into the DVD root menu.</p> 1331</td> 1332<td class="enum_member_annotations"> </td> 1333</tr> 1334<tr> 1335<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-MENU4:CAPS"></a>GST_NAVIGATION_COMMAND_MENU4</p></td> 1336<td class="enum_member_description"> 1337<p>Execute navigation menu command 4. For DVD, 1338this jumps to the Subpicture menu.</p> 1339</td> 1340<td class="enum_member_annotations"> </td> 1341</tr> 1342<tr> 1343<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-MENU5:CAPS"></a>GST_NAVIGATION_COMMAND_MENU5</p></td> 1344<td class="enum_member_description"> 1345<p>Execute navigation menu command 5. For DVD, 1346the jumps to the audio menu.</p> 1347</td> 1348<td class="enum_member_annotations"> </td> 1349</tr> 1350<tr> 1351<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-MENU6:CAPS"></a>GST_NAVIGATION_COMMAND_MENU6</p></td> 1352<td class="enum_member_description"> 1353<p>Execute navigation menu command 6. For DVD, 1354this jumps to the angles menu.</p> 1355</td> 1356<td class="enum_member_annotations"> </td> 1357</tr> 1358<tr> 1359<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-MENU7:CAPS"></a>GST_NAVIGATION_COMMAND_MENU7</p></td> 1360<td class="enum_member_description"> 1361<p>Execute navigation menu command 7. For DVD, 1362this jumps to the chapter menu.</p> 1363</td> 1364<td class="enum_member_annotations"> </td> 1365</tr> 1366<tr> 1367<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-LEFT:CAPS"></a>GST_NAVIGATION_COMMAND_LEFT</p></td> 1368<td class="enum_member_description"> 1369<p>Select the next button to the left in a menu, 1370if such a button exists.</p> 1371</td> 1372<td class="enum_member_annotations"> </td> 1373</tr> 1374<tr> 1375<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-RIGHT:CAPS"></a>GST_NAVIGATION_COMMAND_RIGHT</p></td> 1376<td class="enum_member_description"> 1377<p>Select the next button to the right in a menu, 1378if such a button exists.</p> 1379</td> 1380<td class="enum_member_annotations"> </td> 1381</tr> 1382<tr> 1383<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-UP:CAPS"></a>GST_NAVIGATION_COMMAND_UP</p></td> 1384<td class="enum_member_description"> 1385<p>Select the button above the current one in a 1386menu, if such a button exists.</p> 1387</td> 1388<td class="enum_member_annotations"> </td> 1389</tr> 1390<tr> 1391<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-DOWN:CAPS"></a>GST_NAVIGATION_COMMAND_DOWN</p></td> 1392<td class="enum_member_description"> 1393<p>Select the button below the current one in a 1394menu, if such a button exists.</p> 1395</td> 1396<td class="enum_member_annotations"> </td> 1397</tr> 1398<tr> 1399<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-ACTIVATE:CAPS"></a>GST_NAVIGATION_COMMAND_ACTIVATE</p></td> 1400<td class="enum_member_description"> 1401<p>Activate (click) the currently selected 1402button in a menu, if such a button exists.</p> 1403</td> 1404<td class="enum_member_annotations"> </td> 1405</tr> 1406<tr> 1407<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-PREV-ANGLE:CAPS"></a>GST_NAVIGATION_COMMAND_PREV_ANGLE</p></td> 1408<td class="enum_member_description"> 1409<p>Switch to the previous angle in a 1410multiangle feature.</p> 1411</td> 1412<td class="enum_member_annotations"> </td> 1413</tr> 1414<tr> 1415<td class="enum_member_name"><p><a name="GST-NAVIGATION-COMMAND-NEXT-ANGLE:CAPS"></a>GST_NAVIGATION_COMMAND_NEXT_ANGLE</p></td> 1416<td class="enum_member_description"> 1417<p>Switch to the next angle in a multiangle 1418feature.</p> 1419</td> 1420<td class="enum_member_annotations"> </td> 1421</tr> 1422</tbody> 1423</table></div> 1424</div> 1425</div> 1426<hr> 1427<div class="refsect2"> 1428<a name="GstNavigationEventType"></a><h3>enum GstNavigationEventType</h3> 1429<p>Enum values for the various events that an element implementing the 1430GstNavigation interface might send up the pipeline.</p> 1431<div class="refsect3"> 1432<a name="GstNavigationEventType.members"></a><h4>Members</h4> 1433<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1434<colgroup> 1435<col width="300px" class="enum_members_name"> 1436<col class="enum_members_description"> 1437<col width="200px" class="enum_members_annotations"> 1438</colgroup> 1439<tbody> 1440<tr> 1441<td class="enum_member_name"><p><a name="GST-NAVIGATION-EVENT-INVALID:CAPS"></a>GST_NAVIGATION_EVENT_INVALID</p></td> 1442<td class="enum_member_description"> 1443<p>Returned from 1444<code class="function">gst_navigation_event_get_type()</code> when the passed event is not a navigation event.</p> 1445</td> 1446<td class="enum_member_annotations"> </td> 1447</tr> 1448<tr> 1449<td class="enum_member_name"><p><a name="GST-NAVIGATION-EVENT-KEY-PRESS:CAPS"></a>GST_NAVIGATION_EVENT_KEY_PRESS</p></td> 1450<td class="enum_member_description"> 1451<p>A key press event. Use 1452<a class="link" href="GstNavigation.html#gst-navigation-event-parse-key-event" title="gst_navigation_event_parse_key_event ()"><code class="function">gst_navigation_event_parse_key_event()</code></a> to extract the details from the event.</p> 1453</td> 1454<td class="enum_member_annotations"> </td> 1455</tr> 1456<tr> 1457<td class="enum_member_name"><p><a name="GST-NAVIGATION-EVENT-KEY-RELEASE:CAPS"></a>GST_NAVIGATION_EVENT_KEY_RELEASE</p></td> 1458<td class="enum_member_description"> 1459<p>A key release event. Use 1460<a class="link" href="GstNavigation.html#gst-navigation-event-parse-key-event" title="gst_navigation_event_parse_key_event ()"><code class="function">gst_navigation_event_parse_key_event()</code></a> to extract the details from the event.</p> 1461</td> 1462<td class="enum_member_annotations"> </td> 1463</tr> 1464<tr> 1465<td class="enum_member_name"><p><a name="GST-NAVIGATION-EVENT-MOUSE-BUTTON-PRESS:CAPS"></a>GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS</p></td> 1466<td class="enum_member_description"> 1467<p>A mouse button press event. Use 1468<a class="link" href="GstNavigation.html#gst-navigation-event-parse-mouse-button-event" title="gst_navigation_event_parse_mouse_button_event ()"><code class="function">gst_navigation_event_parse_mouse_button_event()</code></a> to extract the details from the 1469event.</p> 1470</td> 1471<td class="enum_member_annotations"> </td> 1472</tr> 1473<tr> 1474<td class="enum_member_name"><p><a name="GST-NAVIGATION-EVENT-MOUSE-BUTTON-RELEASE:CAPS"></a>GST_NAVIGATION_EVENT_MOUSE_BUTTON_RELEASE</p></td> 1475<td class="enum_member_description"> 1476<p>A mouse button release event. Use 1477<a class="link" href="GstNavigation.html#gst-navigation-event-parse-mouse-button-event" title="gst_navigation_event_parse_mouse_button_event ()"><code class="function">gst_navigation_event_parse_mouse_button_event()</code></a> to extract the details from the 1478event.</p> 1479</td> 1480<td class="enum_member_annotations"> </td> 1481</tr> 1482<tr> 1483<td class="enum_member_name"><p><a name="GST-NAVIGATION-EVENT-MOUSE-MOVE:CAPS"></a>GST_NAVIGATION_EVENT_MOUSE_MOVE</p></td> 1484<td class="enum_member_description"> 1485<p>A mouse movement event. Use 1486<a class="link" href="GstNavigation.html#gst-navigation-event-parse-mouse-move-event" title="gst_navigation_event_parse_mouse_move_event ()"><code class="function">gst_navigation_event_parse_mouse_move_event()</code></a> to extract the details from the 1487event.</p> 1488</td> 1489<td class="enum_member_annotations"> </td> 1490</tr> 1491<tr> 1492<td class="enum_member_name"><p><a name="GST-NAVIGATION-EVENT-COMMAND:CAPS"></a>GST_NAVIGATION_EVENT_COMMAND</p></td> 1493<td class="enum_member_description"> 1494<p>A navigation command event. Use 1495<a class="link" href="GstNavigation.html#gst-navigation-event-parse-command" title="gst_navigation_event_parse_command ()"><code class="function">gst_navigation_event_parse_command()</code></a> to extract the details from the event.</p> 1496</td> 1497<td class="enum_member_annotations"> </td> 1498</tr> 1499</tbody> 1500</table></div> 1501</div> 1502</div> 1503<hr> 1504<div class="refsect2"> 1505<a name="GstNavigationMessageType"></a><h3>enum GstNavigationMessageType</h3> 1506<p>A set of notifications that may be received on the bus when navigation 1507related status changes.</p> 1508<div class="refsect3"> 1509<a name="GstNavigationMessageType.members"></a><h4>Members</h4> 1510<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1511<colgroup> 1512<col width="300px" class="enum_members_name"> 1513<col class="enum_members_description"> 1514<col width="200px" class="enum_members_annotations"> 1515</colgroup> 1516<tbody> 1517<tr> 1518<td class="enum_member_name"><p><a name="GST-NAVIGATION-MESSAGE-INVALID:CAPS"></a>GST_NAVIGATION_MESSAGE_INVALID</p></td> 1519<td class="enum_member_description"> 1520<p>Returned from 1521<a class="link" href="GstNavigation.html#gst-navigation-message-get-type" title="gst_navigation_message_get_type ()"><code class="function">gst_navigation_message_get_type()</code></a> when the passed message is not a 1522navigation message.</p> 1523</td> 1524<td class="enum_member_annotations"> </td> 1525</tr> 1526<tr> 1527<td class="enum_member_name"><p><a name="GST-NAVIGATION-MESSAGE-MOUSE-OVER:CAPS"></a>GST_NAVIGATION_MESSAGE_MOUSE_OVER</p></td> 1528<td class="enum_member_description"> 1529<p>Sent when the mouse moves over or leaves a 1530clickable region of the output, such as a DVD menu button.</p> 1531</td> 1532<td class="enum_member_annotations"> </td> 1533</tr> 1534<tr> 1535<td class="enum_member_name"><p><a name="GST-NAVIGATION-MESSAGE-COMMANDS-CHANGED:CAPS"></a>GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</p></td> 1536<td class="enum_member_description"> 1537<p>Sent when the set of available commands 1538changes and should re-queried by interested applications.</p> 1539</td> 1540<td class="enum_member_annotations"> </td> 1541</tr> 1542<tr> 1543<td class="enum_member_name"><p><a name="GST-NAVIGATION-MESSAGE-ANGLES-CHANGED:CAPS"></a>GST_NAVIGATION_MESSAGE_ANGLES_CHANGED</p></td> 1544<td class="enum_member_description"> 1545<p>Sent when display angles in a multi-angle 1546feature (such as a multiangle DVD) change - either angles have appeared or 1547disappeared.</p> 1548</td> 1549<td class="enum_member_annotations"> </td> 1550</tr> 1551<tr> 1552<td class="enum_member_name"><p><a name="GST-NAVIGATION-MESSAGE-EVENT:CAPS"></a>GST_NAVIGATION_MESSAGE_EVENT</p></td> 1553<td class="enum_member_description"> 1554<p>Sent when a navigation event was not handled 1555by any element in the pipeline (Since: 1.6)</p> 1556</td> 1557<td class="enum_member_annotations"> </td> 1558</tr> 1559</tbody> 1560</table></div> 1561</div> 1562</div> 1563<hr> 1564<div class="refsect2"> 1565<a name="GstNavigationQueryType"></a><h3>enum GstNavigationQueryType</h3> 1566<p>Tyoes of navigation interface queries.</p> 1567<div class="refsect3"> 1568<a name="GstNavigationQueryType.members"></a><h4>Members</h4> 1569<div class="informaltable"><table class="informaltable" width="100%" border="0"> 1570<colgroup> 1571<col width="300px" class="enum_members_name"> 1572<col class="enum_members_description"> 1573<col width="200px" class="enum_members_annotations"> 1574</colgroup> 1575<tbody> 1576<tr> 1577<td class="enum_member_name"><p><a name="GST-NAVIGATION-QUERY-INVALID:CAPS"></a>GST_NAVIGATION_QUERY_INVALID</p></td> 1578<td class="enum_member_description"> 1579<p>invalid query</p> 1580</td> 1581<td class="enum_member_annotations"> </td> 1582</tr> 1583<tr> 1584<td class="enum_member_name"><p><a name="GST-NAVIGATION-QUERY-COMMANDS:CAPS"></a>GST_NAVIGATION_QUERY_COMMANDS</p></td> 1585<td class="enum_member_description"> 1586<p>command query</p> 1587</td> 1588<td class="enum_member_annotations"> </td> 1589</tr> 1590<tr> 1591<td class="enum_member_name"><p><a name="GST-NAVIGATION-QUERY-ANGLES:CAPS"></a>GST_NAVIGATION_QUERY_ANGLES</p></td> 1592<td class="enum_member_description"> 1593<p>viewing angle query</p> 1594</td> 1595<td class="enum_member_annotations"> </td> 1596</tr> 1597</tbody> 1598</table></div> 1599</div> 1600</div> 1601<hr> 1602<div class="refsect2"> 1603<a name="GST-NAVIGATION-COMMAND-DVD-ANGLE-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU</h3> 1604<pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU GST_NAVIGATION_COMMAND_MENU6 1605</pre> 1606</div> 1607<hr> 1608<div class="refsect2"> 1609<a name="GST-NAVIGATION-COMMAND-DVD-AUDIO-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU</h3> 1610<pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU GST_NAVIGATION_COMMAND_MENU5 1611</pre> 1612</div> 1613<hr> 1614<div class="refsect2"> 1615<a name="GST-NAVIGATION-COMMAND-DVD-CHAPTER-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU</h3> 1616<pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU GST_NAVIGATION_COMMAND_MENU7 1617</pre> 1618</div> 1619<hr> 1620<div class="refsect2"> 1621<a name="GST-NAVIGATION-COMMAND-DVD-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_MENU</h3> 1622<pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_MENU GST_NAVIGATION_COMMAND_MENU1 1623</pre> 1624</div> 1625<hr> 1626<div class="refsect2"> 1627<a name="GST-NAVIGATION-COMMAND-DVD-ROOT-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_ROOT_MENU</h3> 1628<pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_ROOT_MENU GST_NAVIGATION_COMMAND_MENU3 1629</pre> 1630</div> 1631<hr> 1632<div class="refsect2"> 1633<a name="GST-NAVIGATION-COMMAND-DVD-SUBPICTURE-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU</h3> 1634<pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU GST_NAVIGATION_COMMAND_MENU4 1635</pre> 1636</div> 1637<hr> 1638<div class="refsect2"> 1639<a name="GST-NAVIGATION-COMMAND-DVD-TITLE-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_TITLE_MENU</h3> 1640<pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_TITLE_MENU GST_NAVIGATION_COMMAND_MENU2 1641</pre> 1642</div> 1643</div> 1644</div> 1645<div class="footer"> 1646<hr>Generated by GTK-Doc V1.28</div> 1647</body> 1648</html>
