org.virtualbox_4_2
Class IUSBController

java.lang.Object
  extended by org.virtualbox_4_2.IUnknown
      extended by org.virtualbox_4_2.IUSBController

public class IUSBController
extends IUnknown


Field Summary
 
Fields inherited from class org.virtualbox_4_2.IUnknown
obj, port
 
Constructor Summary
IUSBController(java.lang.String wrapped, org.virtualbox_4_2.jaxws.VboxPortType port)
           
 
Method Summary
 IUSBDeviceFilter createDeviceFilter(java.lang.String name)
          Creates a new USB device filter.
 java.util.List<IUSBDeviceFilter> getDeviceFilters()
          List of USB device filters associated with the machine.
 java.lang.Boolean getEnabled()
          Flag whether the USB controller is present in the guest system.
 java.lang.Boolean getEnabledEHCI()
          Flag whether the USB EHCI controller is present in the guest system.
 java.lang.Boolean getProxyAvailable()
          Flag whether there is an USB proxy available.
 java.lang.Integer getUSBStandard()
          USB standard version which the controller implements.
 void insertDeviceFilter(java.lang.Long position, IUSBDeviceFilter filter)
          Inserts the given USB device to the specified position in the list of filters.
static IUSBController queryInterface(IUnknown obj)
           
 IUSBDeviceFilter removeDeviceFilter(java.lang.Long position)
          Removes a USB device filter from the specified position in the list of filters.
 void setEnabled(java.lang.Boolean value)
          Flag whether the USB controller is present in the guest system.
 void setEnabledEHCI(java.lang.Boolean value)
          Flag whether the USB EHCI controller is present in the guest system.
 
Methods inherited from class org.virtualbox_4_2.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IUSBController

public IUSBController(java.lang.String wrapped,
                      org.virtualbox_4_2.jaxws.VboxPortType port)
Method Detail

getEnabled

public java.lang.Boolean getEnabled()
Flag whether the USB controller is present in the guest system. If disabled, the virtual guest hardware will not contain any USB controller. Can only be changed when the VM is powered off.

Returns:
Boolean

setEnabled

public void setEnabled(java.lang.Boolean value)
Flag whether the USB controller is present in the guest system. If disabled, the virtual guest hardware will not contain any USB controller. Can only be changed when the VM is powered off.

Parameters:
value - Boolean

getEnabledEHCI

public java.lang.Boolean getEnabledEHCI()
Flag whether the USB EHCI controller is present in the guest system. If disabled, the virtual guest hardware will not contain a USB EHCI controller. Can only be changed when the VM is powered off.

Returns:
Boolean

setEnabledEHCI

public void setEnabledEHCI(java.lang.Boolean value)
Flag whether the USB EHCI controller is present in the guest system. If disabled, the virtual guest hardware will not contain a USB EHCI controller. Can only be changed when the VM is powered off.

Parameters:
value - Boolean

getProxyAvailable

public java.lang.Boolean getProxyAvailable()
Flag whether there is an USB proxy available.

Returns:
Boolean

getUSBStandard

public java.lang.Integer getUSBStandard()
USB standard version which the controller implements. This is a BCD which means that the major version is in the high byte and minor version is in the low byte.

Returns:
Integer

getDeviceFilters

public java.util.List<IUSBDeviceFilter> getDeviceFilters()
List of USB device filters associated with the machine. If the machine is currently running, these filters are activated every time a new (supported) USB device is attached to the host computer that was not ignored by global filters (IHost.getUSBDeviceFilters()). These filters are also activated when the machine is powered up. They are run against a list of all currently available USB devices (in states USBDeviceState.Available, USBDeviceState.Busy, USBDeviceState.Held) that were not previously ignored by global filters. If at least one filter matches the USB device in question, this device is automatically captured (attached to) the virtual USB controller of this machine.

Returns:
List
See Also:
IUSBDeviceFilter, IUSBController

queryInterface

public static IUSBController queryInterface(IUnknown obj)

createDeviceFilter

public IUSBDeviceFilter createDeviceFilter(java.lang.String name)
Creates a new USB device filter. All attributes except the filter name are set to empty (any match), active is false (the filter is not active). The created filter can then be added to the list of filters using insertDeviceFilter(Long,org.virtualbox_4_2.IUSBDeviceFilter).

Parameters:
name - Filter name. See IUSBDeviceFilter.getName() for more info.
Returns:
Created filter object. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATE The virtual machine is not mutable.
See Also:
getDeviceFilters()

insertDeviceFilter

public void insertDeviceFilter(java.lang.Long position,
                               IUSBDeviceFilter filter)
Inserts the given USB device to the specified position in the list of filters. Positions are numbered starting from 0. If the specified position is equal to or greater than the number of elements in the list, the filter is added to the end of the collection.

Parameters:
position - Position to insert the filter to.
filter - USB device filter to insert. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATE Virtual machine is not mutable.
E_INVALIDARG USB device filter not created within this VirtualBox instance.
@link ::VBOX_E_INVALID_OBJECT_STATE VBOX_E_INVALID_OBJECT_STATE USB device filter already in list.
NOTE: Duplicates are not allowed, so an attempt to insert a filter that is already in the collection, will return an error.
See Also:
getDeviceFilters()

removeDeviceFilter

public IUSBDeviceFilter removeDeviceFilter(java.lang.Long position)
Removes a USB device filter from the specified position in the list of filters. Positions are numbered starting from 0. Specifying a position equal to or greater than the number of elements in the list will produce an error.

Parameters:
position - Position to remove the filter from.
Returns:
Removed USB device filter. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATE Virtual machine is not mutable.
E_INVALIDARG USB device filter list empty or invalid position.
See Also:
getDeviceFilters()