Skip to content

Commit f120eaf

Browse files
committed
Address review comments
1 parent c5c77fe commit f120eaf

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

articles/communication-services/concepts/voice-video-calling/data-channel.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ ms.subservice: calling
2424
2525
The Data Channel API enables real-time messaging during audio and video calls. With this API, you can now easily integrate chat and data exchange functionalities into the applications, providing a seamless communication experience for users. Key features include:
2626

27-
1. Real-time Messaging: The Data Channel API enables users to instantly send and receive messages during an ongoing audio or video call, promoting smooth and efficient communication. In group call scenarios, messages can be sent to a single participant, a specific set of participants, or all participants within the call. This flexibility enhances communication and collaboration among users during group interactions.
28-
2. Unidirectional Communication: Unlike bidirectional communication, the Data Channel API is designed for unidirectional communication. It employs distinct objects for sending and receiving messages: the DataChannelSender object for sending and the DataChannelReceiver object for receiving. This separation simplifies message management in group calls, leading to a more streamlined user experience.
29-
3. Binary Data Support: The API supports the sending and receiving of binary data, permitting the exchange of diverse data types, such as text, images, and files. Note that text messages must be serialized into a byte buffer before they can be transmitted.
30-
4. Sender Options: The Data Channel API provides three configurable options when creating a sender object, including Reliability, Priority, and Bitrate. These options enable the configuration of a channel to meet specific needs for different use cases.
31-
5. Security: All messages exchanged between a client and the other endpoint are encrypted, ensuring the privacy and security of users' data.
27+
* Real-time Messaging: The Data Channel API enables users to instantly send and receive messages during an ongoing audio or video call, promoting smooth and efficient communication. In group call scenarios, messages can be sent to a single participant, a specific set of participants, or all participants within the call. This flexibility enhances communication and collaboration among users during group interactions.
28+
* Unidirectional Communication: Unlike bidirectional communication, the Data Channel API is designed for unidirectional communication. It employs distinct objects for sending and receiving messages: the DataChannelSender object for sending and the DataChannelReceiver object for receiving. This separation simplifies message management in group calls, leading to a more streamlined user experience.
29+
* Binary Data Support: The API supports the sending and receiving of binary data, permitting the exchange of diverse data types, such as text, images, and files. Note that text messages must be serialized into a byte buffer before they can be transmitted.
30+
* Sender Options: The Data Channel API provides three configurable options when creating a sender object, including Reliability, Priority, and Bitrate. These options enable the configuration of a channel to meet specific needs for different use cases.
31+
* Security: All messages exchanged between a client and the other endpoint are encrypted, ensuring the privacy and security of users' data.
3232

3333
## Common use cases
3434

@@ -61,7 +61,7 @@ The decoupling of sender and receiver objects simplifies message handling in gro
6161

6262
### Channel
6363
Every Data Channel message is associated with a specific channel identified by `channelId`.
64-
It's important to clarify that this channelId isn't related to the id property in the WebRTC Data Channel.
64+
It's important to clarify that this channelId isn't related to the `id` property in the WebRTC Data Channel.
6565
This channelId can be utilized to differentiate various application uses, such as using 100 for chat messages and 101 for image transfers.
6666

6767
The channelId is assigned during the creation of a DataChannelSender object,
@@ -80,7 +80,8 @@ In the Web SDK, the durability of the channel is ensured through a reliable SCTP
8080
In the context of a group call, it signifies the prevention of message loss between the sender and server.
8181
In a peer-to-peer call, it denotes reliable transmission between the sender and remote endpoint.
8282

83-
Note: In the current Web SDK implementation, data transmission is done through a reliable WebRTC Data Channel connection for both `lossy` and `durable` channels.
83+
> [!Note]
84+
> In the current Web SDK implementation, data transmission is done through a reliable WebRTC Data Channel connection for both `lossy` and `durable` channels.
8485
8586
### Priority
8687
Upon creation, a channel can be configured to be one of the two Priority options: `normal` or `high`.
@@ -129,7 +130,7 @@ As an alternative, you could opt for broadcasting messages. However, be aware th
129130
### Rate limiting
130131
There's a limit on the overall send bitrate, currently set at 500 Kbps.
131132
However, when broadcasting messages, the send bitrate limit is dynamic and depends on the receive bitrate.
132-
In the current implementation, the send bitrate limit is calculted as the maximum send bitrate (500 Kbps) minus 80% of the receive bitrate.
133+
In the current implementation, the send bitrate limit is calculated as the maximum send bitrate (500 Kbps) minus 80% of the receive bitrate.
133134

134135
Furthermore, we also enforce a packet rate restriction when sending broadcast messages.
135136
The current limit is set at 80 packets per second, where every 1200 bytes in a message is counted as one packet.

articles/communication-services/quickstarts/voice-video-calling/get-started-data-channel.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
ms.author: enricohuang
3-
title: Quickstart - Add data channel messaging to your calling app
3+
title: Quickstart - Add Data Channel messaging to your calling app
44
titleSuffix: An Azure Communication Services quickstart
5-
description: In this quickstart, you'll learn how to add data channel to your existing calling app using Azure Communication Services.
5+
description: In this quickstart, you'll learn how to add Data Channel to your existing calling app using Azure Communication Services.
66
author: sloanster
77
services: azure-communication-services
88
ms.date: 05/04/2023
@@ -12,7 +12,7 @@ ms.subservice: calling
1212
ms.custom: mode-other
1313
---
1414

15-
# QuickStart: Add data channel messaging to your calling app
15+
# Quickstart: Add Data Channel messaging to your calling app
1616

1717
[!INCLUDE [Data Channel feature with JavaScript](./includes/data-channel/data-channel-javascript.md)]
1818

articles/communication-services/quickstarts/voice-video-calling/includes/data-channel/data-channel-javascript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.service: azure-communication-services
1111
ms.subservice: calling
1212
---
1313

14-
The Data Channel feature API enables real-time messaging during audio and video calls. In this quickstart guide, we'll illustrate how to integrate DataChannel feature, enabling the exchange of text messages among participants within a group call.
14+
The Data Channel feature API enables real-time messaging during audio and video calls. In this quickstart guide, we'll illustrate how to integrate the Data Channel feature, enabling the exchange of text messages among participants within a group call.
1515

1616

1717
[!INCLUDE [Public Preview](../../../../includes/public-preview-include-document.md)]
@@ -45,7 +45,7 @@ dataChannel.on('dataChannelReceiverCreated', receiver => {
4545
});
4646
```
4747

48-
Within the listener callback function, you can access the receiver object and retrieve information such as `channelId` and the sender participant id `senderParticipantIdentifier`.
48+
Within the listener callback function, you can access the receiver object and retrieve information such as `channelId` and the sender participant ID `senderParticipantIdentifier`.
4949
It's your responsibility to maintain the receiver object reference, as the SDK will only emit the event once for each created receiver object.
5050

5151
## Handle messageReady and close event of DataChannelReceiver object

0 commit comments

Comments
 (0)