Skip to content

Commit

Permalink
spell check
Browse files Browse the repository at this point in the history
  • Loading branch information
@szuperaz
szuperaz committed Oct 27, 2023
1 parent eaf7e28 commit 59831c4
Show file tree
Hide file tree
Showing 9 changed files with 96 additions and 97 deletions.
16 changes: 8 additions & 8 deletions docusaurus/video/docusaurus/docs/api/basics/authentication.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';

## Creating users

Stream Users require only an id to be created. Users can be created with role of user or admin. The role will be set to user if a value is not provided in the request. There are additional properties you can provide to further describe your users.
Stream Users require only an ID to be created. Users can be created with the role of user or admin. The role will be set to user if a value is not provided in the request. There are additional properties you can provide to further describe your users.

The `name` and `image` fields are special fields that are supported by client-side SDKs.

Expand Down Expand Up @@ -55,7 +55,7 @@ client.upsert_users(users=users)
There are two ways to update user objects:

- Updating will replace the existing user object
- Partial update will let you choose which fields you want to chage/unset
- Partial update will let you choose which fields you want to change/unset

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand Down Expand Up @@ -99,7 +99,7 @@ Anonymous users are users that are not authenticated. It's common to use this fo

## Guest users

Guest users are temporary user accounts. You can use it to temporarily give someone a name and image when joining a call. Guest users can aslso be created cliend-side.
Guest users are temporary user accounts. You can use it to temporarily give someone a name and image when joining a call. Guest users can aslso be created client-side.

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand All @@ -123,7 +123,7 @@ const guest = (await client.createGuest({ user: guest })).user;

While it is usually safer for data retention to deactivate a user, some use cases require completely deleting a user and their data.

Once a user has been deleted, it cannot be un-deleted and the user_id cannot be used again.
Once a user has been deleted, it cannot be un-deleted, and the user_id cannot be used again.

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand All @@ -141,12 +141,12 @@ client.deleteUser({ userId: '<id>' });

## User tokens

Stream uses JWT (JSON Web Tokens) to authenticate chat users, enabling them to login. Knowing whether a user is authorized to perform certain actions is managed separately via a role based permissions system. Tokens need to be generated server-side.
Stream uses JWT (JSON Web Tokens) to authenticate chat users, enabling them to log in. Knowing whether a user is authorized to perform certain actions is managed separately via a role-based permissions system. Tokens need to be generated server-side.

You can optionally provide

- Expiration time. By default tokens don't have an expiration date.
- Issued at date which is necessary if you manually wan to revoke tokens. By default the issued at date is set to the current date.
- Issued at date, which is necessary if you manually want to revoke tokens. By default, the issued at date is set to the current date.

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand Down Expand Up @@ -221,5 +221,5 @@ client.create_token(user_id=user_id, exp, iat, call_cids)

## Provisioning token in production

Your authentication service is responsible for generating token for your users. It is highly recommended to always create tokens with an expiration.
All SDK make it easy to automatically re-fetch tokens from your backend servers with token providers when they expire.
Your authentication service is responsible for generating tokens for your users. It is highly recommended to always create tokens with an expiration.
All SDKs make it easy to automatically re-fetch tokens from your backend servers with token providers when they expire.
10 changes: 5 additions & 5 deletions docusaurus/video/docusaurus/docs/api/basics/calls.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';

You can create a call by providing the call type and an ID:

- The [call type](call_types/builtin) controls which features are enabled, and sets up permissions.
- The [call type](call_types/builtin) controls which features are enabled and sets up permissions.
- Calls IDs can be reused, which means they can be joined multiple times, so it's possible to set up recurring calls.

You can optionally restrict call access by providing a list of users.
Expand Down Expand Up @@ -145,7 +145,7 @@ curl -X PUT "https://video.stream-io-api.com/video/call/default/${CALL_ID}?api_k

## Manage call members

Call members can be added and removed as necessary. Their role's can also be changed.
Call members can be added and removed as necessary. Their roles can also be changed.

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand Down Expand Up @@ -210,7 +210,7 @@ For many video calling, live stream, or audio rooms apps, you'll want to show:
- Calls that are currently live
- Popular live streams / audio rooms with a link to the recording

