VirtualBox Main API
Public Member Functions | Public Attributes | List of all members
IRecordingSettings Interface Reference

The IRecordingSettings interface represents recording settings of the virtual machine. More...

Inheritance diagram for IRecordingSettings:

Public Member Functions

void getScreenSettings (in unsigned long screenId, [retval] out IRecordingScreenSettings recordScreenSettings)
 Returns the recording settings for a particular screen.
 

Public Attributes

attribute boolean enabled
 This setting determines whether VirtualBox uses recording to record a VM session.
 
readonly attribute IRecordingScreenSettings[] screens
 This setting returns an array for recording settings of all configured virtual screens.
 

Detailed Description

The IRecordingSettings interface represents recording settings of the virtual machine.

This is used only in the IMachine::recordingSettings attribute.

Interface ID:
{D88F2A5A-47C7-4A3F-AAE1-1B516817DB41}

Member Function Documentation

◆ getScreenSettings()

void IRecordingSettings::getScreenSettings ( in unsigned long  screenId,
[retval] out IRecordingScreenSettings  recordScreenSettings 
)

Returns the recording settings for a particular screen.

Parameters
screenIdScreen ID to retrieve recording screen settings for.
recordScreenSettingsRecording screen settings for the requested screen.

Member Data Documentation

◆ enabled

attribute boolean IRecordingSettings::enabled

This setting determines whether VirtualBox uses recording to record a VM session.

◆ screens

readonly attribute IRecordingScreenSettings [] IRecordingSettings::screens

This setting returns an array for recording settings of all configured virtual screens.