Migrate all examples from client-sdk-cpp

Author: stephen-derosa

.github/workflows/builds.yml

@@ -40,7 +40,14 @@ jobs:
           sudo apt-get install -y \
             cmake ninja-build pkg-config \
             protobuf-compiler libprotobuf-dev \
+            libasound2-dev libpulse-dev \
+            libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxfixes-dev \
+            libxi-dev libxss-dev libxtst-dev libxkbcommon-dev \
+            libdrm-dev libgbm-dev libgl1-mesa-dev libgles2-mesa-dev \
+            libegl1-mesa-dev libdbus-1-dev libibus-1.0-dev libudev-dev \
+            libpipewire-0.3-dev libwayland-dev libdecor-0-dev liburing-dev \
             libssl-dev \
+            libspdlog-dev \
             curl
 
       - name: Install deps (macOS)
@@ -50,6 +57,7 @@ jobs:
           set -eux
           brew update
           brew install cmake ninja protobuf
+          brew install spdlog
 
       - name: Install deps (Windows)
         if: runner.os == 'Windows'

CMakeLists.txt

@@ -1,21 +1,95 @@
+# Copyright 2026 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 cmake_minimum_required(VERSION 3.20)
 project(livekit_cpp_example_collection LANGUAGES CXX)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 # Make "include(LiveKitSDK)" search in ./cmake
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
 set(LIVEKIT_SDK_VERSION "latest" CACHE STRING "LiveKit C++ SDK version (e.g. 0.2.0 or latest)")
+set(LIVEKIT_LOCAL_SDK_DIR "" CACHE PATH "Path to a local LiveKit SDK install prefix (skips download)")
 
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
-include(LiveKitSDK)
+if(LIVEKIT_LOCAL_SDK_DIR)
+  message(STATUS "Using local LiveKit SDK: ${LIVEKIT_LOCAL_SDK_DIR}")
+  list(PREPEND CMAKE_PREFIX_PATH "${LIVEKIT_LOCAL_SDK_DIR}")
+else()
+  include(LiveKitSDK)
+  livekit_sdk_setup(
+    VERSION "${LIVEKIT_SDK_VERSION}"
+    SDK_DIR "${CMAKE_BINARY_DIR}/_deps/livekit-sdk"
+    GITHUB_TOKEN "$ENV{GITHUB_TOKEN}"
+  )
+endif()
+find_package(LiveKit CONFIG REQUIRED)
 
-livekit_sdk_setup(
-  VERSION  "${LIVEKIT_SDK_VERSION}"
-  SDK_DIR  "${CMAKE_BINARY_DIR}/_deps/livekit-sdk"
-  GITHUB_TOKEN "$ENV{GITHUB_TOKEN}"
-)
+if(TARGET LiveKit::livekit)
+  set(LIVEKIT_CORE_TARGET LiveKit::livekit)
+elseif(TARGET livekit)
+  set(LIVEKIT_CORE_TARGET livekit)
+else()
+  message(FATAL_ERROR "Could not find a LiveKit core target (expected LiveKit::livekit or livekit).")
+endif()
+
+set(LIVEKIT_DATA_DIR "")
+if(DEFINED LIVEKIT_ROOT_DIR AND EXISTS "${LIVEKIT_ROOT_DIR}/data")
+  set(LIVEKIT_DATA_DIR "${LIVEKIT_ROOT_DIR}/data")
+endif()
+
+function(livekit_copy_windows_runtime_dlls target_name)
+  if(NOT WIN32)
+    return()
+  endif()
+
+  get_filename_component(_lk_cmake_parent "${LiveKit_DIR}" DIRECTORY)
+  get_filename_component(_lk_lib_dir "${_lk_cmake_parent}" DIRECTORY)
+  get_filename_component(_lk_prefix "${_lk_lib_dir}" DIRECTORY)
+  set(_lk_bin_dir "${_lk_prefix}/bin")
+
+  foreach(_lk_runtime_dll IN ITEMS livekit.dll livekit_ffi.dll)
+    if(EXISTS "${_lk_bin_dir}/${_lk_runtime_dll}")
+      add_custom_command(TARGET ${target_name} POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_if_different
+                "${_lk_bin_dir}/${_lk_runtime_dll}"
+                "$<TARGET_FILE_DIR:${target_name}>"
+      )
+    endif()
+  endforeach()
+
+  if(TARGET SDL3::SDL3)
+    add_custom_command(TARGET ${target_name} POST_BUILD
+      COMMAND ${CMAKE_COMMAND} -E copy_if_different
+              "$<TARGET_FILE:SDL3::SDL3>"
+              "$<TARGET_FILE_DIR:${target_name}>"
+    )
+  endif()
+endfunction()
+
+include(ExampleDeps)
 
