livekit::AudioStream::Options Struct Reference

Configuration options for AudioStream creation. More...

#include <audio_stream.h>

Public Attributes
std::size_t	capacity {0}
std::string	noise_cancellation_module
std::string	noise_cancellation_options_json

Detailed Description

Configuration options for AudioStream creation.

Member Data Documentation

capacity

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

Maximum number of AudioFrameEvent items buffered in the internal queue. 0 means "unbounded" (the queue can grow without limit).

Using a small non-zero capacity gives ring-buffer semantics: if the queue is full, the oldest frame is dropped when a new one arrives.

noise_cancellation_module

std::string livekit::AudioStream::Options::noise_cancellation_module

Optional: name of a noise cancellation module to enable for this stream. Empty string means "no noise cancellation".

noise_cancellation_options_json

std::string livekit::AudioStream::Options::noise_cancellation_options_json

Optional: JSON-encoded configuration for the noise cancellation module. Empty string means "use module defaults".

---

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

• include/livekit/audio_stream.h