VirtualBox

Changeset 75138 in vbox for trunk


Ignore:
Timestamp:
Oct 29, 2018 9:29:11 AM (6 years ago)
Author:
vboxsync
Message:

FE/VBoxManage: Renamed the video capturing options to better reflect which option is generic to capturing and which is bound to the video recording feature. This also should make space for the upcoming audio feature options. Got rid of the deprecated stuff which was in there for too long.

Location:
trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed

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

    r74003 r75138  
    18861886    </sect2>
    18871887
    1888     <sect2 id="vboxmanage-modifyvm-videocap">
    1889 
    1890       <title>Video Capture Settings</title>
     1888    <sect2 id="vboxmanage-modifyvm-capture">
     1889
     1890      <title>Capture Settings</title>
    18911891
    18921892      <para>
    1893         The following settings for changing video recording parameters
    1894         are available through <computeroutput>VBoxManage
     1893        The following settings for changing video and/or audio capture
     1894        parameters are available through <computeroutput>VBoxManage
    18951895        modifyvm</computeroutput>.
    18961896      </para>
    … …  
    19001900        <listitem>
    19011901          <para>
    1902             <computeroutput>--videocap on|off</computeroutput>: This
     1902            <computeroutput>--capture on|off</computeroutput>: This
    19031903            option enables or disables recording a VM session into a
    1904             WebM/VP8 file. If this option is enabled, recording will
    1905             start when the VM session is started.
    1906           </para>
    1907         </listitem>
    1908 
    1909         <listitem>
    1910           <para>
    1911             <computeroutput>--videocapscreens all|&lt;screen ID&gt;
     1904            file. If this option is enabled, recording will start when the
     1905            VM session is started.
     1906          </para>
     1907        </listitem>
     1908
     1909        <listitem>
     1910          <para>
     1911            <computeroutput>--capturescreens 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>--videocapfile
     1920            <computeroutput>--capturefile
    19211921            &lt;filename&gt;</computeroutput>: This option sets the
    19221922            filename VirtualBox uses to save the recorded content.
    … …  
    19261926        <listitem>
    19271927          <para>
    1928             <computeroutput>--videocapres
     1928            <computeroutput>--capturemaxtime
     1929            &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
     1933            not limited by time.
     1934          </para>
     1935        </listitem>
     1936
     1937        <listitem>
     1938          <para>
     1939            <computeroutput>--capturemaxsize
     1940            &lt;MB&gt;</computeroutput>: This option limits the maximum
     1941            size of the captured file (in MB). The capturing stops
     1942            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;
     1950            [,&lt;key=value&gt; ...]</computeroutput>: This format can
     1951            be used to specify additional capturing options. These
     1952            options only are for advanced users and must be specified in
     1953            a comma-separated key=value format. For example:
     1954            <computeroutput>foo=bar,a=b</computeroutput>.
     1955          </para>
     1956        </listitem>
     1957
     1958        <listitem>
     1959          <para>
     1960            <computeroutput>--capturevideores
    19291961            &lt;width&gt;x&lt;height&gt;</computeroutput>: This option
    1930             sets the resolution (in pixels) of the recorded video.
    1931           </para>
    1932         </listitem>
    1933 
    1934         <listitem>
    1935           <para>
    1936             <computeroutput>--videocaprate
    1937             &lt;rate&gt;</computeroutput>: This option sets the bitrate
     1962            sets the video resolution (in pixels) of the recorded file.
     1963          </para>
     1964        </listitem>
     1965
     1966        <listitem>
     1967          <para>
     1968            <computeroutput>--capturevideorate
     1969            &lt;rate&gt;</computeroutput>: This option sets the video bitrate
    19381970            in kilobits (kb) per second. Increasing this value makes the
    19391971            video look better for the cost of an increased file size.
    … …  
    19431975        <listitem>
    19441976          <para>
    1945             <computeroutput>--videocapfps &lt;fps&gt;</computeroutput>:
    1946             This option sets the maximum number of frames per second
     1977            <computeroutput>--capturevideofps &lt;fps&gt;</computeroutput>:
     1978            This option sets the maximum number of video frames per second
    19471979            (FPS) to be recorded. Frames with a higher frequency will be
    19481980            skipped. Reducing this value increases the number of skipped
    19491981            frames and reduces the file size.
    1950           </para>
    1951         </listitem>
    1952 
    1953         <listitem>
    1954           <para>
    1955             <computeroutput>--videocapmaxtime
    1956             &lt;ms&gt;</computeroutput>: This option sets the maximum
    1957             time in milliseconds the video capturing will be enabled
    1958             since activation. The capturing stops when the defined time
    1959             interval has elapsed. If this value is zero the capturing is
    1960             not limited by time.
    1961           </para>
    1962         </listitem>
    1963 
    1964         <listitem>
    1965           <para>
    1966             <computeroutput>--videocapmaxsize
    1967             &lt;MB&gt;</computeroutput>: This option limits the maximum
    1968             size of the captured video file (in MB). The capturing stops
    1969             when the file size has reached the specified size. If this
    1970             value is zero the capturing will not be limited by file
    1971             size.
    1972           </para>
    1973         </listitem>
    1974 
    1975         <listitem>
    1976           <para>
    1977             <computeroutput>--videocapopts &lt;key=value&gt;
    1978             [,&lt;key=value&gt; ...]</computeroutput>: This format can
    1979             be used to specify additional video capturing options. These
    1980             options only are for advanced users and must be specified in
    1981             a comma-separated key=value format. For example:
    1982             <computeroutput>foo=bar,a=b</computeroutput>.
    19831982          </para>
    19841983

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageModifyVM.cpp

    r74474 r75138  
    55
    66/*
    7  * Copyright (C) 2006-2017 Oracle Corporation
     7 * Copyright (C) 2006-2018 Oracle Corporation
    88 *
    99 * This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    215215#endif
    216216#ifdef VBOX_WITH_VIDEOREC
    217     MODIFYVM_VIDEOCAP,
    218     MODIFYVM_VIDEOCAP_SCREENS,
    219     MODIFYVM_VIDEOCAP_FILENAME,
    220     MODIFYVM_VIDEOCAP_WIDTH,
    221     MODIFYVM_VIDEOCAP_HEIGHT,
    222     MODIFYVM_VIDEOCAP_RES,
    223     MODIFYVM_VIDEOCAP_RATE,
    224     MODIFYVM_VIDEOCAP_FPS,
    225     MODIFYVM_VIDEOCAP_MAXTIME,
    226     MODIFYVM_VIDEOCAP_MAXSIZE,
    227     MODIFYVM_VIDEOCAP_OPTIONS,
     217    MODIFYVM_CAPTURE,
     218    MODIFYVM_CAPTURE_FEATURES,
     219    MODIFYVM_CAPTURE_SCREENS,
     220    MODIFYVM_CAPTURE_FILENAME,
     221    MODIFYVM_CAPTURE_WIDTH,
     222    MODIFYVM_CAPTURE_HEIGHT,
     223    MODIFYVM_CAPTURE_VIDEO_RES,
     224    MODIFYVM_CAPTURE_VIDEO_RATE,
     225    MODIFYVM_CAPTURE_VIDEO_FPS,
     226    MODIFYVM_CAPTURE_MAXTIME,
     227    MODIFYVM_CAPTURE_MAXSIZE,
     228    MODIFYVM_CAPTURE_OPTIONS,
    228229#endif
    229230    MODIFYVM_CHIPSET,
    … …  
    394395    { "--chipset",                  MODIFYVM_CHIPSET,                   RTGETOPT_REQ_STRING },
    395396#ifdef VBOX_WITH_VIDEOREC
    396     { "--videocap",                 MODIFYVM_VIDEOCAP,                  RTGETOPT_REQ_BOOL_ONOFF },
    397     { "--vcpenabled",               MODIFYVM_VIDEOCAP,                  RTGETOPT_REQ_BOOL_ONOFF }, /* deprecated */
    398     { "--videocapscreens",          MODIFYVM_VIDEOCAP_SCREENS,          RTGETOPT_REQ_STRING },
    399     { "--vcpscreens",               MODIFYVM_VIDEOCAP_SCREENS,          RTGETOPT_REQ_STRING }, /* deprecated */
    400     { "--videocapfile",             MODIFYVM_VIDEOCAP_FILENAME,         RTGETOPT_REQ_STRING },
    401     { "--vcpfile",                  MODIFYVM_VIDEOCAP_FILENAME,         RTGETOPT_REQ_STRING }, /* deprecated */
    402     { "--videocapres",              MODIFYVM_VIDEOCAP_RES,              RTGETOPT_REQ_STRING },
    403     { "--vcpwidth",                 MODIFYVM_VIDEOCAP_WIDTH,            RTGETOPT_REQ_UINT32 }, /* deprecated */
    404     { "--vcpheight",                MODIFYVM_VIDEOCAP_HEIGHT,           RTGETOPT_REQ_UINT32 }, /* deprecated */
    405     { "--videocaprate",             MODIFYVM_VIDEOCAP_RATE,             RTGETOPT_REQ_UINT32 },
    406     { "--vcprate",                  MODIFYVM_VIDEOCAP_RATE,             RTGETOPT_REQ_UINT32 }, /* deprecated */
    407     { "--videocapfps",              MODIFYVM_VIDEOCAP_FPS,              RTGETOPT_REQ_UINT32 },
    408     { "--vcpfps",                   MODIFYVM_VIDEOCAP_FPS,              RTGETOPT_REQ_UINT32 }, /* deprecated */
    409     { "--videocapmaxtime",          MODIFYVM_VIDEOCAP_MAXTIME,          RTGETOPT_REQ_INT32  },
    410     { "--vcpmaxtime",               MODIFYVM_VIDEOCAP_MAXTIME,          RTGETOPT_REQ_INT32  }, /* deprecated */
    411     { "--videocapmaxsize",          MODIFYVM_VIDEOCAP_MAXSIZE,          RTGETOPT_REQ_INT32  },
    412     { "--vcpmaxsize",               MODIFYVM_VIDEOCAP_MAXSIZE,          RTGETOPT_REQ_INT32  }, /* deprecated */
    413     { "--videocapopts",             MODIFYVM_VIDEOCAP_OPTIONS,          RTGETOPT_REQ_STRING },
    414     { "--vcpoptions",               MODIFYVM_VIDEOCAP_OPTIONS,          RTGETOPT_REQ_STRING }, /* deprecated */
     397    { "--capture",                  MODIFYVM_CAPTURE,                    RTGETOPT_REQ_BOOL_ONOFF },
     398    { "--capturescreens",           MODIFYVM_CAPTURE_SCREENS,            RTGETOPT_REQ_STRING },
     399    { "--capturefile",              MODIFYVM_CAPTURE_FILENAME,           RTGETOPT_REQ_STRING },
     400    { "--capturemaxtime",           MODIFYVM_CAPTURE_MAXTIME,            RTGETOPT_REQ_INT32  },
     401    { "--capturemaxsize",           MODIFYVM_CAPTURE_MAXSIZE,            RTGETOPT_REQ_INT32  },
     402    { "--captureopts",              MODIFYVM_CAPTURE_OPTIONS,            RTGETOPT_REQ_STRING },
     403    { "--captureoptions",           MODIFYVM_CAPTURE_OPTIONS,            RTGETOPT_REQ_STRING },
     404    { "--capturevideores",          MODIFYVM_CAPTURE_VIDEO_RES,          RTGETOPT_REQ_STRING },
     405    { "--capturevideorate",         MODIFYVM_CAPTURE_VIDEO_RATE,         RTGETOPT_REQ_UINT32 },
     406    { "--capturevideofps",          MODIFYVM_CAPTURE_VIDEO_FPS,          RTGETOPT_REQ_UINT32 },
    415407#endif
    416408    { "--autostart-enabled",        MODIFYVM_AUTOSTART_ENABLED,         RTGETOPT_REQ_BOOL_ONOFF },
    … …  
    29362928            }
    29372929#ifdef VBOX_WITH_VIDEOREC
    2938             case MODIFYVM_VIDEOCAP:
     2930            case MODIFYVM_CAPTURE:
    29392931            {
    29402932                CHECK_ERROR(sessionMachine, COMSETTER(VideoCaptureEnabled)(ValueUnion.f));
    29412933                break;
    29422934            }
    2943             case MODIFYVM_VIDEOCAP_SCREENS:
     2935            case MODIFYVM_CAPTURE_SCREENS:
    29442936            {
    29452937                ULONG cMonitors = 64;
    … …  
    29552947                break;
    29562948            }
    2957             case MODIFYVM_VIDEOCAP_FILENAME:
     2949            case MODIFYVM_CAPTURE_FILENAME:
    29582950            {
    29592951                Bstr bstr;
    … …  
    29742966                break;
    29752967            }
    2976             case MODIFYVM_VIDEOCAP_WIDTH:
     2968            case MODIFYVM_CAPTURE_WIDTH:
    29772969            {
    29782970                CHECK_ERROR(sessionMachine, COMSETTER(VideoCaptureWidth)(ValueUnion.u32));
    29792971                break;
    29802972            }
    2981             case MODIFYVM_VIDEOCAP_HEIGHT:
     2973            case MODIFYVM_CAPTURE_HEIGHT:
    29822974            {
    29832975                CHECK_ERROR(sessionMachine, COMSETTER(VideoCaptureHeight)(ValueUnion.u32));
    29842976                break;
    29852977            }
    2986             case MODIFYVM_VIDEOCAP_RES:
     2978            case MODIFYVM_CAPTURE_VIDEO_RES:
    29872979            {
    29882980                uint32_t uWidth = 0;
    … …  
    30072999                break;
    30083000            }
    3009             case MODIFYVM_VIDEOCAP_RATE:
     3001            case MODIFYVM_CAPTURE_VIDEO_RATE:
    30103002            {
    30113003                CHECK_ERROR(sessionMachine, COMSETTER(VideoCaptureRate)(ValueUnion.u32));
    30123004                break;
    30133005            }
    3014             case MODIFYVM_VIDEOCAP_FPS:
     3006            case MODIFYVM_CAPTURE_VIDEO_FPS:
    30153007            {
    30163008                CHECK_ERROR(sessionMachine, COMSETTER(VideoCaptureFPS)(ValueUnion.u32));
    30173009                break;
    30183010            }
    3019             case MODIFYVM_VIDEOCAP_MAXTIME:
     3011            case MODIFYVM_CAPTURE_MAXTIME:
    30203012            {
    30213013                CHECK_ERROR(sessionMachine, COMSETTER(VideoCaptureMaxTime)(ValueUnion.u32));
    30223014                break;
    30233015            }
    3024             case MODIFYVM_VIDEOCAP_MAXSIZE:
     3016            case MODIFYVM_CAPTURE_MAXSIZE:
    30253017            {
    30263018                CHECK_ERROR(sessionMachine, COMSETTER(VideoCaptureMaxFileSize)(ValueUnion.u32));
    30273019                break;
    30283020            }
    3029             case MODIFYVM_VIDEOCAP_OPTIONS:
     3021            case MODIFYVM_CAPTURE_OPTIONS:
    30303022            {
    30313023                Bstr bstr(ValueUnion.psz);
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