Release 1.2.0 (#114)

* Add Instructions for App Client Authentication without Client Secret (#111)

* Fix numbering in and add no-secret case directions to README installation instructions

* Cleanup spacing

* Update referenced step number

* Dual-Stack Endpoint Support (#112)

* Add UI elements for endpoint type selection, cleanup spacing of elements

* Improve endpoint switch UI

* Add handling of the dual-stack UI switch

* Add styling and animation for switch selection

* Add storyboard changes, fix typo and syntax

* Add dual-stack stun server

* Improve UI

* Fix text color for dark-themed devices

* Remove non-supported CI OS versions

* Update CI workflow with new macOS and Xcode versions

* Update app version to 1.2.0 (#113)

Author: stefankiesz

.github/workflows/ci.yml

@@ -14,8 +14,8 @@ jobs:
     strategy:
       matrix:
         config: [
-          {mac_ver: "13", xc_ver: "15.2", os: "17.2", iphone_ver: "14"},
-          {mac_ver: "14", xc_ver: "15.4", os: "17.5", iphone_ver: "15"},
+          {mac_ver: "15-intel", xc_ver: "16.4", os: "18.6", iphone_ver: "16e"},
+          {mac_ver: "15-intel", xc_ver: "16.4", os: "18.6", iphone_ver: "16 Pro"},
           {mac_ver: "15", xc_ver: "16.4", os: "18.6", iphone_ver: "16e"},
           {mac_ver: "15", xc_ver: "16.4", os: "18.6", iphone_ver: "16 Pro"}
         ]
@@ -48,8 +48,8 @@ jobs:
     strategy:
       matrix:
         config: [
-          {mac_ver: "13", xc_ver: "15.2", os: "17.2", iphone_ver: "14"},
-          {mac_ver: "14", xc_ver: "15.4", os: "17.5", iphone_ver: "15"},
+          {mac_ver: "15-intel", xc_ver: "16.4", os: "18.6", iphone_ver: "16e"},
+          {mac_ver: "15-intel", xc_ver: "16.4", os: "18.6", iphone_ver: "16 Pro"},
           {mac_ver: "15", xc_ver: "16.4", os: "18.6", iphone_ver: "16e"},
           {mac_ver: "15", xc_ver: "16.4", os: "18.6", iphone_ver: "16 Pro"}
         ]

README.md

@@ -27,15 +27,15 @@ git clone https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-ios
 
 #### Using XCode to build the project
 
-0. Install XCode. You can install XCode from https://developer.apple.com/download/all/
+1. Install XCode. You can install XCode from https://developer.apple.com/download/all/
 
-1. The [AWS Mobile SDK for iOS](https://github.com/aws-amplify/aws-sdk-ios) is available through [CocoaPods](http://cocoapods.org). If CocoaPods is not installed, install it using the following command. Note that Ruby will also be installed, as it is a dependency of Cocoapods.
+2. The [AWS Mobile SDK for iOS](https://github.com/aws-amplify/aws-sdk-ios) is available through [CocoaPods](http://cocoapods.org). If CocoaPods is not installed, install it using the following command. Note that Ruby will also be installed, as it is a dependency of Cocoapods.
    ```bash
    brew install cocoapods
    pod setup
    ```
 
-2. The following cocoa pod dependencies are included in the [Podfile](Swift/Podfile) and need to be `pod install`'ed:
+3. The following cocoa pod dependencies are included in the [Podfile](Swift/Podfile) and need to be `pod install`'ed:
 
    * Starscream
    * Common Crytpo
@@ -52,17 +52,23 @@ git clone https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-ios
    pod install --repo-update
    ```
 
-3. Create an [Amazon Cognito User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html). Follow steps 2-3 in the [AWS KVS Android WebRTC Repo](https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-android).
+4. Create an [Amazon Cognito User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html). Follow steps 2-3 in the [AWS KVS Android WebRTC Repo](https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-android).
 
-4. To open the project, you can choose between these two methods:
+5. To open the project, you can choose between these two methods:
 
    1. Open XCode, select "Open a project or file", and choose [AWSKinesisVideoWebRTCDemoApp.**xcworkspace**](Swift/AWSKinesisVideoWebRTCDemoApp.xcworkspace), **OR**
    2. Run the following command from the [Swift](Swift) folder.
     ```bash
     xed .
     ```
 
-5. Open [KvsiOSApp/Constants.swift](Swift/KVSiOSApp/Constants.swift). Set `CognitoIdentityUserPoolRegion`, `CognitoIdentityUserPoolId`, `CognitoIdentityUserPoolAppClientId`, `CognitoIdentityUserPoolAppClientSecret` and `CognitoIdentityPoolId` to the values obtained in step 3.
+6. Open [KvsiOSApp/Constants.swift](Swift/KVSiOSApp/Constants.swift). Set `CognitoIdentityUserPoolRegion`, `CognitoIdentityUserPoolId`, `CognitoIdentityUserPoolAppClientId`, `CognitoIdentityUserPoolAppClientSecret` and `CognitoIdentityPoolId` to the values obtained in step 4.
+
+> [!NOTE]  
+> If the User-Pool App-Client does not have a secret, then set `cognitoIdentityUserPoolAppClientSecret` to `nil`:
+> ```
+> let cognitoIdentityUserPoolAppClientSecret: String? = nil
+> ```
 
    <details>
        <summary><strong>Example Constants.swift</strong></summary>
@@ -74,11 +80,16 @@ git clone https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-ios
       let cognitoIdentityUserPoolAppClientSecret = "abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmno"
       let cognitoIdentityPoolId = "us-west-2:01234567-89ab-cdef-0123-456789abcdef"
       ```
-
    </details>
 
    Open [KvsiOSApp/awsconfiguration.json](Swift/KVSiOSApp/awsconfiguration.json) and replace the "REPLACEME" values with the values obtained earlier.
 
+> [!NOTE]  
+> If the User-Pool App-Client does not have a secret, then remove the following line from _awsconfiguration.json_:
+> ```
+> "AppClientSecret": "REPLACEME",
+> ```
+
    <details>
        <summary><strong>Example awsconfiguration.json</strong></summary>
 
@@ -109,7 +120,7 @@ git clone https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-ios
 
    </details>
 
-6. To build and run, click the play button at the top of the XCode UI.
+7. To build and run, click the play button at the top of the XCode UI.
 
 #### Run the iOS Sample Application
 Building the iOS sample application installs the AWSKinesisVideoWebRTCDemoApp on your iOS device. Using this app, you can verify live audio/video streaming between mobile, web and IoT device clients (camera). The procedure below describes some of these scenarios.

Swift/KVSiOSApp/ChannelConfigurationViewController.swift

@@ -37,6 +37,7 @@ class ChannelConfigurationViewController: UIViewController, UITextFieldDelegate
     var isMaster: Bool = false
     var signalingConnected: Bool = false
     var selectedResolution: VideoResolution = .resolution720p
+    var useDualStackKvsEndpoint: Bool = false
 
     // clients for WEBRTC Connection
     var signalingClient: SignalingClient?
@@ -53,6 +54,7 @@ class ChannelConfigurationViewController: UIViewController, UITextFieldDelegate
     @IBOutlet var channelName: UITextField!
     @IBOutlet var clientID: UITextField!
     @IBOutlet var regionName: UITextField!
+    @IBOutlet var useDualStackKvsEndpointSwitch: UISwitch!
     @IBOutlet var isAudioEnabled: UISwitch!
     @IBOutlet var isVideoEnabled: UISwitch!
     @IBOutlet var resolutionButton: UIButton!
@@ -80,6 +82,33 @@ class ChannelConfigurationViewController: UIViewController, UITextFieldDelegate
         return AWSMobileClient.default()
     }
 
+    // Helper function to get KVS endpoint override if specified.
+    private func getKvsEndpointOverride()-> String? {
+
+        // Environment variable override takes precedence.
+        if let envVarOverride = kvsControlPlaneOverride, !envVarOverride.isEmpty {
+            return envVarOverride
+        }
+
+        // If using dual-stack endpoint format, construct the appropriate endpoint using the region name.
+        if self.useDualStackKvsEndpoint {
+
+            guard let regionText = self.regionName.text?.trim(),
+                !regionText.isEmpty else {
+                return nil
+            }
+
+            if regionText.hasPrefix("cn-") {
+                return String(format: PROD_CONTROL_PLANE_ENDPOINT_FORMAT_DUAL_STACK_CN, regionText)
+            }
+
+            return String(format: PROD_CONTROL_PLANE_ENDPOINT_FORMAT_DUAL_STACK, regionText)
+        }
+
+        return nil
+    }
+
+
     override func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(true)
         self.signalingConnected = false
@@ -113,20 +142,16 @@ class ChannelConfigurationViewController: UIViewController, UITextFieldDelegate
         navigationController?.setToolbarHidden(false, animated: true)
     }
 
+    @IBAction func kvsEndpointStateChanged(sender: UISwitch!) {
+        self.useDualStackKvsEndpoint = sender.isOn
+    }
+
     @IBAction func audioStateChanged(sender: UISwitch!) {
-        if sender.isOn {
-            self.sendAudioEnabled = true
-        } else {
-            self.sendAudioEnabled = false
-        }
+        self.sendAudioEnabled = sender.isOn
     }
 
     @IBAction func videoStateChanged(sender: UISwitch!) {
-        if sender.isOn {
-            self.sendVideoEnabled = true
-        } else {
-            self.sendVideoEnabled = false
-        }
+        self.sendVideoEnabled = sender.isOn
     }
 
     @IBAction func resolutionButtonTapped(_ sender: UIButton) {
@@ -221,7 +246,7 @@ class ChannelConfigurationViewController: UIViewController, UITextFieldDelegate
         }
         // Kinesis Video Client Configuration
         let configuration = AWSServiceConfiguration(region: awsRegionType,
-                                                    endpoint: kvsControlPlaneOverride.map { AWSEndpoint(urlString: $0) },
+                                                    endpoint: getKvsEndpointOverride().map { AWSEndpoint(urlString: $0) },
                                                     credentialsProvider: getCredentialsProvider())
         AWSKinesisVideo.register(with: configuration!, forKey: awsKinesisVideoKey)
 
@@ -252,7 +277,7 @@ class ChannelConfigurationViewController: UIViewController, UITextFieldDelegate
         }
 
         // get signalling channel endpoints
-        let endpoints = getSignallingEndpoints(channelARN: channelARN!, region: awsRegionValue, isMaster: self.isMaster, useStorageSession: useStorageSession)
+        let endpoints = getSignallingEndpoints(channelARN: channelARN!, awsRegionValue: awsRegionValue, isMaster: self.isMaster, useStorageSession: useStorageSession)
         //// Ensure that the WebSocket (WSS) endpoint is available; WebRTC requires a valid signaling endpoint.
         if endpoints["WSS"] == nil {
             popUpError(title: "Invalid SignallingEndpoints", message: "SignallingEndpoints is required for WebRTC connection")
@@ -385,7 +410,13 @@ class ChannelConfigurationViewController: UIViewController, UITextFieldDelegate
     func getIceCandidates(channelARN: String, endpoint: AWSEndpoint, regionType: AWSRegionType, clientId: String) -> [RTCIceServer] {
         var RTCIceServersList = [RTCIceServer]()
         // TODO: don't use the self.regionName.text!
-        let kvsStunUrlStrings = ["stun:stun.kinesisvideo." + self.regionName.text! + ".amazonaws.com:443"]
+    
+        let kvsStunUrlStrings: [String]
+        if self.useDualStackKvsEndpoint {
+            kvsStunUrlStrings = ["stun:stun.kinesisvideo." + self.regionName.text! + ".api.aws:443"]
+        } else {
+            kvsStunUrlStrings = ["stun:stun.kinesisvideo." + self.regionName.text! + ".amazonaws.com:443"]
+        }
         /*
             equivalent AWS CLI command:
             aws kinesis-video-signaling get-ice-server-config --channel-arn channelARN --client-id clientId --region cognitoIdentityUserPoolRegion
@@ -418,7 +449,7 @@ class ChannelConfigurationViewController: UIViewController, UITextFieldDelegate
     }
 
     // Get signalling endpoints for the given signalling channel ARN 
-    func getSignallingEndpoints(channelARN: String, region: String, isMaster: Bool, useStorageSession: Bool) -> Dictionary<String, String?> {
+    func getSignallingEndpoints(channelARN: String, awsRegionValue: String, isMaster: Bool, useStorageSession: Bool) -> Dictionary<String, String?> {
 
         var endpoints = Dictionary <String, String?>()
         /*

Swift/KVSiOSApp/Constants.swift

@@ -12,7 +12,7 @@ let cognitoIdentityPoolId = "REPLACEME"
 
 // App constants
 let appName = "aws-kvs-webrtc-ios-client"
-let appVersion = "1.1.0"
+let appVersion = "1.2.0"
 
 // KinesisVideo constants
 let awsKinesisVideoKey = "kinesisvideo"
@@ -59,3 +59,7 @@ let awsAccessKey: String? = ProcessInfo.processInfo.environment["AWS_ACCESS_KEY_
 let awsSecretKey: String? = ProcessInfo.processInfo.environment["AWS_SECRET_ACCESS_KEY"]
 let awsSessionToken: String? = ProcessInfo.processInfo.environment["AWS_SESSION_TOKEN"]
 let kvsControlPlaneOverride: String? = ProcessInfo.processInfo.environment["CONTROL_PLANE_URI"]
+
+// Dual-stack endpoint formats.
+let PROD_CONTROL_PLANE_ENDPOINT_FORMAT_DUAL_STACK = "https://kinesisvideo.%@.api.aws"
+let PROD_CONTROL_PLANE_ENDPOINT_FORMAT_DUAL_STACK_CN = "https://kinesisvideo.%@.api.amazonwebservices.com.cn"