|
VirtualBox Main API
|
The IRecordingSettings interface represents recording settings of the virtual machine. More...
Public Member Functions | |
| void | getScreenSettings (in unsigned long screenId, [retval] out IRecordingScreenSettings recordScreenSettings) |
| Returns the recording settings for a particular screen. | |
| void | start ([retval] out IProgress progress) |
| Starts recording and returns a progress object. | |
Public Attributes | |
| attribute boolean | enabled |
| This setting determines whether recording is enabled for this VM. | |
| readonly attribute IRecordingScreenSettings[] | screens |
| This setting returns an array for recording settings of all configured virtual screens. | |
| readonly attribute IProgress | progress |
| Returns the recording progress object. | |
The IRecordingSettings interface represents recording settings of the virtual machine.
This is used only in the IMachine::recordingSettings attribute.
{BEA3EF5C-DE2F-4B74-AA3A-15D6249371A0} | void IRecordingSettings::getScreenSettings | ( | in unsigned long | screenId, |
| [retval] out IRecordingScreenSettings | recordScreenSettings | ||
| ) |
Returns the recording settings for a particular screen.
| screenId | Screen ID to retrieve recording screen settings for. |
| recordScreenSettings | Recording screen settings for the requested screen. |
| void IRecordingSettings::start | ( | [retval] out IProgress | progress | ) |
Starts recording and returns a progress object.
| progress | The recording progress object for this VM. |
| attribute boolean IRecordingSettings::enabled |
This setting determines whether recording is enabled for this VM.
Note that this attribute does not actually start or stop recording. For starting recording, use IRecordingSettings::start, for stopping, use the the progress object via IRecordingSettings::progress.
If a VM is being started with this setting enabled, recording automatically will be started with the currently configured recording settings.
| readonly attribute IRecordingScreenSettings [] IRecordingSettings::screens |
This setting returns an array for recording settings of all configured virtual screens.
| readonly attribute IProgress IRecordingSettings::progress |
Returns the recording progress object.
Cancelling the progress will stop the recording.
| E_FAIL | Failed to get the recording progress object due to not (yet) started recording. |