VirtualBox

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


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

Recording: Renaming APIs ICapture* -> IRecord* and other terminology to better distinguish from features like mouse capturing and stuff.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r75326 r75341  
    46904690
    46914691  <enum
    4692     name="CaptureDestination"
    4693     uuid="E54603A9-6751-4255-93F8-C69E61693391"
     4692    name="RecordDestination"
     4693    uuid="F52E217E-CA05-41BA-8851-0FA38B3BA38B"
    46944694    >
    46954695    <desc>
    4696       Capturing destination enumeration.
     4696      Recording destination enumeration.
    46974697    </desc>
    46984698
    … …  
    47064706
    47074707  <enum
    4708     name="CaptureFeature"
    4709     uuid="F606CDDB-91B2-4E41-9DFE-4713D4DBA96F"
     4708    name="RecordFeature"
     4709    uuid="52AEC901-4EF5-4E04-8CA3-EF1478BB0930"
    47104710    >
    47114711    <desc>
    4712       Capturing features enumeration.
     4712      Recording features enumeration.
    47134713    </desc>
    47144714
    … …  
    47174717    </const>
    47184718    <const name="Video"                 value="1">
    4719       <desc>Video capturing.</desc>
     4719      <desc>Video recording.</desc>
    47204720    </const>
    47214721    <const name="Audio"                 value="2">
    4722       <desc>Audio capturing.</desc>
     4722      <desc>Audio recording.</desc>
    47234723    </const>
    47244724  </enum>
    47254725
    47264726  <enum
    4727     name="CaptureAudioCodec"
    4728     uuid="9B80C37F-7984-412C-A755-C18FE5859554"
     4727    name="RecordAudioCodec"
     4728    uuid="B72DD288-0D3F-4652-AE66-D6F621D2F275"
    47294729    >
    47304730    <desc>
    4731       Capturing audio codec enumeration.
     4731      Recording audio codec enumeration.
    47324732    </desc>
    47334733
    … …  
    47454745
    47464746  <enum
    4747     name="CaptureVideoCodec"
    4748     uuid="98BBC021-E119-497D-8C66-4336D539A8D6"
     4747    name="RecordVideoCodec"
     4748    uuid="823F3AD4-151F-4BDB-AFF9-F7C998E46105"
    47494749    >
    47504750    <desc>
    4751       Capturing video codec enumeration.
     4751      Recording video codec enumeration.
    47524752    </desc>
    47534753
    … …  
    47674767
    47684768  <enum
    4769     name="CaptureVideoScalingMethod"
    4770     uuid="8315399B-4F31-416E-970E-D7480BDA1ACF"
     4769    name="RecordVideoScalingMethod"
     4770    uuid="8D656085-BAE6-4F63-86F9-616776EB3773"
    47714771    >
    47724772    <desc>
    4773       Capturing video scaling method enumeration.
     4773      Recording video scaling method enumeration.
    47744774    </desc>
    47754775
    … …  
    47924792
    47934793  <enum
    4794     name="CaptureVideoRateControlMode"
    4795     uuid="5D392E29-04EC-4FD7-989C-82452F54414C"
     4794    name="RecordVideoRateControlMode"
     4795    uuid="11F99274-835F-4F2C-86A5-F8DF8999C21A"
    47964796    >
    47974797    <desc>
    4798       Capturing video rate control mode enumeration.
     4798      Recording video rate control mode enumeration.
    47994799    </desc>
    48004800
    … …  
    48084808
    48094809  <interface
    4810     name="ICaptureScreenSettings" extends="$unknown"
    4811     uuid="B19FFA8A-686C-4221-AB29-3C1FA33946CA"
     4810    name="IRecordScreenSettings" extends="$unknown"
     4811    uuid="7811A5C6-11DB-4F9A-8FAE-1CE238AB4B73"
    48124812    wsmap="managed"
    48134813    >
    48144814
    48154815    <desc>
    4816       The ICaptureScreenSettings interface represents capturing settings of a
    4817       single virtual screen. This is used only in the <link to="ICaptureSettings" />
     4816      The IRecordScreenSettings interface represents recording settings of a
     4817      single virtual screen. This is used only in the <link to="IRecordSettings" />
    48184818      interface.
    48194819    </desc>
    48204820
    48214821    <method name="isFeatureEnabled">
    4822       <desc>Returns whether a particular capturing feature is enabled for this
     4822      <desc>Returns whether a particular recording feature is enabled for this
    48234823        screen or not.</desc>
    4824       <param name="feature" type="CaptureFeature" dir="in">
     4824      <param name="feature" type="RecordFeature" dir="in">
    48254825        <desc>Feature to check for.</desc>
    48264826      </param>
    … …  
    48384838    <attribute name="enabled" type="boolean" default="false">
    48394839      <desc>
    4840         This setting determines whether this screen is enabled while capturing.
     4840        This setting determines whether this screen is enabled while recording.
    48414841      </desc>
    48424842    </attribute>
    48434843
    48444844    <attribute name="features" type="unsigned long">
    4845       <desc>This setting determines all enabled capturing features for this
     4845      <desc>This setting determines all enabled recording features for this
    48464846        screen.</desc>
    48474847    </attribute>
    48484848
    4849     <attribute name="destination" type="CaptureDestination">
    4850       <desc>This setting determines the capturing destination for this
     4849    <attribute name="destination" type="RecordDestination">
     4850      <desc>This setting determines the recording destination for this
    48514851        screen.</desc>
    48524852    </attribute>
    … …  
    48564856        This setting determines the filename VirtualBox uses to save
    48574857        the recorded content. This setting cannot be changed while video
    4858         capturing is enabled.
     4858        recording is enabled.
    48594859        <note>
    48604860          When setting this attribute, the specified path has to be
    … …  
    48684868      <desc>
    48694869        This setting defines the maximum amount of time in milliseconds
    4870         to capture. Capturing will stop as soon as the defined time
    4871         interval has elapsed. If this value is zero, capturing will not be
    4872         limited by time. This setting cannot be changed while capturing is
     4870        to record. Recording will stop as soon as the defined time
     4871        interval has elapsed. If this value is zero, recording will not be
     4872        limited by time. This setting cannot be changed while recording is
    48734873        enabled.
    48744874      </desc>
    … …  
    48774877    <attribute name="maxFileSize" type="unsigned long" default="0">
    48784878      <desc>
    4879         This setting determines the maximal number of captured file
    4880         size in MB. Capturing will stop as soon as the file size has
    4881         reached the defined value. If this value is zero, capturing
     4879        This setting determines the maximal number of recording file
     4880        size in MB. Recording will stop as soon as the file size has
     4881        reached the defined value. If this value is zero, recording
    48824882        will not be limited by the file size. This setting cannot be changed
    4883         while capturing is enabled.
     4883        while recording is enabled.
    48844884      </desc>
    48854885    </attribute>
    … …  
    48874887    <attribute name="options" type="wstring">
    48884888      <desc>
    4889         This setting contains any additional capturing options
     4889        This setting contains any additional recording options
    48904890        required in comma-separated key=value format. This setting
    4891         cannot be changed while capturing is enabled.
     4891        cannot be changed while recording is enabled.
    48924892
    48934893        The following keys and their corresponding values are available:
    … …  
    49064906    </attribute>
    49074907
    4908     <attribute name="audioCodec" type="CaptureAudioCodec">
     4908    <attribute name="audioCodec" type="RecordAudioCodec">
    49094909      <desc>
    49104910        Determines the audio codec to use for encoding the
    4911         recorded audio data. This setting cannot be changed while capturing is
     4911        recorded audio data. This setting cannot be changed while recording is
    49124912        enabled.
    49134913      </desc>
    … …  
    49174917      <desc>
    49184918        Determines the Hertz (Hz) rate of the recorded audio data. This setting
    4919         cannot be changed while capturing is enabled.
     4919        cannot be changed while recording is enabled.
    49204920      </desc>
    49214921    </attribute>
    … …  
    49244924      <desc>
    49254925        Determines the bits per sample of the recorded audio data. This setting
    4926         cannot be changed while capturing is enabled.
     4926        cannot be changed while recording is enabled.
    49274927      </desc>
    49284928    </attribute>
    … …  
    49334933        Specifiy 2 for stereo or 1 for mono. More than stereo (2) channels
    49344934        are not supported at the moment. This setting cannot be changed while
    4935         capturing is enabled.
    4936       </desc>
    4937     </attribute>
    4938 
    4939     <attribute name="videoCodec" type="CaptureVideoCodec">
     4935        recording is enabled.
     4936      </desc>
     4937    </attribute>
     4938
     4939    <attribute name="videoCodec" type="RecordVideoCodec">
    49404940      <desc>
    49414941        Determines the video codec to use for encoding the recorded video data.
    4942         This setting cannot be changed while capturing is enabled.
     4942        This setting cannot be changed while recording is enabled.
    49434943      </desc>
    49444944    </attribute>
    … …  
    49474947      <desc>
    49484948        Determines the horizontal resolution of the recorded video data. This
    4949         setting cannot be changed while capturing is enabled.
     4949        setting cannot be changed while recording is enabled.
    49504950      </desc>
    49514951    </attribute>
    … …  
    49544954      <desc>
    49554955        Determines the vertical resolution of the recorded video data. This
    4956         setting cannot be changed while capturing is enabled.
     4956        setting cannot be changed while recording is enabled.
    49574957      </desc>
    49584958    </attribute>
    … …  
    49624962        Determines the bitrate in kilobits per second. Increasing this value
    49634963        makes the video look better for the cost of an increased file size or
    4964         transfer rate. This setting cannot be changed while capturing is enabled.
    4965       </desc>
    4966     </attribute>
    4967 
    4968     <attribute name="videoRateControlMode" type="CaptureVideoRateControlMode">
     4964        transfer rate. This setting cannot be changed while recording is enabled.
     4965      </desc>
     4966    </attribute>
     4967
     4968    <attribute name="videoRateControlMode" type="RecordVideoRateControlMode">
    49694969      <desc>
    49704970        Determines the rate control mode. This setting cannot be changed
    4971         while capturing is enabled.
     4971        while recording is enabled.
    49724972      </desc>
    49734973    </attribute>
    … …  
    49784978        a higher frequency will be skipped. Reducing this value increases the
    49794979        number of skipped frames and reduces the file size or transfer rate.
    4980         This setting cannot be changed while capturing is enabled.
    4981       </desc>
    4982     </attribute>
    4983 
    4984     <attribute name="videoScalingMethod" type="CaptureVideoScalingMethod">
     4980        This setting cannot be changed while recording is enabled.
     4981      </desc>
     4982    </attribute>
     4983
     4984    <attribute name="videoScalingMethod" type="RecordVideoScalingMethod">
    49854985      <desc>
    49864986        Determines the video scaling method to use.
    4987         This setting cannot be changed while capturing is enabled.
     4987        This setting cannot be changed while recording is enabled.
    49884988      </desc>
    49894989    </attribute>
    … …  
    49924992
    49934993  <interface
    4994     name="ICaptureSettings" extends="$unknown"
    4995     uuid="F35B5C06-F6F0-475D-908A-F5FECC820043"
     4994    name="IRecordSettings" extends="$unknown"
     4995    uuid="7202BACF-2BFE-46AA-AEF6-69B32FDDE236"
    49964996    wsmap="managed"
    49974997    >
    49984998
    49994999    <desc>
    5000       The ICaptureSettings interface represents capturing settings of the virtual
    5001       machine. This is used only in the <link to="IMachine::captureSettings" />
     5000      The IRecordSettings interface represents recording settings of the virtual
     5001      machine. This is used only in the <link to="IMachine::recordSettings" />
    50025002      attribute.
    50035003    </desc>
    50045004
    50055005    <method name="getScreenSettings">
    5006       <desc>Returns the capturing settings for a particular screen.</desc>
     5006      <desc>Returns the recording settings for a particular screen.</desc>
    50075007      <param name="screenId" type="unsigned long" dir="in">
    5008         <desc>Screen ID to retrieve capturing screen settings for.</desc>
    5009       </param>
    5010       <param name="captureScreenSettings" type="ICaptureScreenSettings" dir="return">
    5011         <desc>Capturing screen settings for the requested screen.</desc>
     5008        <desc>Screen ID to retrieve recording screen settings for.</desc>
     5009      </param>
     5010      <param name="recordScreenSettings" type="IRecordScreenSettings" dir="return">
     5011        <desc>Recording screen settings for the requested screen.</desc>
    50125012      </param>
    50135013    </method>
    … …  
    50155015    <attribute name="enabled" type="boolean" default="false">
    50165016      <desc>
    5017         This setting determines whether VirtualBox uses capturing to record a
     5017        This setting determines whether VirtualBox uses recording to record a
    50185018        VM session.</desc>
    50195019    </attribute>
    50205020
    5021     <attribute name="screens" type="ICaptureScreenSettings" readonly="yes" safearray="yes">
    5022       <desc>
    5023         This setting returns an array for capturing settings of all configured
     5021    <attribute name="screens" type="IRecordScreenSettings" readonly="yes" safearray="yes">
     5022      <desc>
     5023        This setting returns an array for recording settings of all configured
    50245024        virtual screens.</desc>
    50255025    </attribute>
    … …  
    52215221  <interface
    52225222    name="IMachine" extends="$unknown"
    5223     uuid="316A9802-03A5-44BE-B2A6-51261A021353"
     5223    uuid="7210DD84-2301-4C3B-8DB3-72DEBD3B91F9"
    52245224    wsmap="managed"
    52255225    wrap-hint-server-addinterfaces="IInternalMachineControl"
    … …  
    55065506    </attribute>
    55075507
    5508     <attribute name="captureSettings" type="ICaptureSettings" readonly="yes">
    5509       <desc>Object containing all capturing settings.</desc>
     5508    <attribute name="recordSettings" type="IRecordSettings" readonly="yes">
     5509      <desc>Object containing all recording settings.</desc>
    55105510    </attribute>
    55115511
    … …  
    2065220652  <interface
    2065320653    name="IInternalSessionControl" extends="$unknown"
    20654     uuid="96BDA9B7-92E6-402F-AA8C-2E77818DAE6E"
     20654    uuid="5CEB7885-5DD5-48E4-96C1-EEF4F4FD9FAC"
    2065520655    internal="yes"
    2065620656    wsmap="suppress"
    … …  
    2095220952    </method>
    2095320953
    20954     <method name="onCaptureChange">
    20955       <desc>
    20956         Triggered when capture settings have changed.
     20954    <method name="onRecordChange">
     20955      <desc>
     20956        Triggered when recording settings have changed.
    2095720957      </desc>
    2095820958    </method>
    … …  
    2313623136      </desc>
    2313723137    </const>
    23138     <const name="OnCaptureChanged" value="91">
    23139       <desc>
    23140         See <link to="ICaptureChangedEvent">ICapturedChangeEvent</link>.
     23138    <const name="OnRecordChanged" value="91">
     23139      <desc>
     23140        See <link to="IRecordChangedEvent">IRecordChangeEvent</link>.
    2314123141      </desc>
    2314223142    </const>
    … …  
    2452324523
    2452424524  <interface
    24525     name="ICaptureChangedEvent" extends="IEvent"
    24526     uuid="C694687C-F432-4435-B457-F2E55B845C81"
    24527     wsmap="managed" autogen="VBoxEvent" id="OnCaptureChanged"
     24525    name="IRecordChangedEvent" extends="IEvent"
     24526    uuid="DA51AA0C-E642-4AA0-9DDD-B07E2911188B"
     24527    wsmap="managed" autogen="VBoxEvent" id="OnRecordChanged"
    2452824528    >
    2452924529    <desc>
    24530       Notification when capture settings have changed.
     24530      Notification when recording settings have changed.
    2453124531    </desc>
    2453224532    <attribute name="midlDoesNotLikeEmptyInterfaces" readonly="yes" type="boolean"/>
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