Base class of all composite based streams. More...
Inherits StreamBase.
Inherited by CompositeStream, ImageStream, and PointCloudStream.
Public Member Functions | |
None | deregister_flow_set_pool (self) |
Removes an existing flow set pool from the acquisition engine. More... | |
None | device_abort (self) |
Stops the stream in the device immediately. | |
None | device_start (self, int buffer_count_to_acquire=-1) |
Starts the stream on the device. More... | |
None | device_stop (self) |
Stops the stream in the device. | |
None | engine_abort (self) |
Stops the acquisition engine immediately. | |
None | engine_start (self, int buffer_count_to_acquire=-1) |
Starts the acquisition engine on the host. More... | |
None | engine_stop (self, int timeout=-1) |
Stops the acquisition engine. More... | |
None | register_managed_flow_set_pool (self, int flow_set_count) |
Registers an internal flows set pool. More... | |
bool | try_device_abort (self) |
Stops the stream in the device immediately. More... | |
bool | try_device_stop (self) |
Stops the stream in the device. More... | |
bool | try_engine_abort (self) |
Stops the acquisition engine immediately. More... | |
bool | try_engine_stop (self, int timeout=-1) |
Stops the acquisition engine. More... | |
Public Member Functions inherited from StreamBase | |
None | abort (self) |
Stops the acquisition of images immediately. More... | |
None | start (self) |
Starts the acquisition. More... | |
None | stop (self) |
Stops the acquisition. More... | |
bool | try_abort (self) |
Stops the acquisition of images immediately. More... | |
bool | try_stop (self) |
Stops the acquisition. More... | |
Properties | |
acquisition_state = property | |
int: Returns the current acquisition state (see cvb.AcquisitionState). | |
flow_set_count = property | |
int: Gets the number of registered flow sets. | |
min_required_flow_set_count = property | |
int: Gets minimum number of flow sets required for the acquisition. | |
node_maps = property | |
Dict[str, Optional[cvb.NodeMap]]: Gets the dictionary holding all available NodeMaps. | |
Properties inherited from StreamBase | |
is_indexed = property | |
bool: Returns whether this stream is an indexed stream. | |
Base class of all composite based streams.
None deregister_flow_set_pool | ( | self | ) |
Removes an existing flow set pool from the acquisition engine.
Removing a flow set pool can be useful in between subsequent registrations to reduce memory consumption.This method must only be called when the stream is in AcquisitionState::Stopped.
None device_start | ( | self, | |
int | buffer_count_to_acquire = -1 |
||
) |
Starts the stream on the device.
buffer_count_to_acquire : int Number of buffers to acquire. The default value of -1 starts continuous acquisition that needs to be stopped via engine_stop or engine_abort.
None engine_start | ( | self, | |
int | buffer_count_to_acquire = -1 |
||
) |
Starts the acquisition engine on the host.
buffer_count_to_acquire : int Number of buffers to acquire. The default value of -1 starts continuous acquisition that needs to be stopped via engine_stop or engine_abort.
None engine_stop | ( | self, | |
int | timeout = -1 |
||
) |
Stops the acquisition engine.
The default value of -1 uses an infinite timeout.
timeout : int Timeout duration in milliseconds.
None register_managed_flow_set_pool | ( | self, | |
int | flow_set_count | ||
) |
Registers an internal flows set pool.
flow_set_count : int Number of flow sets to allocate.
bool try_device_abort | ( | self | ) |
Stops the stream in the device immediately.
bool True if successfully stopped, false on error.
bool try_device_stop | ( | self | ) |
Stops the stream in the device.
bool True if successfully stopped, false on error.
bool try_engine_abort | ( | self | ) |
Stops the acquisition engine immediately.
bool True if successfully stopped, false on error.
bool try_engine_stop | ( | self, | |
int | timeout = -1 |
||
) |
Stops the acquisition engine.
The default value of -1 uses an infinite timeout.
timeout : int Timeout duration in milliseconds.
bool True if successfully stopped, false on error.