← Back to branch summary

~bcurtiswx/ubuntu/precise/empathy/3.4.2.1-0ubuntu1

« back to all changes in this revision

Viewing changes to docs/libempathy-gtk/xml/empathy-audio-sink.xml

  • Committer: Bazaar Package Importer
  • Author(s): Laurent Bigonville
  • Date: 2009-11-16 23:40:52 UTC
  • mfrom: (1.1.39 upstream)
  • mto: (6.3.7 experimental)
  • mto: This revision was merged to the branch mainline in revision 80.
  • Revision ID: james.westby@ubuntu.com-20091116234052-7hhwrpeln4mwdyw7
Tags: upstream-2.29.2
Import upstream version 2.29.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy-gtk/xml/empathy-audio-sink.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version SYSTEM "version.xml">
5
 
]>
6
 
<refentry id="EmpathyGstAudioSink">
7
 
<refmeta>
8
 
<refentrytitle role="top_of_page" id="EmpathyGstAudioSink.top_of_page">EmpathyGstAudioSink</refentrytitle>
9
 
<manvolnum>3</manvolnum>
10
 
<refmiscinfo>LIBEMPATHY-GTK Library</refmiscinfo>
11
 
</refmeta>
12
 
 
13
 
<refnamediv>
14
 
<refname>EmpathyGstAudioSink</refname>
15
 
<refpurpose></refpurpose>
16
 
</refnamediv>
17
 
 
18
 
<refsynopsisdiv id="EmpathyGstAudioSink.synopsis" role="synopsis">
19
 
<title role="synopsis.title">Synopsis</title>
20
 
 
21
 
<synopsis>
22
 
                    <link linkend="EmpathyGstAudioSink-struct">EmpathyGstAudioSink</link>;
23
 
<link linkend="GstElement">GstElement</link> *        <link linkend="empathy-audio-sink-new">empathy_audio_sink_new</link>              (void);
24
 
<link linkend="void">void</link>                <link linkend="empathy-audio-sink-set-volume">empathy_audio_sink_set_volume</link>       (<link linkend="EmpathyGstAudioSink">EmpathyGstAudioSink</link> *sink,
25
 
                                                         <link linkend="gdouble">gdouble</link> volume);
26
 
<link linkend="gdouble">gdouble</link>             <link linkend="empathy-audio-sink-get-volume">empathy_audio_sink_get_volume</link>       (<link linkend="EmpathyGstAudioSink">EmpathyGstAudioSink</link> *sink);
27
 
</synopsis>
28
 
</refsynopsisdiv>
29
 
 
30
 
<refsect1 id="EmpathyGstAudioSink.object-hierarchy" role="object_hierarchy">
31
 
<title role="object_hierarchy.title">Object Hierarchy</title>
32
 
<synopsis>
33
 
  <link linkend="GObject">GObject</link>
34
 
   +----<link linkend="GstObject">GstObject</link>
35
 
         +----<link linkend="GstElement">GstElement</link>
36
 
               +----<link linkend="GstBin">GstBin</link>
37
 
                     +----EmpathyGstAudioSink
38
 
</synopsis>
39
 
</refsect1>
40
 
 
41
 
 
42
 
 
43
 
<refsect1 id="EmpathyGstAudioSink.implemented-interfaces" role="impl_interfaces">
44
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
45
 
<para>
46
 
EmpathyGstAudioSink implements
47
 
 <link linkend="GstChildProxy">GstChildProxy</link>.</para>
48
 
</refsect1>
49
 
 
50
 
 
51
 
<refsect1 id="EmpathyGstAudioSink.properties" role="properties">
52
 
<title role="properties.title">Properties</title>
53
 
<synopsis>
54
 
  &quot;<link linkend="EmpathyGstAudioSink--volume">volume</link>&quot;                   <link linkend="gdouble">gdouble</link>               : Read / Write
55
 
</synopsis>
56
 
</refsect1>
57
 
 
58
 
 
59
 
 
60
 
