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>GstPlayerVisualization: GStreamer Bad Plugins 1.0 Library Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Library Reference Manual"> 8<link rel="up" href="player.html" title="Player Library"> 9<link rel="prev" href="GstPlayerVideoOverlayVideoRenderer.html" title="GstPlayerVideoOverlayVideoRenderer"> 10<link rel="next" href="webrtc.html" title="WebRTC Library"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#GstPlayerVisualization.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#GstPlayerVisualization.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="GstPlayerVideoOverlayVideoRenderer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 24<td><a accesskey="n" href="webrtc.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="GstPlayerVisualization"></a><div class="titlepage"></div> 28<div class="refnamediv"><table width="100%"><tr> 29<td valign="top"> 30<h2><span class="refentrytitle"><a name="GstPlayerVisualization.top_of_page"></a>GstPlayerVisualization</span></h2> 31<p>GstPlayerVisualization — Player Visualization</p> 32</td> 33<td class="gallery_image" valign="top" align="right"></td> 34</tr></table></div> 35<div class="refsect1"> 36<a name="GstPlayerVisualization.functions"></a><h2>Functions</h2> 37<div class="informaltable"><table class="informaltable" width="100%" border="0"> 38<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="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="returnvalue">GstPlayerVisualization</span></a> ** 46</td> 47<td class="function_name"> 48<a class="link" href="GstPlayerVisualization.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="GstPlayerVisualization.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="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="returnvalue">GstPlayerVisualization</span></a> * 62</td> 63<td class="function_name"> 64<a class="link" href="GstPlayerVisualization.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="GstPlayerVisualization.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<div class="refsect1"> 79<a name="GstPlayerVisualization.other"></a><h2>Types and Values</h2> 80<div class="informaltable"><table class="informaltable" width="100%" border="0"> 81<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="GstPlayerVisualization.html#GstPlayerVisualization-struct" title="struct GstPlayerVisualization">GstPlayerVisualization</a></td> 88</tr></tbody> 89</table></div> 90</div> 91<div class="refsect1"> 92<a name="GstPlayerVisualization.object-hierarchy"></a><h2>Object Hierarchy</h2> 93<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> 94 <span class="lineart">╰──</span> GstPlayerVisualization 95</pre> 96</div> 97<div class="refsect1"> 98<a name="GstPlayerVisualization.includes"></a><h2>Includes</h2> 99<pre class="synopsis">#include <gst/codecparsers/gstmpeg4parser.h> 100</pre> 101</div> 102<div class="refsect1"> 103<a name="GstPlayerVisualization.description"></a><h2>Description</h2> 104</div> 105<div class="refsect1"> 106<a name="GstPlayerVisualization.functions_details"></a><h2>Functions</h2> 107<div class="refsect2"> 108<a name="gst-player-visualizations-get"></a><h3>gst_player_visualizations_get ()</h3> 109<pre class="programlisting"><a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="returnvalue">GstPlayerVisualization</span></a> ** 110gst_player_visualizations_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> 111<div class="refsect3"> 112<a name="gst-player-visualizations-get.returns"></a><h4>Returns</h4> 113<p>a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array containing all available 114visualizations. Use <a class="link" href="GstPlayerVisualization.html#gst-player-visualizations-free" title="gst_player_visualizations_free ()"><code class="function">gst_player_visualizations_free()</code></a> after 115usage. </p> 116<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> 117</div> 118</div> 119<hr> 120<div class="refsect2"> 121<a name="gst-player-visualizations-free"></a><h3>gst_player_visualizations_free ()</h3> 122<pre class="programlisting"><span class="returnvalue">void</span> 123gst_player_visualizations_free (<em class="parameter"><code><a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> **viss</code></em>);</pre> 124<p>Frees a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of <a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a>.</p> 125<div class="refsect3"> 126<a name="gst-player-visualizations-free.parameters"></a><h4>Parameters</h4> 127<div class="informaltable"><table class="informaltable" width="100%" border="0"> 128<colgroup> 129<col width="150px" class="parameters_name"> 130<col class="parameters_description"> 131<col width="200px" class="parameters_annotations"> 132</colgroup> 133<tbody><tr> 134<td class="parameter_name"><p>viss</p></td> 135<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of <a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> to free</p></td> 136<td class="parameter_annotations"> </td> 137</tr></tbody> 138</table></div> 139</div> 140</div> 141<hr> 142<div class="refsect2"> 143<a name="gst-player-visualization-copy"></a><h3>gst_player_visualization_copy ()</h3> 144<pre class="programlisting"><a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="returnvalue">GstPlayerVisualization</span></a> * 145gst_player_visualization_copy (<em class="parameter"><code>const <a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> *vis</code></em>);</pre> 146<p>Makes a copy of the <a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a>. The result must be 147freed using <a class="link" href="GstPlayerVisualization.html#gst-player-visualization-free" title="gst_player_visualization_free ()"><code class="function">gst_player_visualization_free()</code></a>.</p> 148<div class="refsect3"> 149<a name="gst-player-visualization-copy.parameters"></a><h4>Parameters</h4> 150<div class="informaltable"><table class="informaltable" width="100%" border="0"> 151<colgroup> 152<col width="150px" class="parameters_name"> 153<col class="parameters_description"> 154<col width="200px" class="parameters_annotations"> 155</colgroup> 156<tbody><tr> 157<td class="parameter_name"><p>vis</p></td> 158<td class="parameter_description"><p><a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> instance</p></td> 159<td class="parameter_annotations"> </td> 160</tr></tbody> 161</table></div> 162</div> 163<div class="refsect3"> 164<a name="gst-player-visualization-copy.returns"></a><h4>Returns</h4> 165<p>an allocated copy of <em class="parameter"><code>vis</code></em> 166. </p> 167<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 168</div> 169</div> 170<hr> 171<div class="refsect2"> 172<a name="gst-player-visualization-free"></a><h3>gst_player_visualization_free ()</h3> 173<pre class="programlisting"><span class="returnvalue">void</span> 174gst_player_visualization_free (<em class="parameter"><code><a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> *vis</code></em>);</pre> 175<p>Frees a <a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a>.</p> 176<div class="refsect3"> 177<a name="gst-player-visualization-free.parameters"></a><h4>Parameters</h4> 178<div class="informaltable"><table class="informaltable" width="100%" border="0"> 179<colgroup> 180<col width="150px" class="parameters_name"> 181<col class="parameters_description"> 182<col width="200px" class="parameters_annotations"> 183</colgroup> 184<tbody><tr> 185<td class="parameter_name"><p>vis</p></td> 186<td class="parameter_description"><p><a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> instance</p></td> 187<td class="parameter_annotations"> </td> 188</tr></tbody> 189</table></div> 190</div> 191</div> 192</div> 193<div class="refsect1"> 194<a name="GstPlayerVisualization.other_details"></a><h2>Types and Values</h2> 195<div class="refsect2"> 196<a name="GstPlayerVisualization-struct"></a><h3>struct GstPlayerVisualization</h3> 197<pre class="programlisting">struct GstPlayerVisualization { 198 gchar *name; 199 gchar *description; 200}; 201</pre> 202<p>A <a class="link" href="GstPlayerVisualization.html" title="GstPlayerVisualization"><span class="type">GstPlayerVisualization</span></a> descriptor.</p> 203<div class="refsect3"> 204<a name="GstPlayerVisualization.members"></a><h4>Members</h4> 205<div class="informaltable"><table class="informaltable" width="100%" border="0"> 206<colgroup> 207<col width="300px" class="struct_members_name"> 208<col class="struct_members_description"> 209<col width="200px" class="struct_members_annotations"> 210</colgroup> 211<tbody> 212<tr> 213<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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> 214<td class="struct_member_description"><p>name of the visualization.</p></td> 215<td class="struct_member_annotations"> </td> 216</tr> 217<tr> 218<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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> 219<td class="struct_member_description"><p>description of the visualization.</p></td> 220<td class="struct_member_annotations"> </td> 221</tr> 222</tbody> 223</table></div> 224</div> 225</div> 226</div> 227</div> 228<div class="footer"> 229<hr>Generated by GTK-Doc V1.28</div> 230</body> 231</html>
