blob: 557c3ef5bc59a68048618bba121c6b472705b5ef [file] [log] [blame]
Sebastian Dröge242f5962015-12-24 14:18:20 +01001<!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>gstplayer-visualization: GStreamer Bad Plugins 1.0 Library Reference Manual</title>
Sebastian Dröge3cc648b2016-02-19 11:22:31 +02006<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Sebastian Dröge242f5962015-12-24 14:18:20 +01007<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Library Reference Manual">
8<link rel="up" href="player.html" title="Player Library">
9<link rel="prev" href="gst-plugins-bad-libs-gstplayer-videooverlayvideorenderer.html" title="gstplayer-videooverlayvideorenderer">
10<link rel="next" href="ch08.html" title="Interfaces">
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +020011<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
Sebastian Dröge242f5962015-12-24 14:18:20 +010012<link rel="stylesheet" href="style.css" type="text/css">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gst-plugins-bad-libs-gstplayer-visualization.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#gst-plugins-bad-libs-gstplayer-visualization.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
20</td>
21<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22<td><a accesskey="u" href="player.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23<td><a accesskey="p" href="gst-plugins-bad-libs-gstplayer-videooverlayvideorenderer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24<td><a accesskey="n" href="ch08.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25</tr></table>
26<div class="refentry">
27<a name="gst-plugins-bad-libs-gstplayer-visualization"></a><div class="titlepage"></div>
28<div class="refnamediv"><table width="100%"><tr>
29<td valign="top">
30<h2><span class="refentrytitle"><a name="gst-plugins-bad-libs-gstplayer-visualization.top_of_page"></a>gstplayer-visualization</span></h2>
Sebastian Drögeaa6ed842016-09-01 12:09:11 +030031<p>gstplayer-visualization — Player Visualization</p>
Sebastian Dröge242f5962015-12-24 14:18:20 +010032</td>
33<td class="gallery_image" valign="top" align="right"></td>
34</tr></table></div>
35<div class="refsect1">
36<a name="gst-plugins-bad-libs-gstplayer-visualization.functions"></a><h2>Functions</h2>
Sebastian Dröge3cc648b2016-02-19 11:22:31 +020037<div class="informaltable"><table class="informaltable" width="100%" border="0">
Sebastian Dröge242f5962015-12-24 14:18:20 +010038<colgroup>
39<col width="150px" class="functions_return">
40<col class="functions_name">
41</colgroup>
42<tbody>
43<tr>
44<td class="function_type">
45<a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="returnvalue">GstPlayerVisualization</span></a> **
46</td>
47<td class="function_name">
48<a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#gst-player-visualizations-get" title="gst_player_visualizations_get ()">gst_player_visualizations_get</a> <span class="c_punctuation">()</span>
49</td>
50</tr>
51<tr>
52<td class="function_type">
53<span class="returnvalue">void</span>
54</td>
55<td class="function_name">
56<a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#gst-player-visualizations-free" title="gst_player_visualizations_free ()">gst_player_visualizations_free</a> <span class="c_punctuation">()</span>
57</td>
58</tr>
59<tr>
60<td class="function_type">
61<a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="returnvalue">GstPlayerVisualization</span></a> *
62</td>
63<td class="function_name">
64<a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#gst-player-visualization-copy" title="gst_player_visualization_copy ()">gst_player_visualization_copy</a> <span class="c_punctuation">()</span>
65</td>
66</tr>
67<tr>
68<td class="function_type">
69<span class="returnvalue">void</span>
70</td>
71<td class="function_name">
72<a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#gst-player-visualization-free" title="gst_player_visualization_free ()">gst_player_visualization_free</a> <span class="c_punctuation">()</span>
73</td>
74</tr>
75</tbody>
76</table></div>
77</div>
78<a name="GstPlayerVisualization"></a><div class="refsect1">
79<a name="gst-plugins-bad-libs-gstplayer-visualization.other"></a><h2>Types and Values</h2>
Sebastian Dröge3cc648b2016-02-19 11:22:31 +020080<div class="informaltable"><table class="informaltable" width="100%" border="0">
Sebastian Dröge242f5962015-12-24 14:18:20 +010081<colgroup>
82<col width="150px" class="name">
83<col class="description">
84</colgroup>
85<tbody><tr>
86<td class="datatype_keyword">struct</td>
87<td class="function_name"><a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization-struct" title="struct GstPlayerVisualization">GstPlayerVisualization</a></td>
88</tr></tbody>
89</table></div>
90</div>
91<div class="refsect1">
92<a name="gst-plugins-bad-libs-gstplayer-visualization.object-hierarchy"></a><h2>Object Hierarchy</h2>
93<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-Boxed-Types.html">GBoxed</a>
94 <span class="lineart">╰──</span> GstPlayerVisualization
95</pre>
96</div>
97<div class="refsect1">
98<a name="gst-plugins-bad-libs-gstplayer-visualization.description"></a><h2>Description</h2>
99</div>
100<div class="refsect1">
101<a name="gst-plugins-bad-libs-gstplayer-visualization.functions_details"></a><h2>Functions</h2>
102<div class="refsect2">
103<a name="gst-player-visualizations-get"></a><h3>gst_player_visualizations_get ()</h3>
104<pre class="programlisting"><a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="returnvalue">GstPlayerVisualization</span></a> **
105gst_player_visualizations_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300106<div class="refsect3">
107<a name="gst-player-visualizations-get.returns"></a><h4>Returns</h4>
108<p> a <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array containing all available
109visualizations. Use <a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#gst-player-visualizations-free" title="gst_player_visualizations_free ()"><code class="function">gst_player_visualizations_free()</code></a> after
110usage. </p>
111<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GstPlayerVisualization]</span></p>
112</div>
Sebastian Dröge242f5962015-12-24 14:18:20 +0100113</div>
114<hr>
115<div class="refsect2">
116<a name="gst-player-visualizations-free"></a><h3>gst_player_visualizations_free ()</h3>
117<pre class="programlisting"><span class="returnvalue">void</span>
118gst_player_visualizations_free (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> **viss</code></em>);</pre>
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300119<p>Frees a <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of <a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a>.</p>
120<div class="refsect3">
121<a name="gst-player-visualizations-free.parameters"></a><h4>Parameters</h4>
122<div class="informaltable"><table class="informaltable" width="100%" border="0">
123<colgroup>
124<col width="150px" class="parameters_name">
125<col class="parameters_description">
126<col width="200px" class="parameters_annotations">
127</colgroup>
128<tbody><tr>
129<td class="parameter_name"><p>viss</p></td>
130<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of <a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> to free</p></td>
131<td class="parameter_annotations"> </td>
132</tr></tbody>
133</table></div>
134</div>
Sebastian Dröge242f5962015-12-24 14:18:20 +0100135</div>
136<hr>
137<div class="refsect2">
138<a name="gst-player-visualization-copy"></a><h3>gst_player_visualization_copy ()</h3>
139<pre class="programlisting"><a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="returnvalue">GstPlayerVisualization</span></a> *
140gst_player_visualization_copy (<em class="parameter"><code>const <a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> *vis</code></em>);</pre>
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300141<p>Makes a copy of the <a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a>. The result must be
142freed using <a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#gst-player-visualization-free" title="gst_player_visualization_free ()"><code class="function">gst_player_visualization_free()</code></a>.</p>
143<div class="refsect3">
144<a name="gst-player-visualization-copy.parameters"></a><h4>Parameters</h4>
145<div class="informaltable"><table class="informaltable" width="100%" border="0">
146<colgroup>
147<col width="150px" class="parameters_name">
148<col class="parameters_description">
149<col width="200px" class="parameters_annotations">
150</colgroup>
151<tbody><tr>
152<td class="parameter_name"><p>vis</p></td>
153<td class="parameter_description"><p><a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> instance</p></td>
154<td class="parameter_annotations"> </td>
155</tr></tbody>
156</table></div>
157</div>
158<div class="refsect3">
159<a name="gst-player-visualization-copy.returns"></a><h4>Returns</h4>
160<p> an allocated copy of <em class="parameter"><code>vis</code></em>
161. </p>
162<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
163</div>
Sebastian Dröge242f5962015-12-24 14:18:20 +0100164</div>
165<hr>
166<div class="refsect2">
167<a name="gst-player-visualization-free"></a><h3>gst_player_visualization_free ()</h3>
168<pre class="programlisting"><span class="returnvalue">void</span>
169gst_player_visualization_free (<em class="parameter"><code><a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> *vis</code></em>);</pre>
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300170<p>Frees a <a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a>.</p>
171<div class="refsect3">
172<a name="gst-player-visualization-free.parameters"></a><h4>Parameters</h4>
173<div class="informaltable"><table class="informaltable" width="100%" border="0">
174<colgroup>
175<col width="150px" class="parameters_name">
176<col class="parameters_description">
177<col width="200px" class="parameters_annotations">
178</colgroup>
179<tbody><tr>
180<td class="parameter_name"><p>vis</p></td>
181<td class="parameter_description"><p><a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> instance</p></td>
182<td class="parameter_annotations"> </td>
183</tr></tbody>
184</table></div>
185</div>
Sebastian Dröge242f5962015-12-24 14:18:20 +0100186</div>
187</div>
188<div class="refsect1">
189<a name="gst-plugins-bad-libs-gstplayer-visualization.other_details"></a><h2>Types and Values</h2>
190<div class="refsect2">
191<a name="GstPlayerVisualization-struct"></a><h3>struct GstPlayerVisualization</h3>
192<pre class="programlisting">struct GstPlayerVisualization {
193 gchar *name;
194 gchar *description;
195};
196</pre>
Sebastian Drögeaa6ed842016-09-01 12:09:11 +0300197<p>A <a class="link" href="gst-plugins-bad-libs-gstplayer-visualization.html#GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> descriptor.</p>
198<div class="refsect3">
199<a name="GstPlayerVisualization.members"></a><h4>Members</h4>
200<div class="informaltable"><table class="informaltable" width="100%" border="0">
201<colgroup>
202<col width="300px" class="struct_members_name">
203<col class="struct_members_description">
204<col width="200px" class="struct_members_annotations">
205</colgroup>
206<tbody>
207<tr>
208<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstPlayerVisualization-struct.name"></a>name</code></em>;</p></td>
209<td class="struct_member_description"><p>name of the visualization.</p></td>
210<td class="struct_member_annotations"> </td>
211</tr>
212<tr>
213<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstPlayerVisualization-struct.description"></a>description</code></em>;</p></td>
214<td class="struct_member_description"><p>description of the visualization.</p></td>
215<td class="struct_member_annotations"> </td>
216</tr>
217</tbody>
218</table></div>
219</div>
Sebastian Dröge242f5962015-12-24 14:18:20 +0100220</div>
221</div>
222</div>
223<div class="footer">
Sebastian Dröge8fbe98d2016-03-24 12:31:05 +0200224<hr>Generated by GTK-Doc V1.25</div>
Sebastian Dröge242f5962015-12-24 14:18:20 +0100225</body>
226</html>