org.virtualbox_6_1
Class IUSBDeviceFilters

java.lang.Object
  extended by org.virtualbox_6_1.IUnknown
      extended by org.virtualbox_6_1.IUSBDeviceFilters

public class IUSBDeviceFilters
extends IUnknown


Field Summary
 
Fields inherited from class org.virtualbox_6_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IUSBDeviceFilters(java.lang.String wrapped, org.virtualbox_6_1.ObjectRefManager objMgr, org.virtualbox_6_1.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.
 void insertDeviceFilter(java.lang.Long position, IUSBDeviceFilter filter)
          Inserts the given USB device to the specified position in the list of filters.
static IUSBDeviceFilters queryInterface(IUnknown obj)
           
 IUSBDeviceFilter removeDeviceFilter(java.lang.Long position)
          Removes a USB device filter from the specified position in the list of filters.
 
Methods inherited from class org.virtualbox_6_1.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

IUSBDeviceFilters

public IUSBDeviceFilters(java.lang.String wrapped,
                         org.virtualbox_6_1.ObjectRefManager objMgr,
                         org.virtualbox_6_1.jaxws.VboxPortType port)
Method Detail

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 statesUSBDeviceState.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<org.virtualbox_6_1.IUSBDeviceFilter>
See Also:
IUSBDeviceFilter, IUSBController

queryInterface

public static IUSBDeviceFilters 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),activeis false (the filter is not active). The created filter can then be added to the list of filters usinginsertDeviceFilter(Long,org.virtualbox_6_1.IUSBDeviceFilter).

Parameters:
name - Filter name. SeeIUSBDeviceFilter.getName()for more info.
Returns:
Created filter object. Expected result codes:
VBOX_E_INVALID_VM_STATEThe 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 from0. 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:
VBOX_E_INVALID_VM_STATEVirtual machine is not mutable.
E_INVALIDARGUSB device filter not created within this VirtualBox instance.
VBOX_E_INVALID_OBJECT_STATEUSB 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 from0. 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:
VBOX_E_INVALID_VM_STATEVirtual machine is not mutable.
E_INVALIDARGUSB device filter list empty or invalid position.
See Also:
getDeviceFilters()