Index: /trunk/doc/manual/en_US/user_VBoxManage.xml =================================================================== --- /trunk/doc/manual/en_US/user_VBoxManage.xml (revision 75341) +++ /trunk/doc/manual/en_US/user_VBoxManage.xml (revision 75342) @@ -1886,10 +1886,10 @@ - - - Capture Settings + + + Recording Settings - The following settings for changing video and/or audio capture + The following settings for changing video and/or audio recording parameters are available through VBoxManage modifyvm. @@ -1900,5 +1900,5 @@ - --capture on|off: This + --record on|off: This option enables or disables recording a VM session into a file. If this option is enabled, recording will start when the @@ -1909,5 +1909,5 @@ - --capturescreens all|<screen ID> + --recordscreens all|<screen ID> [<screen ID> ...]: This option allows to specify which screens of the VM are being recorded. Each @@ -1918,5 +1918,5 @@ - --capturefile + --recordfile <filename>: This option sets the filename VirtualBox uses to save the recorded content. @@ -1926,9 +1926,9 @@ - --capturemaxtime + --recordmaxtime <ms>: This option sets the maximum - time in milliseconds the capturing will be enabled - since activation. The capturing stops when the defined time - interval has elapsed. If this value is zero the capturing is + time in milliseconds the recording will be enabled + since activation. The recording stops when the defined time + interval has elapsed. If this value is zero the recording is not limited by time. @@ -1937,17 +1937,17 @@ - --capturemaxsize + --recordmaxsize <MB>: This option limits the maximum - size of the captured file (in MB). The capturing stops + size of the recorded file (in MB). The recording stops when the file size has reached the specified size. If this - value is zero the capturing will not be limited by file size. - - - - - - --captureopts <key=value> + value is zero the recording will not be limited by file size. + + + + + + --recordopts <key=value> [,<key=value> ...]: This format can - be used to specify additional capturing options. These + be used to specify additional recording options. These options only are for advanced users and must be specified in a comma-separated key=value format. For example: @@ -1958,5 +1958,5 @@ - --capturevideores + --recordvideores <width>x<height>: This option sets the video resolution (in pixels) of the recorded file. @@ -1966,5 +1966,5 @@ - --capturevideorate + --recordvideorate <rate>: This option sets the video bitrate in kilobits (kb) per second. Increasing this value makes the @@ -1975,5 +1975,5 @@ - --capturevideofps <fps>: + --recordvideofps <fps>: This option sets the maximum number of video frames per second (FPS) to be recorded. Frames with a higher frequency will be @@ -3643,5 +3643,5 @@ - videocap on|off enables or + record on|off enables or disables recording a VM session into a WebM/VP8 file. @@ -3650,8 +3650,8 @@ - videocapscreens all|<screen ID> + recordscreens all|<screen ID> [<screen ID> ...]] allows to specify which screens of the VM are being recorded. This setting - cannot be changed while video capturing is enabled. Each + cannot be changed while recording is enabled. Each screen is recorded into a separate file. @@ -3660,7 +3660,7 @@ - videocapfile <file> + recordfile <file> sets the filename VirtualBox uses to save the recorded - content. This setting cannot be changed while video capturing + content. This setting cannot be changed while recording is enabled. @@ -3669,67 +3669,61 @@ - videocapres <width> + recordvideores <width> <height> sets the resolution (in pixels) of the recorded video. This setting cannot be changed - while video capturing is enabled. - - - - - - - - videocaprate <rate> + while recording is enabled. + + + + + + recordvideorate <rate> sets the bitrate in kilobits (kb) per second. Increasing this value makes the video look better for the cost of an increased - file size. This setting cannot be changed while video - capturing is enabled. - - - - - - videocapfps <fps> sets + file size. This setting cannot be changed while recording is enabled. + + + + + + recordvideofps <fps> sets the maximum number of frames per second (FPS) to be recorded. Frames with a higher frequency will be skipped. Reducing this value increases the number of skipped frames and reduces the - file size. This setting cannot be changed while video - capturing is enabled. - - - - - - - - videocapmaxtime <ms> - sets the maximum time in milliseconds the video capturing will - be enabled since activation. The capturing stops when the + file size. This setting cannot be changed while recording is enabled. + + + + + + recordmaxtime <ms> + sets the maximum time in milliseconds the recording will + be enabled since activation. The recording stops when the defined time interval has elapsed. If this value is zero the - capturing is not limited by time. This setting cannot be - changed while video capturing is enabled. - - - - - - videocapmaxsize <MB> - limits the maximum size of the captured video file, in MB. The - capturing stops when the file size has reached the specified - size. If this value is zero the capturing will not be limited - by file size. This setting cannot be changed while video - capturing is enabled. - - - - - - videocapopts + recording is not limited by time. This setting cannot be + changed while recording is enabled. + + + + + + recordmaxsize <MB> + limits the maximum size of the recorded file, in MB. The + recording stops when the file size has reached the specified + size. If this value is zero the recording will not be limited + by file size. This setting cannot be changed while recording + is enabled. + + + + + + recordopts <key=value>[,<key=value> ...] can - be used to specify additional video capturing options. These + be used to specify additional recording options. These options only are for advanced users and must be specified in a comma-separated key=value format, e.g. foo=bar,a=b. This setting - cannot be changed while video capturing is enabled. + cannot be changed while recording is enabled.