Build xcframework (#973)

This is quite tricky/manual process, as tools like
https://github.com/segment-integrations/swift-create-xcframework won't
work with newer SPM (that does not allow direct `xcodeproj` generation,
required for archiving) 💀

Install https://github.com/mxcl/swift-sh to handle dependencies.

The ultimate test:
- run `./scripts/xcframework.swift --local` 
- you should be able to replace the package with binaries for every
platform

<img width="468" height="167" alt="image"
src="https://github.com/user-attachments/assets/7a08d09c-70a4-4676-8093-9b9769e3ba63"
/>

### Repo

This will land in
https://github.com/livekit/client-sdk-swift-xcframework (with LICENSE,
maybe copied README).

### Safety

This is mostly additive, except `LK_XCFRAMEWORK` for internal imports.

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: pblazej

AGENTS.md

@@ -60,6 +60,12 @@ Key components:
 
 Dependencies: LiveKitWebRTC, LiveKitUniFFI, SwiftProtobuf.
 
+## Compile-Time Flags
+
+- `LK_XCFRAMEWORK` — set in the generated xcodeproj by `scripts/xcframework.swift`; switches `import SwiftProtobuf` to `internal import` in proto files so it doesn't leak into `.swiftinterface`
+- `LK_BENCHMARK` — set when building benchmarks (`Benchmarks/`); skips `DeviceManager`/`AudioManager` init in `Room.init` to allow headless benchmark runs
+- `LK_SIGNPOSTS` — enables `os.signpost` instrumentation in `StateSync` for profiling lock contention in Instruments
+
 ## WebRTC
 
 WebRTC handles the actual media transport (audio/video/data) between participants. The SDK abstracts WebRTC complexity behind `Room`, `Participant`, and `Track` APIs while LiveKit server coordinates signaling.

Makefile

@@ -5,6 +5,10 @@ proto: protoc protoc-swift
 		${PROTO_SOURCE}/livekit_models.proto \
 		${PROTO_SOURCE}/livekit_rtc.proto \
 		${PROTO_SOURCE}/livekit_metrics.proto
+	@# Use internal import for xcframework builds to keep SwiftProtobuf out of .swiftinterface
+	@for f in Sources/LiveKit/protos/*.pb.swift; do \
+		sed -i '' 's/^import SwiftProtobuf/#if LK_XCFRAMEWORK\ninternal import SwiftProtobuf\n#else\nimport SwiftProtobuf\n#endif/' "$$f"; \
+	done
 
 docs: swift-docs
 	swift doc generate Sources/LiveKit \

README.md

@@ -52,12 +52,20 @@ let package = Package(
 }
 ```
 
-### XCode
+### Xcode
 
 Go to Project Settings -> Swift Packages.
 
 Add a new package and enter: `https://github.com/livekit/client-sdk-swift`
 
+### Pre-built XCFramework
+
+A pre-built binary distribution is available for faster integration and CI builds. Add the XCFramework package instead:
+
+`https://github.com/livekit/client-sdk-swift-xcframework`
+
+This package bundles `LiveKit.xcframework` (dynamic framework) along with its dependencies (`LiveKitWebRTC`, `RustLiveKitUniFFI`). It contains the same code as the source package above, just pre-compiled.
+
 ### CocoaPods
 
 > [!IMPORTANT]

Sources/LKObjCHelpers/module.modulemap

@@ -0,0 +1,4 @@
+module LKObjCHelpers {
+    header "include/LKObjCHelpers.h"
+    export *
+}

Sources/LiveKit/Broadcast/LKSampleHandler.swift

@@ -24,7 +24,7 @@ import Combine
 import OSLog
 
 #if !COCOAPODS
-import LKObjCHelpers
+internal import LKObjCHelpers
 #endif
 
 @available(macCatalyst 13.1, *)

Sources/LiveKit/Protos/livekit_metrics.pb.swift

@@ -8,7 +8,11 @@
 // For information on using the generated types, please see the documentation:
 //   https://github.com/apple/swift-protobuf/
 
+#if LK_XCFRAMEWORK
+internal import SwiftProtobuf
+#else
 import SwiftProtobuf
+#endif
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

Sources/LiveKit/Protos/livekit_models.pb.swift

@@ -27,7 +27,11 @@ import FoundationEssentials
 #else
 import Foundation
 #endif
+#if LK_XCFRAMEWORK
+internal import SwiftProtobuf
+#else
 import SwiftProtobuf
+#endif
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

Sources/LiveKit/Protos/livekit_rtc.pb.swift

@@ -27,7 +27,11 @@ import FoundationEssentials
 #else
 import Foundation
 #endif
+#if LK_XCFRAMEWORK
+internal import SwiftProtobuf
+#else
 import SwiftProtobuf
+#endif
 
 // If the compiler emits an error on this type, it is because this file
 // was generated by a version of the `protoc` Swift plug-in that is

scripts/Package.swift.stencil

@@ -0,0 +1,36 @@
+// swift-tools-version:6.2
+// Auto-generated by scripts/xcframework.swift
+
+import PackageDescription
+
+let package = Package(
+    name: "LiveKit",
+    platforms: [
+        .iOS(.v13),
+        .macOS(.v10_15),
+        .macCatalyst(.v14),
+        .tvOS(.v17),
+        .visionOS(.v26),
+    ],
+    products: [
+        .library(name: "LiveKit", targets: ["LiveKit", "LiveKitWebRTC", "RustLiveKitUniFFI"]),
+    ],
+    targets: [{% if local %}
+        .binaryTarget(name: "LiveKit", path: "LiveKit.xcframework.zip"),{% else %}
+        .binaryTarget(
+            name: "LiveKit",
+            url: "{{ baseURL }}/LiveKit.xcframework.zip",
+            checksum: "{{ checksumLiveKit }}"
+        ),{% endif %}
+        .binaryTarget(
+            name: "LiveKitWebRTC",
+            url: "{{ webrtcURL }}",
+            checksum: "{{ webrtcChecksum }}"
+        ),
+        .binaryTarget(
+            name: "RustLiveKitUniFFI",
+            url: "{{ uniffiURL }}",
+            checksum: "{{ uniffiChecksum }}"
+        ),
+    ]
+)