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/quickstarts/rooms/includes/rooms-quickstart-az-cli.md
+11-13Lines changed: 11 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ az extension add --name communication
29
29
```
30
30
31
31
### Sign in to Azure CLI
32
-
You'll need to [sign in to Azure CLI](/cli/azure/authenticate-azure-cli). You can sign in running the ```az login``` command from the terminal and providing your credentials.
32
+
You need to [sign in to Azure CLI](/cli/azure/authenticate-azure-cli). You can sign in by running the ```az login``` command from the terminal and providing your credentials.
33
33
34
34
35
35
### Store your connection string in an environment variable
@@ -42,7 +42,7 @@ You can configure the `AZURE_COMMUNICATION_CONNECTION_STRING` environment variab
After you add the environment variable, you may need to restart any running programs that will need to read the environment variable, including the console window. For example, if you're using Visual Studio as your editor, restart Visual Studio before running the example.
45
+
After you add the environment variable, you might need to restart any running programs that need to read the environment variable, including the console window. For example, if you're using Visual Studio as your editor, restart Visual Studio before running the example.
46
46
47
47
##### [macOS](#tab/unix)
48
48
@@ -52,7 +52,7 @@ Edit your **`.zshrc`**, and add the environment variable:
After you add the environment variable, run `source ~/.zshrc` from your console window to make the changes effective. If you created the environment variable with your IDE open, you may need to close and reopen the editor, IDE, or shell in order to access the variable.
55
+
After you add the environment variable, run `source ~/.zshrc` from your console window to make the changes effective. If you created the environment variable with your IDE open, you might need to close and reopen the editor, IDE, or shell in order to access the variable.
56
56
57
57
##### [Linux](#tab/linux)
58
58
@@ -62,7 +62,7 @@ Edit your **`.bash_profile`**, and add the environment variable:
After you add the environment variable, run `source ~/.bash_profile` from your console window to make the changes effective. If you created the environment variable with your IDE open, you may need to close and reopen the editor, IDE, or shell in order to access the variable.
65
+
After you add the environment variable, run `source ~/.bash_profile` from your console window to make the changes effective. If you created the environment variable with your IDE open, you might need to close and reopen the editor, IDE, or shell in order to access the variable.
66
66
67
67
---
68
68
@@ -76,22 +76,20 @@ Use the `rooms create` command to create a room.
76
76
az communication rooms create --presenter-participants "<participantId>" --consumer-participants "<participantId>" --attendee-participant "<participantId>" --valid-from "<valid-from>" --valid-until "<valid-until>" --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --connection-string "<connection-string>"
77
77
```
78
78
79
-
- Use `<participantId>` optionally to specify the type of participant as presenter-participants, consumer-participants, or attendee-participants. If you do not specify a value, the default is empty.
79
+
- Use `<participantId>` optionally to specify the type of participant as presenter-participants, consumer-participants, or attendee-participants. If you don't specify a value, the default is empty.
80
80
- Replace `<connection-string>` with your Azure Communication Services connection string.
81
81
- Use `<valid-from>` optionally to specify the timestamp when the room is open for joining, in ISO8601 format, ex: 2022-07-14T10:21.
82
82
- Use `<valid-until>` optionally to specify the timestamp when the room can no longer be joined, in ISO8601 format, ex: 2022-07-14T10:21.
83
-
- Use `<pstn-dial-out-enabled>`* optionally by setting this flag ("True" or "False") to enable or disable PSTN dial out for a room. By default, this flag is set to "False" when creating a room.
84
-
85
-
*`<pstn-dial-out-enabled>` is currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
83
+
- Use `<pstn-dial-out-enabled>` optionally by setting this flag ("True" or "False") to enable or disable PSTN dial out for a room. By default, this flag is set to "False" when creating a room.
86
84
87
85
If you've stored the connection string in environment variables as stated above, you won't need to pass them to the command.
88
86
89
87
```azurecli-interactive
90
88
az communication rooms create
91
89
```
92
90
93
-
### Enable PSTN Dial Out Capability for a Room (Currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/))
94
-
The PSTN dial out can be enabled during `rooms create` by defining the `--pstn-dial-out-enabled` parameter as "True". This capability may also be modified during `rooms update` by specifying the `--pstn-dial-out-enabled` parameter.
91
+
### Enable PSTN dial out capability for a room
92
+
The PSTN dial out can be enabled during `rooms create` by defining the `--pstn-dial-out-enabled` parameter as "True". This capability can also be modified during `rooms update` by specifying the `--pstn-dial-out-enabled` parameter.
95
93
96
94
```azurecli-interactive
97
95
az communication rooms create --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --connection-string "<connection-string>"
@@ -101,7 +99,7 @@ az communication rooms create --pstn-dial-out-enabled "<pstn-dial-out-enabled>"
101
99
az communication rooms update --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --room "<roomId>"
102
100
```
103
101
104
-
-Use `<pstn-dial-out-enabled>`set this flag ("True" or "False") to enable or disable PSTN dial out for a room.
102
+
-To enable or disable PSTN dial out for a room, set `<pstn-dial-out-enabled>` flag ("True" or "False").
105
103
106
104
### Get the rooms
107
105
@@ -144,13 +142,13 @@ Use the `identity user create` command to create a new participant, identified b
144
142
az communication identity user create
145
143
```
146
144
147
-
Add a user as a participant to the room
145
+
Add a user as a participant to the room.
148
146
149
147
```azurecli-interactive
150
148
az communication rooms participant add-or-update --attendee-participant "<participantId>" --room "<roomId>"
151
149
```
152
150
153
-
- Replace `<participantId>` with your participant ID. If the `<participantId>`does not exist in the room, the participant will be added to the room as an attendee role. Otherwise, the participant's role is updated to an attendee role.
151
+
- Replace `<participantId>` with your participant ID. If the `<participantId>`doesn't exist in the room, the participant will be added to the room as an attendee role. Otherwise, the participant's role is updated to an attendee role.
Copy file name to clipboardExpand all lines: articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-call-ios.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,10 +25,10 @@ In Xcode, create a new iOS project and select the Single View App template. This
25
25
:::image type="content" source="../../voice-video-calling/media/ios/xcode-new-ios-project.png" alt-text="Screenshot showing the New Project window within Xcode.":::
26
26
27
27
### Installing CocoaPods
28
-
Please use this guide to [install CocoaPods](https://guides.cocoapods.org/using/getting-started.html) on your Mac.
28
+
Use this guide to [install CocoaPods](https://guides.cocoapods.org/using/getting-started.html) on your Mac.
29
29
30
30
### Install the package and dependencies with CocoaPods
31
-
1. To create a Podfile for your application open the terminal and navigate to the project folder and run pod init.
31
+
1. To create a Podfile for your application, open the terminal and navigate to the project folder and run pod init.
32
32
33
33
2. Add the following code to the Podfile and save:
34
34
@@ -43,11 +43,11 @@ end
43
43
44
44
3. Run pod install.
45
45
46
-
4. Open the .xcworkspace with Xcode.
46
+
4. Open the `.xcworkspace` file with Xcode.
47
47
48
48
49
-
### Request access to the Microphone and Camera
50
-
To access the device's microphone and camera, you need to update your app's Information Property List with an `NSMicrophoneUsageDescription` and `NSCameraUsageDescription`. You set the associated value to a string that will be included in the dialog the system uses to request access from the user.
49
+
### Request access to the microphone and camera
50
+
To access the device's microphone and camera, you need to update your app's Information Property List with `NSMicrophoneUsageDescription` and `NSCameraUsageDescription`. Set the associated value to a string that will be included in the dialog the system uses to request access from the user.
51
51
52
52
Right-click the `Info.plist` entry of the project tree and select Open As > Source Code. Add the following lines the top level `<dict>` section, and then save the file.
53
53
@@ -74,11 +74,11 @@ The following classes and interfaces handle some of the major features of the Az
74
74
| CallClient | The CallClient is the main entry point to the Calling SDK. |
75
75
| CallAgent | The CallAgent is used to start and manage calls. |
76
76
| CommunicationTokenCredential | The CommunicationTokenCredential is used as the token credential to instantiate the CallAgent. |
77
-
| CommunicationIdentifier | The CommunicationIdentifier is used to represent the identity of the user which can be one of the following: CommunicationUserIdentifier/PhoneNumberIdentifier/CallingApplication. |
77
+
| CommunicationIdentifier | The CommunicationIdentifier is used to represent the identity of the user, and can have one of the following values: CommunicationUserIdentifier/PhoneNumberIdentifier/CallingApplication. |
78
78
| RoomCallLocator | The RoomCallLocator is used by CallAgent to join a Room call|
79
79
80
80
## Create the Call Agent
81
-
Replace the implementation of the ContentView struct with some simple UI controls that enable a user to initiate and end a call. We will attach business logic to these controls in this quickstart.
81
+
Replace the implementation of the ContentView struct with some simple UI controls that enable a user to initiate and end a call. We'll attach business logic to these controls in this quickstart.
In order to initialize a CallAgent instance we need a User Access Token which will enable us to join Room calls.
202
+
### Authenticate the client
203
+
In order to initialize a CallAgent instance, we need a User Access Token which will enable us to join Room calls.
204
204
205
-
Once you have a token, Add the following code to the `onAppear` callback in `ContentView.swift`. You will need to replace `<USER ACCESS TOKEN>` with a valid user access token for your resource:
205
+
Once you have a token, add the following code to the `onAppear` callback in `ContentView.swift`. You need to replace `<USER ACCESS TOKEN>` with a valid user access token for your resource:
All remote participants are represented by the `RemoteParticipant` type and are available through the `remoteParticipants` collection on a call instance. We can implement a `Participant` class to manage the updates on remote video streams of remote participants amongst other things.
425
+
All remote participants are represented by the `RemoteParticipant` type and are available through the `remoteParticipants` collection on a call instance. We can implement a `Participant` class to manage the updates on remote video streams of remote participants among other things.
Copy file name to clipboardExpand all lines: articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-java.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,15 +27,15 @@ You can review and download the sample code for this quick start on [GitHub](htt
27
27
28
28
### Create a new Java application
29
29
30
-
In a console window (such as cmd, PowerShell, or Bash), use the `mvn` command below to create a new console app with the name `rooms-quickstart`. This command creates a simple "Hello World" Java project with a single source file: **App.java**.
30
+
In a console window (such as cmd, PowerShell, or Bash), use the `mvn` command to create a new console app with the name `rooms-quickstart`. This command creates a simple "Hello World" Java project with a single source file: **App.java**.
You'll need to use the Azure Communication Rooms client library for Java [version 1.0.0](https://search.maven.org/artifact/com.azure/azure-communication-rooms/1.0.0/jar) or above.
38
+
You need to use the Azure Communication Rooms client library for Java [version 1.1.0](https://search.maven.org/artifact/com.azure/azure-communication-rooms/1.1.0/jar) or above.
39
39
40
40
#### Include the BOM file
41
41
@@ -123,7 +123,7 @@ RoomsClient roomsClient = new RoomsClientBuilder().connectionString(connectionSt
123
123
## Create a room
124
124
125
125
### Set up room participants
126
-
In order to set up who can join a room, you'll need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-java) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
126
+
In order to set up who can join a room, you need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-java) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
127
127
128
128
To use `CommunicationIdentityClient`, add the following package:
129
129
@@ -184,11 +184,9 @@ System.out.println("\nCreated a room with id: " + roomCreated.getRoomId());
184
184
185
185
```
186
186
187
-
*setPstnDialOutEnabled is currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
188
-
189
187
Since `rooms` are server-side entities, you may want to keep track of and persist the `roomId` in the storage medium of choice. You can reference the `roomId` to view or update the properties of a `room` object.
190
188
191
-
### Enable PSTN Dial Out Capability for a Room (Currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/))
189
+
### Enable PSTN dial out capability for a room
192
190
Each `room` has PSTN dial out disabled by default. The PSTN dial out can be enabled for a `room` at creation, by defining the `pstnDialOutEnabled` parameter as true. This capability may also be modified for a `room` by issuing an update request for the `pstnDialOutEnabled` parameter.
Copy file name to clipboardExpand all lines: articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-javascript.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ Create a new file `index.js` where the code for this quickstart will be added.
42
42
43
43
### Install the packages
44
44
45
-
You'll need to use the Azure Communication Rooms client library for JavaScript [version 1.0.0](https://www.npmjs.com/package/@azure/communication-rooms) or above.
45
+
You need to use the Azure Communication Rooms client library for JavaScript [version 1.1.0](https://www.npmjs.com/package/@azure/communication-rooms) or above.
46
46
47
47
Use the `npm install` command to install the below Communication Services SDKs for JavaScript.
@@ -89,7 +89,7 @@ const roomsClient = new RoomsClient(connectionString);
89
89
90
90
### Set up room participants
91
91
92
-
In order to set up who can join a room, you'll need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-javascript) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
92
+
In order to set up who can join a room, you need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-javascript) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
93
93
94
94
To use the CommunicationIdentityClient, install the following npm package:
console.log("\nCreated a room with id: ", roomId);
149
149
```
150
-
*pstnDialOutEnabled is currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
151
150
152
151
Since `rooms` are server-side entities, you may want to keep track of and persist the `roomId` in the storage medium of choice. You can reference the `roomId` to view or update the properties of a `room` object.
153
152
154
-
### Enable PSTN Dial Out Capability for a Room (Currently in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/))
153
+
### Enable PSTN dial out capability for a room
155
154
Each `room` has PSTN dial out disabled by default. The PSTN dial out can be enabled for a `room` at creation, by defining the `pstnDialOutEnabled` parameter as true. This capability may also be modified for a `room` by issuing an update request for the `pstnDialOutEnabled` parameter.
0 commit comments