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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="ClutterGstAudio">
<refmeta>
<refentrytitle role="top_of_page" id="ClutterGstAudio.top_of_page">ClutterGstAudio</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER-GST Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ClutterGstAudio</refname>
<refpurpose>Object for playback of audio files.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="ClutterGstAudio.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="ClutterGstAudio-struct">ClutterGstAudio</link>;
<link linkend="ClutterGstAudioClass">ClutterGstAudioClass</link>;
<link linkend="ClutterGstAudio">ClutterGstAudio</link>* <link linkend="clutter-gst-audio-new">clutter_gst_audio_new</link> (void);
<link linkend="GstElement">GstElement</link>* <link linkend="clutter-gst-audio-get-playbin">clutter_gst_audio_get_playbin</link> (<link linkend="ClutterGstAudio">ClutterGstAudio</link> *audio);
</synopsis>
</refsynopsisdiv>
<refsect1 id="ClutterGstAudio.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----ClutterGstAudio
</synopsis>
</refsect1>
<refsect1 id="ClutterGstAudio.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
ClutterGstAudio implements
<link linkend="ClutterMedia">ClutterMedia</link>.</para>
</refsect1>
<refsect1 id="ClutterGstAudio.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="ClutterGstAudio"><type>ClutterGstAudio</type></link> is an object that plays audio files. It is a simple
wrapper around GStreamer base audio sink implementing the <link linkend="ClutterMedia"><type>ClutterMedia</type></link>
interface and providing a nice API to play a sound file using its URI.</para>
<para>
</para>
</refsect1>
<refsect1 id="ClutterGstAudio.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="ClutterGstAudio-struct" role="struct">
<title>ClutterGstAudio</title>
<indexterm zone="ClutterGstAudio-struct"><primary>ClutterGstAudio</primary></indexterm><programlisting>typedef struct _ClutterGstAudio ClutterGstAudio;</programlisting>
<para>
Simple class for playing audio files.
</para>
<para>
The <link linkend="ClutterGstAudio"><type>ClutterGstAudio</type></link> structure contains only private data and should
not be accessed directly.</para>
<para>
</para></refsect2>
<refsect2 id="ClutterGstAudioClass" role="struct">
<title>ClutterGstAudioClass</title>
<indexterm zone="ClutterGstAudioClass"><primary>ClutterGstAudioClass</primary></indexterm><programlisting>typedef struct {
} ClutterGstAudioClass;
</programlisting>
<para>
Base class for <link linkend="ClutterGstAudio"><type>ClutterGstAudio</type></link>.</para>
<para>
</para></refsect2>
<refsect2 id="clutter-gst-audio-new" role="function">
<title>clutter_gst_audio_new ()</title>
<indexterm zone="clutter-gst-audio-new"><primary>clutter_gst_audio_new</primary></indexterm><programlisting><link linkend="ClutterGstAudio">ClutterGstAudio</link>* clutter_gst_audio_new (void);</programlisting>
<para>
Creates <link linkend="ClutterGstAudio"><type>ClutterGstAudio</type></link> object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated <link linkend="ClutterGstAudio"><type>ClutterGstAudio</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="clutter-gst-audio-get-playbin" role="function">
<title>clutter_gst_audio_get_playbin ()</title>
<indexterm zone="clutter-gst-audio-get-playbin"><primary>clutter_gst_audio_get_playbin</primary></indexterm><programlisting><link linkend="GstElement">GstElement</link>* clutter_gst_audio_get_playbin (<link linkend="ClutterGstAudio">ClutterGstAudio</link> *audio);</programlisting>
<para>
Retrieves the <link linkend="GstElement"><type>GstElement</type></link> used by the <parameter>audio</parameter>, for direct use with
GStreamer API.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>audio</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterGstAudio"><type>ClutterGstAudio</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the playbin element used by the audio object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
