Skip to content

Commit

Permalink
docs(concepts): added preset sample and auth token information
Browse files Browse the repository at this point in the history
  • Loading branch information
ravindra-dyte committed Mar 5, 2024
1 parent 5c91ad7 commit 7f919ab
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/guides/live-video/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ We highly recommend that you go through this page to understand the basics of Dy

### Organization

In Dyte, the organization serves as the top-level entity where all participants of your group are added. You can create an organization using the [API](/api#/operations/createOrg) or through the Developer Portal.
In Dyte, the organization serves as the top-level entity where all participants of your group are added. You can create an organization using the [API](/api#/operations/createOrg) or through the [Developer Portal](https://dev.dyte.io).

- Meetings are created within the organization.
- The API keys are generated for your organization. These API Keys are unique to your organization and are required to use Dyte REST APIs such as when instantiating a meeting.
- Additionally, Dyte considers the organization as a billing unit.

### Meeting

A communication channel created on Dyte is termed as a `meeting`. Meetings can be created using the [Create a meeting API](/api#/operations/create_meeting) or through the Developer Portal. Similarly, you can get the details of your meeting using the [API](/api#/operations/get_all_meetings) or developer portal.
A communication channel created on Dyte is termed as a `meeting`. Meetings can be created using the [Create a meeting API](/api#/operations/create_meeting) or through the [Developer Portal](https://dev.dyte.io/meetings). Similarly, you can get the details of your meeting using the [API](/api#/operations/get_all_meetings) or [Developer Portal](https://dev.dyte.io/meetings).

An example from the Developer Portal displaying meeting details.

Expand Down Expand Up @@ -50,10 +50,22 @@ An example from the Developer Portal displaying session details.

A preset is a set of permissions and UI configurations that are applied to participants for different meeting types such as Group Call, Webinar, and Livestream. The presets define how a meeting will appear visually and functional aspects of the meeting. They allow customization options like setting maximum number of participants on-screen, permissions to share screen, enabling poll creation, disabling video and audio, adjusting text color, configuring plugins, etc.

To create a preset, please refer to our Developer Portal's [Presets Section](https://dev.dyte.io/presets).

<img
src="/static/guides/preset-editor-sample.png"
width="600"
height="300"
alt="preset-editor"
className="preset-editor-preview"
/>

### Participant

Anyone who joins the `meeting`, including actual users and machine users. You can add participants using the [Add Participant API](/api#/operations/add_participant). Participants will have permissions for the meeting depending on the selected preset. The `presetName` must be passed in the body of the Add Participant API request.

The [Add Participant API](/api#/operations/add_participant) responds with a JWT authentication token for the participant. This token usually gets referred as "authToken" in this documentation. This "authToken" is required to initialize a Dyte meeting.

## Architecture

Now that you are familiar with the terminology of basic concepts on Dyte, we can take a look at how different offerings from Dyte come together. The key offerings are the REST API, core SDK , UIKit and a Developer Portal. Each of these serve different purposes and belong in different blocks of your application.
Expand All @@ -62,7 +74,7 @@ Let's dive deeper into what purpose each of these components server.

### Developer Portal

To begin with, let's start with our dashboard. This is where you will do a number of administrative tasks. This is your go-to-place for things like defining organisations, meeting logs, grabbing API Keys and billing operations.
To begin with, let's start with our [dashboard](https://dev.dyte.io/dashboard). This is where you will do a number of administrative tasks. This is your go-to-place for things like defining organisations, meeting logs, grabbing API Keys and billing operations.
You can also use Developer Portal to create meetings, presets, setup storage for recordings, add webhooks, and much more.

<img
Expand Down
Binary file added static/static/guides/preset-editor-sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7f919ab

Please sign in to comment.