Below you can find a few examples of different quieries:
Below you can find a few examples of different queries:

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand Down Expand Up @@ -268,7 +268,7 @@ client.query_calls(
</TabItem>
</Tabs>

Filter expressions support multiple match criteria and it's also possible to combine filters. For more information visit the [filter operators](https://getstream.io/chat/docs/node/query_syntax_operators/?language=javascript) guide.
Filter expressions support multiple match criteria, and it's also possible to combine filters. For more information, visit the [filter operators](https://getstream.io/chat/docs/node/query_syntax_operators/?language=javascript) guide.

## Query call members

Expand Down Expand Up @@ -328,4 +328,4 @@ call.query_members(
</TabItem>
</Tabs>

Filter expressions support multiple match criteria and it's also possible to combine filters. For more information visit the [filter operators](https://getstream.io/chat/docs/node/query_syntax_operators/?language=javascript) guide.
Filter expressions support multiple match criteria, and it's also possible to combine filters. For more information, visit the [filter operators](https://getstream.io/chat/docs/node/query_syntax_operators/?language=javascript) guide.
18 changes: 9 additions & 9 deletions docusaurus/video/docusaurus/docs/api/basics/get_started.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import RTMP from '../_common_/rtmp.mdx';

For the average Stream integration, the development work focuses on code that executes in the client. However, some tasks must be executed from the server for safety (for example token generation).
For the average Stream integration, the development work focuses on code that executes in the client. However, some tasks must be executed from the server for safety (for example, token generation).

Stream provides server-side SDKs to help executing these tasks.
Stream provides server-side SDKs to help execute these tasks.

You can reference our [development roadmap](https://github.com/GetStream/protocol/discussions/177) to know which languages and features are supported.

## Installation

All official SDK are available on package managers, full source code is available on the GetStream Github organization.
All official SDKs are available on package managers, full source code is available on the GetStream Github organization.

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand All @@ -40,7 +40,7 @@ pip install getstream

## Creating client

To create a server-side client you'll need your **API key** and **secret**, both of them can be found in your [Stream Dashboard](https://dashboard.getstream.io/).
To create a server-side client, you'll need your **API key** and **secret**. Both of them can be found in your [Stream Dashboard](https://dashboard.getstream.io/).

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand All @@ -65,7 +65,7 @@ client = Stream(api_key="your_api_key", api_secret="your_api_secret")

## Creating user tokens

Tokens need to be generated server-side. Typically you integrate this into the part of your codebase where you login or register users. The tokens provide a way to authenticate a user or give access to a specific set of video/audio calls.
Tokens need to be generated server-side. Typically, you integrate this into the part of your codebase where you log in or register users. The tokens provide a way to authenticate a user or give access to a specific set of video/audio calls.

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand Down Expand Up @@ -94,7 +94,7 @@ token = client.create_token("admin-user")

You can create a call by providing the call type and an ID:

- The [call type](call_types/builtin) controls which features are enabled, and sets up permissions.
- The [call type](call_types/builtin) controls which features are enabled and sets up permissions.
- Calls IDs can be reused, which means they can be joined multiple times, so it's possible to set up recurring calls.

You can optionally restrict call access by providing a list of users.
Expand Down Expand Up @@ -192,7 +192,7 @@ curl -X PUT "https://video.stream-io-api.com/video/call/default/${CALL_ID}/membe

## Updating a call

- Most of the call type settings can be overriden on a call level.
- Most of the call type settings can be overridden on a call level.

- Custom data can also be stored for calls.

Expand Down Expand Up @@ -293,7 +293,7 @@ curl -X POST "https://video.stream-io-api.com/video/call/default/${CALL_ID}/star
</TabItem>
</Tabs>

Almost all livestream software and hardware supports RTMPS. Our API supports using a third-party software for streaming using RTMPS. For more information reference the [Streaming section](streaming/overview/).
Almost all livestream software and hardware supports RTMPS. Our API supports using third-party software for streaming using RTMPS. For more information, reference the [Streaming section](streaming/overview/).

The following example shows how to get the RTMP address that you need to provide for the third-party software:

Expand All @@ -303,7 +303,7 @@ The following example shows how to get the RTMP address that you need to provide

Calls can be recorded for later use. Calls recording can be started/stopped via API calls or configured to start automatically when the first user joins the call.

For more information see the [Recordings section](recording/calls/).
For more information, see the [Recordings section](recording/calls/).

The following example shows how to start and stop recording:

Expand Down
27 changes: 13 additions & 14 deletions docusaurus/video/docusaurus/docs/api/call_types/geofencing.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,20 @@ title: Geofencing
---

With geofencing, you can define which edge nodes are utilized for video calls within specific geo-fenced areas.
You can set geo-fences to a call type or specify when creating a new call. Multiple geo-fences can be used at the same time.
You can set geofences to a call type or specify when creating a new call. Multiple geo-fences can be used at the same time.

At this present, you can only select from a predefined list of geofences:

At this present you can only select from a predefined list of geo-fences:

| Name | Description |
|-------------------|-----------------------------------------------------------------------------------------------------------------|
| european_union | The list of countries that are part of european union |
| united_states | Only selects edges in US |
| canada | Only selects edges in Canada |
| united_kingdom | Only selects edges in the United Kingdom |
| india | Only selects edges in India |
| china_exclusion | Excludes edges running in mainland China (currently Stream edge infrastructure does not have any edge in China) |
| russia_exclusion | Excludes edges running in Russia |
| belarus_exclusion | Excludes edges running in Belarus |
| Name | Description |
| ----------------- | ---------------------------------------------------------------------------------------------------------------- |
| european_union | The list of countries that are part of european union |
| united_states | Only selects edges in US |
| canada | Only selects edges in Canada |
| united_kingdom | Only selects edges in the United Kingdom |
| india | Only selects edges in India |
| china_exclusion | Excludes edges running in mainland China (currently, Stream edge infrastructure does not have any edge in China) |
| russia_exclusion | Excludes edges running in Russia |
| belarus_exclusion | Excludes edges running in Belarus |

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down Expand Up @@ -52,4 +51,4 @@ call.create({
```

</TabItem>
</Tabs>
</Tabs>
10 changes: 5 additions & 5 deletions docusaurus/video/docusaurus/docs/api/call_types/permissions.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ import TabItem from '@theme/TabItem';

This page shows how you can create or update roles for a call type.

Stream has a role-based permission system. Each user has an application level role, and also channel (chat product) and call (video product) level roles. Every role (be it application or call/channel level) contains a list of capabilities. A capability is an action (for example create call). The list of capabilities assigned to a role defines what a user is allowed to do. Call roles are defined on the call type level.
Stream has a role-based permission system. Each user has an application-level role, and also channel (chat product) and call (video product) level roles. Every role (be it application or call/channel level) contains a list of capabilities. A capability is an action (for example, create a call). The list of capabilities assigned to a role defines what a user is allowed to do. Call roles are defined on the call type level.

## Configuring roles

When you create a call type you can specify your role configurations. A role configuration consists of a role name and the list of capabilities that are enabled for that role.
When you create a call type, you can specify your role configurations. A role configuration consists of a role name and the list of capabilities that are enabled for that role.

When you create a call type it comes with a default set of configuration. You can override or extend that.
When you create a call type, it comes with a default set of configurations. You can override or extend that.

The following example overrides the capabilities of the built-in `admin` role, and defines the `customrole`.
The following example overrides the capabilities of the built-in `admin` role and defines the `customrole`.

Please note that for the below code to work you need to create the `customrole` beforehand, you can do that in your [Stream Dashboard](https://dashboard.getstream.io/).
Please note that for the below code to work, you need to create the `customrole` beforehand. You can do that in your [Stream Dashboard](https://dashboard.getstream.io/).

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/video/docusaurus/docs/api/call_types/settings.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Stream API provides multiple configuration options on the call type level.
<CallTypeSettings />

- You can provide the settings when creating or updating a call type
- For maximum flexiblity you can ovverride the settings on the call-level when creating or updating a call
- For maximum flexibility, you can override the settings on the call level when creating or updating a call

## Code examples

Expand Down
Loading

0 comments on commit 59831c4

Please sign in to comment.