# client-sdk-swift **Repository Path**: felixfxu/client-sdk-swift ## Basic Information - **Project Name**: client-sdk-swift - **Description**: https://github.com/livekit/client-sdk-swift.git - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2024-01-27 - **Last Updated**: 2024-02-29 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README The LiveKit icon, the name of the repository and some sample code in the background. # iOS/macOS Swift SDK for LiveKit Use this SDK to add real-time video, audio and data features to your Swift app. By connecting to a self- or cloud-hosted LiveKit server, you can quickly build applications like interactive live streaming or video calls with just a few lines of code. ## Docs & Example app Docs and guides are at [https://docs.livekit.io](https://docs.livekit.io). There is full source code of a [iOS/macOS Swift UI Example App](https://github.com/livekit/client-example-swift). For minimal examples view this repo 馃憠 [Swift SDK Examples](https://github.com/livekit/client-example-collection-swift) ## Installation LiveKit for Swift is available as a Swift Package. ### Package.swift Add the dependency and also to your target ```swift title="Package.swift" let package = Package( ... dependencies: [ .package(name: "LiveKit", url: "https://github.com/livekit/client-sdk-swift.git", .upToNextMajor("1.0.0")), ], targets: [ .target( name: "MyApp", dependencies: ["LiveKit"] ) ] } ``` ### XCode Go to Project Settings -> Swift Packages. Add a new package and enter: `https://github.com/livekit/client-sdk-swift` ## iOS Usage LiveKit provides an UIKit based `VideoView` class that renders video tracks. Subscribed audio tracks are automatically played. ```swift import LiveKit import UIKit class RoomViewController: UIViewController { lazy var room = Room(delegate: self) lazy var remoteVideoView: VideoView = { let videoView = VideoView() view.addSubview(videoView) // additional initialization ... return videoView }() lazy var localVideoView: VideoView = { let videoView = VideoView() view.addSubview(videoView) // additional initialization ... return videoView }() override func viewDidLoad() { super.viewDidLoad() view.backgroundColor = .white let url: String = "ws://your_host" let token: String = "your_jwt_token" room.connect(url, token).then { room in // Publish camera & mic room.localParticipant?.setCamera(enabled: true) room.localParticipant?.setMicrophone(enabled: true) }.catch { error in // failed to connect } } } extension RoomViewController: RoomDelegate { func room(_ room: Room, localParticipant: LocalParticipant, didPublish publication: LocalTrackPublication) { guard let track = publication?.track as? VideoTrack else { return } DispatchQueue.main.async { localVideoView.track = track } } func room(_ room: Room, participant: RemoteParticipant, didSubscribe publication: RemoteTrackPublication, track: Track) { guard let track = track as? VideoTrack else { return } DispatchQueue.main.async { remoteVideoView.track = track } } } ``` ### Screen Sharing See [iOS Screen Sharing instructions](https://github.com/livekit/client-sdk-swift/wiki/iOS-Screen-Sharing). ## Integration Notes ### Thread safety Since `VideoView` is a UI component, all operations (read/write properties etc) must be performed from the `main` thread. Other core classes can be accessed from any thread. Delegates will be called on the SDK's internal thread. Make sure any access to the UI is within the main thread, for example by using `DispatchQueue.main.async`. ### Memory management It is recommended to use **weak var** when storing references to objects created and managed by the SDK, such as `Participant`, `TrackPublication` etc. These objects are invalid when the `Room` disconnects, and will be released by the SDK. Holding strong reference to these objects will prevent releasing `Room` and other internal objects. `VideoView.track` property does not hold strong reference, so it's not required to set it to `nil`. ### AudioSession management LiveKit will automatically manage the underlying `AVAudioSession` while connected. The session will be set to `playback` category by default. When a local stream is published, it'll be switched to `playAndRecord`. In general, it'll pick sane defaults and do the right thing. However, if you'd like to customize this behavior, you would override `AudioManager.customConfigureAudioSessionFunc` to manage the underlying session on your own. See [example here](https://github.com/livekit/client-sdk-swift/blob/1f5959f787805a4b364f228ccfb413c1c4944748/Sources/LiveKit/Track/AudioManager.swift#L153) for the default behavior. ### iOS Simulator limitations - Currently, `VideoView` will use OpenGL for iOS Simulator. - Publishing the camera track is not supported by iOS Simulator. ### ScrollView performance It is recommended to turn off rendering of `VideoView`s that scroll off the screen and isn't visible by setting `false` to `isEnabled` property and `true` when it will re-appear to save CPU resources. `UICollectionViewDelegate`'s `willDisplay` / `didEndDisplaying` has been reported to be unreliable for this purpose. Specifically, in some iOS versions `didEndDisplaying` could get invoked even when the cell is visible. The following is an alternative method to using `willDisplay` / `didEndDisplaying` : ```swift // 1. define a weak-reference set for all cells private var allCells = NSHashTable.weakObjects() ``` ```swift // in UICollectionViewDataSource... public func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell { let cell = collectionView.dequeueReusableCell(withReuseIdentifier: ParticipantCell.reuseIdentifier, for: indexPath) if let cell = cell as? ParticipantCell { // 2. keep weak reference to the cell allCells.add(cell) // configure cell etc... } return cell } ``` ```swift // 3. define a func to re-compute and update isEnabled property for cells that visibility changed func reComputeVideoViewEnabled() { let visibleCells = collectionView.visibleCells.compactMap { $0 as? ParticipantCell } let offScreenCells = allCells.allObjects.filter { !visibleCells.contains($0) } for cell in visibleCells.filter({ !$0.videoView.isEnabled }) { print("enabling cell#\(cell.hashValue)") cell.videoView.isEnabled = true } for cell in offScreenCells.filter({ $0.videoView.isEnabled }) { print("disabling cell#\(cell.hashValue)") cell.videoView.isEnabled = false } } ``` ```swift // 4. set a timer to invoke the func self.timer = Timer.scheduledTimer(withTimeInterval: 0.1, repeats: true, block: { [weak self] _ in self?.reComputeVideoViewEnabled() }) // alternatively, you can call `reComputeVideoViewEnabled` whenever cell visibility changes (such as scrollViewDidScroll(_:)), // but this will be harder to track all cases such as cell reload etc. ``` For the full example, see 馃憠 [UIKit Minimal Example](https://github.com/livekit/client-example-collection-swift/tree/main/uikit-minimal) # Frequently asked questions ### Mic privacy indicator (orange dot) remains on even after muting audio track You will need to un-publish the LocalAudioTrack for the indicator to turn off. More discussion here https://github.com/livekit/client-sdk-swift/issues/140 ### How to publish camera in 60 FPS ? - Create a `LocalVideoTrack` by calling `LocalVideoTrack.createCameraTrack(options: CameraCaptureOptions(fps: 60))`. - Publish with `LocalParticipant.publishVideoTrack(track: track, publishOptions: VideoPublishOptions(encoding: VideoEncoding(maxFps: 60)))`. # Known issues ### Avoid crashes on macOS Catalina If your app is targeting macOS Catalina, make sure to do the following to avoid crash (ReplayKit not found): 1. Explicitly add "ReplayKit.framework" to the Build Phases > Link Binary with Libraries section 2. Set it to Optional replykit - I am not sure why this is required for ReplayKit at the moment. - If you are targeting macOS 11.0+, this is not required. # Getting help / Contributing Please join us on [Slack](https://livekit.io/join-slack) to get help from our devs / community members. We welcome your contributions(PRs) and details can be discussed there.
LiveKit Ecosystem
Real-time SDKsReact Components 路 JavaScript 路 iOS/macOS 路 Android 路 Flutter 路 React Native 路 Rust 路 Python 路 Unity (web) 路 Unity (beta)
Server APIsNode.js 路 Golang 路 Ruby 路 Java/Kotlin 路 Python 路 Rust 路 PHP (community)
Agents FrameworksPython 路 Playground
ServicesLivekit server 路 Egress 路 Ingress 路 SIP
ResourcesDocs 路 Example apps 路 Cloud 路 Self-hosting 路 CLI