ark::image::VideoBuffer

Defined in header “ark/image/video_device.hh”.

---

A buffer that is coming from the device. Contains basic metadata surrounding the frame. When you are done with it, manually release it against the given video device.

The contents of this buffer are shared, so if you hold onto it for too long, the host device my end up timing out.

Variables

• std::vector< VideoBufferPlane > planes
  The video planes for this buffer. This structure’s size can be assumed to be static (it doesn’t change during the lifetime of a buffer).

• std::chrono::steady_clock::time_point capture_time{}
  Timestamp of the contents in this image.

• uint64_t sequence_number= 0
  The sequence number of this image, from the device.

• bool queued= false
  Indicates if the buffer is currently queued on the remote device.

• bool actively_writing= false
  Indicates if this buffer is currently being used for an output.

• size_t identifier= 0
  The identifier of the buffer (for convenience).

• bool error_bit
  If the ’error bit’ was set on this buffer or not when it was grabbed. It’s a bit device-specific what this ’error bit’ means, so we pass this along to downstream consumers to decide what to do with it.