-find_package(LiveKit CONFIG REQUIRED)
 add_subdirectory(basic_room)
+add_subdirectory(simple_room)
+add_subdirectory(simple_rpc)
+add_subdirectory(simple_data_stream)
+add_subdirectory(logging_levels_basic_usage)
+add_subdirectory(logging_levels_custom_sinks)
+add_subdirectory(hello_livekit_sender)
+add_subdirectory(hello_livekit_receiver)
+add_subdirectory(simple_joystick_sender)
+add_subdirectory(simple_joystick_receiver)
+add_subdirectory(ping_pong_ping)
+add_subdirectory(ping_pong_pong)

README.md

@@ -35,6 +35,16 @@ rm -rf build
 cmake -S . -B build -DLIVEKIT_SDK_VERSION=0.3.1
 ```
 
+Build against a local SDK:
+```bash
+rm -rf build
+# install the SDK into $HOME/livekit-sdk-install (or any other directory)
+cmake --install <sdk-build-dir> --prefix $HOME/livekit-sdk-install
+
+# build the examples against the local SDK
+cmake -S . -B build -DLIVEKIT_LOCAL_SDK_DIR=$HOME/livekit-sdk-install
+```
+
 
 ### Building the examples
 #### macOS / Linux

basic_room/CMakeLists.txt

@@ -1,3 +1,17 @@
+# Copyright 2026 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 add_executable(basic_room
   main.cpp
   capture_utils.cpp
@@ -13,19 +27,10 @@ get_filename_component(_lk_lib_dir  "${_lk_cmake_dir}" DIRECTORY) # .../lib
 target_link_directories(basic_room PRIVATE "${_lk_lib_dir}")
 
 
-
-# Nice-to-have: copy runtime DLLs next to the exe on Windows for "run from build dir".
-# Only do this if your exported package provides these targets.
+# Nice-to-have: copy extra runtime DLLs next to the exe on Windows for "run from build dir".
+# The common LiveKit runtime copies are handled by livekit_copy_windows_runtime_dlls()
+# in this target's directory below.
 if(WIN32)
-  # livekit_ffi.dll
-  if(TARGET LiveKit::livekit_ffi)
-    add_custom_command(TARGET basic_room POST_BUILD
-      COMMAND ${CMAKE_COMMAND} -E copy_if_different
-        "$<TARGET_FILE:LiveKit::livekit_ffi>"
-        "$<TARGET_FILE_DIR:basic_room>"
-    )
-  endif()
-
   # If you also export protobuf/abseil runtime targets, copy them too (optional).
   if(TARGET protobuf::libprotobuf)
     add_custom_command(TARGET basic_room POST_BUILD
@@ -40,6 +45,8 @@ if(WIN32)
       COMMAND ${CMAKE_COMMAND} -E copy_if_different
         "$<TARGET_FILE:absl::abseil_dll>"
         "$<TARGET_FILE_DIR:basic_room>"
-    )
+      )
   endif()
 endif()
+
+livekit_copy_windows_runtime_dlls(basic_room)

basic_room/main.cpp

@@ -41,7 +41,8 @@ void printUsage(const char *prog) {
             << "  LIVEKIT_URL, LIVEKIT_TOKEN\n";
 }
 
-bool parseArgs(int argc, char *argv[], std::string &url, std::string &token, bool &self_test) {
+bool parseArgs(int argc, char *argv[], std::string &url, std::string &token,
+               bool &self_test) {
   for (int i = 1; i < argc; ++i) {
     const std::string a = argv[i];
     if (a == "-h" || a == "--help")
@@ -85,14 +86,9 @@ bool parseArgs(int argc, char *argv[], std::string &url, std::string &token, boo
 }
 
 void print_livekit_version() {
-  std::cout
-    << "LiveKit version: "
-    << LIVEKIT_BUILD_VERSION_FULL
-    << " (" << LIVEKIT_BUILD_FLAVOR
-    << ", commit " << LIVEKIT_BUILD_COMMIT
-    << ", built " << LIVEKIT_BUILD_DATE
-    << ")"
-    << std::endl;
+  std::cout << "LiveKit version: " << LIVEKIT_BUILD_VERSION_FULL << " ("
+            << LIVEKIT_BUILD_FLAVOR << ", commit " << LIVEKIT_BUILD_COMMIT
+            << ", built " << LIVEKIT_BUILD_DATE << ")" << std::endl;
 }
 
 } // namespace
@@ -106,7 +102,7 @@ int main(int argc, char *argv[]) {
     return 1;
   }
   if (self_test) {
-    livekit::initialize(livekit::LogSink::kConsole);
+    livekit::initialize(livekit::LogLevel::Info, livekit::LogSink::kConsole);
     livekit::shutdown();
     std::cout << "self-test ok" << std::endl;
     return 0;
@@ -115,7 +111,7 @@ int main(int argc, char *argv[]) {
   std::signal(SIGINT, handleSignal);
 
   // Init LiveKit
-  livekit::initialize(livekit::LogSink::kConsole);
+  livekit::initialize(livekit::LogLevel::Info, livekit::LogSink::kConsole);
 
   auto room = std::make_unique<Room>();
 
@@ -145,7 +141,8 @@ int main(int argc, char *argv[]) {
 
   std::shared_ptr<LocalTrackPublication> audioPub;
   try {
-    audioPub = room->localParticipant()->publishTrack(audioTrack, audioOpts);
+    room->localParticipant()->publishTrack(audioTrack, audioOpts);
+    audioPub = audioTrack->publication();
     std::cout << "Published audio: sid=" << audioPub->sid() << "\n";
   } catch (const std::exception &e) {
     std::cerr << "Failed to publish audio: " << e.what() << "\n";
@@ -163,7 +160,8 @@ int main(int argc, char *argv[]) {
 
   std::shared_ptr<LocalTrackPublication> videoPub;
   try {
-    videoPub = room->localParticipant()->publishTrack(videoTrack, videoOpts);
+    room->localParticipant()->publishTrack(videoTrack, videoOpts);
+    videoPub = videoTrack->publication();
     std::cout << "Published video: sid=" << videoPub->sid() << "\n";
   } catch (const std::exception &e) {
     std::cerr << "Failed to publish video: " << e.what() << "\n";

cmake/ExampleDeps.cmake

@@ -0,0 +1,30 @@
+include(FetchContent)
+
+find_package(nlohmann_json CONFIG QUIET)
+if(NOT TARGET nlohmann_json::nlohmann_json)
+  FetchContent_Declare(
+    nlohmann_json
+    URL https://github.com/nlohmann/json/releases/download/v3.11.3/json.tar.xz
+  )
+  FetchContent_MakeAvailable(nlohmann_json)
+endif()
+
+find_package(SDL3 CONFIG QUIET)
+set(_need_sdl3_fetch TRUE)
+if(TARGET SDL3::SDL3)
+  get_target_property(_sdl3_include_dirs SDL3::SDL3 INTERFACE_INCLUDE_DIRECTORIES)
+  if(_sdl3_include_dirs)
+    set(_need_sdl3_fetch FALSE)
+  endif()
+endif()
+
+if(_need_sdl3_fetch)
+  FetchContent_Declare(
+    SDL3
+    URL https://github.com/libsdl-org/SDL/releases/download/release-3.2.26/SDL3-3.2.26.tar.gz
+  )
+  FetchContent_MakeAvailable(SDL3)
+endif()
+
+unset(_need_sdl3_fetch)
+unset(_sdl3_include_dirs)

hello_livekit_receiver/CMakeLists.txt

@@ -0,0 +1,22 @@
+# Copyright 2026 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+add_executable(HelloLivekitReceiver
+  main.cpp
+)
+
+target_include_directories(HelloLivekitReceiver PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
+target_link_libraries(HelloLivekitReceiver PRIVATE ${LIVEKIT_CORE_TARGET})
+
+livekit_copy_windows_runtime_dlls(HelloLivekitReceiver)