diff options
Diffstat (limited to 'gst-mixer/doc/C/index.docbook')
| -rw-r--r-- | gst-mixer/doc/C/index.docbook | 434 |
1 files changed, 434 insertions, 0 deletions
diff --git a/gst-mixer/doc/C/index.docbook b/gst-mixer/doc/C/index.docbook new file mode 100644 index 0000000..13f7ac0 --- /dev/null +++ b/gst-mixer/doc/C/index.docbook @@ -0,0 +1,434 @@ +<?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 appversion "2.2.2"> + <!ENTITY manrevision "2.1"> + <!ENTITY date "February 2004"> + <!ENTITY app "<application>MATE Volume Control</application>"> + <!ENTITY appname "MATE 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 Jan 2, 2002 +--> + + +<article id="index" lang="en"> +<articleinfo> + <title>&appname; Manual V&manrevision;</title> + + <copyright> + <year>2004</year> + <holder>Sun Microsystems</holder> + </copyright> + + <copyright> + <year>2003</year> + <holder>Christian Schaller</holder> + </copyright> + + <copyright> + <year>2002</year> + <holder>Michael Froh</holder> + </copyright> + + <copyright> + <year>2000</year> + <holder>Erik Jarvi</holder> + </copyright> + +<!-- translators: uncomment this: + + <copyright> + <year>2004</year> + <holder>ME-THE-TRANSLATOR (Latin translation)</holder> + </copyright> + + --> + + <abstract role="description"> + <para>&app; is an audio mixer</para> + </abstract> + + <publisher> + <publishername>MATE Documentation Project</publishername> + </publisher> + + &legal; + <!-- This file contains link to license for the documentation (GNU FDL), and + other legal stuff such as "NO WARRANTY" statement. Please do not change + any of this. --> + + <authorgroup> + + <author role="maintainer"> + <firstname>Sun</firstname> + <surname>MATE Documentation Team</surname> + <affiliation><orgname>Sun Microsystems</orgname></affiliation> + </author> + + <author> + <firstname>Christian Fredrik</firstname> + <surname>Kalager Schaller</surname> + <affiliation> + <orgname>MATE Documentation Project</orgname> + <address> + <email>[email protected]</email> + </address> + </affiliation> + </author> + + <author> + <firstname>Michael</firstname> + <surname>Froh</surname> + <affiliation> + <orgname>MATE Documentation Project</orgname> + <address> + <email>[email protected]</email> + </address> + </affiliation> + </author> + + <author> + <firstname>Erik</firstname> + <surname>Jarvi</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> + + + <revhistory> + + <revision> + <revnumber>&appname; Manual V&manrevision;</revnumber> + <date>&date;</date> + <revdescription> + <para role="author">Sun MATE Documentation Team</para> + <para role="publisher">MATE Documentation Project</para> + </revdescription> + </revision> + + <revision> + <revnumber>2.0</revnumber> + <date>25 October 2003</date> + <revdescription> + <para role="author">Christian Schaller + <email>[email protected]</email></para> + <para role="publisher">MATE Documentation Project</para> + </revdescription> + </revision> + + <revision> + <revnumber>1.0</revnumber> + <date>19 Feb 2002</date> <!-- or use &date; --> + <revdescription> + <para role="author">Michael Froh + <email>[email protected]</email></para> + <para role="publisher">MATE Documentation Project</para> + <para>Updated to Docbook 4.1.2, for MATE 2.0</para> + </revdescription> + + </revision> + + <revision> + <revnumber>0.1</revnumber> + <date>23 Mar 2001</date> + <revdescription> + <para role="author">Erik Jarvi + <email>[email protected]</email></para> + <para role="publisher">MATE Documentation + Project</para> + <para>This was the original release, for MATE 1.2</para> + </revdescription> + </revision> + + </revhistory> + + <releaseinfo> + This manual describes version &appversion; of &appname;. + </releaseinfo> + + <legalnotice> + <title>Feedback</title> + <para>To report a bug or make a suggestion regarding the &appname; application or this manual, follow the directions in the <ulink url="help:mate-feedback" type="help">MATE Feedback Page</ulink>. + </para> +<!-- Translators may also add here feedback address for translations --> + </legalnotice> + +</articleinfo> + +<indexterm zone="index"><primary>mate-volume-control</primary></indexterm> +<indexterm zone="index"><primary>MATE Volume Control</primary></indexterm> + +<!-- ============= Document Body ============================= --> + <!-- ============= Introduction ============================== --> + + <sect1 id="mate-volume-control-intro"> + <title>Introduction</title> + <para> + The &app; application is an audio mixer that enables you to mix audio for two-channel sound cards. + </para> + </sect1> + +<!-- ============= Getting Started =========================== --> + <sect1 id="mate-volume-control-getting-started"> + <title>Getting Started</title> + +<!-- ============= To Start Volume Control ============================ --> + <sect2 id="mate-volume-control-to-start"> + <title>To Start &appname;</title> + <para>You can start &app; in the following ways:</para> + <variablelist> + <varlistentry> + <term><guimenu>Applications</guimenu> menu</term> + <listitem> + <para> + Choose <menuchoice><guisubmenu>Multimedia</guisubmenu><guimenuitem>Volume Control</guimenuitem></menuchoice>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Command line</term> + <listitem> + <para> + Execute the following command: <command>mate-volume-control</command></para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + + <sect2 id="mate-volume-control-when-you-start"> + <title>When You Start &appname;</title> + <para> + When you start &app;, the following window is displayed: + </para> + <figure id="mate-volume-control-window"> + <title>&appname; Window</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="figures/mate-volume-control_window.png" format="PNG"/> + </imageobject> + <textobject> <phrase>Shows Volume Control main window.</phrase> + </textobject> + </mediaobject> + </screenshot> + </figure> + <para> + The &app; window contains the following elements: + </para> + <variablelist> + <varlistentry> + <term>Menubar</term> + <listitem> + <para> + The menus on the menubar contain all of the commands that you need to work with &app;. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Display area</term> + <listitem> + <para> + The display area contains the channel faders and associated options for several mixers, which enable you to control the volume on those mixers. + </para> + <note> + <para> + &app; populates the display area dynamically, based on the functionality supported by your sound card. The mixers displayed in your &app; window might be different to those shown in Figure 1. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </sect2> + </sect1> + + <!-- ================ Usage ================================ --> + + <sect1 id="mate-volume-control-usage"> + <title>Usage</title> + + <sect2 id="mate-volume-control-usage-vol"> + <title>To Change a Mixer Volume</title> + <para> + To change a mixer volume, use the channel faders for that mixer, as follows: + </para> + <itemizedlist> + <listitem> + <para> + To increase the volume, slide the fader up. + </para> + </listitem> + <listitem> + <para> + To decrease the volume, slide the fader down. + </para> + </listitem> + </itemizedlist> + </sect2> + + <sect2 id="mate-volume-control-usage-lock"> + <title>To Lock the Mixer Channels</title> + <para> + To lock the left and right mixer channels together, select the <guilabel>Lock</guilabel> option for that mixer. When you lock the mixer channels, &app; synchronizes both faders. + </para> + </sect2> + + <sect2 id="mate-volume-control-usage-mute"> + <title>To Silence a Mixer</title> + <para> + To silence a mixer, select the <guilabel>Mute</guilabel> option for that mixer. + </para> + <note> + <para> + When you adjust the fader of a muted channel, &app; deselects the <guilabel>Mute</guilabel> option for that mixer. + </para> + </note> +<!-- Note from original author: + [I find this to be anti-intutive, IMHO this should be + an option. If this feature was on a real console, I'd probably be fired + more than a few times. :)] +--> + </sect2> + + <sect2 id="mate-volume-control-usage-rec"> + <title>To Specify the Current Recording Source</title> + <para> + Any mixer that has a <guilabel>Rec</guilabel> option can be a recording source. + </para> + <para> + To specify the current recording source, select the <guilabel>Rec</guilabel> option for that mixer. + </para> + </sect2> + + </sect1> + + <sect1 id="prefs"> + <title>Preferences</title> + <para> + To configure &app;, choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem></menuchoice>. + </para> + <note> + <para> + &app; populates the <guilabel>Mate Volume Control Preferences</guilabel> dialog dynamically, based on the functionality supported by your sound card. + </para> + </note> + <para> + Use the options in the <guilabel>Shown</guilabel> column to select the mixers that are displayed in the main &app; window. + </para> + <variablelist> + <varlistentry> + <term><guilabel>vol</guilabel></term> + <listitem> + <para> + Select this option to display the faders that control the main volume. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>pcm</guilabel></term> + <listitem> + <para> + Select this option to display the faders that control the wave files. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>speaker</guilabel></term> + <listitem> + <para> + Select this option to display the fader that controls the speaker output jack. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>line</guilabel></term> + <listitem> + <para> + Select this option to display the faders that control the line input on your sound card, if the sound card has a line input. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>mic</guilabel></term> + <listitem> + <para> + Select this option to display the fader that controls the microphone input on your sound card. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>cd</guilabel></term> + <listitem> + <para> + Select this option to display the faders that control the CD player input gain. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>igain</guilabel></term> + <listitem> + <para> + Select this option to display the faders that control the volume level of the selected recording device. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>line1</guilabel></term> + <listitem> + <para> + Select this option to display the faders that control the second line input on your sound card, if the sound card has a second line input. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>phin</guilabel></term> + <listitem> + <para> + Select this option to display the fader that controls the volume of the phin device. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>video</guilabel></term> + <listitem> + <para> + Select this option to display the faders that control the volume of the video devices. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + To change a mixer label, double-click on the text in the <guilabel>Mixer label</guilabel> column, then enter the new label text. + </para> + <para> + To reset the mixer labels to the default values, click on the <guibutton>Reset labels to their defaults</guibutton> button. + </para> + + </sect1> + +</article> |