CVBpy 14.1
Stream Class Reference

Represents one acquisition stream of a device. More...

Inherits StreamBase.

Inherited by IndexedStream.

Public Member Functions

Tuple[Optional[cvb.StreamImage], int] get_snapshot (self)
 Acquires a single image and returns it. More...
 
Tuple[Optional[cvb.StreamImage], int] get_timed_snapshot (self, int time_span)
 Acquires a single image for a given time span and returns it. More...
 
Tuple[Optional[Union[cvb.RingBufferImage, cvb.StreamImage]], int] wait (self)
 Waits forever for the next acquired image and returns it. More...
 
cvb.AsyncWaitResult wait_async (self, int time_span)
 Waits asynchronously for the next acquired image. More...
 
cvb.AsyncWaitResult wait_async_for (self, int time_span)
 Waits asyncronously for the given time span for the next acquired image. More...
 
Tuple[Optional[Union[cvb.RingBufferImage, cvb.StreamImage]], int] wait_for (self, int time_span)
 Waits for the given time span for the next acquired image. 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_interface = property
 int: Gets or sets the interface of this implementation (see cvb.AcquisitionInterface).
 
 is_running = property
 bool: Returns whether the acquisition is currently active.
 
 ring_buffer = property
 Optional[cvb.RingBuffer]: Gets the ring buffer interface object if present.
 
 statistics = property
 cvb.StreamStatistics: Gets statistics.
 
- Properties inherited from StreamBase
 is_indexed = property
 bool: Returns whether this stream is an indexed stream.
 

Detailed Description

Represents one acquisition stream of a device.

This class is deprecated for all technologies providing a GenTL. Use ImageStream, PointCloudStream or CompositeStream instead.

Member Function Documentation

◆ get_snapshot()

Tuple[Optional[cvb.StreamImage], int] get_snapshot (   self)

Acquires a single image and returns it.

Returns

Tuple[Optional[cvb.StreamImage], int] A tuple containing the image (if any), and the status (see cvb.WaitStatus).

◆ get_timed_snapshot()

Tuple[Optional[cvb.StreamImage], int] get_timed_snapshot (   self,
int  time_span 
)

Acquires a single image for a given time span and returns it.

Parameters

time_span : int Time (in ms) to wait for an image.

Returns

Tuple[Optional[cvb.StreamImage], int] A tuple containing the image (if any), and the status (see cvb.WaitStatus).

◆ wait()

Tuple[Optional[Union[cvb.RingBufferImage, cvb.StreamImage]], int] wait (   self)

Waits forever for the next acquired image and returns it.

Returns

Tuple[Optional[Union[cvb.RingBufferImage, cvb.StreamImage]], int] A tuple containing the image (if any), and the status (see cvb.WaitStatus).

◆ wait_async()

cvb.AsyncWaitResult wait_async (   self,
int  time_span 
)

Waits asynchronously for the next acquired image.

The stream must support pending images.

Parameters

time_span : int Time (in ms) to wait for an image.

Returns

cvb.AsyncWaitResult An async wait result that is awaitable.

◆ wait_async_for()

cvb.AsyncWaitResult wait_async_for (   self,
int  time_span 
)

Waits asyncronously for the given time span for the next acquired image.

The stream must support pending images.

Parameters

time_span : int Time (in ms) to wait for an image.

Returns

cvb.AsyncWaitResult An async wait result that is awaitable.

◆ wait_for()

Tuple[Optional[Union[cvb.RingBufferImage, cvb.StreamImage]], int] wait_for (   self,
int  time_span 
)

Waits for the given time span for the next acquired image.

Parameters

time_span : int Time (in ms) to wait for an image.

Returns

Tuple[Optional[Union[cvb.RingBufferImage, cvb.StreamImage]], int] A tuple containing the image (if any), and the status (see cvb.WaitStatus).