summaryrefslogtreecommitdiff
path: root/gst-mixer-applet/docs/C/index.docbook
blob: b3bf6b16b9189d4ed77cc8c490e2b96147b1f9d4 (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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY appletversion "2.8">
  <!ENTITY manrevision "2.8">
  <!ENTITY date "August 2004">
  <!ENTITY applet "Volume Control">
]>

<!-- 
      (Do not remove this comment block.)
  Maintained by the MATE Documentation Project
  http://developer.mate.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Mar 12, 2002
  
-->

<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo> 
	 <title>&applet; Manual</title> 
	 <abstract role="description">
	   <para>&applet; enables you to control the sound
	     volume on your system and provides visual feedback on the
	     current volume level.</para>
	 </abstract>
	 <copyright> 
		<year>2002</year> 
		<year>2003</year> 
		<year>2004</year> 
		<holder>Sun Microsystems</holder> 
	 </copyright> 
	 <copyright> 
		<year>2000</year> 
		<holder>Dan Mueth</holder> 
	 </copyright>
<!-- translators: uncomment this:

  <copyright>
   <year>2003</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

   -->

	 <publisher role="maintainer"> 
		<publishername>MATE Documentation Project</publishername> 
	 </publisher> 

&legal;


	 <authorgroup> 
		<author> 
		  <firstname>Angela</firstname> 
		  <surname>Boyle</surname> 
		  <affiliation> 
			 <address><email>aboyle@aboyle.com</email></address> 
		  </affiliation> 
		</author> 
		<author> 
		  <firstname>Dan</firstname> 
		  <surname>Mueth</surname> 
		  <affiliation> 
			 <orgname>MATE Documentation Project</orgname> 
			 <address> <email>d-mueth@uchicago.edu</email> </address> 
		  </affiliation> 
		</author>
      <!-- This is appropriate place for other contributors: translators,
           maintainers,  etc. Commented out by default.
           <othercredit role="translator">
	     <firstname>Latin</firstname> 
	     <surname>Translator 1</surname> 
	     <affiliation> 
	       <orgname>Latin Translation Team</orgname> 
	       <address> <email>translator@gnome.org</email> </address> 
	     </affiliation>
	     <contrib>Latin translation</contrib>
           </othercredit>
-->
	 </authorgroup>
	 
	 <releaseinfo revision="2.26" role="review"/>

	 <revhistory>
		<revision> 
		  <revnumber>&applet; Applet Manual V&manrevision;</revnumber> 
		  <date>&date;</date> 
		  <revdescription> 
			 <para role="author">Angela Boyle</para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision>  
		<revision> 
		  <revnumber>Volume Control Applet Manual V2.6</revnumber> 
		  <date>February 2004</date> 
		  <revdescription> 
			 <para role="author">Sun GNOME Documentation Team
				</para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision>  
		<revision> 
		  <revnumber>Volume Control Applet Manual V2.5</revnumber> 
		  <date>September 2003</date> 
		  <revdescription> 
			 <para role="author">Sun GNOME Documentation Team
				</para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision> 
		<revision> 
		  <revnumber>Volume Control Applet Manual V2.4</revnumber> 
		  <date>August 2003</date> 
		  <revdescription> 
			 <para role="author">Sun GNOME Documentation Team
				</para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision>  
		<revision> 
		  <revnumber>Volume Control Applet Manual V2.3</revnumber> 
		  <date>March 2003</date> 
		  <revdescription> 
			 <para role="author">Sun GNOME Documentation Team
				</para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision> 
		<revision> 
		  <revnumber>Volume Control Applet Manual V2.2</revnumber> 
		  <date>January 2003</date> 
		  <revdescription> 
			 <para role="author">Sun GNOME Documentation Team
				</para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision> 
		<revision> 
		  <revnumber>Volume Control Applet Manual V2.1</revnumber> 
		  <date>August 2002</date> 
		  <revdescription> 
			 <para role="author">Sun GNOME Documentation Team
				</para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision> 
		<revision> 
		  <revnumber>Volume Control Applet Manual V2.0</revnumber> 
		  <date>April 2002</date> 
		  <revdescription> 
			 <para role="author">Sun GNOME Documentation Team
				</para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision> 
		<revision> 
		  <revnumber>Mixer Applet</revnumber> 
		  <date>2000</date> 
		  <revdescription> 
			 <para role="author">Dan Mueth
				<email>d-mueth@uchicago.edu</email></para> 
			 <para role="publisher">MATE Documentation Project</para> 
		  </revdescription> 
		</revision> 
	 </revhistory> 
	 <releaseinfo> This manual describes version &appletversion; of &applet;.
		</releaseinfo> 
	 <legalnotice> 
		<title>Feedback</title> 
		<para> To report a bug or make a suggestion regarding the &applet; applet or this manual, follow the directions in the <ulink url="help:mate-feedback" type="help">MATE Feedback Page</ulink>. </para>
		
	 </legalnotice> 
  </articleinfo> 
  <indexterm> 
	 <primary>Volume Control</primary> 
  </indexterm> 

