tizen 2.0 init
[framework/multimedia/gst-plugins-base0.10.git] / docs / libs / html / gst-plugins-base-libs-gstnavigation.html
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</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-interfaces.html" title="Interfaces Library">
9 <link rel="prev" href="gst-plugins-base-libs-gstmixertrack.html" title="gstmixertrack">
10 <link rel="next" href="gst-plugins-base-libs-gstpropertyprobe.html" title="gstpropertyprobe">
11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gst-plugins-base-libs-gstmixertrack.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-interfaces.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-base-libs-gstpropertyprobe.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstnavigation.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-libs-gstnavigation.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-base-libs-gstnavigation.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="gst-plugins-base-libs-gstnavigation"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstnavigation.top_of_page"></a>gstnavigation</span></h2>
36 <p>gstnavigation — Interface for creating, sending and parsing navigation
37 events.</p>
38 </td>
39 <td valign="top" align="right"></td>
40 </tr></table></div>
41 <div class="refsynopsisdiv">
42 <a name="gst-plugins-base-libs-gstnavigation.synopsis"></a><h2>Synopsis</h2>
43 <a name="GstNavigation"></a><pre class="synopsis">
44 #include &lt;gst/interfaces/navigation.h&gt;
45
46                     <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation-struct" title="GstNavigation">GstNavigation</a>;
47 struct              <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationInterface" title="struct GstNavigationInterface">GstNavigationInterface</a>;
48 enum                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand">GstNavigationCommand</a>;
49 enum                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationEventType" title="enum GstNavigationEventType">GstNavigationEventType</a>;
50 enum                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationMessageType" title="enum GstNavigationMessageType">GstNavigationMessageType</a>;
51 enum                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType">GstNavigationQueryType</a>;
52 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-send-event" title="gst_navigation_send_event ()">gst_navigation_send_event</a>           (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>,
53                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);
54 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-send-key-event" title="gst_navigation_send_key_event ()">gst_navigation_send_key_event</a>       (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>,
55                                                          <em class="parameter"><code>const <span class="type">char</span> *event</code></em>,
56                                                          <em class="parameter"><code>const <span class="type">char</span> *key</code></em>);
57 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-send-mouse-event" title="gst_navigation_send_mouse_event ()">gst_navigation_send_mouse_event</a>     (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>,
58                                                          <em class="parameter"><code>const <span class="type">char</span> *event</code></em>,
59                                                          <em class="parameter"><code><span class="type">int</span> button</code></em>,
60                                                          <em class="parameter"><code><span class="type">double</span> x</code></em>,
61                                                          <em class="parameter"><code><span class="type">double</span> y</code></em>);
62 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-send-command" title="gst_navigation_send_command ()">gst_navigation_send_command</a>         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>,
63                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> command</code></em>);
64 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-event-parse-command" title="gst_navigation_event_parse_command ()">gst_navigation_event_parse_command</a>  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
65                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *command</code></em>);
66 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-event-parse-key-event" title="gst_navigation_event_parse_key_event ()">gst_navigation_event_parse_key_event</a>
67                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
68                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **key</code></em>);
69 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-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>
70                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
71                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *button</code></em>,
72                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>,
73                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>);
74 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-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>
75                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
76                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>,
77                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>);
78 <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationMessageType" title="enum GstNavigationMessageType"><span class="returnvalue">GstNavigationMessageType</span></a> <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-message-get-type" title="gst_navigation_message_get_type ()">gst_navigation_message_get_type</a>
79                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> *message</code></em>);
80 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="returnvalue">GstMessage</span></a> *        <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-message-new-angles-changed" title="gst_navigation_message_new_angles_changed ()">gst_navigation_message_new_angles_changed</a>
81                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> *src</code></em>,
82                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> cur_angle</code></em>,
83                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_angles</code></em>);
84 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="returnvalue">GstMessage</span></a> *        <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-message-new-commands-changed" title="gst_navigation_message_new_commands_changed ()">gst_navigation_message_new_commands_changed</a>
85                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> *src</code></em>);
86 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="returnvalue">GstMessage</span></a> *        <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-message-new-mouse-over" title="gst_navigation_message_new_mouse_over ()">gst_navigation_message_new_mouse_over</a>
87                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> *src</code></em>,
88                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> active</code></em>);
89 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-message-parse-mouse-over" title="gst_navigation_message_parse_mouse_over ()">gst_navigation_message_parse_mouse_over</a>
90                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> *message</code></em>,
91                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *active</code></em>);
92 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-message-parse-angles-changed" title="gst_navigation_message_parse_angles_changed ()">gst_navigation_message_parse_angles_changed</a>
93                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> *message</code></em>,
94                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *cur_angle</code></em>,
95                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_angles</code></em>);
96 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="returnvalue">GstQuery</span></a> *          <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-new-angles" title="gst_navigation_query_new_angles ()">gst_navigation_query_new_angles</a>     (<em class="parameter"><code><span class="type">void</span></code></em>);
97 <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType"><span class="returnvalue">GstNavigationQueryType</span></a> <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-get-type" title="gst_navigation_query_get_type ()">gst_navigation_query_get_type</a>    (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>);
98 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="returnvalue">GstQuery</span></a> *          <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-new-commands" title="gst_navigation_query_new_commands ()">gst_navigation_query_new_commands</a>   (<em class="parameter"><code><span class="type">void</span></code></em>);
99 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-parse-angles" title="gst_navigation_query_parse_angles ()">gst_navigation_query_parse_angles</a>   (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
100                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *cur_angle</code></em>,
101                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_angles</code></em>);
102 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-parse-commands-length" title="gst_navigation_query_parse_commands_length ()">gst_navigation_query_parse_commands_length</a>
103                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
104                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_cmds</code></em>);
105 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-parse-commands-nth" title="gst_navigation_query_parse_commands_nth ()">gst_navigation_query_parse_commands_nth</a>
106                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
107                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nth</code></em>,
108                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *cmd</code></em>);
109 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-set-angles" title="gst_navigation_query_set_angles ()">gst_navigation_query_set_angles</a>     (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
110                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> cur_angle</code></em>,
111                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_angles</code></em>);
112 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-set-commands" title="gst_navigation_query_set_commands ()">gst_navigation_query_set_commands</a>   (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
113                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cmds</code></em>,
114                                                          <em class="parameter"><code>...</code></em>);
115 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-set-commandsv" title="gst_navigation_query_set_commandsv ()">gst_navigation_query_set_commandsv</a>  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
116                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cmds</code></em>,
117                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *cmds</code></em>);
118 #define             <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-COMMAND-DVD-ANGLE-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU">GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU</a>
119 #define             <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-COMMAND-DVD-AUDIO-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU">GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU</a>
120 #define             <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-COMMAND-DVD-CHAPTER-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU">GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU</a>
121 #define             <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-COMMAND-DVD-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_MENU">GST_NAVIGATION_COMMAND_DVD_MENU</a>
122 #define             <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-COMMAND-DVD-ROOT-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_ROOT_MENU">GST_NAVIGATION_COMMAND_DVD_ROOT_MENU</a>
123 #define             <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-COMMAND-DVD-SUBPICTURE-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU">GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU</a>
124 #define             <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-COMMAND-DVD-TITLE-MENU:CAPS" title="GST_NAVIGATION_COMMAND_DVD_TITLE_MENU">GST_NAVIGATION_COMMAND_DVD_TITLE_MENU</a>
125 </pre>
126 </div>
127 <div class="refsect1">
128 <a name="gst-plugins-base-libs-gstnavigation.object-hierarchy"></a><h2>Object Hierarchy</h2>
129 <pre class="synopsis">
130   GInterface
131    +----GstNavigation
132 </pre>
133 </div>
134 <div class="refsect1">
135 <a name="gst-plugins-base-libs-gstnavigation.description"></a><h2>Description</h2>
136 <p>
137 The Navigation interface is used for creating and injecting navigation related
138 events such as mouse button presses, cursor motion and key presses. The associated
139 library also provides methods for parsing received events, and for sending and
140 receiving navigation related bus events. One main usecase is DVD menu navigation.
141 </p>
142 <p>
143 The main parts of the API are:
144 </p>
145 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
146 <li class="listitem"><p>
147 The GstNavigation interface, implemented by elements which provide an application
148 with the ability to create and inject navigation events into the pipeline.
149 </p></li>
150 <li class="listitem"><p>
151 GstNavigation event handling API. GstNavigation events are created in response to
152 calls on a GstNavigation interface implementation, and sent in the pipeline. Upstream
153 elements can use the navigation event API functions to parse the contents of received
154 messages.
155 </p></li>
156 <li class="listitem">
157 <p>
158 GstNavigation message handling API. GstNavigation messages may be sent on the message
159 bus to inform applications of navigation related changes in the pipeline, such as the
160 mouse moving over a clickable region, or the set of available angles changing.
161 </p>
162 <p>
163 The GstNavigation message functions provide functions for creating and parsing
164 custom bus messages for signaling GstNavigation changes.
165 </p>
166 </li>
167 </ul></div>
168 <p>
169 </p>
170 </div>
171 <div class="refsect1">
172 <a name="gst-plugins-base-libs-gstnavigation.details"></a><h2>Details</h2>
173 <div class="refsect2">
174 <a name="GstNavigation-struct"></a><h3>GstNavigation</h3>
175 <pre class="programlisting">typedef struct _GstNavigation GstNavigation;</pre>
176 </div>
177 <hr>
178 <div class="refsect2">
179 <a name="GstNavigationInterface"></a><h3>struct GstNavigationInterface</h3>
180 <pre class="programlisting">struct GstNavigationInterface {
181   GTypeInterface g_iface;
182
183   /* virtual functions */
184   void (*send_event) (GstNavigation *navigation, GstStructure *structure);
185 };
186 </pre>
187 <p>
188 Color-balance interface.
189 </p>
190 <div class="variablelist"><table border="0">
191 <col align="left" valign="top">
192 <tbody>
193 <tr>
194 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GstNavigationInterface.g-iface"></a>g_iface</code></em>;</span></p></td>
195 <td>the parent interface</td>
196 </tr>
197 <tr>
198 <td><p><span class="term"><em class="structfield"><code><a name="GstNavigationInterface.send-event"></a>send_event</code></em> ()</span></p></td>
199 <td>sending a navigation event</td>
200 </tr>
201 </tbody>
202 </table></div>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="GstNavigationCommand"></a><h3>enum GstNavigationCommand</h3>
207 <pre class="programlisting">typedef enum {
208   GST_NAVIGATION_COMMAND_INVALID  = 0,
209
210   GST_NAVIGATION_COMMAND_MENU1    = 1,
211   GST_NAVIGATION_COMMAND_MENU2    = 2,
212   GST_NAVIGATION_COMMAND_MENU3    = 3,
213   GST_NAVIGATION_COMMAND_MENU4    = 4,
214   GST_NAVIGATION_COMMAND_MENU5    = 5,
215   GST_NAVIGATION_COMMAND_MENU6    = 6,
216   GST_NAVIGATION_COMMAND_MENU7    = 7,
217
218   GST_NAVIGATION_COMMAND_LEFT     = 20,
219   GST_NAVIGATION_COMMAND_RIGHT    = 21,
220   GST_NAVIGATION_COMMAND_UP       = 22,
221   GST_NAVIGATION_COMMAND_DOWN     = 23,
222   GST_NAVIGATION_COMMAND_ACTIVATE = 24,
223
224   GST_NAVIGATION_COMMAND_PREV_ANGLE = 30,
225   GST_NAVIGATION_COMMAND_NEXT_ANGLE = 31
226 } GstNavigationCommand;
227 </pre>
228 <p>
229 A set of commands that may be issued to an element providing the
230 <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> interface. The available commands can be queried via
231 the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#gst-navigation-query-new-commands" title="gst_navigation_query_new_commands ()"><code class="function">gst_navigation_query_new_commands()</code></a> query.
232 </p>
233 <p>
234 For convenience in handling DVD navigation, the MENU commands are aliased as:
235    GST_NAVIGATION_COMMAND_DVD_MENU            = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU1</code></em>
236    GST_NAVIGATION_COMMAND_DVD_TITLE_MENU      = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU2</code></em>
237    GST_NAVIGATION_COMMAND_DVD_ROOT_MENU       = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU3</code></em>
238    GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU4</code></em>
239    GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU      = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU5</code></em>
240    GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU      = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU6</code></em>
241    GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU    = <em class="parameter"><code>GST_NAVIGATION_COMMAND_MENU7</code></em>
242 </p>
243 <div class="variablelist"><table border="0">
244 <col align="left" valign="top">
245 <tbody>
246 <tr>
247 <td><p><a name="GST-NAVIGATION-COMMAND-INVALID:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_INVALID</code></span></p></td>
248 <td>An invalid command entry
249 </td>
250 </tr>
251 <tr>
252 <td><p><a name="GST-NAVIGATION-COMMAND-MENU1:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_MENU1</code></span></p></td>
253 <td>Execute navigation menu command 1. For DVD,
254 this enters the DVD root menu, or exits back to the title from the menu.
255 </td>
256 </tr>
257 <tr>
258 <td><p><a name="GST-NAVIGATION-COMMAND-MENU2:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_MENU2</code></span></p></td>
259 <td>Execute navigation menu command 2. For DVD,
260 this jumps to the DVD title menu.
261 </td>
262 </tr>
263 <tr>
264 <td><p><a name="GST-NAVIGATION-COMMAND-MENU3:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_MENU3</code></span></p></td>
265 <td>Execute navigation menu command 3. For DVD,
266 this jumps into the DVD root menu.
267 </td>
268 </tr>
269 <tr>
270 <td><p><a name="GST-NAVIGATION-COMMAND-MENU4:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_MENU4</code></span></p></td>
271 <td>Execute navigation menu command 4. For DVD,
272 this jumps to the Subpicture menu.
273 </td>
274 </tr>
275 <tr>
276 <td><p><a name="GST-NAVIGATION-COMMAND-MENU5:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_MENU5</code></span></p></td>
277 <td>Execute navigation menu command 5. For DVD,
278 the jumps to the audio menu.
279 </td>
280 </tr>
281 <tr>
282 <td><p><a name="GST-NAVIGATION-COMMAND-MENU6:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_MENU6</code></span></p></td>
283 <td>Execute navigation menu command 6. For DVD,
284 this jumps to the angles menu.
285 </td>
286 </tr>
287 <tr>
288 <td><p><a name="GST-NAVIGATION-COMMAND-MENU7:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_MENU7</code></span></p></td>
289 <td>Execute navigation menu command 7. For DVD,
290 this jumps to the chapter menu.
291 </td>
292 </tr>
293 <tr>
294 <td><p><a name="GST-NAVIGATION-COMMAND-LEFT:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_LEFT</code></span></p></td>
295 <td>Select the next button to the left in a menu,
296 if such a button exists.
297 </td>
298 </tr>
299 <tr>
300 <td><p><a name="GST-NAVIGATION-COMMAND-RIGHT:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_RIGHT</code></span></p></td>
301 <td>Select the next button to the right in a menu,
302 if such a button exists.
303 </td>
304 </tr>
305 <tr>
306 <td><p><a name="GST-NAVIGATION-COMMAND-UP:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_UP</code></span></p></td>
307 <td>Select the button above the current one in a
308 menu, if such a button exists.
309 </td>
310 </tr>
311 <tr>
312 <td><p><a name="GST-NAVIGATION-COMMAND-DOWN:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_DOWN</code></span></p></td>
313 <td>Select the button below the current one in a
314 menu, if such a button exists.
315 </td>
316 </tr>
317 <tr>
318 <td><p><a name="GST-NAVIGATION-COMMAND-ACTIVATE:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_ACTIVATE</code></span></p></td>
319 <td>Activate (click) the currently selected
320 button in a menu, if such a button exists.
321 </td>
322 </tr>
323 <tr>
324 <td><p><a name="GST-NAVIGATION-COMMAND-PREV-ANGLE:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_PREV_ANGLE</code></span></p></td>
325 <td>Switch to the previous angle in a
326 multiangle feature.
327 </td>
328 </tr>
329 <tr>
330 <td><p><a name="GST-NAVIGATION-COMMAND-NEXT-ANGLE:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_COMMAND_NEXT_ANGLE</code></span></p></td>
331 <td>Switch to the next angle in a multiangle
332 feature.
333 </td>
334 </tr>
335 </tbody>
336 </table></div>
337 <p class="since">Since 0.10.23</p>
338 </div>
339 <hr>
340 <div class="refsect2">
341 <a name="GstNavigationEventType"></a><h3>enum GstNavigationEventType</h3>
342 <pre class="programlisting">typedef enum {
343   GST_NAVIGATION_EVENT_INVALID                    = 0,
344   GST_NAVIGATION_EVENT_KEY_PRESS                  = 1,
345   GST_NAVIGATION_EVENT_KEY_RELEASE                = 2,
346   GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS         = 3,
347   GST_NAVIGATION_EVENT_MOUSE_BUTTON_RELEASE       = 4,
348   GST_NAVIGATION_EVENT_MOUSE_MOVE                 = 5,
349   GST_NAVIGATION_EVENT_COMMAND                    = 6
350 } GstNavigationEventType;
351 </pre>
352 <p>
353 Enum values for the various events that an element implementing the
354 GstNavigation interface might send up the pipeline.
355 </p>
356 <div class="variablelist"><table border="0">
357 <col align="left" valign="top">
358 <tbody>
359 <tr>
360 <td><p><a name="GST-NAVIGATION-EVENT-INVALID:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_EVENT_INVALID</code></span></p></td>
361 <td>Returned from
362 <code class="function">gst_navigation_event_get_type()</code> when the passed event is not a navigation event.
363 </td>
364 </tr>
365 <tr>
366 <td><p><a name="GST-NAVIGATION-EVENT-KEY-PRESS:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_EVENT_KEY_PRESS</code></span></p></td>
367 <td>A key press event. Use
368 <a class="link" href="gst-plugins-base-libs-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.
369 </td>
370 </tr>
371 <tr>
372 <td><p><a name="GST-NAVIGATION-EVENT-KEY-RELEASE:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_EVENT_KEY_RELEASE</code></span></p></td>
373 <td>A key release event. Use
374 <a class="link" href="gst-plugins-base-libs-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.
375 </td>
376 </tr>
377 <tr>
378 <td><p><a name="GST-NAVIGATION-EVENT-MOUSE-BUTTON-PRESS:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS</code></span></p></td>
379 <td>A mouse button press event. Use
380 <a class="link" href="gst-plugins-base-libs-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
381 event.
382 </td>
383 </tr>
384 <tr>
385 <td><p><a name="GST-NAVIGATION-EVENT-MOUSE-BUTTON-RELEASE:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_EVENT_MOUSE_BUTTON_RELEASE</code></span></p></td>
386 <td>A mouse button release event. Use
387 <a class="link" href="gst-plugins-base-libs-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
388 event.
389 </td>
390 </tr>
391 <tr>
392 <td><p><a name="GST-NAVIGATION-EVENT-MOUSE-MOVE:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_EVENT_MOUSE_MOVE</code></span></p></td>
393 <td>A mouse movement event. Use
394 <a class="link" href="gst-plugins-base-libs-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
395 event.
396 </td>
397 </tr>
398 <tr>
399 <td><p><a name="GST-NAVIGATION-EVENT-COMMAND:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_EVENT_COMMAND</code></span></p></td>
400 <td>A navigation command event. Use
401 <a class="link" href="gst-plugins-base-libs-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.
402 </td>
403 </tr>
404 </tbody>
405 </table></div>
406 <p class="since">Since 0.10.23</p>
407 </div>
408 <hr>
409 <div class="refsect2">
410 <a name="GstNavigationMessageType"></a><h3>enum GstNavigationMessageType</h3>
411 <pre class="programlisting">typedef enum {
412   GST_NAVIGATION_MESSAGE_INVALID,
413   GST_NAVIGATION_MESSAGE_MOUSE_OVER,
414   GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED,
415   GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
416 } GstNavigationMessageType;
417 </pre>
418 <p>
419 A set of notifications that may be received on the bus when navigation
420 related status changes.
421 </p>
422 <div class="variablelist"><table border="0">
423 <col align="left" valign="top">
424 <tbody>
425 <tr>
426 <td><p><a name="GST-NAVIGATION-MESSAGE-INVALID:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_MESSAGE_INVALID</code></span></p></td>
427 <td>Returned from
428 <a class="link" href="gst-plugins-base-libs-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
429 navigation message.
430 </td>
431 </tr>
432 <tr>
433 <td><p><a name="GST-NAVIGATION-MESSAGE-MOUSE-OVER:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_MESSAGE_MOUSE_OVER</code></span></p></td>
434 <td>Sent when the mouse moves over or leaves a
435 clickable region of the output, such as a DVD menu button.
436 </td>
437 </tr>
438 <tr>
439 <td><p><a name="GST-NAVIGATION-MESSAGE-COMMANDS-CHANGED:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</code></span></p></td>
440 <td>Sent when the set of available commands
441 changes and should re-queried by interested applications.
442 </td>
443 </tr>
444 <tr>
445 <td><p><a name="GST-NAVIGATION-MESSAGE-ANGLES-CHANGED:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_MESSAGE_ANGLES_CHANGED</code></span></p></td>
446 <td>Sent when display angles in a multi-angle
447 feature (such as a multiangle DVD) change - either angles have appeared or
448 disappeared.
449 </td>
450 </tr>
451 </tbody>
452 </table></div>
453 <p class="since">Since 0.10.23</p>
454 </div>
455 <hr>
456 <div class="refsect2">
457 <a name="GstNavigationQueryType"></a><h3>enum GstNavigationQueryType</h3>
458 <pre class="programlisting">typedef enum {
459   GST_NAVIGATION_QUERY_INVALID     = 0,
460   GST_NAVIGATION_QUERY_COMMANDS    = 1,
461   GST_NAVIGATION_QUERY_ANGLES      = 2
462 } GstNavigationQueryType;
463 </pre>
464 <p>
465 Tyoes of navigation interface queries.
466 </p>
467 <div class="variablelist"><table border="0">
468 <col align="left" valign="top">
469 <tbody>
470 <tr>
471 <td><p><a name="GST-NAVIGATION-QUERY-INVALID:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_QUERY_INVALID</code></span></p></td>
472 <td>invalid query
473 </td>
474 </tr>
475 <tr>
476 <td><p><a name="GST-NAVIGATION-QUERY-COMMANDS:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_QUERY_COMMANDS</code></span></p></td>
477 <td>command query
478 </td>
479 </tr>
480 <tr>
481 <td><p><a name="GST-NAVIGATION-QUERY-ANGLES:CAPS"></a><span class="term"><code class="literal">GST_NAVIGATION_QUERY_ANGLES</code></span></p></td>
482 <td>viewing angle query
483 </td>
484 </tr>
485 </tbody>
486 </table></div>
487 </div>
488 <hr>
489 <div class="refsect2">
490 <a name="gst-navigation-send-event"></a><h3>gst_navigation_send_event ()</h3>
491 <pre class="programlisting"><span class="returnvalue">void</span>                gst_navigation_send_event           (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>,
492                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstStructure.html#GstStructure"><span class="type">GstStructure</span></a> *structure</code></em>);</pre>
493 </div>
494 <hr>
495 <div class="refsect2">
496 <a name="gst-navigation-send-key-event"></a><h3>gst_navigation_send_key_event ()</h3>
497 <pre class="programlisting"><span class="returnvalue">void</span>                gst_navigation_send_key_event       (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>,
498                                                          <em class="parameter"><code>const <span class="type">char</span> *event</code></em>,
499                                                          <em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
500 <div class="variablelist"><table border="0">
501 <col align="left" valign="top">
502 <tbody>
503 <tr>
504 <td><p><span class="term"><em class="parameter"><code>navigation</code></em> :</span></p></td>
505 <td>The navigation interface instance</td>
506 </tr>
507 <tr>
508 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
509 <td>The type of the key event. Recognised values are "key-press" and
510 "key-release"</td>
511 </tr>
512 <tr>
513 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
514 <td>Character representation of the key. This is typically as produced
515 by XKeysymToString.</td>
516 </tr>
517 </tbody>
518 </table></div>
519 </div>
520 <hr>
521 <div class="refsect2">
522 <a name="gst-navigation-send-mouse-event"></a><h3>gst_navigation_send_mouse_event ()</h3>
523 <pre class="programlisting"><span class="returnvalue">void</span>                gst_navigation_send_mouse_event     (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>,
524                                                          <em class="parameter"><code>const <span class="type">char</span> *event</code></em>,
525                                                          <em class="parameter"><code><span class="type">int</span> button</code></em>,
526                                                          <em class="parameter"><code><span class="type">double</span> x</code></em>,
527                                                          <em class="parameter"><code><span class="type">double</span> y</code></em>);</pre>
528 <p>
529 Sends a mouse event to the navigation interface. Mouse event coordinates
530 are sent relative to the display space of the related output area. This is
531 usually the size in pixels of the window associated with the element
532 implementing the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> interface.
533 </p>
534 <div class="variablelist"><table border="0">
535 <col align="left" valign="top">
536 <tbody>
537 <tr>
538 <td><p><span class="term"><em class="parameter"><code>navigation</code></em> :</span></p></td>
539 <td>The navigation interface instance</td>
540 </tr>
541 <tr>
542 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
543 <td>The type of mouse event, as a text string. Recognised values are
544 "mouse-button-press", "mouse-button-release" and "mouse-move".</td>
545 </tr>
546 <tr>
547 <td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
548 <td>The button number of the button being pressed or released. Pass 0
549 for mouse-move events.</td>
550 </tr>
551 <tr>
552 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
553 <td>The x coordinate of the mouse event.</td>
554 </tr>
555 <tr>
556 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
557 <td>The y coordinate of the mouse event.</td>
558 </tr>
559 </tbody>
560 </table></div>
561 </div>
562 <hr>
563 <div class="refsect2">
564 <a name="gst-navigation-send-command"></a><h3>gst_navigation_send_command ()</h3>
565 <pre class="programlisting"><span class="returnvalue">void</span>                gst_navigation_send_command         (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> *navigation</code></em>,
566                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> command</code></em>);</pre>
567 <p>
568 Sends the indicated command to the navigation interface.
569 </p>
570 <div class="variablelist"><table border="0">
571 <col align="left" valign="top">
572 <tbody>
573 <tr>
574 <td><p><span class="term"><em class="parameter"><code>navigation</code></em> :</span></p></td>
575 <td>The navigation interface instance</td>
576 </tr>
577 <tr>
578 <td><p><span class="term"><em class="parameter"><code>command</code></em> :</span></p></td>
579 <td>The command to issue</td>
580 </tr>
581 </tbody>
582 </table></div>
583 <p class="since">Since 0.10.23</p>
584 </div>
585 <hr>
586 <div class="refsect2">
587 <a name="gst-navigation-event-parse-command"></a><h3>gst_navigation_event_parse_command ()</h3>
588 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_event_parse_command  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
589                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *command</code></em>);</pre>
590 <p>
591 Inspect a <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> command event and retrieve the enum value of the
592 associated command.
593 </p>
594 <div class="variablelist"><table border="0">
595 <col align="left" valign="top">
596 <tbody>
597 <tr>
598 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
599 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> to inspect.</td>
600 </tr>
601 <tr>
602 <td><p><span class="term"><em class="parameter"><code>command</code></em> :</span></p></td>
603 <td>Pointer to GstNavigationCommand to receive the type of the
604 navigation event.</td>
605 </tr>
606 <tr>
607 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
608 <td>TRUE if the navigation command could be extracted, otherwise FALSE.</td>
609 </tr>
610 </tbody>
611 </table></div>
612 <p class="since">Since 0.10.23</p>
613 </div>
614 <hr>
615 <div class="refsect2">
616 <a name="gst-navigation-event-parse-key-event"></a><h3>gst_navigation_event_parse_key_event ()</h3>
617 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_event_parse_key_event
618                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
619                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **key</code></em>);</pre>
620 <div class="variablelist"><table border="0">
621 <col align="left" valign="top">
622 <tbody>
623 <tr>
624 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
625 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> to inspect.</td>
626 </tr>
627 <tr>
628 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
629 <td>A pointer to a location to receive the string identifying the key
630 press. The returned string is owned by the event, and valid only until the
631 event is unreffed.</td>
632 </tr>
633 </tbody>
634 </table></div>
635 <p class="since">Since 0.10.23</p>
636 </div>
637 <hr>
638 <div class="refsect2">
639 <a name="gst-navigation-event-parse-mouse-button-event"></a><h3>gst_navigation_event_parse_mouse_button_event ()</h3>
640 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_event_parse_mouse_button_event
641                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
642                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *button</code></em>,
643                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>,
644                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>);</pre>
645 <p>
646 Retrieve the details of either a <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> mouse button press event or
647 a mouse button release event. Determine which type the event is using
648 <code class="function">gst_navigation_event_get_type()</code> to retrieve the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationEventType" title="enum GstNavigationEventType"><span class="type">GstNavigationEventType</span></a>.
649 </p>
650 <div class="variablelist"><table border="0">
651 <col align="left" valign="top">
652 <tbody>
653 <tr>
654 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
655 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> to inspect.</td>
656 </tr>
657 <tr>
658 <td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
659 <td>Pointer to a gint that will receive the button number associated
660 with the event.</td>
661 </tr>
662 <tr>
663 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
664 <td>Pointer to a gdouble to receive the x coordinate of the mouse button
665 event.</td>
666 </tr>
667 <tr>
668 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
669 <td>Pointer to a gdouble to receive the y coordinate of the mouse button
670 event.</td>
671 </tr>
672 <tr>
673 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
674 <td>TRUE if the button number and both coordinates could be extracted,
675 otherwise FALSE.</td>
676 </tr>
677 </tbody>
678 </table></div>
679 <p class="since">Since 0.10.23</p>
680 </div>
681 <hr>
682 <div class="refsect2">
683 <a name="gst-navigation-event-parse-mouse-move-event"></a><h3>gst_navigation_event_parse_mouse_move_event ()</h3>
684 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_event_parse_mouse_move_event
685                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
686                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>,
687                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>);</pre>
688 <p>
689 Inspect a <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> mouse movement event and extract the coordinates
690 of the event.
691 </p>
692 <div class="variablelist"><table border="0">
693 <col align="left" valign="top">
694 <tbody>
695 <tr>
696 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
697 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> to inspect.</td>
698 </tr>
699 <tr>
700 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
701 <td>Pointer to a gdouble to receive the x coordinate of the mouse movement.</td>
702 </tr>
703 <tr>
704 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
705 <td>Pointer to a gdouble to receive the y coordinate of the mouse movement.</td>
706 </tr>
707 <tr>
708 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
709 <td>TRUE if both coordinates could be extracted, otherwise FALSE.</td>
710 </tr>
711 </tbody>
712 </table></div>
713 <p class="since">Since 0.10.23</p>
714 </div>
715 <hr>
716 <div class="refsect2">
717 <a name="gst-navigation-message-get-type"></a><h3>gst_navigation_message_get_type ()</h3>
718 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationMessageType" title="enum GstNavigationMessageType"><span class="returnvalue">GstNavigationMessageType</span></a> gst_navigation_message_get_type
719                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> *message</code></em>);</pre>
720 <p>
721 Check a bus message to see if it is a <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> event, and return
722 the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationMessageType" title="enum GstNavigationMessageType"><span class="type">GstNavigationMessageType</span></a> identifying the type of the message if so.
723 </p>
724 <div class="variablelist"><table border="0">
725 <col align="left" valign="top">
726 <tbody>
727 <tr>
728 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
729 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> to inspect.</td>
730 </tr>
731 <tr>
732 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
733 <td>The type of the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a>, or
734 <a class="link" href="gst-plugins-base-libs-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="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a>
735 notification.</td>
736 </tr>
737 </tbody>
738 </table></div>
739 <p class="since">Since 0.10.23</p>
740 </div>
741 <hr>
742 <div class="refsect2">
743 <a name="gst-navigation-message-new-angles-changed"></a><h3>gst_navigation_message_new_angles_changed ()</h3>
744 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="returnvalue">GstMessage</span></a> *        gst_navigation_message_new_angles_changed
745                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> *src</code></em>,
746                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> cur_angle</code></em>,
747                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_angles</code></em>);</pre>
748 <p>
749 Creates a new <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> message with type
750 <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-MESSAGE-ANGLES-CHANGED:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_ANGLES_CHANGED</span></a> for notifying an application
751 that the current angle, or current number of angles available in a
752 multiangle video has changed.
753 </p>
754 <div class="variablelist"><table border="0">
755 <col align="left" valign="top">
756 <tbody>
757 <tr>
758 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
759 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> to set as source of the new message.</td>
760 </tr>
761 <tr>
762 <td><p><span class="term"><em class="parameter"><code>cur_angle</code></em> :</span></p></td>
763 <td>The currently selected angle.</td>
764 </tr>
765 <tr>
766 <td><p><span class="term"><em class="parameter"><code>n_angles</code></em> :</span></p></td>
767 <td>The number of viewing angles now available.</td>
768 </tr>
769 <tr>
770 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
771 <td>The new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a>.</td>
772 </tr>
773 </tbody>
774 </table></div>
775 <p class="since">Since 0.10.23</p>
776 </div>
777 <hr>
778 <div class="refsect2">
779 <a name="gst-navigation-message-new-commands-changed"></a><h3>gst_navigation_message_new_commands_changed ()</h3>
780 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="returnvalue">GstMessage</span></a> *        gst_navigation_message_new_commands_changed
781                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> *src</code></em>);</pre>
782 <p>
783 Creates a new <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> message with type
784 <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-MESSAGE-COMMANDS-CHANGED:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</span></a>
785 </p>
786 <div class="variablelist"><table border="0">
787 <col align="left" valign="top">
788 <tbody>
789 <tr>
790 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
791 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> to set as source of the new message.</td>
792 </tr>
793 <tr>
794 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
795 <td>The new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a>.</td>
796 </tr>
797 </tbody>
798 </table></div>
799 <p class="since">Since 0.10.23</p>
800 </div>
801 <hr>
802 <div class="refsect2">
803 <a name="gst-navigation-message-new-mouse-over"></a><h3>gst_navigation_message_new_mouse_over ()</h3>
804 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="returnvalue">GstMessage</span></a> *        gst_navigation_message_new_mouse_over
805                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> *src</code></em>,
806                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> active</code></em>);</pre>
807 <p>
808 Creates a new <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> message with type
809 <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-MESSAGE-MOUSE-OVER:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_MOUSE_OVER</span></a>.
810 </p>
811 <div class="variablelist"><table border="0">
812 <col align="left" valign="top">
813 <tbody>
814 <tr>
815 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
816 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html"><span class="type">GstObject</span></a> to set as source of the new message.</td>
817 </tr>
818 <tr>
819 <td><p><span class="term"><em class="parameter"><code>active</code></em> :</span></p></td>
820 <td>
821 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the mouse has entered a clickable area of the display.
822 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it over a non-clickable area.</td>
823 </tr>
824 <tr>
825 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
826 <td>The new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a>.</td>
827 </tr>
828 </tbody>
829 </table></div>
830 <p class="since">Since 0.10.23</p>
831 </div>
832 <hr>
833 <div class="refsect2">
834 <a name="gst-navigation-message-parse-mouse-over"></a><h3>gst_navigation_message_parse_mouse_over ()</h3>
835 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_message_parse_mouse_over
836                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> *message</code></em>,
837                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *active</code></em>);</pre>
838 <p>
839 Parse a <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> message of type <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-MESSAGE-MOUSE-OVER:CAPS"><span class="type">GST_NAVIGATION_MESSAGE_MOUSE_OVER</span></a>
840 and extract the active/inactive flag. If the mouse over event is marked
841 active, it indicates that the mouse is over a clickable area.
842 </p>
843 <div class="variablelist"><table border="0">
844 <col align="left" valign="top">
845 <tbody>
846 <tr>
847 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
848 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> to inspect.</td>
849 </tr>
850 <tr>
851 <td><p><span class="term"><em class="parameter"><code>active</code></em> :</span></p></td>
852 <td>A pointer to a gboolean to receive the active/inactive state,
853 or NULL.</td>
854 </tr>
855 <tr>
856 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
857 <td>
858 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the message could be successfully parsed. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</td>
859 </tr>
860 </tbody>
861 </table></div>
862 <p class="since">Since 0.10.23</p>
863 </div>
864 <hr>
865 <div class="refsect2">
866 <a name="gst-navigation-message-parse-angles-changed"></a><h3>gst_navigation_message_parse_angles_changed ()</h3>
867 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_message_parse_angles_changed
868                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> *message</code></em>,
869                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *cur_angle</code></em>,
870                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_angles</code></em>);</pre>
871 <p>
872 Parse a <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
873 and extract the <em class="parameter"><code>cur_angle</code></em> and <em class="parameter"><code>n_angles</code></em> parameters.
874 </p>
875 <div class="variablelist"><table border="0">
876 <col align="left" valign="top">
877 <tbody>
878 <tr>
879 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
880 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> to inspect.</td>
881 </tr>
882 <tr>
883 <td><p><span class="term"><em class="parameter"><code>cur_angle</code></em> :</span></p></td>
884 <td>A pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> to receive the new current angle number,
885 or NULL</td>
886 </tr>
887 <tr>
888 <td><p><span class="term"><em class="parameter"><code>n_angles</code></em> :</span></p></td>
889 <td>A pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> to receive the new angle count, or NULL.</td>
890 </tr>
891 <tr>
892 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
893 <td>
894 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the message could be successfully parsed. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</td>
895 </tr>
896 </tbody>
897 </table></div>
898 <p class="since">Since 0.10.23</p>
899 </div>
900 <hr>
901 <div class="refsect2">
902 <a name="gst-navigation-query-new-angles"></a><h3>gst_navigation_query_new_angles ()</h3>
903 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="returnvalue">GstQuery</span></a> *          gst_navigation_query_new_angles     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
904 <p>
905 Create a new <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> angles query. When executed, it will
906 query the pipeline for the set of currently available angles, which may be
907 greater than one in a multiangle video.
908 </p>
909 <div class="variablelist"><table border="0">
910 <col align="left" valign="top">
911 <tbody><tr>
912 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
913 <td>The new query.</td>
914 </tr></tbody>
915 </table></div>
916 <p class="since">Since 0.10.23</p>
917 </div>
918 <hr>
919 <div class="refsect2">
920 <a name="gst-navigation-query-get-type"></a><h3>gst_navigation_query_get_type ()</h3>
921 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType"><span class="returnvalue">GstNavigationQueryType</span></a> gst_navigation_query_get_type    (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>);</pre>
922 <p>
923 Inspect a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> and return the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType"><span class="type">GstNavigationQueryType</span></a> associated with
924 it if it is a <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> query.
925 </p>
926 <div class="variablelist"><table border="0">
927 <col align="left" valign="top">
928 <tbody>
929 <tr>
930 <td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
931 <td>The query to inspect</td>
932 </tr>
933 <tr>
934 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
935 <td>The <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationQueryType" title="enum GstNavigationQueryType"><span class="type">GstNavigationQueryType</span></a> of the query, or
936 <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-QUERY-INVALID:CAPS"><span class="type">GST_NAVIGATION_QUERY_INVALID</span></a>
937 </td>
938 </tr>
939 </tbody>
940 </table></div>
941 <p class="since">Since 0.10.23</p>
942 </div>
943 <hr>
944 <div class="refsect2">
945 <a name="gst-navigation-query-new-commands"></a><h3>gst_navigation_query_new_commands ()</h3>
946 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="returnvalue">GstQuery</span></a> *          gst_navigation_query_new_commands   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
947 <p>
948 Create a new <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> commands query. When executed, it will
949 query the pipeline for the set of currently available commands.
950 </p>
951 <div class="variablelist"><table border="0">
952 <col align="left" valign="top">
953 <tbody><tr>
954 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
955 <td>The new query.</td>
956 </tr></tbody>
957 </table></div>
958 <p class="since">Since 0.10.23</p>
959 </div>
960 <hr>
961 <div class="refsect2">
962 <a name="gst-navigation-query-parse-angles"></a><h3>gst_navigation_query_parse_angles ()</h3>
963 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_query_parse_angles   (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
964                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *cur_angle</code></em>,
965                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_angles</code></em>);</pre>
966 <p>
967 Parse the current angle number in the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> angles <em class="parameter"><code>query</code></em> into the
968 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> pointed to by the <em class="parameter"><code>cur_angle</code></em> variable, and the number of available
969 angles into the <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> pointed to by the <em class="parameter"><code>n_angles</code></em> variable.
970 </p>
971 <div class="variablelist"><table border="0">
972 <col align="left" valign="top">
973 <tbody>
974 <tr>
975 <td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
976 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a>
977 </td>
978 </tr>
979 <tr>
980 <td><p><span class="term"><em class="parameter"><code>cur_angle</code></em> :</span></p></td>
981 <td>Pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> into which to store the currently selected
982 angle value from the query, or NULL</td>
983 </tr>
984 <tr>
985 <td><p><span class="term"><em class="parameter"><code>n_angles</code></em> :</span></p></td>
986 <td>Pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> into which to store the number of angles
987 value from the query, or NULL</td>
988 </tr>
989 <tr>
990 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
991 <td>
992 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the query could be successfully parsed. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</td>
993 </tr>
994 </tbody>
995 </table></div>
996 <p class="since">Since 0.10.23</p>
997 </div>
998 <hr>
999 <div class="refsect2">
1000 <a name="gst-navigation-query-parse-commands-length"></a><h3>gst_navigation_query_parse_commands_length ()</h3>
1001 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_query_parse_commands_length
1002                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
1003                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *n_cmds</code></em>);</pre>
1004 <p>
1005 Parse the number of commands in the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> commands <em class="parameter"><code>query</code></em>.
1006 </p>
1007 <div class="variablelist"><table border="0">
1008 <col align="left" valign="top">
1009 <tbody>
1010 <tr>
1011 <td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
1012 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a>
1013 </td>
1014 </tr>
1015 <tr>
1016 <td><p><span class="term"><em class="parameter"><code>n_cmds</code></em> :</span></p></td>
1017 <td>the number of commands in this query.</td>
1018 </tr>
1019 <tr>
1020 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1021 <td>
1022 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the query could be successfully parsed. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</td>
1023 </tr>
1024 </tbody>
1025 </table></div>
1026 <p class="since">Since 0.10.23</p>
1027 </div>
1028 <hr>
1029 <div class="refsect2">
1030 <a name="gst-navigation-query-parse-commands-nth"></a><h3>gst_navigation_query_parse_commands_nth ()</h3>
1031 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_navigation_query_parse_commands_nth
1032                                                         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
1033                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nth</code></em>,
1034                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *cmd</code></em>);</pre>
1035 <p>
1036 Parse the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> command query and retrieve the <em class="parameter"><code>nth</code></em> command from
1037 it into <em class="parameter"><code>cmd</code></em>. If the list contains less elements than <em class="parameter"><code>nth</code></em>, <em class="parameter"><code>cmd</code></em> will be
1038 set to <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GST-NAVIGATION-COMMAND-INVALID:CAPS"><span class="type">GST_NAVIGATION_COMMAND_INVALID</span></a>.
1039 </p>
1040 <div class="variablelist"><table border="0">
1041 <col align="left" valign="top">
1042 <tbody>
1043 <tr>
1044 <td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
1045 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a>
1046 </td>
1047 </tr>
1048 <tr>
1049 <td><p><span class="term"><em class="parameter"><code>nth</code></em> :</span></p></td>
1050 <td>the nth command to retrieve.</td>
1051 </tr>
1052 <tr>
1053 <td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
1054 <td>a pointer to store the nth command into.</td>
1055 </tr>
1056 <tr>
1057 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1058 <td>
1059 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the query could be successfully parsed. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</td>
1060 </tr>
1061 </tbody>
1062 </table></div>
1063 <p class="since">Since 0.10.23</p>
1064 </div>
1065 <hr>
1066 <div class="refsect2">
1067 <a name="gst-navigation-query-set-angles"></a><h3>gst_navigation_query_set_angles ()</h3>
1068 <pre class="programlisting"><span class="returnvalue">void</span>                gst_navigation_query_set_angles     (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
1069                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> cur_angle</code></em>,
1070                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_angles</code></em>);</pre>
1071 <p>
1072 Set the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> angles query result field in <em class="parameter"><code>query</code></em>.
1073 </p>
1074 <div class="variablelist"><table border="0">
1075 <col align="left" valign="top">
1076 <tbody>
1077 <tr>
1078 <td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
1079 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a>
1080 </td>
1081 </tr>
1082 <tr>
1083 <td><p><span class="term"><em class="parameter"><code>cur_angle</code></em> :</span></p></td>
1084 <td>the current viewing angle to set.</td>
1085 </tr>
1086 <tr>
1087 <td><p><span class="term"><em class="parameter"><code>n_angles</code></em> :</span></p></td>
1088 <td>the number of viewing angles to set.</td>
1089 </tr>
1090 </tbody>
1091 </table></div>
1092 <p class="since">Since 0.10.23</p>
1093 </div>
1094 <hr>
1095 <div class="refsect2">
1096 <a name="gst-navigation-query-set-commands"></a><h3>gst_navigation_query_set_commands ()</h3>
1097 <pre class="programlisting"><span class="returnvalue">void</span>                gst_navigation_query_set_commands   (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
1098                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cmds</code></em>,
1099                                                          <em class="parameter"><code>...</code></em>);</pre>
1100 <p>
1101 Set the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> command query result fields in <em class="parameter"><code>query</code></em>. The number
1102 of commands passed must be equal to <em class="parameter"><code>n_commands</code></em>.
1103 </p>
1104 <div class="variablelist"><table border="0">
1105 <col align="left" valign="top">
1106 <tbody>
1107 <tr>
1108 <td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
1109 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a>
1110 </td>
1111 </tr>
1112 <tr>
1113 <td><p><span class="term"><em class="parameter"><code>n_cmds</code></em> :</span></p></td>
1114 <td>the number of commands to set.</td>
1115 </tr>
1116 <tr>
1117 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1118 <td>A list of <em class="parameter"><code>GstNavigationCommand</code></em> values, <em class="parameter"><code>n_cmds</code></em> entries long.</td>
1119 </tr>
1120 </tbody>
1121 </table></div>
1122 <p class="since">Since 0.10.23</p>
1123 </div>
1124 <hr>
1125 <div class="refsect2">
1126 <a name="gst-navigation-query-set-commandsv"></a><h3>gst_navigation_query_set_commandsv ()</h3>
1127 <pre class="programlisting"><span class="returnvalue">void</span>                gst_navigation_query_set_commandsv  (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a> *query</code></em>,
1128                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cmds</code></em>,
1129                                                          <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigationCommand" title="enum GstNavigationCommand"><span class="type">GstNavigationCommand</span></a> *cmds</code></em>);</pre>
1130 <p>
1131 Set the <a class="link" href="gst-plugins-base-libs-gstnavigation.html#GstNavigation"><span class="type">GstNavigation</span></a> command query result fields in <em class="parameter"><code>query</code></em>. The number
1132 of commands passed must be equal to <em class="parameter"><code>n_commands</code></em>.
1133 </p>
1134 <div class="variablelist"><table border="0">
1135 <col align="left" valign="top">
1136 <tbody>
1137 <tr>
1138 <td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td>
1139 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstQuery.html#GstQuery"><span class="type">GstQuery</span></a>
1140 </td>
1141 </tr>
1142 <tr>
1143 <td><p><span class="term"><em class="parameter"><code>n_cmds</code></em> :</span></p></td>
1144 <td>the number of commands to set.</td>
1145 </tr>
1146 <tr>
1147 <td><p><span class="term"><em class="parameter"><code>cmds</code></em> :</span></p></td>
1148 <td>An array containing <em class="parameter"><code>n_cmds</code></em> <em class="parameter"><code>GstNavigationCommand</code></em> values.</td>
1149 </tr>
1150 </tbody>
1151 </table></div>
1152 <p class="since">Since 0.10.23</p>
1153 </div>
1154 <hr>
1155 <div class="refsect2">
1156 <a name="GST-NAVIGATION-COMMAND-DVD-ANGLE-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU</h3>
1157 <pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU      GST_NAVIGATION_COMMAND_MENU6
1158 </pre>
1159 </div>
1160 <hr>
1161 <div class="refsect2">
1162 <a name="GST-NAVIGATION-COMMAND-DVD-AUDIO-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU</h3>
1163 <pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU      GST_NAVIGATION_COMMAND_MENU5
1164 </pre>
1165 </div>
1166 <hr>
1167 <div class="refsect2">
1168 <a name="GST-NAVIGATION-COMMAND-DVD-CHAPTER-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU</h3>
1169 <pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU    GST_NAVIGATION_COMMAND_MENU7
1170 </pre>
1171 </div>
1172 <hr>
1173 <div class="refsect2">
1174 <a name="GST-NAVIGATION-COMMAND-DVD-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_MENU</h3>
1175 <pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_MENU            GST_NAVIGATION_COMMAND_MENU1
1176 </pre>
1177 </div>
1178 <hr>
1179 <div class="refsect2">
1180 <a name="GST-NAVIGATION-COMMAND-DVD-ROOT-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_ROOT_MENU</h3>
1181 <pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_ROOT_MENU       GST_NAVIGATION_COMMAND_MENU3
1182 </pre>
1183 </div>
1184 <hr>
1185 <div class="refsect2">
1186 <a name="GST-NAVIGATION-COMMAND-DVD-SUBPICTURE-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU</h3>
1187 <pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU GST_NAVIGATION_COMMAND_MENU4
1188 </pre>
1189 </div>
1190 <hr>
1191 <div class="refsect2">
1192 <a name="GST-NAVIGATION-COMMAND-DVD-TITLE-MENU:CAPS"></a><h3>GST_NAVIGATION_COMMAND_DVD_TITLE_MENU</h3>
1193 <pre class="programlisting">#define GST_NAVIGATION_COMMAND_DVD_TITLE_MENU      GST_NAVIGATION_COMMAND_MENU2
1194 </pre>
1195 </div>
1196 </div>
1197 </div>
1198 <div class="footer">
1199 <hr>
1200           Generated by GTK-Doc V1.18</div>
1201 </body>
1202 </html>