summaryrefslogtreecommitdiff
path: root/gst-mixer-applet/docs/C
diff options
context:
space:
mode:
authorStefano Karapetsas <[email protected]>2012-12-08 22:18:30 +0100
committerStefano Karapetsas <[email protected]>2012-12-08 22:18:30 +0100
commit4cf8fbb6f138203019c67df2db9b48f2b02cae79 (patch)
treec787d84646619b59c88fa212004e507b74a47185 /gst-mixer-applet/docs/C
parente9711267ec88b5e3510f1b59796dc155ed22b156 (diff)
downloadmate-media-4cf8fbb6f138203019c67df2db9b48f2b02cae79.tar.bz2
mate-media-4cf8fbb6f138203019c67df2db9b48f2b02cae79.tar.xz
add gst-mixer-applet (moved from mate-applets package)
it will builds only if gstreamer is enabled
Diffstat (limited to 'gst-mixer-applet/docs/C')
-rw-r--r--gst-mixer-applet/docs/C/figures/volumecontrol_applet.pngbin0 -> 987 bytes
-rw-r--r--gst-mixer-applet/docs/C/legal.xml76
-rw-r--r--gst-mixer-applet/docs/C/mate-mixer_applet2.xml264
3 files changed, 340 insertions, 0 deletions
diff --git a/gst-mixer-applet/docs/C/figures/volumecontrol_applet.png b/gst-mixer-applet/docs/C/figures/volumecontrol_applet.png
new file mode 100644
index 0000000..94b342b
--- /dev/null
+++ b/gst-mixer-applet/docs/C/figures/volumecontrol_applet.png
Binary files differ
diff --git a/gst-mixer-applet/docs/C/legal.xml b/gst-mixer-applet/docs/C/legal.xml
new file mode 100644
index 0000000..acb0b40
--- /dev/null
+++ b/gst-mixer-applet/docs/C/legal.xml
@@ -0,0 +1,76 @@
+ <legalnotice id="legalnotice">
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation
+ License (GFDL), Version 1.1 or any later version published
+ by the Free Software Foundation with no Invariant Sections,
+ no Front-Cover Texts, and no Back-Cover Texts. You can find
+ a copy of the GFDL at this <ulink type="help"
+ url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
+ distributed with this manual.
+ </para>
+ <para> This manual is part of a collection of MATE manuals
+ distributed under the GFDL. If you want to distribute this
+ manual separately from the collection, you can do so by
+ adding a copy of the license to the manual, as described in
+ section 6 of the license.
+ </para>
+
+ <para>
+ Many of the names used by companies to distinguish their
+ products and services are claimed as trademarks. Where those
+ names appear in any MATE documentation, and the members of
+ the MATE Documentation Project are made aware of those
+ trademarks, then the names are in capital letters or initial
+ capital letters.
+ </para>
+
+ <para>
+ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
+ UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
+ WITH THE FURTHER UNDERSTANDING THAT:
+
+ <orderedlist>
+ <listitem>
+ <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
+ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+ IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
+ THAT THE DOCUMENT OR MODIFIED VERSION OF THE
+ DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
+ A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
+ RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
+ OF THE DOCUMENT OR MODIFIED VERSION OF THE
+ DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
+ MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
+ YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
+ CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
+ SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
+ OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
+ LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
+ VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
+ EXCEPT UNDER THIS DISCLAIMER; AND
+ </para>
+ </listitem>
+ <listitem>
+ <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
+ THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
+ CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
+ INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
+ DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
+ OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
+ PARTIES, BE LIABLE TO ANY PERSON FOR ANY
+ DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
+ CONSEQUENTIAL DAMAGES OF ANY CHARACTER
+ INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
+ OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
+ MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
+ LOSSES ARISING OUT OF OR RELATING TO USE OF THE
+ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
+ EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
+ THE POSSIBILITY OF SUCH DAMAGES.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </legalnotice>
+
diff --git a/gst-mixer-applet/docs/C/mate-mixer_applet2.xml b/gst-mixer-applet/docs/C/mate-mixer_applet2.xml
new file mode 100644
index 0000000..7bc1f20
--- /dev/null
+++ b/gst-mixer-applet/docs/C/mate-mixer_applet2.xml
@@ -0,0 +1,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>[email protected]</email></address>
+ </affiliation>
+ </author>
+ <author>
+ <firstname>Dan</firstname>
+ <surname>Mueth</surname>
+ <affiliation>
+ <orgname>MATE Documentation Project</orgname>
+ <address> <email>[email protected]</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>[email protected]</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 MATE 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 MATE 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 MATE 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 MATE 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 MATE 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 MATE 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 MATE 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>[email protected]</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="ghelp: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>