<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<sect1 id="volumecontrol-introduction">
<title>Introduction</title>
<!-- ==== Figure ============================================= -->
	 <figure id="volumecontrol-fig"> 
		<title>&applet; Applet</title> 
		<screenshot> 
		  <mediaobject> 
			 <imageobject><imagedata fileref="figures/volumecontrol_applet.png" format="PNG"/> 
			 </imageobject>
			 <textobject> 
				<phrase>Shows Volume Control applet. Contains image of a speaker.</phrase> 
			 </textobject> 
		  </mediaobject> 
		</screenshot> 
	 </figure> 
    <!-- ==== End of Figure ======================================= -->
<para>The <application>&applet;</application> applet enables you to control the sound volume on your system. The applet icon changes depending on the volume level that you select. For example, if you select a low volume level, the icon displays one sound wave emanating from the speaker in the applet icon. As you increase the volume, the icon changes to display more sound waves. </para>

    <sect2 id="volumecontrol-introduction-add">
      <title>To Add &applet; to a Panel</title>
      <para>To add <application>&applet;</application> to a panel,
      right-click on the panel, then choose <guimenuitem>Add to
      Panel</guimenuitem>.  Select <application>&applet;</application>
      in the <application>Add to the panel</application> dialog, then
      click <guibutton>OK</guibutton>.</para>
    </sect2>
</sect1>

<sect1 id="volumecontrol-usage">
<title>Using &applet;</title>

	<sect2 id="volumecontrol-adjust">
	<title>To Adjust the Volume</title>
	<para>Click on the applet to display a slider control. To increase the volume, move the slider upwards. To decrease the volume, move the slider downwards.</para>
	</sect2>
	
	<sect2 id="volumecontrol-off">
	<title>To Switch the Volume Off</title>
	<para>To switch the volume off, right-click on the applet, then choose <guimenuitem>Mute</guimenuitem>. </para>
	</sect2>
	
	<sect2 id="volumecontrol-add">
	<title>To Access Additional Features</title>
	<para>To access additional functionality for working with volume, right-click on the applet, then choose <guimenuitem>Open Volume Control</guimenuitem>. A volume control application starts, which enables you to control the volume and balance levels for audio playback and recording.</para>
	</sect2>

</sect1>

<sect1 id="volumecontrol-prefs">
<title>Customizing &applet;</title>
<para>To configure <application>&applet;</application>, right-click on the applet, then choose <guimenuitem>Preferences</guimenuitem>.</para> 
    <note>
      <para>
        <application>&applet;</application> populates the <guilabel>Volume Control Preferences</guilabel> dialog dynamically, based on the functionality supported by your sound card.
      </para>
    </note>

<variablelist> 
		  <varlistentry> 
			 <term><guilabel>Audio Channels</guilabel></term> 
			 <listitem> 
			 <para>Select the audio output channel that you want to control:</para> 
			 <itemizedlist>
			 	<listitem><para><guilabel>Volume</guilabel></para></listitem>
			 	<listitem><para><guilabel>PCM</guilabel></para></listitem>
			 	<listitem><para><guilabel>Speaker</guilabel></para></listitem>
				<listitem><para><guilabel>Line-in</guilabel></para></listitem>
				<listitem><para><guilabel>Microphone</guilabel></para></listitem>
				<listitem><para><guilabel>CD</guilabel></para></listitem>
				<listitem><para><guilabel>Record</guilabel></para></listitem>
				<listitem><para><guilabel>Line-1</guilabel></para></listitem>
				<listitem><para><guilabel>Line-2</guilabel></para></listitem>
			 </itemizedlist>
			 </listitem> 
		  </varlistentry> 
		</variablelist> 

<para>Click <guibutton>Close</guibutton> to close the <guilabel>Volume Control Preferences</guilabel> dialog.</para>

</sect1>
</article>