Update API

Author: ipavlidakis

DemoApp/Sources/Views/CallView/CallingView/SimpleCallingView.swift

@@ -202,7 +202,7 @@ struct SimpleCallingView: View {
             return
         }
         let call = streamVideo.call(callType: callType, callId: callId)
-        await call.updateClientCapabilities(clientCapabilities)
+        await call.enableClientCapabilities(clientCapabilities)
     }
 
     private func parseURLIfRequired(_ text: String) {

DocumentationTests/DocumentationTests/DocumentationTests/05-ui-cookbook/25-incoming-video-state.swift

@@ -7,7 +7,7 @@ import Combine
 fileprivate func content() {
     asyncContainer {
         let call = streamVideo.call(callType: "default", callId: "my-call-id")
-        await call.updateClientCapabilities([])
+        await call.disableClientCapabilities([.subscriberVideoPause])
     }
 
     container {

Sources/StreamVideo/Call.swift

@@ -1389,14 +1389,32 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
         proximity.remove(policy)
     }
 
-    // MARK: - ClientCapabilities
+    // MARK: - Client Capabilities
 
-    /// Updates the set of client capabilities for the call.
+    /// Enables a set of client capabilities for the call.
     ///
-    /// - Parameter clientCapabilities: A set of client capabilities that influence
-    ///     subscription logic (e.g., support for paused tracks).
-    public func updateClientCapabilities(_ clientCapabilities: Set<ClientCapability>) async {
-        await callController.updateClientCapabilities(clientCapabilities)
+    /// Use this to activate one or more client capabilities for the current call
+    /// session. Enabling capabilities may affect how features such as paused tracks,
+    /// bandwidth management, or other optional behaviors work for this call.
+    ///
+    /// - Parameter capabilities: The set of capabilities to enable.
+    public func enableClientCapabilities(
+        _ capabilities: Set<ClientCapability>
+    ) async {
+        await callController.enableClientCapabilities(capabilities)
+    }
+
+    /// Disables a set of client capabilities for the call.
+    ///
+    /// Use this to deactivate one or more client capabilities for the current call
+    /// session. Disabling capabilities can limit or remove optional features
+    /// associated with those capabilities.
+    ///
+    /// - Parameter capabilities: The set of capabilities to disable.
+    public func disableClientCapabilities(
+        _ capabilities: Set<ClientCapability>
+    ) async {
+        await callController.disableClientCapabilities(capabilities)
     }
 
     // MARK: - Internal

Sources/StreamVideo/Controllers/CallController.swift

@@ -505,8 +505,14 @@ class CallController: @unchecked Sendable {
         try webRTCCoordinator.callKitActivated(audioSession)
     }
 
-    func updateClientCapabilities(_ capabilities: Set<ClientCapability>) async {
-        await webRTCCoordinator.updateClientCapabilities(capabilities)
+    // MARK: - Client Capabilities
+
+    func enableClientCapabilities(_ capabilities: Set<ClientCapability>) async {
+        await webRTCCoordinator.enableClientCapabilities(capabilities)
+    }
+
+    func disableClientCapabilities(_ capabilities: Set<ClientCapability>) async {
+        await webRTCCoordinator.disableClientCapabilities(capabilities)
     }
 
     // MARK: - private

Sources/StreamVideo/WebRTC/v2/WebRTCCoordinator.swift

@@ -436,8 +436,12 @@ final class WebRTCCoordinator: @unchecked Sendable {
         try stateAdapter.audioSession.callKitActivated(audioSession)
     }
 
-    func updateClientCapabilities(_ capabilities: Set<ClientCapability>) async {
-        await stateAdapter.set(clientCapabilities: capabilities)
+    func enableClientCapabilities(_ capabilities: Set<ClientCapability>) async {
+        await stateAdapter.enableClientCapabilities(capabilities)
+    }
+
+    func disableClientCapabilities(_ capabilities: Set<ClientCapability>) async {
+        await stateAdapter.disableClientCapabilities(capabilities)
     }
 
     // MARK: - Private

Sources/StreamVideo/WebRTC/v2/WebRTCStateAdapter.swift

@@ -220,8 +220,14 @@ actor WebRTCStateAdapter: ObservableObject, StreamAudioSessionAdapterDelegate {
         statsAdapter?.isTracingEnabled = value
     }
 
-    func set(clientCapabilities value: Set<ClientCapability>) {
-        self.clientCapabilities = value
+    // MARK: - Client Capabilities
+
+    func enableClientCapabilities(_ capabilities: Set<ClientCapability>) {
+        self.clientCapabilities = self.clientCapabilities.union(capabilities)
+    }
+
+    func disableClientCapabilities(_ capabilities: Set<ClientCapability>) {
+        self.clientCapabilities = self.clientCapabilities.subtracting(capabilities)
     }
 
     // MARK: - Session Management

StreamVideoTests/Call/Call_Tests.swift

@@ -537,19 +537,37 @@ final class Call_Tests: StreamVideoTestCase {
         XCTAssert(call?.state.broadcasting == false)
     }
 
-    // MARK: - updateClientCapabilities
+    // MARK: - enableClientCapabilities
 
-    func test_updateClientCapabilities_correctlyUpdatesStateAdapter() async throws {
+    func test_enableClientCapabilities_correctlyUpdatesStateAdapter() async throws {
         let mockCallController = MockCallController()
         let call = MockCall(.dummy(callController: mockCallController))
         call.stub(for: \.state, with: .init())
 
-        await call.updateClientCapabilities([.subscriberVideoPause])
+        await call.enableClientCapabilities([.subscriberVideoPause])
 
         XCTAssertEqual(
             mockCallController.recordedInputPayload(
                 Set<ClientCapability>.self,
-                for: .updateClientCapabilities
+                for: .enableClientCapabilities
+            )?.first,
+            [.subscriberVideoPause]
+        )
+    }
+
+    // MARK: - disableClientCapabilities
+
+    func test_disableClientCapabilities_correctlyUpdatesStateAdapter() async throws {
+        let mockCallController = MockCallController()
+        let call = MockCall(.dummy(callController: mockCallController))
+        call.stub(for: \.state, with: .init())
+
+        await call.disableClientCapabilities([.subscriberVideoPause])
+
+        XCTAssertEqual(
+            mockCallController.recordedInputPayload(
+                Set<ClientCapability>.self,
+                for: .disableClientCapabilities
             )?.first,
             [.subscriberVideoPause]
         )

StreamVideoTests/Controllers/CallController_Tests.swift

@@ -659,15 +659,28 @@ final class CallController_Tests: StreamVideoTestCase, @unchecked Sendable {
         XCTAssertEqual(call.state.anonymousParticipantCount, 0)
     }
 
-    func test_updateClientCapabilities_correctlyUpdatesStateAdapter() async throws {
-        await subject.updateClientCapabilities([.subscriberVideoPause])
+    // MARK: - enableClientCapabilities
+
+    func test_enableClientCapabilities_correctlyUpdatesStateAdapter() async throws {
+        await subject.enableClientCapabilities([.subscriberVideoPause])
 
         await assertEqualAsync(
             await mockWebRTCCoordinatorFactory.mockCoordinatorStack.coordinator.stateAdapter.clientCapabilities,
             [.subscriberVideoPause]
         )
     }
 
+    // MARK: - disableClientCapabilities
+
+    func test_disableClientCapabilities_correctlyUpdatesStateAdapter() async throws {
+        await subject.disableClientCapabilities([.subscriberVideoPause])
+
+        await assertEqualAsync(
+            await mockWebRTCCoordinatorFactory.mockCoordinatorStack.coordinator.stateAdapter.clientCapabilities,
+            []
+        )
+    }
+
     // MARK: - Private helpers
 
     private func assertTransitionToStage(

StreamVideoTests/Mock/MockCallController.swift

@@ -12,7 +12,8 @@ final class MockCallController: CallController, Mockable, @unchecked Sendable {
         case setDisconnectionTimeout
         case observeWebRTCStateUpdated
         case changeVideoState
-        case updateClientCapabilities
+        case enableClientCapabilities
+        case disableClientCapabilities
     }
 
     enum MockFunctionInputKey: Payloadable {
@@ -30,7 +31,9 @@ final class MockCallController: CallController, Mockable, @unchecked Sendable {
 
         case changeVideoState(Bool)
 
-        case updateClientCapabilities(Set<ClientCapability>)
+        case enableClientCapabilities(Set<ClientCapability>)
+
+        case disableClientCapabilities(Set<ClientCapability>)
 
         var payload: Any {
             switch self {
@@ -42,7 +45,9 @@ final class MockCallController: CallController, Mockable, @unchecked Sendable {
                 return ()
             case let .changeVideoState(value):
                 return value
-            case let .updateClientCapabilities(value):
+            case let .enableClientCapabilities(value):
+                return value
+            case let .disableClientCapabilities(value):
                 return value
             }
         }
@@ -121,8 +126,17 @@ final class MockCallController: CallController, Mockable, @unchecked Sendable {
             .append(.changeVideoState(isEnabled))
     }
 
-    override func updateClientCapabilities(_ capabilities: Set<ClientCapability>) async {
-        stubbedFunctionInput[.updateClientCapabilities]?
-            .append(.updateClientCapabilities(capabilities))
+    override func enableClientCapabilities(
+        _ capabilities: Set<ClientCapability>
+    ) async {
+        stubbedFunctionInput[.enableClientCapabilities]?
+            .append(.enableClientCapabilities(capabilities))
+    }
+
+    override func disableClientCapabilities(
+        _ capabilities: Set<ClientCapability>
+    ) async {
+        stubbedFunctionInput[.disableClientCapabilities]?
+            .append(.disableClientCapabilities(capabilities))
     }
 }

StreamVideoTests/WebRTC/v2/StateMachine/Stages/WebRTCCoordinatorStateMachine_JoiningStageTests.swift

@@ -114,10 +114,6 @@ final class WebRTCCoordinatorStateMachine_JoiningStageTests: XCTestCase, @unchec
             .stateAdapter
             .set(sfuAdapter: mockCoordinatorStack.sfuStack.adapter)
 
-        await mockCoordinatorStack
-            .coordinator
-            .updateClientCapabilities([.subscriberVideoPause])
-
         try await assertTransition(
             from: .connected,
             expectedTarget: .disconnected,