adapt SDK 3.4.5

Author: Xia Ning

macOS/APIExample/Commons/AgoraExtension.swift

@@ -87,6 +87,21 @@ extension AgoraClientRole {
     }
 }
 
+extension AgoraVideoBackgroundSourceType {
+    func description() -> String {
+        switch self {
+        case .none: return "None".localized
+        case .color: return "Colored Background".localized
+        case .img: return "Image Background".localized
+        default:
+            return "\(self.rawValue)"
+        }
+    }
+    static func allValues() -> [AgoraVideoBackgroundSourceType] {
+        return [.none, .color, .img]
+    }
+}
+
 extension AgoraAudioScenario {
     func description() -> String {
         switch self {
@@ -109,17 +124,15 @@ extension AgoraAudioScenario {
 extension AgoraEncryptionMode {
     func description() -> String {
         switch self {
-        case .AES128XTS: return "AES128XTS"
-        case .AES256XTS: return "AES256XTS"
-        case .AES128ECB: return "AES128ECB"
-        case .SM4128ECB: return "SM4128ECB"
+        case .AES128GCM2: return "AES128GCM2"
+        case .AES256GCM2: return "AES256GCM2"
         default:
             return "\(self.rawValue)"
         }
     }
 
     static func allValues() -> [AgoraEncryptionMode] {
-        return [.AES128XTS, .AES256XTS, .AES128ECB, .SM4128ECB]
+        return [.AES128GCM2, .AES256GCM2]
     }
 }
 

macOS/APIExample/Examples/Advanced/JoinMultiChannel/JoinMultiChannel.swift

@@ -117,6 +117,8 @@ class JoinMultipleChannel: BaseViewController {
             let mediaOptions = AgoraRtcChannelMediaOptions()
             mediaOptions.autoSubscribeAudio = true
             mediaOptions.autoSubscribeVideo = true
+            mediaOptions.publishLocalAudio = false
+            mediaOptions.publishLocalVideo = false
 
             var channel: AgoraRtcChannel?
             if channel2 == nil {

macOS/APIExample/Examples/Advanced/StreamEncryption/StreamEncryption.swift

@@ -243,6 +243,7 @@ class StreamEncryption: BaseViewController {
                 let config = AgoraEncryptionConfig()
                 config.encryptionMode = selectedEncrption!
                 config.encryptionKey = encryptionSecretField.stringValue
+                config.encryptionKdfSalt = getEncryptionSaltFromServer()
                 let ret = agoraKit.enableEncryption(true, encryptionConfig: config)
                 if ret != 0 {
                     // for errors please take a look at:
@@ -296,6 +297,11 @@ class StreamEncryption: BaseViewController {
         }
     }
 
+    func getEncryptionSaltFromServer() -> Data {
+        
+        return "EncryptionKdfSaltInBase64Strings".data(using: .utf8)!
+    }
+    
     func layoutVideos(_ count: Int) {
         videos = []
         for i in 0...count - 1 {

macOS/APIExample/Examples/Basic/JoinChannelVideo/Base.lproj/JoinChannelVideo.storyboard

@@ -49,11 +49,15 @@
                                                     <autoresizingMask key="autoresizingMask" widthSizable="YES" flexibleMinY="YES"/>
                                                 </view>
                                                 <view id="zNc-vL-43g" customClass="Picker" customModule="APIExample" customModuleProvider="target">
-                                                    <rect key="frame" x="27" y="183" width="260" height="50"/>
+                                                    <rect key="frame" x="27" y="223" width="260" height="50"/>
+                                                    <autoresizingMask key="autoresizingMask" widthSizable="YES" flexibleMinY="YES"/>
+                                                </view>
+                                                <view id="Pvr-Dh-TRD" customClass="Picker" customModule="APIExample" customModuleProvider="target">
+                                                    <rect key="frame" x="27" y="107" width="260" height="50"/>
                                                     <autoresizingMask key="autoresizingMask" widthSizable="YES" flexibleMinY="YES"/>
                                                 </view>
                                                 <view id="SX5-NX-wxs" customClass="Picker" customModule="APIExample" customModuleProvider="target">
-                                                    <rect key="frame" x="27" y="232" width="260" height="50"/>
+                                                    <rect key="frame" x="27" y="165" width="260" height="50"/>
                                                     <autoresizingMask key="autoresizingMask" widthSizable="YES" flexibleMinY="YES"/>
                                                 </view>
                                             </subviews>
@@ -126,6 +130,7 @@
                         <outlet property="Container" destination="r7G-ng-73B" id="YGH-31-sQ1"/>
                         <outlet property="channelField" destination="cOW-S1-5WE" id="jDn-mo-xGn"/>
                         <outlet property="joinChannelButton" destination="Wck-kx-dah" id="7Zo-gi-hFo"/>
+                        <outlet property="selectBackgroundPicker" destination="Pvr-Dh-TRD" id="9nr-pb-br2"/>
                         <outlet property="selectCameraPicker" destination="Wvv-X8-f7U" id="pNv-K1-sH1"/>
                         <outlet property="selectFpsPicker" destination="jHK-UU-E1C" id="agM-jd-ePJ"/>
                         <outlet property="selectLayoutPicker" destination="SX5-NX-wxs" id="Xf2-oi-ivY"/>

macOS/APIExample/Examples/Basic/JoinChannelVideo/JoinChannelVideo.swift

@@ -218,6 +218,28 @@ class JoinChannelVideoMain: BaseViewController {
         }
     }
 
+    /**
+     --- Background Picker ---
+     */
+    @IBOutlet weak var selectBackgroundPicker: Picker!
+    private let backgroundTypes = AgoraVideoBackgroundSourceType.allValues()
+    var selectedBackgroundType: AgoraVideoBackgroundSourceType? {
+        let index = self.selectBackgroundPicker.indexOfSelectedItem
+        if index >= 0 && index < backgroundTypes.count {
+            return backgroundTypes[index]
+        } else {
+            return nil
+        }
+    }
+    func initSelectBackgroundPicker() {
+        selectBackgroundPicker.label.stringValue = "Camera Background Setting".localized
+        selectBackgroundPicker.picker.addItems(withTitles: backgroundTypes.map { $0.description() })
+        selectBackgroundPicker.onSelectChanged {
+            guard self.selectedBackgroundType != nil else { return }
+            self.setBackground()
+        }
+    }
+    
     /**
      --- Channel TextField ---
      */
@@ -259,17 +281,36 @@ class JoinChannelVideoMain: BaseViewController {
         config.areaCode = GlobalSettings.shared.area.rawValue
         agoraKit = AgoraRtcEngineKit.sharedEngine(with: config, delegate: self)
         agoraKit.enableVideo()
-        
+        setBackground()
         initSelectCameraPicker()
         initSelectResolutionPicker()
         initSelectFpsPicker()
         initSelectMicsPicker()
         initSelectLayoutPicker()
         initSelectRolePicker()
+        initSelectBackgroundPicker()
         initChannelField()
         initJoinChannelButton()
     }
 
+    private func setBackground(){
+        let backgroundSource = AgoraVideoBackgroundSource()
+        backgroundSource.backgroundSourceType = selectedBackgroundType ?? .none
+        switch self.selectedBackgroundType {
+        case .color:
+            backgroundSource.color = 0x000000
+        case .img:
+            if let resourcePath = Bundle.main.resourcePath {
+                let imgName = "bg.jpg"
+                let path = resourcePath + "/" + imgName
+                backgroundSource.source = path
+            }
+        default:
+            break
+        }
+        agoraKit.enableVideoBackgroundSubstitution(true, backData: backgroundSource)
+    }
+    
     func layoutVideos(_ count: Int) {
         videos = []
         for i in 0...count - 1 {
@@ -425,7 +466,7 @@ extension JoinChannelVideoMain: AgoraRtcEngineDelegate {
             videoCanvas.uid = uid
             // the view to be binded
             videoCanvas.view = remoteVideo.videocanvas
-            videoCanvas.renderMode = .hidden
+            videoCanvas.renderMode = .fit
             agoraKit.setupRemoteVideo(videoCanvas)
             remoteVideo.uid = uid
         } else {
@@ -485,4 +526,13 @@ extension JoinChannelVideoMain: AgoraRtcEngineDelegate {
     func rtcEngine(_ engine: AgoraRtcEngineKit, remoteAudioStats stats: AgoraRtcRemoteAudioStats) {
         videos.first(where: { $0.uid == stats.uid })?.statsInfo?.updateAudioStats(stats)
     }
+    
+    /// Reports the video background substitution success or failed.
+    /// @param enabled whether background substitution is enabled.
+    /// @param reason The reason of the background substitution callback. See [AgoraVideoBackgroundSourceStateReason](AgoraVideoBackgroundSourceStateReason).
+    func rtcEngine(_ engine: AgoraRtcEngineKit, videoBackgroundSourceEnabled enabled: Bool, reason: AgoraVideoBackgroundSourceStateReason) {
+        if reason != .vbsStateReasonSuccess {
+            LogUtils.log(message: "background substitution failed to enabled for \(reason.rawValue)", level: .warning)
+        }
+    }
 }

macOS/APIExample/Localizable.strings

@@ -156,3 +156,8 @@
 "Sending" = "发送中";
 "Raw Audio Data" = "音频裸数据";
 "Video Source" = "视频源选择";
+"Sending" = "发送中";
+"None" = "无背景";
+"Colored Background" = "纯色背景";
+"Image Background" = "图片背景";
+"Camera Background Setting" = "主播背景设置";