public class IRecordingSettings extends IUnknown
IMachine.getRecordingSettings()
attribute.
Interface ID: {BEA3EF5C-DE2F-4B74-AA3A-15D6249371A0}
Constructor and Description |
---|
IRecordingSettings(java.lang.String wrapped,
org.virtualbox_7_1.ObjectRefManager objMgr,
org.virtualbox_7_1.jaxws.VboxPortType port) |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getEnabled()
This setting determines whether recording is enabled for this VM.
|
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 |
setEnabled(java.lang.Boolean value)
This setting determines whether recording is enabled for this VM.
|
IProgress |
start()
Starts recording and returns a progress object.
|
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
public IRecordingSettings(java.lang.String wrapped, org.virtualbox_7_1.ObjectRefManager objMgr, org.virtualbox_7_1.jaxws.VboxPortType port)
public java.lang.Boolean getEnabled()
start()
, 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.public void setEnabled(java.lang.Boolean value)
start()
, 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.value
- Booleanpublic java.util.List<IRecordingScreenSettings> getScreens()
public IProgress getProgress()
E_FAIL
- Failed to get the recording progress object due to not (yet) started
recording.public static IRecordingSettings queryInterface(IUnknown obj)
public IRecordingScreenSettings getScreenSettings(java.lang.Long screenId)
screenId
- Screen ID to retrieve recording screen settings for.public IProgress start()