Changeset 98032 in vbox for trunk/doc/manual/en_US

Timestamp:

Jan 9, 2023 5:27:44 PM (2 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

155127

Message:

Audio/VBoxManage: Resolved a @todo: Marked the modifyvm "--audio" switch as being deprecated and introduced the switches "--audio-driver" and "--audio-enabled". This allows more flexible control of the audio stack.

File:

• trunk/doc/manual/en_US/man_VBoxManage-modifyvm.xml (modified) (4 diffs)

trunk/doc/manual/en_US/man_VBoxManage-modifyvm.xml

@@ -426 +426 @@
           <arg choice="plain"><replaceable>IO-base</replaceable> <replaceable>IRQ</replaceable></arg>
         </group></arg>
-      <arg>--audio=<group choice="plain">
+      <arg>--audio-controller=<group choice="plain">
+          <arg choice="plain">ac97</arg>
+          <arg choice="plain">hda</arg>
+          <arg choice="plain">sb16</arg>
+        </group></arg>
+      <arg>--audio-codec=<group choice="plain">
+          <arg choice="plain">stac9700</arg>
+          <arg choice="plain">ad1980</arg>
+          <arg choice="plain">stac9221</arg>
+          <arg choice="plain">sb16</arg>
+        </group></arg>
+      <arg>--audio-driver=<group choice="plain">
           <arg choice="plain">none</arg>
           <arg choice="plain">default</arg>
@@ -437 +448 @@
           <arg choice="plain">coreaudio</arg>
         </group></arg>
-      <arg>--audio-controller=<group choice="plain">
-          <arg choice="plain">ac97</arg>
-          <arg choice="plain">hda</arg>
-          <arg choice="plain">sb16</arg>
-        </group></arg>
-      <arg>--audio-codec=<group choice="plain">
-          <arg choice="plain">stac9700</arg>
-          <arg choice="plain">ad1980</arg>
-          <arg choice="plain">stac9221</arg>
-          <arg choice="plain">sb16</arg>
+      <arg>--audio-enabled=<group choice="plain">
+          <arg choice="plain">on</arg>
+          <arg choice="plain">off</arg>
         </group></arg>
       <arg>--audio-in=<group choice="plain">
@@ -1935 +1939 @@
         </varlistentry>
         <varlistentry>
-          <term><option>--audio=<replaceable>type</replaceable></option></term>
-          <listitem><para>
-              Specifies whether the VM has audio support, and if so,
-              which type. Valid audio type values are:
+          <term><option>--audio-controller=<replaceable>controller-type</replaceable></option></term>
+          <listitem><para>
+              Specifies the audio controller to be used with the VM.
+              Valid audio controller type values are:
+              <literal>ac97</literal>, <literal>hda</literal>, and
+              <literal>sb16</literal>.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--audio-codec=<replaceable>codec-type</replaceable></option></term>
+          <listitem><para>
+              Specifies the audio codec to be used with the VM. Valid
+              audio codec type values are: <literal>stac9700</literal>,
+              <literal>ad1980</literal>, <literal>stac9221</literal>,
+              and <literal>sb16</literal>.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--audio-driver=<replaceable>type</replaceable></option></term>
+          <listitem><para>
+              Specifies whether which audio driver (backend) to use.
               <literal>none</literal>, <literal>default</literal>,
               <literal>null</literal>, <literal>dsound</literal>,
@@ -1945 +1966 @@
               <literal>coreaudio</literal>.
             </para><para>
-              Note that the audio types are dependent on the host
+              Note that the audio driver are dependent on the host
               operating system. Use the <command>VBoxManage
               modifyvm</command> command usage output to determine the
               supported audio types for your host system.
-            </para></listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><option>--audio-controller=<replaceable>controller-type</replaceable></option></term>
-          <listitem><para>
-              Specifies the audio controller to be used with the VM.
-              Valid audio controller type values are:
-              <literal>ac97</literal>, <literal>hda</literal>, and
-              <literal>sb16</literal>.
-            </para></listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><option>--audio-codec=<replaceable>codec-type</replaceable></option></term>
-          <listitem><para>
-              Specifies the audio codec to be used with the VM. Valid
-              audio codec type values are: <literal>stac9700</literal>,
-              <literal>ad1980</literal>, <literal>stac9221</literal>,
-              and <literal>sb16</literal>.
+            </para>
+            <para>
+              For maximum interoperability between hosts, the default
+              audio driver can be used. The VM will then automatically select
+              the most appropriate audio driver for the current host available.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--audio-enabled=on|off</option></term>
+          <listitem><para>
+              Specifies whether to enable or disable audio for the VM.
+            </para>
+            <para>
+              This option has precedence over the --audio-on and --audio-off
+              options, i.e. turning off audio via this option will turn off
+              both, input and output, audio.
             </para></listitem>
         </varlistentry>