Skip to content

Commit 2139b4c

Browse files
committed
Edits and Acrolinx
Made all include files consistent, ran Acrolinx, made text edits.
1 parent 2a1fd9b commit 2139b4c

File tree

4 files changed

+62
-50
lines changed

4 files changed

+62
-50
lines changed

articles/communication-services/quickstarts/voice-video-calling/includes/call-recording-samples/call-recording-csharp.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ CallAutomationClient callAutomationClient = new CallAutomationClient("<ACSConnec
4848
## 2. Start recording session with StartRecordingOptions using 'StartAsync' API
4949

5050
Use the `serverCallId` received during initiation of the call.
51-
- Use `RecordingContent` to pass the recording content type. Use `audio`.
52-
- Use `RecordingChannel` to pass the recording channel type. Use `mixed` or `unmixed`.
53-
- Use `RecordingFormat` to pass the format of the recording. Use `wav`.
51+
- Use `RecordingContent` to pass the recording content type. Use `AUDIO`.
52+
- Use `RecordingChannel` to pass the recording channel type. Use `MIXED` or `UNMIXED`.
53+
- Use `RecordingFormat` to pass the format of the recording. Use `WAV`.
5454

5555
```csharp
5656
StartRecordingOptions recordingOptions = new StartRecordingOptions(new ServerCallLocator("<ServerCallId>"))
@@ -63,9 +63,9 @@ StartRecordingOptions recordingOptions = new StartRecordingOptions(new ServerCal
6363
Response<RecordingStateResult> response = await callAutomationClient.GetCallRecording()
6464
.StartAsync(recordingOptions);
6565
```
66-
### 2.1. Start Recording - Bring Your Own Azure Blob Store
66+
### 2.1. Start Recording - Bring Your Own Azure Blob Store
6767

68-
To store the recording file when recording is complete, start recording with your own Azure Blob Storage defined.
68+
Start recording using your designated Azure Blob Storage to store the recorded file once recording is complete.
6969

7070
```csharp
7171
StartRecordingOptions recordingOptions = new StartRecordingOptions(new ServerCallLocator("<ServerCallId>"))
@@ -80,9 +80,12 @@ StartRecordingOptions recordingOptions = new StartRecordingOptions(new ServerCal
8080
Response<RecordingStateResult> response = await callAutomationClient.GetCallRecording()
8181
.StartAsync(recordingOptions);
8282
```
83+
8384
## 2.2. Start recording session with Pause mode enabled using 'StartAsync' API
85+
8486
> [!NOTE]
8587
> **Recordings will need to be resumed for recording file to be generated.**
88+
8689
```csharp
8790
StartRecordingOptions recordingOptions = new StartRecordingOptions(new ServerCallLocator("<ServerCallId>"))
8891
{
@@ -97,6 +100,7 @@ Response<RecordingStateResult> response = await callAutomationClient.GetCallReco
97100
```
98101

99102
### 2.3. Only for Unmixed - Specify a user on channel 0
103+
100104
To produce unmixed audio recording files, you can use the `AudioChannelParticipantOrdering` functionality to specify which user you want to record on channel 0. The rest of the participants are assigned to a channel as they speak. If you use `RecordingChannel.Unmixed` but don't use `AudioChannelParticipantOrdering`, Call Recording assigns channel 0 to the first participant speaking.
101105

102106
```csharp
@@ -131,29 +135,29 @@ The `StartAsync` API response contains the `recordingId` of the recording sessio
131135

132136
## 3. Stop recording session using `StopAsync` API
133137

134-
Use the `recordingId` received in response of `StartAsync`.
138+
Use the `recordingId` received in response to `StartAsync`.
135139

136140
```csharp
137141
var stopRecording = await callAutomationClient.GetCallRecording().StopAsync(recordingId);
138142
```
139143

140144
## 4. Pause recording session using `PauseAsync` API
141145

142-
Use the `recordingId` received in response of `StartAsync`.
146+
Use the `recordingId` received in response to `StartAsync`.
143147

144148
```csharp
145149
var pauseRecording = await callAutomationClient.GetCallRecording ().PauseAsync(recordingId);
146150
```
147151

148152
## 5. Resume recording session using `ResumeAsync` API
149153

150-
Use the `recordingId` received in response of `StartAsync`.
154+
Use the `recordingId` received in response to `StartAsync`.
151155

152156
```csharp
153157
var resumeRecording = await callAutomationClient.GetCallRecording().ResumeAsync(recordingId);
154158
```
155159

156-
## 6. Download recording File using `DownloadToAsync` API
160+
## 6. Download recording File using `DownloadToAsync` API
157161

158162
Use an [Azure Event Grid](../../../../../event-grid/event-schema-communication-services.md) web hook or other triggered action to notify your services when the recorded media is ready for download.
159163

@@ -197,11 +201,11 @@ var recordingDownloadUri = new Uri(contentLocation);
197201
var response = await callAutomationClient.GetCallRecording().DownloadToAsync(recordingDownloadUri, fileName);
198202
```
199203

200-
Fetch the `downloadLocation` for the recording from the `contentLocation` attribute of the `recordingChunk`. `DownloadToAsync` method downloads the content into provided filename.
204+
Fetch the `downloadLocation` for the recording from the `contentLocation` attribute of the `recordingChunk`. Use the `DownloadToAsync` method to download the content into a provided filename.
201205

202206
## 7. Delete recording content using `DeleteAsync` API
203207

204-
Use `DeleteAsync` API to delete the recording content (such as recorded media and metadata)
208+
Use `DeleteAsync` API to delete the recording content (such as recorded media and metadata).
205209

206210
```csharp
207211
var recordingDeleteUri = new Uri(deleteLocation);

articles/communication-services/quickstarts/voice-video-calling/includes/call-recording-samples/call-recording-java.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ Response<RecordingStateResult> response = callAutomationClient.getCallRecording(
6868

6969
```
7070

71-
### 2.1. Start Recording - Bring Your Own Azure Blob Store
71+
### 2.1. Start Recording - Bring Your Own Azure Blob Store
7272

73-
To store the recording file when recording is complete, start the recording session with your own Azure Blob Storage.
73+
Start recording using your designated Azure Blob Storage to store the recorded file once recording is complete.
7474

7575
```java
7676
StartRecordingOptions recordingOptions = new StartRecordingOptions(callLocator)
@@ -203,14 +203,13 @@ The following code is an example of the event schema.
203203
}
204204
```
205205

206-
Use `downloadToWithResponse` method of `CallRecording` class for downloading the recorded media. Following are the supported parameters for `downloadToWithResponse` method:
206+
Use `downloadToWithResponse` method of `CallRecording` class to download the recorded media. Following are the supported parameters for `downloadToWithResponse` method:
207207
- `contentLocation`: Azure Communication Services URL where the content is located.
208208
- `destinationPath` : File location.
209209
- `parallelDownloadOptions`: An optional `ParallelDownloadOptions` object to modify how the parallel download works.
210210
- `overwrite`: True to overwrite the file if it exists.
211211
- `context`: A Context representing the request context.
212212

213-
214213
```java
215214
Boolean overwrite = true;
216215
ParallelDownloadOptions parallelDownloadOptions = null;

articles/communication-services/quickstarts/voice-video-calling/includes/call-recording-samples/call-recording-javascript.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,24 @@ You can download the sample app from [GitHub](https://github.com/Azure-Samples/c
2121
Call Recording APIs use exclusively the `serverCallId`to initiate recording. There are a couple of methods you can use to fetch the `serverCallId` depending on your scenario:
2222

2323
### Call Automation scenarios
24+
2425
- When using [Call Automation](../../../call-automation/callflows-for-customer-interactions.md), you have two options to get the `serverCallId`:
25-
1) Once a call is created, a `serverCallId` is returned as a property of the `CallConnected` event after a call has been established. Learn how to [Get CallConnected event](../../../call-automation/callflows-for-customer-interactions.md?pivots=programming-language-javascript#update-programcs) from Call Automation SDK.
26-
2) Once you answer the call or a call is created the `serverCallId` is returned as a property of the `AnswerCallResult` or `CreateCallResult` API responses respectively.
26+
1) Once a call is created, a `serverCallId` is returned as a property of the `CallConnected` event after a call is established. Learn how to [Get a CallConnected event](../../../call-automation/callflows-for-customer-interactions.md?pivots=programming-language-javascript#update-programcs) from the Call Automation SDK.
27+
2) Once you answer the call or a call is created, it returns the `serverCallId` as a property of the `AnswerCallResult` or `CreateCallResult` API responses respectively.
2728

2829
### Calling SDK scenarios
29-
- When using [Calling Client SDK](../../get-started-with-video-calling.md), you can retrieve the `serverCallId` by using the `getServerCallId` method on the call.
30-
Use this example to learn how to [Get serverCallId](../../get-server-call-id.md) from the Calling Client SDK.
3130

31+
When using [Calling Client SDK](../../get-started-with-video-calling.md), you can retrieve the `serverCallId` by using the `getServerCallId` method on the call.
3232

33+
Use this example to learn how to [Get a serverCallId](../../get-server-call-id.md) from the Calling Client SDK.
3334

3435
Let's get started with a few simple steps!
3536

36-
37-
3837
## 1. Create a Call Automation client
3938

4039
Call Recording APIs are part of the Azure Communication Services [Call Automation](../../../../concepts/call-automation/call-automation.md) libraries. Thus, it's necessary to create a Call Automation client.
41-
To create a call automation client, you'll use your Communication Services connection string and pass it to `CallAutomationClient` object.
40+
41+
To create a call automation client, use your Communication Services connection string and pass it to `CallAutomationClient` object.
4242

4343
```javascript
4444
const callAutomationClient = new CallAutomationClient.CallAutomationClient("<ACSConnectionString>");
@@ -47,9 +47,9 @@ const callAutomationClient = new CallAutomationClient.CallAutomationClient("<ACS
4747
## 2. Start recording session with StartRecordingOptions using 'StartAsync' API
4848

4949
Use the `serverCallId` received during initiation of the call.
50-
- RecordingContent is used to pass the recording content type. Use audio
51-
- RecordingChannel is used to pass the recording channel type. Use mixed or unmixed.
52-
- RecordingFormat is used to pass the format of the recording. Use wav.
50+
- Use `RecordingContent` to pass the recording content type. Use `AUDIO`.
51+
- Use `RecordingChannel` to pass the recording channel type. Use `MIXED` or `UNMIXED`.
52+
- Use `RecordingFormat` to pass the format of the recording. Use `WAV`.
5353

5454
```javascript
5555
var locator: CallLocator = { id: "<ServerCallId>", kind: "serverCallLocator" };
@@ -65,8 +65,9 @@ var options: StartRecordingOptions =
6565
var response = await callAutomationClient.getCallRecording().start(options);
6666
```
6767

68-
### 2.1. Start Recording - Bring Your Own Azure Blob Store
69-
Start Recording with your own Azure Blob Storage defined to store the recording file once recording is complete.
68+
### 2.1. Start Recording - Bring Your Own Azure Blob Store
69+
70+
Start recording using your designated Azure Blob Storage to store the recorded file once recording is complete.
7071

7172
```javascript
7273
const recordingStorageKind: RecordingStorageKind = "azureBlobStorage"
@@ -104,7 +105,7 @@ var response = await callAutomationClient.getCallRecording().start(options);
104105
```
105106

106107
### 2.3. Only for Unmixed - Specify a user on channel 0
107-
To produce unmixed audio recording files, you can use the `AudioChannelParticipantOrdering` functionality to specify which user you want to record on channel 0. The rest of the participants will be assigned to a channel as they speak. If you use `RecordingChannel.Unmixed` but don't use `AudioChannelParticipantOrdering`, Call Recording will assign channel 0 to the first participant speaking.
108+
To produce unmixed audio recording files, you can use the `AudioChannelParticipantOrdering` functionality to specify which user you want to record on channel 0. The rest of the participants are assigned to a channel as they speak. If you use `RecordingChannel.Unmixed` but don't use `AudioChannelParticipantOrdering`, Call Recording assigns channel 0 to the first participant speaking.
108109

109110
```javascript
110111
var locator: CallLocator = { id: "<ServerCallId>", kind: "serverCallLocator" };
@@ -145,23 +146,23 @@ The `StartAsync` API response contains the `recordingId` of the recording sessio
145146

146147
## 3. Stop recording session using 'stop' API
147148

148-
Use the `recordingId` received in response of `start`.
149+
Use the `recordingId` received in response to `start`.
149150

150151
```javascript
151152
var stopRecording = await callAutomationClient.getCallRecording().stop(recordingId);
152153
```
153154

154155
## 4. Pause recording session using 'pause' API
155156

156-
Use the `recordingId` received in response of `start`.
157+
Use the `recordingId` received in response to `start`.
157158

158159
```javascript
159160
var pauseRecording = await callAutomationClient.getCallRecording().pause(recordingId);
160161
```
161162

162163
## 5. Resume recording session using 'ResumeAsync' API
163164

164-
Use the `recordingId` received in response of `start`.
165+
Use the `recordingId` received in response to `start`.
165166

166167
```javascript
167168
var resumeRecording = await callAutomationClient.getCallRecording().resume(recordingId);
@@ -171,9 +172,9 @@ var resumeRecording = await callAutomationClient.getCallRecording().resume(recor
171172

172173
Use an [Azure Event Grid](../../../../../event-grid/event-schema-communication-services.md) web hook or other triggered action should be used to notify your services when the recorded media is ready for download.
173174

174-
An Event Grid notification `Microsoft.Communication.RecordingFileStatusUpdated` is published when a recording is ready for retrieval, typically a few minutes after the recording process has completed (for example, meeting ended, recording stopped). Recording event notifications include `contentLocation` and `metadataLocation`, which are used to retrieve both recorded media and a recording metadata file.
175+
An Event Grid notification `Microsoft.Communication.RecordingFileStatusUpdated` is published when a recording is ready for retrieval, typically a few minutes after the recording process completes (such as the meeting ended or the recording stopped). Recording event notifications include `contentLocation` and `metadataLocation`, which are used to retrieve both recorded media and a recording metadata file.
175176

176-
Below is an example of the event schema.
177+
The following code is an example of the event schema.
177178

178179
```
179180
{
@@ -204,12 +205,12 @@ Below is an example of the event schema.
204205
}
205206
```
206207

207-
Use `downloadToPath` API for downloading the recorded media.
208+
Use `downloadToPath` API to download the recorded media.
208209

209210
```javascript
210211
var response = await callAutomationClient.getCallRecording().downloadToPath(contentLocation, fileName);
211212
```
212-
The `downloadLocation` for the recording can be fetched from the `contentLocation` attribute of the `recordingChunk`. `DownloadToAsync` method download the content into provided filename.
213+
The `downloadLocation` for the recording can be fetched from the `contentLocation` attribute of the `recordingChunk`. Use the `DownloadToAsync` method to download the content into a provided filename.
213214

214215
## 7. Delete recording content using 'DeleteAsync' API
215216

0 commit comments

Comments
 (0)