examples -> cpp-examples-collection, CI to build collection in docker

Author: stephen-derosa

.github/workflows/builds.yml

@@ -266,6 +266,18 @@ jobs:
           submodules: recursive
           fetch-depth: 0
 
+      # Default ubuntu-latest images are tight on disk; this Dockerfile builds GCC
+      # from source plus Rust — BuildKit export/import needs several extra GB.
+      - name: Free disk space
+        uses: jlumbroso/free-disk-space@v1.3.1
+        with:
+          tool-cache: false
+          android: true
+          dotnet: true
+          haskell: true
+          large-packages: true
+          swap-storage: true
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
@@ -305,6 +317,16 @@ jobs:
           submodules: recursive
           fetch-depth: 0
 
+      - name: Free disk space
+        uses: jlumbroso/free-disk-space@v1.3.1
+        with:
+          tool-cache: false
+          android: true
+          dotnet: true
+          haskell: true
+          large-packages: true
+          swap-storage: true
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 

.gitignore

@@ -9,6 +9,7 @@ build.log
 build/
 build-debug/
 build-release/
+local-install/
 release/
 vcpkg_installed/
 # Generated header

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "client-sdk-rust"]
 	path = client-sdk-rust
 	url = https://github.com/livekit/client-sdk-rust
+[submodule "cpp-example-collection"]
+	path = cpp-example-collection
+	url = https://github.com/livekit-examples/cpp-example-collection.git

CMakeLists.txt

