Streams

class hs.Stream(iter, header)

Stream type

__iter__()

Implement iter(self).

__next__()

Implement next(self).

get_frame()

Get a single frame from the stream.

Returns:

A tuple containing the frame index and the frame data as a 2D Numpy array.

Return type:

tuple[FrameMeta, numpy.ndarray]

meta()

stop()

Stop the stream.

class hs.FrameMeta

Frame metadata.

dropped

Whether the original frame was dropped and replaced with a black frame.

seq

Frame sequence number.

timestamp

Frame timestamp in seconds. Monotonically increasing.