|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectorg.virtualbox_7_2.IUnknown
org.virtualbox_7_2.IRecordingSettings
public class IRecordingSettings
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 |
|---|
public IRecordingSettings(java.lang.String wrapped,
org.virtualbox_7_2.ObjectRefManager objMgr,
org.virtualbox_7_2.jaxws.VboxPortType port)
| Method Detail |
|---|
public java.lang.Boolean getPaused()
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.
public void setPaused(java.lang.Boolean value)
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.
value - Booleanpublic 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()
public void resume()
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||