Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: links & broken images #235

Merged
merged 2 commits into from
Jan 6, 2024
Merged

docs: links & broken images #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2528143
docs: links & broken images
vaibhavshn Jan 6, 2024
b2b579e
fix: incorrect redirect
vaibhavshn Jan 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/android-core/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ You’ll learn how to:
## Before Getting Started

Make sure you've read the
[Getting Started with Dyte](https://docs.dyte.io/getting-started) topic and
[Getting Started with Dyte](/getting-started) topic and
completed the steps in the
[Integrate Dyte](https://docs.dyte.io/getting-started#integrate-dyte) section.
[Integrate Dyte](/getting-started#integrate-dyte) section.
You must complete the following steps:

- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](https://docs.dyte.io/api/?v=v2#/operations/create_meeting)
- [Add Participant](https://docs.dyte.io/api/?v=v2#/operations/add_participant)
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
to the meeting
- Install [Android Studio](https://developer.android.com/studio)

Expand Down Expand Up @@ -84,9 +84,9 @@ val dyteClient = DyteAndroidClientBuilder.build(activity)
Set the properties in the `DyteMeetingInfoV2` class. You just need to provide the
participant's `authToken`.

| Name | Description |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| `authToken` | After you've created the meeting, add each participant to the meeting using the [Add Participant API](https://docs.dyte.io/api?v=v2#/operations/add_participant) (The presetName created earlier must be passed in the body of the Add Participant API request) The API response contains the `authToken`. | |
| Name | Description |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| `authToken` | After you've created the meeting, add each participant to the meeting using the [Add Participant API](/api?v=v2#/operations/add_participant) (The presetName created earlier must be passed in the body of the Add Participant API request) The API response contains the `authToken`. | |

```kotlin
val meetingInfo = DyteMeetingInfoV2(
Expand Down
14 changes: 7 additions & 7 deletions docs/android/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@ You’ll learn how to:
## Before Getting Started

Make sure you've read the
[Getting Started with Dyte](https://docs.dyte.io/getting-started) topic and
[Getting Started with Dyte](/getting-started) topic and
completed the steps in the
[Integrate Dyte](https://docs.dyte.io/getting-started#integrate-dyte) section.
[Integrate Dyte](/getting-started#integrate-dyte) section.
You must complete the following steps:

- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](https://docs.dyte.io/api/?v=v2#/operations/create_meeting)
- [Add Participant](https://docs.dyte.io/api/?v=v2#/operations/add_participant)
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
to the meeting
- Install [Android Studio](https://developer.android.com/studio)

Expand Down Expand Up @@ -70,9 +70,9 @@ builds, refer to the [Release Builds](#release-builds) section.
Set the properties in the `DyteMeetingInfoV2` class. You just need to provide
the participant's `authToken`.

| Name | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | After you've created the meeting, <br/> add each participant to the meeting <br/> using the [Add Participant API](https://docs.dyte.io/api?v=v2#/operations/add_participant)<br/> (The presetName created earlier <br/> must be passed in the body <br/> of the Add Participant API request) <br/> The API response contains the `authToken`. |
| Name | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | After you've created the meeting, <br/> add each participant to the meeting <br/> using the [Add Participant API](/api?v=v2#/operations/add_participant)<br/> (The presetName created earlier <br/> must be passed in the body <br/> of the Add Participant API request) <br/> The API response contains the `authToken`. |

```kotlin
val meetingInfo = DyteMeetingInfoV2(
Expand Down
14 changes: 7 additions & 7 deletions docs/flutter-core/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ You’ll learn how to:
## Before Getting Started

- Make sure you've read the
[Getting Started with Dyte](https://docs.dyte.io/getting-started) topic and
[Getting Started with Dyte](/getting-started) topic and
completed the steps in the
[Integrate Dyte](https://docs.dyte.io/getting-started#integrate-dyte) section.
[Integrate Dyte](/getting-started#integrate-dyte) section.
You must complete the following steps:
- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](https://docs.dyte.io/api/?v=v2#/operations/create_meeting)
- [Add Participant](https://docs.dyte.io/api/?v=v2#/operations/add_participant)
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
to the meeting
- Install Flutter on your system
- (For iOS apps) Install
Expand Down Expand Up @@ -136,9 +136,9 @@ final dyteClient = DyteMobileClient();
Set the properties in the `DyteMeetingInfo` class. You just need to provide the
participant's `authToken`.

| Name | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | After you've created the meeting, <br/> add each participant to the meeting <br/> using the [Add Participant API](https://docs.dyte.io/api?v=v2#/operations/add_participant)<br/> (The presetName created earlier <br/> must be passed in the body <br/> of the Add Participant API request) <br/> The API response contains the `authToken`. |
| Name | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | After you've created the meeting, <br/> add each participant to the meeting <br/> using the [Add Participant API](/api?v=v2#/operations/add_participant)<br/> (The presetName created earlier <br/> must be passed in the body <br/> of the Add Participant API request) <br/> The API response contains the `authToken`. |

```dart
final meetingInfo = DyteMeetingInfoV2(
Expand Down
12 changes: 6 additions & 6 deletions docs/flutter/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ You’ll learn how to:
## Before Getting Started

Make sure you've read the
[Getting Started with Dyte](https://docs.dyte.io/getting-started) topic and
[Getting Started with Dyte](/getting-started) topic and
completed the steps in the
[Integrate Dyte](https://docs.dyte.io/getting-started#integrate-dyte) section.
[Integrate Dyte](/getting-started#integrate-dyte) section.
You must complete the following steps:

- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](https://docs.dyte.io/api/?v=v2#/operations/create_meeting)
- [Add Participant](https://docs.dyte.io/api/?v=v2#/operations/add_participant)
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
to the meeting

## Step 1: Install the SDK
Expand Down Expand Up @@ -89,7 +89,7 @@ platform :ios, '13.0'

## Step 3: Configure a Dyte meeting

To initiate Dyte Meeting for any participant you just need to pass `authToken` as an argument. You can get the `authToken` via the [Add Participant API](https://docs.dyte.io/api?v=v2#/operations/add_participant).
To initiate Dyte Meeting for any participant you just need to pass `authToken` as an argument. You can get the `authToken` via the [Add Participant API](/api?v=v2#/operations/add_participant).

After getting the `authToken`, you need to create the `DyteMeetingInfoV2` object as follows:

Expand All @@ -102,7 +102,6 @@ final meetingInfo = DyteMeetingInfoV2(authToken: '<auth_token>');
The `DyteUIKit` is the main class of the SDK. It is the entry point and the only
class required to initialize Dyte UI Kit SDK. To initialize it we have to pass `DyteUIKitInfo` object as an argument.


```dart

/* Passing the DyteMeetingInfoV2 object `meetingInfo` you created in the Step 3,
Expand All @@ -124,6 +123,7 @@ final uikitInfo = DyteUIKitInfo(
final uiKit = DyteUIKitBuilder.build(uiKitInfo: uikitInfo);

```

You can learn more about customization of the uikit in the [Design System](/flutter/design-token) section.

## Step 5: Launch the meeting UI
Expand Down
19 changes: 8 additions & 11 deletions docs/guides/capabilities/ai/meeting-transcription.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,12 @@ Dyte's AI meeting transcription currently only supports English.
You can control whether or not a participant's audio will be transcribe with the help of the `transcription_enabled` flag in the participant's preset.
All participants with the `transcription_enabled` turned on in their preset will be able to generate transcripts in real-time in a Dyte meeting.

You can create a new preset on our [Developer Portal](https://dev.dyte.io/presets), or using our [REST API](https://docs.dyte.io/api#/operations/post-presets).

:::info NOTE
To learn more about how to create and edit presets, see [Presets](https://docs.dyte.io/guides/capabilities/presets).
:::
You can create a new preset on our [Developer Portal](https://dev.dyte.io/presets), or using our [REST API](/api#/operations/post-presets).

## Consuming transcripts

There are 3 ways in which these transcripts can be consumed.

1. Client core SDK: The transcripts can be consumed on the client-side using the Dyte SDK that's suitable for your platform. These transcripts are generated on the server in real-time.
2. Webhooks: The meeting transcript can be consumed via a [webhook after the meeting ends](#consume-transcript-via-a-post-meeting-webhook).
3. REST API: The meeting transcript can also be fetched via the [rest API](/api#/operations/GetSessionTranscript).
Expand All @@ -55,7 +52,7 @@ meeting.ai.on('transcript', (transcriptData) => {
### Consume transcript via a post-meeting webhook

You can configure a webhook with the `meeting.transcript` event enabled to receive the meeting transcript after the meeting has ended.
You can do this either on our [Developer Portal](https://dev.dyte.io/webhooks), or using a [REST API](https://docs.dyte.io/api#/operations/addWebhook).
You can do this either on our [Developer Portal](https://dev.dyte.io/webhooks), or using a [REST API](/api#/operations/addWebhook).

You can see the webhook format [here](/guides/capabilities/webhooks/webhook-events#meetingtranscript).

Expand All @@ -71,10 +68,11 @@ Timestamp, Participant ID, User ID, Custom Participant ID, Participant Name, Tra
```

The following is a description of all the fields specified in the above CSV.

1. Timestamp: An ISO 8601 format string indicating the time of utterance (or the time of speech).
2. Participant ID: An identifier for individual peers in the meeting. For instance, if the participant joins the meeting twice, both the "peers" will have the same User ID but different Participant IDs.
3. User ID: An identifier for a participant in the meeting, as returned by the [add participant API call](https://docs.dyte.io/api#/operations/add_participant#response-body).
4. Custom Participant ID: An identifier that you can specify to identify a user. This can be sent in the request body of the [add participant API call](https://docs.dyte.io/api#/operations/add_participant#request-body).
3. User ID: An identifier for a participant in the meeting, as returned by the [add participant API call](/api#/operations/add_participant#response-body).
4. Custom Participant ID: An identifier that you can specify to identify a user. This can be sent in the request body of the [add participant API call](/api#/operations/add_participant#request-body).
5. Participant Name: The display name of the user.
6. Transcript: The transcribed utterance.

Expand All @@ -83,8 +81,7 @@ The following is a description of all the fields specified in the above CSV.
Once you have configured a preset and a webhook according to the instructions above, you can proceed to test whether meeting transcription is working for your organization.
To test if meeting transcription has been configured for your organization, perform the following steps.

1. [Create a meeting](https://docs.dyte.io/api#/operations/create_meeting).
2. [Add a participant](https://docs.dyte.io/api#/operations/add_participant) to the meeting. Make sure that the preset you use was configured according to this guide.
1. [Create a meeting](/api#/operations/create_meeting).
2. [Add a participant](/api#/operations/add_participant) to the meeting. Make sure that the preset you use was configured according to this guide.
3. Join the meeting with the `authToken` you just obtained. As you unmute and speak, your speech should be getting transcribed in real-time for all the participants in the meeting.
4. Once the meeting ends, you will be getting a webhook with the event `meeting.transcript`. The body of this webhook will consist of the entire meeting transcript.

Loading