livekit::VideoStream::Options Struct Reference

Options for creating a decoded video frame stream. More...

#include <video_stream.h>

Public Attributes
std::size_t	capacity {0}
	Maximum number of VideoFrameEvent items buffered in the internal queue.
VideoBufferType	format {VideoBufferType::RGBA}
	Preferred pixel format for frames delivered by read().

Detailed Description

Options for creating a decoded video frame stream.

Member Data Documentation

capacity

std::size_t livekit::VideoStream::Options::capacity {0}

Maximum number of VideoFrameEvent items buffered in the internal queue.

0 means "unbounded" (the queue can grow without limit).

With a non-zero capacity, the queue behaves like a ring-buffer: if it is full, the oldest frame is dropped when a new one arrives.

format

VideoBufferType livekit::VideoStream::Options::format {VideoBufferType::RGBA}

Preferred pixel format for frames delivered by read().

The FFI layer converts into this format if supported (e.g., RGBA, BGRA, I420, ...).

---

The documentation for this struct was generated from the following file:

• include/livekit/video_stream.h