Repository Documentation

July 1, 2026 · View on GitHub

Additional documentation for the SDK.

  • Building — prerequisites, build scripts, CMake presets, vcpkg, Docker, integration into your CMake project, troubleshooting.
  • Authentication — generating tokens, token source types (initial connect only), and in-session token refresh.
  • Logging — compile-time vs runtime filtering, log levels, custom sinks (file, JSON, ROS2 RCLCPP_* macros).
  • Tracing — Chromium-format performance traces, viewing in chrome://tracing and Perfetto.
  • Testing — unit, integration, and stress test suites; env vars; token-helper script for local livekit-server --dev runs.
  • Developer toolsclang-tidy, clang-format, valgrind, Doxygen, pre-commit hook, Rust submodule recovery tips.