You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/communication-services/how-tos/calling-sdk/includes/install-sdk/install-sdk-android.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,11 @@ ms.topic: include
5
5
ms.date: 09/08/2021
6
6
ms.author: rifox
7
7
---
8
+
8
9
## Install the SDK
9
10
10
-
Locate your project level build.gradle and make sure to add `mavenCentral()` to the list of repositories under `buildscript` and `allprojects`
11
+
Locate your project-level *build.gradle* file and add `mavenCentral()` to the list of repositories under `buildscript` and `allprojects`:
12
+
11
13
```groovy
12
14
buildscript {
13
15
repositories {
@@ -27,7 +29,8 @@ allprojects {
27
29
}
28
30
}
29
31
```
30
-
Then, in your module level build.gradle add the following lines to the dependencies section
32
+
33
+
Then, in your module-level *build.gradle* file, add the following lines to the `dependencies` section:
31
34
32
35
```groovy
33
36
dependencies {
@@ -39,27 +42,30 @@ dependencies {
39
42
40
43
### Initialize the required objects
41
44
42
-
To create a `CallAgent` instance you have to call the `createCallAgent` method on a `CallClient` instance. This asynchronously returns a `CallAgent` instance object.
43
-
The `createCallAgent` method takes a `CommunicationUserCredential` as an argument, which encapsulates an [access token](../../../../quickstarts/identity/access-tokens.md).
44
-
To access the `DeviceManager`, a callAgent instance must be created first, and then you can use the `CallClient.getDeviceManager` method to get the DeviceManager.
45
+
To create a `CallAgent` instance, you have to call the `createCallAgent` method on a `CallClient` instance. This call asynchronously returns a `CallAgent` instance object.
46
+
47
+
The `createCallAgent` method takes `CommunicationUserCredential` as an argument, which encapsulates an [access token](../../../../quickstarts/identity/access-tokens.md).
48
+
49
+
To access `DeviceManager`, you must create a `callAgent` instance first. Then you can use the `CallClient.getDeviceManager` method to get `DeviceManager`.
Copy file name to clipboardExpand all lines: articles/communication-services/how-tos/calling-sdk/includes/install-sdk/install-sdk-ios.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,19 +5,20 @@ ms.topic: include
5
5
ms.date: 09/08/2021
6
6
ms.author: rifox
7
7
---
8
+
8
9
## Set up your system
9
10
10
11
### Create the Xcode project
11
12
12
-
In Xcode, create a new iOS project and select the **Single View App** template. This quickstart uses the [SwiftUI framework](https://developer.apple.com/xcode/swiftui/), so you should set the **Language** to **Swift** and **User Interface** to **SwiftUI**.
13
+
In Xcode, create a new iOS project and select the **Single View App** template. This quickstart uses the [SwiftUI framework](https://developer.apple.com/xcode/swiftui/), so you should set **Language** to **Swift** and set **Interface** to **SwiftUI**.
13
14
14
-
You're not going to create unit tests or UI tests during this quickstart. Feel free to clear the **Include Unit Tests**and **Include UI Tests** text boxes.
15
+
You're not going to create tests during this quickstart. Feel free to clear the **Include Tests**checkbox.
15
16
16
17
:::image type="content" source="../../../../quickstarts/voice-video-calling/media/ios/xcode-new-ios-project.png" alt-text="Screenshot that shows the window for creating a project within Xcode.":::
17
18
18
-
### Install the package and dependencies with CocoaPods
19
+
### Install the package and dependencies by using CocoaPods
19
20
20
-
1. Create a Podfile for your application, like this:
21
+
1. Create a Podfile for your application, like this example:
21
22
22
23
```
23
24
platform :ios, '13.0'
@@ -27,13 +28,13 @@ You're not going to create unit tests or UI tests during this quickstart. Feel f
27
28
end
28
29
```
29
30
2. Run `pod install`.
30
-
3. Open `.xcworkspace` with Xcode.
31
+
3. Open `.xcworkspace` by using Xcode.
31
32
32
33
### Request access to the microphone
33
34
34
-
To access the device's microphone, you need to update your app's information property list with `NSMicrophoneUsageDescription`. You set the associated value to a `string` that will be included in the dialog that the system uses to request access from the user.
35
+
To access the device's microphone, you need to update your app's information property list by using `NSMicrophoneUsageDescription`. You set the associated value to a string that will be included in the dialog that the system uses to request access from the user.
35
36
36
-
Right-click the `Info.plist` entry of the project tree and select **Open As** > **Source Code**. Add the following lines in the top-level `<dict>` section, and then save the file.
37
+
Right-click the *Info.plist* entry of the project tree, and then select **Open As** > **Source Code**. Add the following lines in the top-level `<dict>` section, and then save the file.
37
38
38
39
```xml
39
40
<key>NSMicrophoneUsageDescription</key>
@@ -42,7 +43,7 @@ Right-click the `Info.plist` entry of the project tree and select **Open As** >
42
43
43
44
### Set up the app framework
44
45
45
-
Open your project's *ContentView.swift* file and add an `import` declaration to the top of the file to import the `AzureCommunicationCalling` library. In addition, import `AVFoundation`. You'll need it for audio permission requests in the code.
46
+
Open your project's *ContentView.swift* file. Add an `import` declaration to the top of the file to import the `AzureCommunicationCalling` library. In addition, import `AVFoundation`. You'll need it for audio permission requests in the code.
46
47
47
48
```swift
48
49
importAzureCommunicationCalling
@@ -53,7 +54,7 @@ import AVFoundation
53
54
54
55
To create a `CallAgent` instance from `CallClient`, you have to use a `callClient.createCallAgent` method that asynchronously returns a `CallAgent` object after it's initialized.
55
56
56
-
To create a call client, you have to pass a `CommunicationTokenCredential` object.
57
+
To create a call client, pass a `CommunicationTokenCredential` object:
57
58
58
59
```swift
59
60
importAzureCommunication
@@ -76,7 +77,7 @@ public func fetchTokenSync(then onCompletion: TokenRefreshOnCompletion) {
76
77
}
77
78
```
78
79
79
-
Pass the `CommunicationTokenCredential` object that you created to `CallClient`, and set the display name.
80
+
Pass the `CommunicationTokenCredential` object that you created to `CallClient`, and set the display name:
A CallClient, instance is required for most call operations. Let's create a new `CallClient` instance. You can configure it with custom options like a Logger instance.
19
+
A `CallClient` instance is required for most call operations. Here, you create a new `CallClient` instance. You can configure it with custom options like a `Logger` instance.
20
20
21
21
When you have a `CallClient` instance, you can create a `CallAgent` instance by calling the `createCallAgent` method on the `CallClient` instance. This method asynchronously returns a `CallAgent` instance object.
Copy file name to clipboardExpand all lines: articles/communication-services/how-tos/calling-sdk/includes/install-sdk/install-sdk-windows.md
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,21 +5,23 @@ ms.topic: include
5
5
ms.date: 05/30/2023
6
6
ms.author: jowang
7
7
---
8
-
## Setting up
8
+
## Set up your system
9
9
10
-
### Creating the Visual Studio project
10
+
### Create the Visual Studio project
11
11
12
-
For UWP app, in Visual Studio 2022, create a new `Blank App (Universal Windows)` project. After entering the project name, feel free to pick any Windows SDK greater than `10.0.17763.0`.
12
+
For a UWP app, in Visual Studio 2022, create a new **Blank App (Universal Windows)** project. After you enter the project name, feel free to choose any Windows SDK later than 10.0.17763.0.
13
13
14
-
For WinUI 3 app, create a new project with the `Blank App, Packaged (WinUI 3 in Desktop)` template to set up a single-page WinUI 3 app. [Windows App SDK version 1.3](/windows/apps/windows-app-sdk/stable-channel#version-13) and above is required.
15
-
### Install the package and dependencies with NuGet Package Manager
14
+
For a WinUI 3 app, create a new project with the **Blank App, Packaged (WinUI 3 in Desktop)** template to set up a single-page WinUI 3 app. [Windows App SDK version 1.3](/windows/apps/windows-app-sdk/stable-channel#version-13) or later is required.
15
+
16
+
### Install the package and dependencies by using NuGet Package Manager
16
17
17
18
The Calling SDK APIs and libraries are publicly available via a NuGet package.
18
-
The following steps exemplify how to find, download, and install the Calling SDK NuGet package.
19
19
20
-
1. Open NuGet Package Manager (`Tools` -> `NuGet Package Manager` -> `Manage NuGet Packages for Solution`)
21
-
2. Click on `Browse` and then type `Azure.Communication.Calling.WindowsClient` in the search box.
22
-
3. Make sure that `Include prerelease` check box is selected.
23
-
4. Click on the `Azure.Communication.Calling.WindowsClient` package, select `Azure.Communication.Calling.WindowsClient`[1.4.0-beta.1](https://www.nuget.org/packages/Azure.Communication.Calling.WindowsClient/1.4.0-beta.1) or newer version.
24
-
5. Select the checkbox corresponding to the CS project on the right-side tab.
25
-
6. Click on the `Install` button.
20
+
The following steps exemplify how to find, download, and install the Calling SDK NuGet package:
21
+
22
+
1. Open NuGet Package Manager by selecting **Tools** > **NuGet Package Manager** > **Manage NuGet Packages for Solution**.
23
+
2. Select **Browse**, and then enter `Azure.Communication.Calling.WindowsClient` in the search box.
24
+
3. Make sure that the **Include prerelease** check box is selected.
25
+
4. Select the `Azure.Communication.Calling.WindowsClient` package, and then select `Azure.Communication.Calling.WindowsClient`[1.4.0-beta.1](https://www.nuget.org/packages/Azure.Communication.Calling.WindowsClient/1.4.0-beta.1) or a newer version.
26
+
5. Select the checkbox that corresponds to the Communication Services project on the right-side tab.
> Up until version 1.1.0 and beta release version 1.1.0-beta.1 of the Azure Communication Services Calling Android SDK has the `isRecordingActive` and `addOnIsRecordingActiveChangedListener` are part of the `Call` object. For new beta releases, those APIs have been moved as an extended feature of `Call` just like described below.
13
11
14
12
> [!NOTE]
15
-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. To use this api please use 'beta' release of Azure Communication Services Calling Android SDK
13
+
> This API is provided as a preview for developers and might change based on feedback that we receive. Don't use this API in a production environment. To use this API, use the beta release of the Azure Communication Services Calling Android SDK.
14
+
15
+
Call recording is an extended feature of the core `Call` object.
16
+
17
+
> [!WARNING]
18
+
> Up until version 1.1.0 and beta release version 1.1.0-beta.1 of the Azure Communication Services Calling Android SDK, `isRecordingActive` and `addOnIsRecordingActiveChangedListener` were part of the `Call` object. For new beta releases, those APIs were moved as an extended feature of `Call`.
16
19
17
-
Call recording is an extended feature of the core `Call` object. You first need to obtain the recording feature object:
20
+
You first need to obtain the recording feature object:
If you want to start recording from your application, please first follow [Calling Recording overview](../../../../concepts/voice-video-calling/call-recording.md) for the steps to set up call recording.
42
+
If you want to start recording from your application, first follow [Call recording overview](../../../../concepts/voice-video-calling/call-recording.md) for the steps to set up call recording.
40
43
41
-
Once you have the call recording setup on your server, from your Android application you need to obtain the `ServerCallId` value from the call and then send it to your server to start the recording process. The `ServerCallId` value can be found using `getServerCallId()` from the `CallInfo` class, which can be found in the class object using `getInfo()`.
44
+
After you set up call recording on your server, from your Android application, you need to obtain the `ServerCallId` value from the call and then send it to your server to start the recording process. You can find the `ServerCallId` value by using `getServerCallId()` from the `CallInfo` class. You can find the `CallInfo` class in the class object by using `getInfo()`.
42
45
43
46
```java
44
47
try {
@@ -51,9 +54,9 @@ try {
51
54
}
52
55
```
53
56
54
-
When recording is started from the server, the event `handleCallOnIsRecordingChanged`will trigger and the value of `callRecordingFeature.isRecordingActive()`will be`true`.
57
+
When you start recording from the server, the event `handleCallOnIsRecordingChanged`is triggered and the value of `callRecordingFeature.isRecordingActive()`is`true`.
55
58
56
-
Just like starting the call recording, if you want to stop the call recording you need to get the `ServerCallId` and send it to your recording server so that it can stop the call recording.
59
+
Just like starting the call recording, if you want to stop the call recording, you need to get `ServerCallId` and send it to your recording server so that it can stop the recording:
57
60
58
61
```java
59
62
try {
@@ -66,4 +69,4 @@ try {
66
69
}
67
70
```
68
71
69
-
When recording is stopped from the server, the event `handleCallOnIsRecordingChanged`will trigger and the value of `callRecordingFeature.isRecordingActive()`will be`false`.
72
+
When you stop recording from the server, the event `handleCallOnIsRecordingChanged`is triggered and the value of `callRecordingFeature.isRecordingActive()`is`false`.
0 commit comments