Skip to content

Commit 0131624

Browse files
authored
fix: vale doc fixes (#523)
* vale doc fixes * vale doc fixes * vale doc fixes
1 parent 1800e79 commit 0131624

File tree

5 files changed

+28
-19
lines changed

5 files changed

+28
-19
lines changed

.styles/Vocab/Base/accept.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,17 @@ keystore
2222
keystores
2323
Xcode
2424
melos
25+
Melos
2526
env
2627
UIs
2728
const
2829
Geofencing
29-
mixin
30+
mixin
31+
permission_handler
32+
unmuting
33+
lecle_yoyo_player
34+
stream_video
35+
stream_video_push_notification
36+
screensharing
37+
Livestreaming
38+
livestreaming

docusaurus/docs/Flutter/02-tutorials/03-livestreaming.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ slug: /livestreaming
33
title: Livestreaming
44
---
55

6-
In this tutorial, we will cover the steps to quickly build a low-latency live-streaming experience in Flutter using Stream’s Video SDK. The livestream is broadcasted using Stream's edge network of servers around the world.
6+
In this tutorial, we will cover the steps to quickly build a low-latency live-streaming experience in Flutter using Stream’s Video SDK. The Livestream is broadcast using Stream's edge network of servers around the world.
77

88
For this tutorial, we will cover the following topics:
99

@@ -56,7 +56,7 @@ Future<void> main() async {
5656
```
5757

5858
### Setting up the UI
59-
To keep things simple, our sample application will only consist of two screens, a landing page to allow users the ability to create a livestream and another option to allow users the ability to join an existing livestream.
59+
To keep things simple, our sample application will only consist of two screens, a landing page to allow users the ability to create a Livestream and another option to allow users the ability to join an existing Livestream.
6060

6161
**Home page:**
6262
```dart
@@ -286,14 +286,14 @@ class LiveStreamScreen extends StatelessWidget {
286286
}
287287
```
288288

289-
### Viewing a livestream (Webrtc)
290-
Stream offers two flavors of livestreaming, WebRTC-based livestreaming and RTMP-based livestreaming.
289+
### Viewing a Livestream (WebRTC)
290+
Stream offers two flavors of Livestreaming, WebRTC-based livestreaming and RTMP-based livestreaming.
291291

292-
WebRTC based livestreaming allows users to easily start a livestream directly from their phone and benefit from ultra low latency.
292+
WebRTC based livestreaming allows users to easily start a Livestream directly from their phone and benefit from ultra low latency.
293293

294294
To setup WebRTC based livestreaming, we can first make a call using `makeCall` and set the call type to `livestream` followed by a room ID (this can also be left blank).
295295

296-
Next, we can set some default behaviour for our livestream such as configuring whether the camera and microphone should be enabled by default.
296+
Next, we can set some default behaviour for our Livestream such as configuring whether the camera and microphone should be enabled by default.
297297

298298
Finally, we can create the call by invoking `getOrCreate` on the object we just created. By default, a `livestream` call is started in backstage mode, meaning the call hosts can join and see each other but the call will be invisible to others.
299299

@@ -325,7 +325,7 @@ Future<void> _createLivestream() async {
325325
}
326326
```
327327

328-
To join the call, we can run another instance of the app on a second device and copy the call ID from the console. When the app is ready, we can click “Join a livestream” and paste in the ID we copied.
328+
To join the call, we can run another instance of the app on a second device and copy the call ID from the console. When the app is ready, we can click “Join a Livestream” and paste in the ID we copied.
329329

330330
If all works as intended, we will be able to view the video feed from the first device and observe the view count increase by one.
331331

@@ -341,13 +341,13 @@ By default, when a call is created, it is given a dedicated RTMP URL which can b
341341
1. The RTMP URL of the call
342342
2. A “streaming key” comprised of your application’s API Key and User Token in the format `apikey/usertoken`
343343

344-
With these two pieces of information, we can update the settings in OBS then select the “Start Streaming” option to view our livestream in the application!
344+
With these two pieces of information, we can update the settings in OBS then select the “Start Streaming” option to view our Livestream in the application.
345345

346346
:::note
347347
A user with the name and associated with the user token provided to OBS will appear in the call. It is worth creating a dedicated user object for OBS streaming.
348348
:::
349349

350-
### Viewing a livestream (HLS)
350+
### Viewing a Livestream (HLS)
351351
The final piece of livestreaming using Stream is support for HLS or HTTP Live Streaming. HLS unlike WebRTC based streaming tends to have a 10 to 20 second delay but offers video buffering under poor network condition.
352352

353353
To enable HLS support, your `call` must first be placed into “broadcasting” mode using the `call.startHLS()` method.
@@ -364,7 +364,7 @@ if (result.isSuccess) {
364364
}
365365
```
366366

367-
With the HLS URL, your call can be broadcasted to most livestreaming platforms such as Youtube.
367+
With the HLS URL, your call can be broadcast to most livestreaming platforms such as YouTube.
368368

369369
### Recap
370370
In just a few minutes, we were able to create our first livestreaming experience for our app. Please let us know if you ran into any issues during the process. Our team constantly reviews feedback and applies changes to improve the overall experience.

docusaurus/docs/Flutter/03-core-concepts/02-joining-and-creating-calls.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Although we are not passing any parameters to `getOrCreate` in the above example
2828
2. Ringing: If ringing is set to `true`, Stream will send a notification to the users on the call, triggering the platform call screen on iOS and Android.
2929

3030
:::note
31-
Depending on call permissions settings, call member may have different permissions than other users joining the call (i.e. call can be configured so only members can join). See [here](#Restricting-access)
31+
Depending on call permissions settings, call member may have different permissions than other users joining the call. For example, call can be configured so only members can join. See [here](#Restricting-access).
3232
:::
3333

3434
By default, calling `getOrCreate` assigns `admin` permission to each user who is supplied during creation.

docusaurus/docs/Flutter/05-advanced/02-ringing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Future<void> _handleRemoteMessage(RemoteMessage message) async {
141141
}
142142
```
143143

144-
The code upto this point handles calls for the background and foreground state of the app.
144+
The code until this point handles calls for the background and foreground state of the app.
145145
To handle calls from a terminated state, we need to add some additional code.
146146

147147
In a high-level widget, add this method and call it from the `initState()` method:

docusaurus/docs/Flutter/06-ui-cookbook/05-watching-a-livestream.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Watching a Livestream
22

3-
This sample walks you through building advanced UIs for watching a livestream on Flutter.
3+
This sample walks you through building advanced UIs for watching a Livestream on Flutter.
44

55
:::note
6-
In this cookbook tutorial, we will assume that you already know how to join a livestream call. If you haven't familiarized yourself with the **[Livestream Tutorial](https://getstream.io/video/docs/flutter/livestreaming/)** yet, we highly recommend doing so before proceeding with this cookbook.
6+
In this cookbook tutorial, we will assume that you already know how to join a Livestream call. If you haven't familiarized yourself with the **[Livestream Tutorial](https://getstream.io/video/docs/flutter/livestreaming/)** yet, we highly recommend doing so before proceeding with this cookbook.
77
::::
88

99
To view an HLS stream and benefit from the full experience of selecting different streaming qualities and performing different player actions like muting and unmuting the stream, we recommend using [lecle_yoyo_player](https://pub.dev/packages/lecle_yoyo_player).
1010

1111
When building for livestreaming, there are a few considerations you need to keep in mind for the UI:
1212

1313
- UI for when the video isn't loaded yet
14-
- A message to show when the livestream hasn't started yet
15-
- What to show when the livestream stopped
14+
- A message to show when the Livestream hasn't started yet
15+
- What to show when the Livestream stopped
1616
- How to indicate when there are connection problems
1717
- Number of participants
1818
- Duration of the call
1919

2020
## Setting up the UI
21-
To setup our UI for rendering a livestream, we can use Flutter’s built-in `StreamBuilder` widget for listening to changes in our call state and rendering different UIs based on the stage of our live stream:
21+
To setup our UI for rendering a Livestream, we can use Flutter’s built-in `StreamBuilder` widget for listening to changes in our call state and rendering different UIs based on the stage of our live stream:
2222

2323
```dart
2424
@override
@@ -55,7 +55,7 @@ To setup our UI for rendering a livestream, we can use Flutter’s built-in `Str
5555
By looking at different properties on our `CallState`, we can render different UIs and messages based on whether the call is live, backstage, or loading. A `Stack` also allows us to add different secondary live stream elements such as a view count above the main UI.
5656

5757
## Rendering the Livestream
58-
Before running the code below to see the livestream in action, we recommend going to our [Dashboard](https://dashboard.getstream.io/) and creating a livestream first since it can be done visually without having to create another instance of the application on the simulator.
58+
Before running the code below to see the Livestream in action, we recommend going to our [Dashboard](https://dashboard.getstream.io/) and creating a Livestream first since it can be done visually without having to create another instance of the application on the simulator.
5959

6060
Once a stream is started on the dashboard, the `Livestream ID` can be passed to the `id` parameter for the `Call` object in code.
6161

0 commit comments

Comments
 (0)