Factory object for creating device objects. More...
Inherits object.
Public Member Functions | |
List[cvb.DiscoveryInformation] | discover_from_level (str access_token, int flags=cvb.DiscoverFlags.FindAll, int time_span=300) |
Discovers available devices / nodes depending on the given flags and starting at the level of the given access token. More... | |
List[cvb.DiscoveryInformation] | discover_from_root (int flags=cvb.DiscoverFlags.FindAll, int time_span=300) |
Discovers available devices / nodes depending on the given flags. More... | |
Union[cvb.GenICamDevice, cvb.VinDevice, cvb.EmuDevice, cvb.VideoDevice, cvb.NonStreamingDevice] | open (str provider, int acquisition_stack=cvb.AcquisitionStack.PreferVin) |
Opens a device with the given provider and acquisition stack. More... | |
Union[cvb.VinDevice, cvb.EmuDevice, cvb.VideoDevice, cvb.NonStreamingDevice] | open (str provider, int port=0, int board=0) |
Opens a device with the given provider. More... | |
cvb.VinDevice | open_board (str provider, int board) |
Open a device with the given provider and board. More... | |
cvb.VinDevice | open_port (str provider, int port) |
Opens a device with the given provider and port. More... | |
Factory object for creating device objects.
List[cvb.DiscoveryInformation] discover_from_level | ( | str | access_token, |
int | flags = cvb.DiscoverFlags.FindAll , |
||
int | time_span = 300 |
||
) |
Discovers available devices / nodes depending on the given flags and starting at the level of the given access token.
This method does not throw if the wait time is exceeded: it just waits for the time span. If a device answers after this span, it is not in the returned list.
access_token : str Start level for the discover or root, if none provided.
flags : int Discovery control flags (see cvb.DiscoverFlags).
time_span : int Time in ms to wait for discovery answers from devices.
List[cvb.DiscoveryInformation] The list of found devices / nodes.
List[cvb.DiscoveryInformation] discover_from_root | ( | int | flags = cvb.DiscoverFlags.FindAll , |
int | time_span = 300 |
||
) |
Discovers available devices / nodes depending on the given flags.
This method does not throw, if the wait time is exceeded: it just waits for the time span. If a device answers after this span, it is not in the returned list.
flags : int Discovery control flags (see cvb.DiscoverFlags).
time_span : int Time in ms to wait for discovery answers from devices.
List[cvb.DiscoveryInformation] The list of found devices / nodes.
Union[cvb.GenICamDevice, cvb.VinDevice, cvb.EmuDevice, cvb.VideoDevice, cvb.NonStreamingDevice] open | ( | str | provider, |
int | acquisition_stack = cvb.AcquisitionStack.PreferVin |
||
) |
Opens a device with the given provider and acquisition stack.
Full acqusition stack support is only possible if the provider is an accesstoken. GenTL user should always select cvb.AcqusitionStack.GenTL.
provider : str An access token or a path to a file
acquisition_stack : int Acquisition stack to open the device with.
Union[cvb.GenICamDevice, cvb.VinDevice, cvb.EmuDevice, cvb.VideoDevice, cvb.NonStreamingDevice] A device object
Union[cvb.VinDevice, cvb.EmuDevice, cvb.VideoDevice, cvb.NonStreamingDevice] open | ( | str | provider, |
int | port = 0 , |
||
int | board = 0 |
||
) |
Opens a device with the given provider.
This works with a file path only. After the device is opened, the device is switched to the given port and board internally.
provider : str A path to a file (may be a VIN driver)
port : int Port number to open (use keyword).
board : int Board number to open (use keyword).
Union[cvb.VinDevice, cvb.EmuDevice, cvb.VideoDevice, cvb.NonStreamingDevice] A device object
cvb.VinDevice open_board | ( | str | provider, |
int | board | ||
) |
Open a device with the given provider and board.
provider : str The provider string, which may be a path to vin-driver.
board : int Board number to open.
cvb.VinDevice A device object.
cvb.VinDevice open_port | ( | str | provider, |
int | port | ||
) |
Opens a device with the given provider and port.
provider : str The provider string, which may be a path to vin-driver.
port : int Port number to open.
cvb.VinDevice A device object.