org.virtualbox_7_2
Class IRecordingSettings

java.lang.Object
  extended by org.virtualbox_7_2.IUnknown
      extended by org.virtualbox_7_2.IRecordingSettings

public class IRecordingSettings
extends IUnknown

The IRecordingSettings interface represents recording settings of the virtual machine. This is used only in theIMachine.getRecordingSettings()attribute. Interface ID: {83CFDC66-4F20-4569-AD39-8722F7D472B3}


Field Summary
 
Fields inherited from class org.virtualbox_7_2.IUnknown
obj, objMgr, port
 
Constructor Summary
IRecordingSettings(java.lang.String wrapped, org.virtualbox_7_2.ObjectRefManager objMgr, org.virtualbox_7_2.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Boolean getEnabled()
          This setting determines whether recording is enabled for this VM.
 java.lang.Boolean getPaused()
          Pauses the recording or returns the current paused status.If recording already has been paused, this attribute does nothing.
 IProgress getProgress()
          Returns the recording progress object.
 java.util.List<IRecordingScreenSettings> getScreens()
          This setting returns an array for recording settings of all configured virtual screens.
 IRecordingScreenSettings getScreenSettings(java.lang.Long screenId)
          Returns the recording settings for a particular screen.
static IRecordingSettings queryInterface(IUnknown obj)
           
 void resume()
          Resumes the recording.
 void setEnabled(java.lang.Boolean value)
          This setting determines whether recording is enabled for this VM.
 void setPaused(java.lang.Boolean value)
          Pauses the recording or returns the current paused status.If recording already has been paused, this attribute does nothing.
 IProgress start()
          Starts recording and returns a progress object.
 
Methods inherited from class org.virtualbox_7_2.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IRecordingSettings

public IRecordingSettings(java.lang.String wrapped,
                          org.virtualbox_7_2.ObjectRefManager objMgr,
                          org.virtualbox_7_2.jaxws.VboxPortType port)
Method Detail

getPaused

public java.lang.Boolean getPaused()
Pauses the recording or returns the current paused status.If recording already has been paused, this attribute does nothing.

Expected result codes:
E_FAIL - Unable to pause recording due to pausing not available. See error message for more information.
VBOX_E_NOT_SUPPORTED - Pausing is not supported.
NOTE: Currently not implemented. NOTE: This will not affect the recording progress object.

Returns:
Boolean

setPaused

public void setPaused(java.lang.Boolean value)
Pauses the recording or returns the current paused status.If recording already has been paused, this attribute does nothing.

Expected result codes:
E_FAIL - Unable to pause recording due to pausing not available. See error message for more information.
VBOX_E_NOT_SUPPORTED - Pausing is not supported.
NOTE: Currently not implemented. NOTE: This will not affect the recording progress object.

Parameters:
value - Boolean

getEnabled

public java.lang.Boolean getEnabled()
This setting determines whether recording is enabled for this VM. Note that this attribute does not actually start or stop recording. For starting recording, usestart(), for stopping, use the the progress object viagetProgress(). If a VM is being started with this setting enabled, recording automatically will be started with the currently configured recording settings.

Returns:
Boolean

setEnabled

public void setEnabled(java.lang.Boolean value)
This setting determines whether recording is enabled for this VM. Note that this attribute does not actually start or stop recording. For starting recording, usestart(), for stopping, use the the progress object viagetProgress(). If a VM is being started with this setting enabled, recording automatically will be started with the currently configured recording settings.

Parameters:
value - Boolean

getScreens

public java.util.List<IRecordingScreenSettings> getScreens()
This setting returns an array for recording settings of all configured virtual screens.

Returns:
List<org.virtualbox_7_2.IRecordingScreenSettings>

getProgress

public IProgress getProgress()
Returns the recording progress object. Also valid when recording has been paused. Cancelling the progress will stop the recording.

Expected result codes:
E_FAIL - Failed to get the recording progress object due to not (yet) started recording.

Returns:
org.virtualbox_7_2.IProgress

queryInterface

public static IRecordingSettings queryInterface(IUnknown obj)

getScreenSettings

public IRecordingScreenSettings getScreenSettings(java.lang.Long screenId)
Returns the recording settings for a particular screen.

Parameters:
screenId - Screen ID to retrieve recording screen settings for.
Returns:
Recording screen settings for the requested screen.

start

public IProgress start()
Starts recording and returns a progress object.

Returns:
The recording progress object for this VM.

resume

public void resume()
Resumes the recording. NOTE: Currently not implemented. NOTE: This will not affect the recording progress object.