Skip to content

Commit d71a9a2

Browse files
committed
Doc improvements
1 parent 6626717 commit d71a9a2

File tree

3 files changed

+29
-32
lines changed

3 files changed

+29
-32
lines changed

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-call-android.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ ms.custom: include file
1212
ms.author: t-siddiquim
1313
---
1414

15-
## Sample App
15+
## Sample app
1616

1717

1818
To follow along with this quickstart, you can download the Room Call quickstart on [GitHub](https://github.com/Azure-Samples/communication-services-android-quickstarts/tree/main/RoomsCallQuickstart).
1919

2020

21-
## Setting up Project
21+
## Setting up project
2222

2323

2424
## Create an Android app with an empty activity
@@ -91,7 +91,7 @@ To request permissions required to make a call, you must first declare the permi
9191

9292
### Set up the layout for the app
9393

94-
You need a text input for the room Id, a button for placing the call, and extra button for hanging up the call.
94+
You need a text input for the room ID, a button for placing the call, and extra button for hanging up the call.
9595

9696
Go to `app/src/main/res/layout/activity_main.xml`, and replace the content of file with the following code:
9797

@@ -134,7 +134,7 @@ Go to `app/src/main/res/layout/activity_main.xml`, and replace the content of fi
134134
android:layout_width="match_parent"
135135
android:layout_height="wrap_content"
136136
android:ems="10"
137-
android:hint="Room Id"
137+
android:hint="Room ID"
138138
android:inputType="textPersonName"
139139
android:layout_marginTop="100dp"
140140
android:layout_marginHorizontal="20dp"
@@ -352,10 +352,10 @@ private val userToken = "<ACS_USER_TOKEN>"
352352
353353
Run the project on an emulator or a physical device.
354354
355-
You should see a field to enter your Room Id and a button to start the Room Call. Enter your Room Id and verify the Call status has changed along with your Role.
355+
You should see a field to enter your Room ID and a button to start the Room Call. Enter your Room ID and verify the Call status has changed along with your Role.
356356
357357
358-
## Understanding joining a Room Call
358+
## Understanding joining a Room call
359359
360360
All the code that you have added in your QuickStart app allowed you to successfully start and join a room call. We need to dive deep into how it all works and what more methods/handlers you can access for Rooms.
361361

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-call-ios.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ ms.author: t-siddiquim
1313
---
1414

1515

16-
## Join a room call
16+
## Join a Room call
1717

1818
To follow along with this quickstart, you can download the Room Call quickstart on [GitHub](https://github.com/Azure-Samples/communication-services-ios-quickstarts/tree/main/join-room-call).
1919

2020

2121
## Setting up
22-
### Creating the Xcode Project
22+
### Creating the Xcode project
2323
In Xcode, create a new iOS project and select the Single View App template. This tutorial uses the [SwiftUI framework](https://developer.apple.com/xcode/swiftui/), so you should set the Language to Swift and the User Interface to SwiftUI.
2424

2525
:::image type="content" source="../../voice-video-calling/media/ios/xcode-new-ios-project.png" alt-text="Screenshot showing the New Project window within Xcode.":::
2626

2727
### Installing CocoaPods
2828
Please use this guide to [install CocoaPods](https://guides.cocoapods.org/using/getting-started.html) on your Mac.
2929

30-
### Install the Package and Dependencies with CocoaPods
30+
### Install the package and dependencies with CocoaPods
3131
1. To create a Podfile for your application open the terminal and navigate to the project folder and run pod init.
3232

3333
2. Add the following code to the Podfile and save:
@@ -46,7 +46,7 @@ end
4646
4. Open the .xcworkspace with Xcode.
4747

4848

49-
### Request Access to the Microphone and Camera
49+
### Request access to the Microphone and Camera
5050
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.
5151

5252
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.
@@ -58,15 +58,15 @@ Right-click the `Info.plist` entry of the project tree and select Open As > Sour
5858
<string>Need camera access for video calling</string>
5959
```
6060

61-
### Set up the App framework
61+
### Set up the app framework
6262
Open your project's `ContentView.swift` file and add an import declaration to the top of the file to import the `AzureCommunicationCalling` library and `AVFoundation`. AVFoundation is used to capture audio permission from code.
6363

6464
```Swift
6565
import AzureCommunicationCalling
6666
import AVFoundation
6767
```
6868

69-
## Object Model
69+
## Object model
7070
The following classes and interfaces handle some of the major features of the Azure Communication Services Calling SDK for iOS.
7171

7272
| Name | Description |
@@ -214,7 +214,7 @@ do {
214214
}
215215
```
216216

217-
### Initialize the CallAgent and Access the Device Manager
217+
### Initialize the CallAgent and access the Device Manager
218218
To create a CallAgent instance from a CallClient, use the `callClient.createCallAgent` method that asynchronously returns a CallAgent object once it's initialized. DeviceManager lets you enumerate local devices that can be used in a call to transmit audio/video streams. It also allows you to request permission from a user to access microphone/camera.
219219

220220
```Swift
@@ -239,7 +239,7 @@ self.callClient?.createCallAgent(userCredential: userCredential!) { (agent, erro
239239
}
240240
```
241241

242-
### Ask for Permissions
242+
### Ask for permissions
243243
We need to add the following code to the `onAppear` callback to ask for permissions for audio and video.
244244

245245
```Swift
@@ -252,7 +252,7 @@ AVAudioSession.sharedInstance().requestRecordPermission { (granted) in
252252
}
253253
```
254254

255-
## Joining a Room Call
255+
## Joining a Room call
256256
The `joinRoomCall` method is set as the action that will be performed when the Join Room Call button is tapped. In this quickstart, calls are audio only by default but can have video enabled once a Room has been joined.
257257

258258
```Swift
@@ -300,7 +300,7 @@ func setCallAndObserver(call:Call!, error:Error?) {
300300
}
301301
```
302302

303-
## Leaving a Room Call
303+
## Leaving a Room call
304304
The `leaveRoomCall` method is set as the action that will be performed when the Leave Room Call button is tapped. It handles leaving a call and cleans up any resources that were created.
305305

306306
```swift
@@ -324,7 +324,7 @@ private func leaveRoomCall() {
324324
}
325325
```
326326

327-
## Broadcasting Video
327+
## Broadcasting video
328328
During a Room call we can use `startVideo` or `stopVideo` to start or stop sending `LocalVideoStream` to remote participants.
329329

330330
```Swift
@@ -361,7 +361,7 @@ func toggleLocalVideo() {
361361
}
362362
```
363363

364-
## Muting Local Audio
364+
## Muting local audio
365365
During a Room call we can use `mute` or `unMute` to mute or unmute our microphone.
366366

367367
```swift
@@ -382,7 +382,7 @@ func toggleMute() {
382382
}
383383
```
384384

385-
## Handling Call Updates
385+
## Handling call updates
386386
To deal with call updates, implement an `CallHandler` to handle update events. Put the following implementation in `CallHandler.swift`.
387387

388388
```Swift
@@ -408,7 +408,7 @@ final class CallHandler: NSObject, CallAgentDelegate {
408408
}
409409
```
410410

411-
We need to create a instance of `CallHandler` by adding the following code to the `onAppear` callback in `ContentView.swift`:
411+
We need to create an instance of `CallHandler` by adding the following code to the `onAppear` callback in `ContentView.swift`:
412412

413413
```Swift
414414
self.callHandler = CallHandler.getOrCreateInstance()
@@ -421,7 +421,7 @@ Set a delegate to the CallAgent after the CallAgent being successfully created:
421421
self.callAgent!.delegate = callHandler
422422
```
423423

424-
## Remote Participant Management
424+
## Remote participant management
425425
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.
426426

427427
```swift
@@ -556,7 +556,7 @@ class Utilities {
556556
```
557557

558558

559-
## Remote Participant Video Streams
559+
## Remote participant video streams
560560
We can create a `ParticipantView` to handle the rendering of video streams of remote participants. Put the implementation in `ParticipantView.swift`
561561

562562
```Swift
@@ -629,7 +629,7 @@ struct RenderInboundVideoView: UIViewRepresentable {
629629
}
630630
```
631631

632-
## Subscribe to Events
632+
## Subscribe to events
633633
We can implement a `CallObserver` class to subscribe to a collection of events to be notified when values, like `remoteParticipants`, change during the call.
634634

635635
```Swift
@@ -752,7 +752,7 @@ public class CallObserver : NSObject, CallDelegate
752752
}
753753
```
754754

755-
## Run the Code
755+
## Run the code
756756
You can build and run your app on iOS simulator by selecting Product > Run or by using the (⌘-R) keyboard shortcut.
757757

758758

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-call-web.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -393,19 +393,16 @@ Use the `webpack-dev-server` to build and run your app. Run the following comman
393393
npx webpack-dev-server --entry ./client.js --output bundle.js --debug --devtool inline-source-map
394394
```
395395

396-
Open your browser navigate to http://localhost:8080/.
397-
398-
On the first input field, enter a valid user access token.
399-
400-
Click on the "Initialize Call Agent" and enter your Room ID.
401-
402-
Click "Join Room Call"
396+
1. Open your browser navigate to http://localhost:8080/.
397+
2. On the first input field, enter a valid user access token.
398+
3. Click on the "Initialize Call Agent" and enter your Room ID.
399+
4. Click "Join Room Call"
403400

404401
You have now successfully joined a Rooms call!
405402

406403

407404

408-
## Understanding joining a Room Call
405+
## Understanding joining a Room call
409406

410407
All the code that you have added in your QuickStart app allowed you to successfully start and join a room call. Here is more information about what more methods/handlers you can access for Rooms to extend functionality in your application.
411408

0 commit comments

Comments
 (0)