VirtualBox Main API
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
oCIAdditionsFacilityStructure representing a Guest Additions facility
oCIAdditionsStateChangedEventNotification when a Guest Additions property changes
oCIApplianceRepresents a platform-independent appliance in OVF format
oCIAudioAdapterVirtual audio adapter of the virtual machine
oCIBandwidthControlControls the bandwidth groups of one machine used to cap I/O done by a VM
oCIBandwidthGroupRepresents one bandwidth group
oCIBandwidthGroupChangedEventNotification when one of the bandwidth groups changed
oCIBIOSSettingsBIOS settings of the virtual machine
oCICanShowWindowEventNotification when a call to IMachine::canShowConsoleWindow is made by a front-end to check if a subsequent call to IMachine::showConsoleWindow can succeed
oCIClipboardModeChangedEventNotification when the shared clipboard mode changes
oCIConsoleInterface to control virtual machine execution
oCICPUChangedEventNotification when a CPU changes
oCICPUExecutionCapChangedEventNotification when the CPU execution cap changes
oCIDHCPServerVirtualBox DHCP server configuration
oCIDirectoryAbstract parent interface for directories handled by VirtualBox
oCIDisplayVirtual machine's display
oCIDragAndDropModeChangedEventNotification when the drag'n'drop mode changes
oCIEmulatedUSBManages emulated USB devices
oCIEventAbstract parent interface for VirtualBox events
oCIEventListenerEvent listener
oCIEventSourceEvent source
oCIEventSourceChangedEventNotification when an event source state changes (listener added or removed)
oCIExtPackInterface for querying information about an extension pack as well as accessing COM objects within it
oCIExtPackBaseInterface for querying information about an extension pack as well as accessing COM objects within it
oCIExtPackFileExtension pack file (aka tarball, .vbox-extpack) representation returned by IExtPackManager::openExtPackFile
oCIExtPackManagerInterface for managing VirtualBox Extension Packs
oCIExtPackPlugInInterface for keeping information about a plug-in that ships with an extension pack
oCIExtraDataCanChangeEventNotification when someone tries to change extra data for either the given machine or (if null) global extra data
oCIExtraDataChangedEventNotification when machine specific or global extra data has changed
oCIFileAbstract parent interface for files handled by VirtualBox
oCIFramebuffer
oCIFramebufferOverlayAlpha blended overlay for displaying status icons above an IFramebuffer
oCIFsObjInfoAbstract parent interface for VirtualBox file system object information
oCIGuestInformation about the operating system running inside the virtual machine
oCIGuestDirectoryImplementation of the IDirectory object for directories on the guest
oCIGuestFileImplementation of the IFile object for files on the guest
oCIGuestFileEventBase abstract interface for all guest file events
oCIGuestFileIOEventBase abstract interface for all guest file input/output (IO) events
oCIGuestFileOffsetChangedEventNotification when a guest file changed its current offset
oCIGuestFileReadEventNotification when data has been read from a guest file
oCIGuestFileRegisteredEventNotification when a guest file was registered or unregistered
oCIGuestFileStateChangedEventNotification when a guest file changed its state
oCIGuestFileWriteEventNotification when data has been written to a guest file
oCIGuestFsObjInfoRepresents the guest implementation of the IFsObjInfo object
oCIGuestKeyboardEventNotification when guest keyboard event happens
oCIGuestMonitorChangedEventNotification when the guest enables one of its monitors
oCIGuestMouseEventNotification when guest mouse event happens
oCIGuestMultiTouchEventNotification when guest touch screen event happens
oCIGuestOSType
oCIGuestProcessImplementation of the IProcess object for processes on the guest
oCIGuestProcessEventBase abstract interface for all guest process events
oCIGuestProcessInputNotifyEventNotification when a guest process' stdin became available
oCIGuestProcessIOEventBase abstract interface for all guest process input/output (IO) events
oCIGuestProcessOutputEventNotification when there is guest process output available for reading
oCIGuestProcessRegisteredEventNotification when a guest process was registered or unregistered
oCIGuestProcessStateChangedEventNotification when a guest process changed its state
oCIGuestPropertyChangedEventNotification when a guest property has changed
oCIGuestSessionA guest session represents one impersonated user account on the guest, so every operation will use the same credentials specified when creating the session object via IGuest::createSession
oCIGuestSessionEventBase abstract interface for all guest session events
oCIGuestSessionRegisteredEventNotification when a guest session was registered or unregistered
oCIGuestSessionStateChangedEventNotification when a guest session changed its state
oCIGuestUserStateChangedEventNotification when a guest user changed its state
oCIHostPhysical machine that this VirtualBox installation runs on
oCIHostNameResolutionConfigurationChangeEvent
oCIHostNetworkInterfaceRepresents one of host's network interfaces
oCIHostPCIDevicePlugEventNotification when host PCI device is plugged/unplugged
oCIHostUSBDevicePhysical USB device attached to the host computer
oCIHostUSBDeviceFilterGlobal filter for a physical USB device used by the host computer
oCIHostVideoInputDeviceRepresents one of host's video capture devices, for example a webcam
oCIInternalMachineControl
oCIInternalSessionControl
oCIKeyboardVirtual machine's keyboard
oCIKeyboardLedsChangedEventNotification when the guest OS executes the KBD_CMD_SET_LEDS command to alter the state of the keyboard LEDs
oCIMachineVirtual machine, or guest, created in VirtualBox
oCIMachineDataChangedEventAny of the settings of the given machine has changed
oCIMachineDebugger
oCIMachineEventBase abstract interface for all machine events
oCIMachineRegisteredEventThe given machine was registered or unregistered within this VirtualBox installation
oCIMachineStateChangedEventMachine state change event
oCIManagedObjectRefManaged object reference
oCIMediumVirtual storage for a machine's hard disks, CD/DVD or floppy drives
oCIMediumAttachmentLinks storage media to virtual machines
oCIMediumChangedEventNotification when a medium attachment changes
oCIMediumFormatMedium format
oCIMediumRegisteredEventThe given medium was registered or unregistered within this VirtualBox installation
oCIMouseVirtual machine's mouse
oCIMouseCapabilityChangedEventNotification when the mouse capabilities reported by the guest have changed
oCIMousePointerShapeChangedEventNotification when the guest mouse pointer shape has changed
oCINATEngineInterface for managing a NAT engine which is used with a virtual machine
oCINATNetwork
oCINATNetworkAlterEvent
oCINATNetworkChangedEvent
oCINATNetworkCreationDeletionEvent
oCINATNetworkPortForwardEvent
oCINATNetworkSettingEvent
oCINATNetworkStartStopEvent
oCINATRedirectEventNotification when NAT redirect rule added or removed
oCINetworkAdapterRepresents a virtual network adapter that is attached to a virtual machine
oCINetworkAdapterChangedEventNotification when a property of one of the virtual network adapters changes
oCIParallelPortVirtual parallel port device
oCIParallelPortChangedEventNotification when a property of one of the virtual parallel ports changes
oCIPCIAddressAddress on the PCI bus
oCIPCIDeviceAttachmentInformation about PCI attachments
oCIPerformanceCollectorService that collects and stores performance metrics data
oCIPerformanceMetricParameters of the given performance metric
oCIProcessAbstract parent interface for processes handled by VirtualBox
oCIProgressUsed to track and control asynchronous tasks within VirtualBox
oCIReusableEventBase abstract interface for all reusable events
oCIRuntimeErrorEventNotification when an error happens during the virtual machine execution
oCISerialPortVirtual serial port device
oCISerialPortChangedEventNotification when a property of one of the virtual serial ports changes
oCISessionClient process and allows for locking virtual machines (represented by IMachine objects) to prevent conflicting changes to the machine
oCISessionStateChangedEventThe state of the session for the given machine was changed
oCISharedFolderFolder in the host computer's file system accessible from the guest OS running inside a virtual machine using an associated logical name
oCISharedFolderChangedEventNotification when a shared folder is added or removed
oCIShowWindowEventNotification when a call to IMachine::showConsoleWindow requests the console window to be activated and brought to foreground on the desktop of the host PC
oCISnapshotSnapshot of the virtual machine
oCISnapshotChangedEventSnapshot properties (name and/or description) have been changed
oCISnapshotDeletedEventSnapshot of the given machine has been deleted
oCISnapshotEventBase interface for all snapshot events
oCISnapshotTakenEventA new snapshot of the machine has been taken
oCIStateChangedEventNotification when the execution state of the machine has changed
oCIStorageControllerRepresents a storage controller that is attached to a virtual machine (IMachine)
oCIStorageControllerChangedEventNotification when a medium attachment changes
oCIStorageDeviceChangedEventNotification when a storage device is attached or removed
oCISystemPropertiesGlobal properties of the given VirtualBox installation
oCITokenToken passed to an API client, which triggers cleanup actions when it is explicitly released by calling the abandon method (preferred, as it is accurately defined when the release happens), or when the object reference count drops to 0
oCIUSBController
oCIUSBControllerChangedEventNotification when a property of the virtual USB controllers changes
oCIUSBDeviceVirtual USB device attached to the virtual machine
oCIUSBDeviceFilterUSB device filter used to perform actions on a group of USB devices
oCIUSBDeviceFilters
oCIUSBDeviceStateChangedEventNotification when a USB device is attached to or detached from the virtual USB controller
oCIVBoxSVCAvailabilityChangedEventNotification when VBoxSVC becomes unavailable (due to a crash or similar unexpected circumstances) or available again
oCIVetoEventBase abstract interface for veto events
oCIVFSExplorerThe VFSExplorer interface unifies access to different file system types
oCIVideoCaptureChangedEventNotification when video capture settings have changed
oCIVirtualBoxMain interface exposed by the product that provides virtual machine management
oCIVirtualBoxClientConvenience interface for client applications
oCIVirtualBoxErrorInfoExtended error information
oCIVirtualSystemDescriptionRepresents one virtual system (machine) in an appliance
oCIVRDEServer
oCIVRDEServerChangedEventNotification when a property of the VRDE server changes
oCIVRDEServerInfoContains information about the remote desktop (VRDE) server capabilities and status
oCIVRDEServerInfoChangedEventNotification when the status of the VRDE server changes
\CIWebsessionManagerWebsession manager