@@ -689,7 +689,8 @@ install(FILES
 add_subdirectory(bridge)
 
 if(LIVEKIT_BUILD_EXAMPLES)
-  add_subdirectory(examples)
+  include(cpp-example-collection)
+  livekit_configure_cpp_example_collection()
 endif()
 
 if(LIVEKIT_BUILD_TESTS)

README.md

@@ -150,22 +150,22 @@ lk token create -r test -i your_own_identity  --join --valid-for 99999h --dev --
 
 ### SimpleRoom
 
-```bash
-./build/examples/SimpleRoom --url $URL --token <jwt-token>
+```bash`
+./build-release/cpp-example-collection-build/simple_room/SimpleRoom --url $URL --token <jwt-token>
 ```
 
 You can also provide the URL and token via environment variables:
 ```bash
 export LIVEKIT_URL=ws://localhost:7880
 export LIVEKIT_TOKEN=<jwt-token>
-./build/examples/SimpleRoom
+./build-release/cpp-example-collection-build/simple_room/SimpleRoom
 ```
 
 **End-to-End Encryption (E2EE)**
 You can enable E2E encryption for the streams via --enable_e2ee and --e2ee_key flags,
 by running the following cmds in two terminals or computers. **Note, jwt_token needs to be different identity**
 ```bash
-./build/examples/SimpleRoom --url $URL --token <jwt-token> --enable_e2ee --e2ee_key="your_key"
+./build-release/cpp-example-collection-build/simple_room/SimpleRoom --url $URL --token <jwt-token> --enable_e2ee --e2ee_key="your_key"
 ```
 **Note**, **all participants must use the exact same E2EE configuration and shared key.**
 If the E2EE keys do not match between participants:
@@ -195,7 +195,7 @@ lk token create -r test -i math-genius --join --valid-for 99999h --dev --room=yo
 #### ▶ Start Participants
 Every participant is run as a separate terminal process, note --role needs to match the token identity.
 ```bash
-./build/examples/SimpleRpc --url $URL --token <jwt-token> --role=math-genius
+./build-release/cpp-example-collection-build/simple_rpc/SimpleRpc --url $URL --token <jwt-token> --role=math-genius
 ```
 The caller will automatically:
 - Wait for the greeter and math-genius to join
@@ -223,11 +223,11 @@ lk token create -r test -i greeter --join --valid-for 99999h --dev --room=your_o
 #### ▶ Start Participants
 Start the receiver first (so it registers stream handlers before messages arrive):
 ```bash
-./build/examples/SimpleDataStream --url $URL --token <jwt-token>
+./build-release/cpp-example-collection-build/simple_data_stream/SimpleDataStream --url $URL --token <jwt-token>
 ```
 On another terminal or computer, start the sender
 ```bash
-./build/examples/SimpleDataStream --url $URL --token <jwt-token>
+./build-release/cpp-example-collection-build/simple_data_stream/SimpleDataStream --url $URL --token <jwt-token>
 ```
 
 **Sender** (e.g. greeter)
@@ -306,7 +306,7 @@ livekit::setLogCallback(
 livekit::setLogCallback(nullptr);
 ```
 
-See [`examples/logging_levels/custom_sinks.cpp`](examples/logging_levels/custom_sinks.cpp)
+See [`cpp-example-collection/logging_levels/custom_sinks.cpp`](cpp-example-collection/logging_levels/custom_sinks.cpp)
 for three copy-paste-ready patterns: **file logger**, **JSON structured lines**,
 and a **ROS2 bridge** that maps `LogLevel` to `RCLCPP_*` macros.
 

cmake/cpp-example-collection.cmake

@@ -0,0 +1,61 @@
+# Copyright 2026 LiveKit, Inc.
+#
+# LiveKit examples integration helpers.
+
+include_guard(GLOBAL)
+
+function(livekit_configure_cpp_example_collection)
+  # Absolute paths so out-of-tree builds and symlinks behave consistently.
+  get_filename_component(LIVEKIT_CPP_EXAMPLES_SOURCE_DIR
+    "${CMAKE_SOURCE_DIR}/cpp-example-collection" ABSOLUTE)
+
+  get_filename_component(_lk_examples_install_default
+    "${CMAKE_SOURCE_DIR}/local-install" ABSOLUTE)
+  set(LIVEKIT_CPP_EXAMPLES_INSTALL_PREFIX "${_lk_examples_install_default}"
+    CACHE PATH "Install prefix used by cpp-example-collection")
+
+  get_filename_component(_lk_examples_binary_default
+    "${CMAKE_BINARY_DIR}/cpp-example-collection-build" ABSOLUTE)
+  set(LIVEKIT_CPP_EXAMPLES_BINARY_DIR "${_lk_examples_binary_default}"
+    CACHE PATH "Build directory for cpp-example-collection")
+
+  get_filename_component(LIVEKIT_CPP_EXAMPLES_LIVEKIT_DIR
+    "${LIVEKIT_CPP_EXAMPLES_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/cmake/LiveKit"
+    ABSOLUTE)
+
+  if(NOT EXISTS "${LIVEKIT_CPP_EXAMPLES_SOURCE_DIR}/CMakeLists.txt")
+    message(FATAL_ERROR
+      "cpp-example-collection submodule is missing. Run: "
+      "git submodule sync --recursive && "
+      "git submodule update --init --recursive --checkout")
+  endif()
+
+  add_custom_target(install_livekit_sdk_for_examples
+    COMMAND ${CMAKE_COMMAND} -E make_directory "${LIVEKIT_CPP_EXAMPLES_INSTALL_PREFIX}"
+    COMMAND ${CMAKE_COMMAND} --install "${CMAKE_BINARY_DIR}"
+            --prefix "${LIVEKIT_CPP_EXAMPLES_INSTALL_PREFIX}"
+            --config "$<CONFIG>"
+    DEPENDS livekit
+    COMMENT "Installing LiveKit SDK for cpp-example-collection"
+    VERBATIM
+  )
+
+  # cmake --install /Users/sderosa/workspaces/client-sdk-cpp/build-debug --prefix ~/livekit-sdk-local
+
+
+  add_custom_target(cpp_example_collection ALL
+    COMMAND ${CMAKE_COMMAND} --install "${CMAKE_BINARY_DIR}"
+            --prefix "${LIVEKIT_CPP_EXAMPLES_INSTALL_PREFIX}"
+    COMMAND ${CMAKE_COMMAND} -S "${LIVEKIT_CPP_EXAMPLES_SOURCE_DIR}"
+            -B "${LIVEKIT_CPP_EXAMPLES_BINARY_DIR}"
+            "-DCMAKE_PREFIX_PATH=${LIVEKIT_CPP_EXAMPLES_INSTALL_PREFIX}"
+            "-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}"
+            "-DLIVEKIT_LOCAL_SDK_DIR=${LIVEKIT_CPP_EXAMPLES_INSTALL_PREFIX}"
+            "-DLiveKit_DIR=${LIVEKIT_CPP_EXAMPLES_LIVEKIT_DIR}"
+    COMMAND ${CMAKE_COMMAND} --build "${LIVEKIT_CPP_EXAMPLES_BINARY_DIR}"
+            --config "$<CONFIG>"
+    DEPENDS install_livekit_sdk_for_examples
+    COMMENT "Configuring and building cpp-example-collection"
+    VERBATIM
+  )
+endfunction()

cmake/spdlog.cmake

@@ -71,7 +71,7 @@ FetchContent_Declare(
 set(SPDLOG_BUILD_SHARED OFF CACHE BOOL "" FORCE)
 set(SPDLOG_BUILD_EXAMPLE OFF CACHE BOOL "" FORCE)
 set(SPDLOG_BUILD_TESTS OFF CACHE BOOL "" FORCE)
-set(SPDLOG_INSTALL OFF CACHE BOOL "" FORCE)
+set(SPDLOG_INSTALL ON CACHE BOOL "" FORCE)
 
 FetchContent_MakeAvailable(livekit_spdlog)
 

cpp-example-collection

@@ -112,18 +112,14 @@ WORKDIR /client-sdk-cpp
 RUN mkdir -p /client-sdk-cpp
 COPY src /client-sdk-cpp/src
 COPY include /client-sdk-cpp/include
-COPY bridge /client-sdk-cpp/bridge
 COPY build.sh /client-sdk-cpp/build.sh
 COPY CMakePresets.json /client-sdk-cpp/CMakePresets.json
 COPY build.cmd /client-sdk-cpp/build.cmd
 COPY client-sdk-rust /client-sdk-cpp/client-sdk-rust
 COPY data /client-sdk-cpp/data
-COPY examples /client-sdk-cpp/examples
 COPY cmake /client-sdk-cpp/cmake
 COPY CMakeLists.txt /client-sdk-cpp/CMakeLists.txt
 COPY build.h.in /client-sdk-cpp/build.h.in
-COPY build.sh /client-sdk-cpp/build.sh
-COPY build.cmd /client-sdk-cpp/build.cmd
 
 # Configure Rust linker: use full GCC path so liblto_plugin.so is found (not /home/installs/ which has no plugin)
 RUN mkdir -p /client-sdk-cpp/client-sdk-rust/.cargo \