aboutsummaryrefslogtreecommitdiff
path: root/tests/poppler/glib/reference/html/PopplerMovie.html
blob: 5c74af9c69cbdf5979eebd09e3024b70222295f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PopplerMovie</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Poppler Reference Manual">
<link rel="up" href="ch01.html" title="Poppler">
<link rel="prev" href="PopplerMedia.html" title="PopplerMedia">
<link rel="next" href="poppler-Version-and-Features-Information.html" title="Version and Features Information">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="PopplerMedia.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Poppler Reference Manual</th>
<td><a accesskey="n" href="poppler-Version-and-Features-Information.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PopplerMovie.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#PopplerMovie.description" class="shortcut">Description</a>
                   | 
                  <a href="#PopplerMovie.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="PopplerMovie"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PopplerMovie.top_of_page"></a>PopplerMovie</span></h2>
<p>PopplerMovie — Movies</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PopplerMovie.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;poppler.h&gt;

                    <a class="link" href="PopplerMovie.html#PopplerMovie-struct" title="PopplerMovie">PopplerMovie</a>;
const <span class="returnvalue">gchar</span> *       <a class="link" href="PopplerMovie.html#poppler-movie-get-filename" title="poppler_movie_get_filename ()">poppler_movie_get_filename</a>          (<em class="parameter"><code><a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a> *poppler_movie</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="PopplerMovie.html#poppler-movie-need-poster" title="poppler_movie_need_poster ()">poppler_movie_need_poster</a>           (<em class="parameter"><code><a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a> *poppler_movie</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="PopplerMovie.html#poppler-movie-show-controls" title="poppler_movie_show_controls ()">poppler_movie_show_controls</a>         (<em class="parameter"><code><a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a> *poppler_movie</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PopplerMovie.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----PopplerMovie
</pre>
</div>
<div class="refsect1">
<a name="PopplerMovie.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="PopplerMovie.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PopplerMovie-struct"></a><h3>PopplerMovie</h3>
<pre class="programlisting">typedef struct _PopplerMovie PopplerMovie;</pre>
</div>
<hr>
<div class="refsect2">
<a name="poppler-movie-get-filename"></a><h3>poppler_movie_get_filename ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       poppler_movie_get_filename          (<em class="parameter"><code><a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a> *poppler_movie</code></em>);</pre>
<p>
Returns the local filename identifying a self-describing movie file
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>poppler_movie</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a local filename, return value is owned by <a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a> and
should not be freed</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.14</p>
</div>
<hr>
<div class="refsect2">
<a name="poppler-movie-need-poster"></a><h3>poppler_movie_need_poster ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            poppler_movie_need_poster           (<em class="parameter"><code><a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a> *poppler_movie</code></em>);</pre>
<p>
Returns whether a poster image representing the Movie
shall be displayed. The poster image must be retrieved
from the movie file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>poppler_movie</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if move needs a poster image, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.14</p>
</div>
<hr>
<div class="refsect2">
<a name="poppler-movie-show-controls"></a><h3>poppler_movie_show_controls ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            poppler_movie_show_controls         (<em class="parameter"><code><a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a> *poppler_movie</code></em>);</pre>
<p>
Returns whether to display a movie controller bar while playing the movie
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>poppler_movie</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerMovie.html" title="PopplerMovie"><span class="type">PopplerMovie</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if controller bar should be displayed, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.14</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>