Changeset 96141 in vbox for trunk/src/VBox/Main/idl

Timestamp:

Aug 11, 2022 3:37:19 PM (3 years ago)

Author:

vboxsync

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

152947

Message:

Recording/Main:

• Renamed RecordingVideoScalingMethod -> RecordingVideoScalingMode (to match the other enums).
• Renamed RecordingVideoRateControlMode -> RecordingRateControlMode, as this also can apply to audio codecs.
• Added ABR (average bitrate) mode to RecordingRateControlMode.

IRecordingScreenSettings:

• Added audioRateControlMode.
• Added videoScalingMode.

ISystemProperties:

• Renamed supportedRecordingVSMethods to supportedRecordingVSModes (to match RecordingVideoScalingMode).
• Added supportedRecordingARCModes.

Renamed com::settings::RecordingScreenSettings.Audio.enmAudioCodec -> .enmCodec (Doppelmoppel).

More documentation.

​bugref:10275

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (9 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -5869 +5869 @@
 
   <enum
-    name="RecordingVideoScalingMethod"
-    uuid="5576D890-48EE-449A-A81B-B776233598B7"
+    name="RecordingVideoScalingMode"
+    uuid="0dd1127d-4f62-4b82-beee-91086a9f1d24"
     >
     <desc>
@@ -5877 +5877 @@
 
     <const name="None"                  value="0">
-      <desc>No scaling performed.</desc>
+      <desc>No scaling performed.
+        The image wil be cropped when the source is bigger than the target size.</desc>
     </const>
     <const name="NearestNeighbor"       value="1">
@@ -5894 +5895 @@
 
   <enum
-    name="RecordingVideoRateControlMode"
-    uuid="D4EFB692-9F98-4112-88D3-A16FBE2BF6A8"
+    name="RecordingRateControlMode"
+    uuid="d07a33ac-b4ea-4917-942d-c03be14fbe2f"
     >
     <desc>
       Recording video rate control mode enumeration.
+      <note>Not all codecs may support all rate control modes.</note>
     </desc>
 
-    <const name="CBR" value="0">
-      <desc>Constant bit rate (CBR).</desc>
-    </const>
-    <const name="VBR" value="1">
-      <desc>Variable bit rate (VBR). Not yet implemented.</desc>
+    <const name="ABR" value="0">
+      <desc>Average bit rate (ABR). Constrained to a certain size.</desc>
+    </const>
+    <const name="CBR" value="1">
+      <desc>Constant bit rate (CBR). Constrained to a certain size.</desc>
+    </const>
+    <const name="VBR" value="2">
+      <desc>Variable bit rate (VBR). Constrained to a certain quality.</desc>
     </const>
   </enum>
@@ -5911 +5916 @@
   <interface
     name="IRecordingScreenSettings" extends="$unknown"
-    uuid="92eb5328-c0b3-4ad2-ae25-75b12c52871f"
+    uuid="2377f7d2-1971-40ff-8e39-e61089bb3a22"
     wsmap="managed"
     rest="managed"
@@ -6030 +6035 @@
     </attribute>
 
+    <attribute name="audioRateControlMode" type="RecordingRateControlMode">
+      <desc>
+        Determines the audio rate control mode. This setting cannot be changed
+        while recording is enabled.
+      </desc>
+    </attribute>
+
     <attribute name="audioDeadline" type="RecordingCodecDeadline" default="Default">
       <desc>
@@ -6100 +6112 @@
     </attribute>
 
-    <attribute name="videoRateControlMode" type="RecordingVideoRateControlMode">
-      <desc>
-        Determines the rate control mode. This setting cannot be changed
+    <attribute name="videoRateControlMode" type="RecordingRateControlMode">
+      <desc>
+        Determines the video rate control mode. This setting cannot be changed
         while recording is enabled.
       </desc>
@@ -6116 +6128 @@
     </attribute>
 
-    <attribute name="videoScalingMethod" type="RecordingVideoScalingMethod">
-      <desc>
-        Determines the video scaling method to use.
+    <attribute name="videoScalingMode" type="RecordingVideoScalingMode">
+      <desc>
+        Determines the video scaling mode to use.
         This setting cannot be changed while recording is enabled.
       </desc>
@@ -12392 +12404 @@
     name="ISystemProperties"
     extends="$unknown"
-    uuid="3624830f-4ac4-404f-bc58-cf20ed8836b0"
+    uuid="068decf8-335d-4ec5-8265-ccfd910c4f9d"
     wsmap="managed"
     rest="managed"
@@ -12829 +12841 @@
     </attribute>
 
-    <attribute name="supportedRecordingVSMethods" type="RecordingVideoScalingMethod" safearray="yes" readonly="yes">
-      <desc>
-        Returns an array of officially supported values for enum <link to="RecordingVideoScalingMethod"/>,
+    <attribute name="supportedRecordingVSModes" type="RecordingVideoScalingMode" safearray="yes" readonly="yes">
+      <desc>
+        Returns an array of officially supported values for enum <link to="RecordingVideoScalingMode"/>,
         in the sense of what is e.g. worth offering in the VirtualBox GUI.
       </desc>
     </attribute>
 
-    <attribute name="supportedRecordingVRCModes" type="RecordingVideoRateControlMode" safearray="yes" readonly="yes">
-      <desc>
-        Returns an array of officially supported values for enum <link to="RecordingVideoRateControlMode"/>,
+    <attribute name="supportedRecordingARCModes" type="RecordingRateControlMode" safearray="yes" readonly="yes">
+      <desc>
+        Returns an array of officially supported audio codec values for enum <link to="RecordingVideoRateControlMode"/>,
+        in the sense of what is e.g. worth offering in the VirtualBox GUI.
+      </desc>
+    </attribute>
+
+    <attribute name="supportedRecordingVRCModes" type="RecordingRateControlMode" safearray="yes" readonly="yes">
+      <desc>
+        Returns an array of officially supported video codec values for enum <link to="RecordingVideoRateControlMode"/>,
         in the sense of what is e.g. worth offering in the VirtualBox GUI.
       </desc>