Changeset 46667 in vbox for trunk/src/VBox/Main/idl/VirtualBox.xidl

Timestamp:

Jun 19, 2013 3:30:23 PM (12 years ago)

Author:

vboxsync

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

86558

Message:

Main/idl: clarify IMachine.videoCaptureFile to be an absolute path, and many naming convention cleanups for method/attribute names starting with an uppercase letter or containing an acronym
Main/xml/Settings.cpp: clean up default video capture file handling and related path conversions, version handling of the new functionality
Main/Machine: handle default value for video capture file better, store relative path in settings if possible, cleanups
Main/src-client/VideoRec.cpp: do not overwrite a file ever
Main/Display: generate a unique name if there is a collision, matching cleanups for name changes
Frontends/VirtualBox: matching name changes
Frontends/VBoxManage: matching name changes, fixing the machine readable output

File:

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

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

@@ -1380 +1380 @@
     uuid="03DFD6F7-1B78-48A3-8345-C785281E9523"
     wsmap="managed">
-    <attribute name="NetworkName" type="wstring">
+    <attribute name="networkName" type="wstring">
       <desc>
         TBD: the idea, technically we can start any number of the NAT networks,
@@ -4248 +4248 @@
     </attribute>
 
-    <attribute name="VideoCaptureEnabled" type="boolean" default="false">
+    <attribute name="videoCaptureEnabled" type="boolean" default="false">
       <desc>
         This setting determines whether VirtualBox uses video recording to
@@ -4254 +4254 @@
     </attribute>
 
-    <attribute name="VideoCaptureScreens" type="boolean" safearray="yes">
+    <attribute name="videoCaptureScreens" type="boolean" safearray="yes">
       <desc>
         This setting determines for which screens video recording is
@@ -4260 +4260 @@
     </attribute>
 
-    <attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
+    <attribute name="videoCaptureFile" type="wstring">
       <desc>
         This setting determines the filename VirtualBox uses to save
         the recorded content. This setting cannot be changed while video
-        capturing is enabled.
-      </desc>
-    </attribute>
-
-    <attribute name="VideoCaptureWidth" type="unsigned long" default="640">
+        capturing is enabled. 
+        <note>
+          When setting this attribute, the specified path has to be
+          absolute (full path). When reading this attribute, a full path is
+          always returned.
+        </note>
+      </desc>
+    </attribute>
+
+    <attribute name="videoCaptureWidth" type="unsigned long" default="640">
       <desc>
         This setting determines the horizontal resolution of the recorded
@@ -4276 +4281 @@
     </attribute>
 
-    <attribute name="VideoCaptureHeight" type="unsigned long" default="480">
+    <attribute name="videoCaptureHeight" type="unsigned long" default="480">
       <desc>
         This setting determines the vertical resolution of the recorded
@@ -4284 +4289 @@
     </attribute>
 
-    <attribute name="VideoCaptureRate" type="unsigned long" default="512">
+    <attribute name="videoCaptureRate" type="unsigned long" default="512">
       <desc>
         This setting determines the bitrate in kilobits per second.
@@ -4293 +4298 @@
     </attribute>
 
-    <attribute name="VideoCaptureFps" type="unsigned long" default="25">
+    <attribute name="videoCaptureFPS" type="unsigned long" default="25">
       <desc>
         This setting determines the maximum number of frames per second.
         Frames with a higher frequency will be skipped. Reducing this
-        value increses the number of skipped frames but reduces the
+        value increases the number of skipped frames and reduces the
         file size. This setting cannot be changed while video capturing
         is enabled.
@@ -12749 +12754 @@
       <desc>
         Returns the storage format variant information for this medium
-        as an aaray of the flags described at <link to="MediumVariant" />.
+        as an array of the flags described at <link to="MediumVariant" />.
         Before <link to="#refreshState"/> is called this method returns
         an undefined value.
@@ -20942 +20947 @@
     >
     <!-- network name is common setting for all event types -->
-    <attribute name="NetworkName" type="wstring" readonly="yes"/>
+    <attribute name="networkName" type="wstring" readonly="yes"/>
   </interface>
   <!-- base class for start/stop events -->