<refsect1 id="EmpathyGstAudioSink.description" role="desc">
61
 
<title role="desc.title">Description</title>
62
 
<para>
63
 
</para>
64
 
</refsect1>
65
 
 
66
 
<refsect1 id="EmpathyGstAudioSink.details" role="details">
67
 
<title role="details.title">Details</title>
68
 
<refsect2 id="EmpathyGstAudioSink-struct" role="struct">
69
 
<title>EmpathyGstAudioSink</title>
70
 
<indexterm zone="EmpathyGstAudioSink-struct"><primary sortas="EmpathyGstAudioSink">EmpathyGstAudioSink</primary></indexterm><programlisting>typedef struct _EmpathyGstAudioSink EmpathyGstAudioSink;</programlisting>
71
 
<para>
72
 
</para></refsect2>
73
 
<refsect2 id="empathy-audio-sink-new" role="function">
74
 
<title>empathy_audio_sink_new ()</title>
75
 
<indexterm zone="empathy-audio-sink-new"><primary sortas="empathy_audio_sink_new">empathy_audio_sink_new</primary></indexterm><programlisting><link linkend="GstElement">GstElement</link> *        empathy_audio_sink_new              (void);</programlisting>
76
 
<para>
77
 
</para><variablelist role="params">
78
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
79
 
</simpara></listitem></varlistentry>
80
 
</variablelist></refsect2>
81
 
<refsect2 id="empathy-audio-sink-set-volume" role="function">
82
 
<title>empathy_audio_sink_set_volume ()</title>
83
 
<indexterm zone="empathy-audio-sink-set-volume"><primary sortas="empathy_audio_sink_set_volume">empathy_audio_sink_set_volume</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_audio_sink_set_volume       (<link linkend="EmpathyGstAudioSink">EmpathyGstAudioSink</link> *sink,
84
 
                                                         <link linkend="gdouble">gdouble</link> volume);</programlisting>
85
 
<para>
86
 
</para><variablelist role="params">
87
 
<varlistentry><term><parameter>sink</parameter>&#160;:</term>
88
 
<listitem><simpara>
89
 
</simpara></listitem></varlistentry>
90
 
<varlistentry><term><parameter>volume</parameter>&#160;:</term>
91
 
<listitem><simpara>
92
 
</simpara></listitem></varlistentry>
93
 
</variablelist></refsect2>
94
 
<refsect2 id="empathy-audio-sink-get-volume" role="function">
95
 
<title>empathy_audio_sink_get_volume ()</title>
96
 
<indexterm zone="empathy-audio-sink-get-volume"><primary sortas="empathy_audio_sink_get_volume">empathy_audio_sink_get_volume</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             empathy_audio_sink_get_volume       (<link linkend="EmpathyGstAudioSink">EmpathyGstAudioSink</link> *sink);</programlisting>
97
 
<para>
98
 
</para><variablelist role="params">
99
 
<varlistentry><term><parameter>sink</parameter>&#160;:</term>
100
 
<listitem><simpara>
101
 
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
103
 
</simpara></listitem></varlistentry>
104
 
</variablelist></refsect2>
105
 
 
106
 
</refsect1>
107
 
<refsect1 id="EmpathyGstAudioSink.property-details" role="property_details">
108
 
<title role="property_details.title">Property Details</title>
109
 
<refsect2 id="EmpathyGstAudioSink--volume" role="property"><title>The <literal>&quot;volume&quot;</literal> property</title>
110
 
<indexterm zone="EmpathyGstAudioSink--volume"><primary sortas="EmpathyGstAudioSink:volume">EmpathyGstAudioSink:volume</primary></indexterm><programlisting>  &quot;volume&quot;                   <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
111
 
<para>volume control.</para><para>Allowed values: [0,5]</para>
112
 
<para>Default value: 1</para>
113
 
</refsect2>
114
 
</refsect1>
115
 
 
116
 
 
117
 
 
118
 
 
119
 
</refentry>