File: ClutterGstAudio.html

package info (click to toggle)
clutter-gst 0.8.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 2,012 kB
  • ctags: 337
  • sloc: sh: 8,845; ansic: 2,313; xml: 440; makefile: 91
file content (157 lines) | stat: -rw-r--r-- 7,133 bytes parent folder | download
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
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterGstAudio</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Clutter Gst 0.8 Reference Manual">
<link rel="up" href="ch02.html" title="Clutter Actors And Objects">
<link rel="prev" href="ClutterGstVideoTexture.html" title="ClutterGstVideoTexture">
<link rel="next" href="ClutterGstVideoSink.html" title="ClutterGstVideoSink">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Clutter Gst Overview">
<link rel="chapter" href="ch02.html" title="Clutter Actors And Objects">
<link rel="appendix" href="license.html" title="Appendix A. License">
</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="ClutterGstVideoTexture.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">Clutter Gst 0.8
 Reference Manual</th>
<td><a accesskey="n" href="ClutterGstVideoSink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#ClutterGstAudio.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#ClutterGstAudio.description" class="shortcut">Description</a>
                   | 
                  <a href="#ClutterGstAudio.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#ClutterGstAudio.implemented-interfaces" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="ClutterGstAudio"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterGstAudio.top_of_page"></a>ClutterGstAudio</span></h2>
<p>ClutterGstAudio — Object for playback of audio files.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ClutterGstAudio.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a class="link" href="ClutterGstAudio.html#ClutterGstAudio-struct" title="ClutterGstAudio">ClutterGstAudio</a>;
                    <a class="link" href="ClutterGstAudio.html#ClutterGstAudioClass" title="ClutterGstAudioClass">ClutterGstAudioClass</a>;
<a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio">ClutterGstAudio</a>*    <a class="link" href="ClutterGstAudio.html#clutter-gst-audio-new" title="clutter_gst_audio_new ()">clutter_gst_audio_new</a>               (void);
GstElement*         <a class="link" href="ClutterGstAudio.html#clutter-gst-audio-get-playbin" title="clutter_gst_audio_get_playbin ()">clutter_gst_audio_get_playbin</a>       (<a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio">ClutterGstAudio</a> *audio);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="ClutterGstAudio.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----ClutterGstAudio
</pre>
</div>
<div class="refsect1" lang="en">
<a name="ClutterGstAudio.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterGstAudio implements
 <a
href="/usr/share/gtk-doc/html/clutter/ClutterMedia.html"
>ClutterMedia</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="ClutterGstAudio.description"></a><h2>Description</h2>
<p>
<a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio"><span class="type">ClutterGstAudio</span></a> is an object that plays audio files. It is a simple
wrapper around GStreamer base audio sink implementing the <a
href="/usr/share/gtk-doc/html/clutter/ClutterMedia.html"
><span class="type">ClutterMedia</span></a>
interface and providing a nice API to play a sound file using its URI.</p>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="ClutterGstAudio.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="ClutterGstAudio-struct"></a><h3>ClutterGstAudio</h3>
<pre class="programlisting">typedef struct _ClutterGstAudio ClutterGstAudio;</pre>
<p>
Simple class for playing audio files.
</p>
<p>
The <a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio"><span class="type">ClutterGstAudio</span></a> structure contains only private data and should
not be accessed directly.</p>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="ClutterGstAudioClass"></a><h3>ClutterGstAudioClass</h3>
<pre class="programlisting">typedef struct {
} ClutterGstAudioClass;
</pre>
<p>
Base class for <a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio"><span class="type">ClutterGstAudio</span></a>.</p>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="clutter-gst-audio-new"></a><h3>clutter_gst_audio_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio">ClutterGstAudio</a>*    clutter_gst_audio_new               (void);</pre>
<p>
Creates <a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio"><span class="type">ClutterGstAudio</span></a> object.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A newly allocated <a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio"><span class="type">ClutterGstAudio</span></a> object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="clutter-gst-audio-get-playbin"></a><h3>clutter_gst_audio_get_playbin ()</h3>
<pre class="programlisting">GstElement*         clutter_gst_audio_get_playbin       (<a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio">ClutterGstAudio</a> *audio);</pre>
<p>
Retrieves the <span class="type">GstElement</span> used by the <em class="parameter"><code>audio</code></em>, for direct use with
GStreamer API.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>audio</code></em> :</span></p></td>
<td> a <a class="link" href="ClutterGstAudio.html" title="ClutterGstAudio"><span class="type">ClutterGstAudio</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the playbin element used by the audio object
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>