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

Timestamp:

Jul 11, 2024 7:49:37 AM (10 months ago)

Author:

vboxsync

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

163915

Message:

Recording: Implemented support for a dedicated progress object, which is exposed to API clients. This can be used for better tracking the recording progress as well as for error reporting. The RecordingSettings API also now has a dedicated start() method to start recording, as well as support for attaching to an already ongoing recording by retrieving the progress object at a later time. Adapted FE/Qt (draft, see @todos), FE/VBoxManage and the Validation Kit testdriver to the new APIs. VBoxManage also can attach to an ongoing recording now. The recording progress object also will have multiple operations to get the recording progress for convenience. bugref:10718

File:

• trunk/doc/manual/en_US/man_VBoxManage-controlvm.xml (modified) (2 diffs)

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

@@ -481 +481 @@
       </group>
     </cmdsynopsis>
+<!--
+    <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-start">
+      <command>VBoxManage controlvm</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg choice="plain">recording start</arg>
+      <arg><replaceable>wait</replaceable></arg>
+    </cmdsynopsis>
+
+    <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-stop">
+      <command>VBoxManage controlvm</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg choice="plain">recording stop</arg>
+    </cmdsynopsis>
+
+    <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-attach">
+      <command>VBoxManage controlvm</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg choice="plain">recording attach</arg>
+    </cmdsynopsis>-->
 
     <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-screens">
@@ -1497 +1525 @@
       </para>
     </refsect2>
+<!--
+    <refsect2 id="vboxmanage-controlvm-recording-start">
+      <title>Starts the Recording of a Virtual Machine Session</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage controlvm
+        <replaceable>vmname</replaceable> recording start</command> command
+        starts the recording of a VM session into a
+        WebM/VP8 file.
+      </para>
+    </refsect2>
+    <refsect2 id="vboxmanage-controlvm-recording-stop">
+      <title>Stops the Recording of a Virtual Machine Session</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage controlvm
+        <replaceable>vmname</replaceable> recording stop</command> command
+        stops the recording of a VM session.
+      </para>
+    </refsect2>
+    <refsect2 id="vboxmanage-controlvm-recording-attach">
+      <title>Attaches to a running Recording of a Virtual Machine Session</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage controlvm
+        <replaceable>vmname</replaceable> recording attach</command> command
+        attaches to a running recording of a VM session.
+      </para>
+    </refsect2>
+-->
     <refsect2 id="vboxmanage-controlvm-recording-screens">
       <title>Specify the Virtual Machine Screens to Record</title>