VirtualBox

Changeset 75342 in vbox


Ignore:
Timestamp:
Nov 9, 2018 8:50:58 AM (6 years ago)
Author:
vboxsync
Message:

Recording/Docs: Update for VBoxManage.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r75138 r75342  
    18861886    </sect2>
    18871887
    1888     <sect2 id="vboxmanage-modifyvm-capture">
    1889 
    1890       <title>Capture Settings</title>
     1888    <sect2 id="vboxmanage-modifyvm-record">
     1889
     1890      <title>Recording Settings</title>
    18911891
    18921892      <para>
    1893         The following settings for changing video and/or audio capture
     1893        The following settings for changing video and/or audio recording
    18941894        parameters are available through <computeroutput>VBoxManage
    18951895        modifyvm</computeroutput>.
    … …  
    19001900        <listitem>
    19011901          <para>
    1902             <computeroutput>--capture on|off</computeroutput>: This
     1902            <computeroutput>--record on|off</computeroutput>: This
    19031903            option enables or disables recording a VM session into a
    19041904            file. If this option is enabled, recording will start when the
    … …  
    19091909        <listitem>
    19101910          <para>
    1911             <computeroutput>--capturescreens all|&lt;screen ID&gt;
     1911            <computeroutput>--recordscreens all|&lt;screen ID&gt;
    19121912            [&lt;screen ID&gt; ...]</computeroutput>: This option allows
    19131913            to specify which screens of the VM are being recorded. Each
    … …  
    19181918        <listitem>
    19191919          <para>
    1920             <computeroutput>--capturefile
     1920            <computeroutput>--recordfile
    19211921            &lt;filename&gt;</computeroutput>: This option sets the
    19221922            filename VirtualBox uses to save the recorded content.
    … …  
    19261926        <listitem>
    19271927          <para>
    1928             <computeroutput>--capturemaxtime
     1928            <computeroutput>--recordmaxtime
    19291929            &lt;ms&gt;</computeroutput>: This option sets the maximum
    1930             time in milliseconds the capturing will be enabled
    1931             since activation. The capturing stops when the defined time
    1932             interval has elapsed. If this value is zero the capturing is
     1930            time in milliseconds the recording will be enabled
     1931            since activation. The recording stops when the defined time
     1932            interval has elapsed. If this value is zero the recording is
    19331933            not limited by time.
    19341934          </para>
    … …  
    19371937        <listitem>
    19381938          <para>
    1939             <computeroutput>--capturemaxsize
     1939            <computeroutput>--recordmaxsize
    19401940            &lt;MB&gt;</computeroutput>: This option limits the maximum
    1941             size of the captured file (in MB). The capturing stops
     1941            size of the recorded file (in MB). The recording stops
    19421942            when the file size has reached the specified size. If this
    1943             value is zero the capturing will not be limited by file size.
    1944           </para>
    1945         </listitem>
    1946 
    1947         <listitem>
    1948           <para>
    1949             <computeroutput>--captureopts &lt;key=value&gt;
     1943            value is zero the recording will not be limited by file size.
     1944          </para>
     1945        </listitem>
     1946
     1947        <listitem>
     1948          <para>
     1949            <computeroutput>--recordopts &lt;key=value&gt;
    19501950            [,&lt;key=value&gt; ...]</computeroutput>: This format can
    1951             be used to specify additional capturing options. These
     1951            be used to specify additional recording options. These
    19521952            options only are for advanced users and must be specified in
    19531953            a comma-separated key=value format. For example:
    … …  
    19581958        <listitem>
    19591959          <para>
    1960             <computeroutput>--capturevideores
     1960            <computeroutput>--recordvideores
    19611961            &lt;width&gt;x&lt;height&gt;</computeroutput>: This option
    19621962            sets the video resolution (in pixels) of the recorded file.
    … …  
    19661966        <listitem>
    19671967          <para>
    1968             <computeroutput>--capturevideorate
     1968            <computeroutput>--recordvideorate
    19691969            &lt;rate&gt;</computeroutput>: This option sets the video bitrate
    19701970            in kilobits (kb) per second. Increasing this value makes the
    … …  
    19751975        <listitem>
    19761976          <para>
    1977             <computeroutput>--capturevideofps &lt;fps&gt;</computeroutput>:
     1977            <computeroutput>--recordvideofps &lt;fps&gt;</computeroutput>:
    19781978            This option sets the maximum number of video frames per second
    19791979            (FPS) to be recorded. Frames with a higher frequency will be
    … …  
    36433643      <listitem>
    36443644        <para>
    3645           <computeroutput>videocap on|off</computeroutput> enables or
     3645          <computeroutput>record on|off</computeroutput> enables or
    36463646          disables recording a VM session into a WebM/VP8 file.
    36473647        </para>
    … …  
    36503650      <listitem>
    36513651        <para>
    3652           <computeroutput>videocapscreens all|&lt;screen ID&gt;
     3652          <computeroutput>recordscreens all|&lt;screen ID&gt;
    36533653          [&lt;screen ID&gt; ...]]</computeroutput> allows to specify
    36543654          which screens of the VM are being recorded. This setting
    3655           cannot be changed while video capturing is enabled. Each
     3655          cannot be changed while recording is enabled. Each
    36563656          screen is recorded into a separate file.
    36573657        </para>
    … …  
    36603660      <listitem>
    36613661        <para>
    3662           <computeroutput>videocapfile &lt;file&gt;</computeroutput>
     3662          <computeroutput>recordfile &lt;file&gt;</computeroutput>
    36633663          sets the filename VirtualBox uses to save the recorded
    3664           content. This setting cannot be changed while video capturing
     3664          content. This setting cannot be changed while recording
    36653665          is enabled.
    36663666        </para>
    … …  
    36693669      <listitem>
    36703670        <para>
    3671           <computeroutput>videocapres &lt;width&gt;
     3671          <computeroutput>recordvideores &lt;width&gt;
    36723672          &lt;height&gt;</computeroutput> sets the resolution (in
    36733673          pixels) of the recorded video. This setting cannot be changed
    3674           while video capturing is enabled.
    3675         </para>
    3676       </listitem>
    3677 
    3678       <listitem>
    3679 <!-- @todo r=andy Clarify rate. -->
    3680 
    3681         <para>
    3682           <computeroutput>videocaprate &lt;rate&gt;</computeroutput>
     3674          while recording is enabled.
     3675        </para>
     3676      </listitem>
     3677
     3678      <listitem>
     3679        <para>
     3680          <computeroutput>recordvideorate &lt;rate&gt;</computeroutput>
    36833681          sets the bitrate in kilobits (kb) per second. Increasing this
    36843682          value makes the video look better for the cost of an increased
    3685           file size. This setting cannot be changed while video
    3686           capturing is enabled.
    3687         </para>
    3688       </listitem>
    3689 
    3690       <listitem>
    3691         <para>
    3692           <computeroutput>videocapfps &lt;fps&gt;</computeroutput> sets
     3683          file size. This setting cannot be changed while recording is enabled.
     3684        </para>
     3685      </listitem>
     3686
     3687      <listitem>
     3688        <para>
     3689          <computeroutput>recordvideofps &lt;fps&gt;</computeroutput> sets
    36933690          the maximum number of frames per second (FPS) to be recorded.
    36943691          Frames with a higher frequency will be skipped. Reducing this
    36953692          value increases the number of skipped frames and reduces the
    3696           file size. This setting cannot be changed while video
    3697           capturing is enabled.
    3698         </para>
    3699       </listitem>
    3700 
    3701       <listitem>
    3702 <!-- @todo r=andy Clarify time format. -->
    3703 
    3704         <para>
    3705           <computeroutput>videocapmaxtime &lt;ms&gt;</computeroutput>
    3706           sets the maximum time in milliseconds the video capturing will
    3707           be enabled since activation. The capturing stops when the
     3693          file size. This setting cannot be changed while recording is enabled.
     3694        </para>
     3695      </listitem>
     3696
     3697      <listitem>
     3698        <para>
     3699          <computeroutput>recordmaxtime &lt;ms&gt;</computeroutput>
     3700          sets the maximum time in milliseconds the recording will
     3701          be enabled since activation. The recording stops when the
    37083702          defined time interval has elapsed. If this value is zero the
    3709           capturing is not limited by time. This setting cannot be
    3710           changed while video capturing is enabled.
    3711         </para>
    3712       </listitem>
    3713 
    3714       <listitem>
    3715         <para>
    3716           <computeroutput>videocapmaxsize &lt;MB&gt;</computeroutput>
    3717           limits the maximum size of the captured video file, in MB. The
    3718           capturing stops when the file size has reached the specified
    3719           size. If this value is zero the capturing will not be limited
    3720           by file size. This setting cannot be changed while video
    3721           capturing is enabled.
    3722         </para>
    3723       </listitem>
    3724 
    3725       <listitem>
    3726         <para>
    3727           <computeroutput>videocapopts
     3703          recording is not limited by time. This setting cannot be
     3704          changed while recording is enabled.
     3705        </para>
     3706      </listitem>
     3707
     3708      <listitem>
     3709        <para>
     3710          <computeroutput>recordmaxsize &lt;MB&gt;</computeroutput>
     3711          limits the maximum size of the recorded file, in MB. The
     3712          recording stops when the file size has reached the specified
     3713          size. If this value is zero the recording will not be limited
     3714          by file size. This setting cannot be changed while recording
     3715          is enabled.
     3716        </para>
     3717      </listitem>
     3718
     3719      <listitem>
     3720        <para>
     3721          <computeroutput>recordopts
    37283722          &lt;key=value&gt;[,&lt;key=value&gt; ...]</computeroutput> can
    3729           be used to specify additional video capturing options. These
     3723          be used to specify additional recording options. These
    37303724          options only are for advanced users and must be specified in a
    37313725          comma-separated key=value format, e.g.
    37323726          <computeroutput>foo=bar,a=b</computeroutput>. This setting
    3733           cannot be changed while video capturing is enabled.
     3727          cannot be changed while recording is enabled.
    37343728        </para>
    37353729      </listitem>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette