Skip to content

Commit eedbf58

Browse files
Merge pull request #209665 from emlynmac/emlyn/update-ios-calling-hero
Updated iOS Azure Communication Services Calling Hero Sample App Documentation
2 parents 0889b26 + 970ca37 commit eedbf58

File tree

6 files changed

+26
-14
lines changed

6 files changed

+26
-14
lines changed

articles/communication-services/samples/includes/ios-calling-hero.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Azure Communication Services **Group Calling Hero Sample for iOS** demonstra
1616

1717
## Download code
1818

19-
Find the project for this sample on [GitHub](https://github.com/Azure-Samples/communication-services-ios-calling-hero). A version of the sample with [Teams Interop](../../concepts/teams-interop.md) can be found on a separate [Branch](https://github.com/Azure-Samples/communication-services-ios-calling-hero/).
19+
Find the project for this sample on [GitHub](https://github.com/Azure-Samples/communication-services-ios-calling-hero).
2020

2121
## Overview
2222

@@ -26,13 +26,23 @@ Here's what the sample looks like:
2626

2727
:::image type="content" source="../media/calling/landing-page-ios.png" alt-text="Screenshot showing the landing page of the sample application.":::
2828

29-
When you press the "Start new call" button, the iOS application creates a new call and joins it. The application allows you to join an existing Azure Communication Services call by specifying the existing call's ID.
30-
31-
After joining a call, you'll be prompted to give the application permission to access your camera and microphone. You'll also be asked to provide a display name.
29+
When you press the "Start new call" button, the iOS application prompts you to enter your display
30+
name to use for the call.
3231

3332
:::image type="content" source="../media/calling/pre-call-ios.png" alt-text="Screenshot showing the pre-call screen of the sample application.":::
3433

35-
Once you configure your display name and devices, you can join the call. You'll see the main call canvas where the core calling experience lives.
34+
After tapping "Next" on the "Start Call" screen, you have the opportunity to share the group ID of
35+
the call via the iOS share sheet.
36+
37+
:::image type="content" source="../media/calling/share-call-ios.png" alt-text="Screenshot showing the share group ID screen of the sample application.":::
38+
39+
The application also allows you to join an existing Azure Communication Services call by specifying the existing call's ID or teams ID link.
40+
41+
:::image type="content" source="../media/calling/join-call-ios.png" alt-text="Screenshot showing the join call screen of the sample application.":::
42+
43+
After joining a call, you'll be prompted to give the application permission to access your camera and microphone, if not already authorized. Keep in mind that, like all AVFoundation-based apps, true audio and video functionality is only available on real hardware.
44+
45+
Once you configure your display name and join the call, you'll see the main call canvas where the core calling experience lives.
3646

3747
:::image type="content" source="../media/calling/main-app-ios.png" alt-text="Screenshot showing the main screen of the sample application.":::
3848

@@ -58,11 +68,14 @@ The group calling sample can be run locally using XCode. Developers can either u
5868

5969
1. Install dependencies by running `pod install`.
6070
2. Open `AzureCalling.xcworkspace` in XCode.
61-
3. Update `AppSettings.plist`. Set the value for the `communicationTokenFetchUrl` key to be the URL for your Authentication Endpoint.
71+
3. Create a text file at the root, called `AppSettings.xcconfig` and set the value:
72+
```text
73+
communicationTokenFetchUrl = <your authentication endpoint, without the https:// component>
74+
```
6275

6376
### Run sample
6477

65-
Build and run the sample in XCode.
78+
Build and run the sample in XCode, using the AzureCalling target on the simulator or device of your choice.
6679

6780
## (Optional) Securing an authentication endpoint
6881

@@ -77,13 +90,12 @@ With additional configuration, this sample supports connecting to an **Azure Act
7790

7891
:::image type="content" source="../media/calling/aad-overview.png" alt-text="Azure Active Directory configuration on Azure portal.":::
7992

80-
3. Open `AppSettings.plist` in Xcode, add the following key values:
81-
- `communicationTokenFetchUrl`: The URL to request Azure Communication Services token
82-
- `isAADAuthEnabled`: A boolean value to indicate if the Azure Communication Services token authentication is required or not
83-
- `aadClientId`: Your Application (client) ID
84-
- `aadTenantId`: Your Directory (tenant) ID
85-
- `aadRedirectURI`: The redirect URI should be in this format: `msauth.<app_bundle_id>://auth`
86-
- `aadScopes`: An array of permission scopes requested from users for authorization. Add `<Application ID URI>/user_impersonation` to the array to grant access to authentication endpoint
93+
3. Create a `AppSettings.xcconfig` file at the root if not already present and add the values:
94+
```text
95+
communicationTokenFetchUrl = <Application ID URI, without the https:// component>
96+
aadClientId = <Application (client) ID>
97+
aadTenantId = <Directory (tenant) ID>
98+
```
8799

88100
## Clean up resources
89101

30.7 KB
Loading
13 Bytes
Loading
-2.3 KB
Loading
3.33 KB
Loading
33.6 KB
Loading

0 commit comments

Comments
 (0)