diff --git a/docs/android-core/quickstart.mdx b/docs/android-core/quickstart.mdx index b5401748aa..2a4a3a5881 100644 --- a/docs/android-core/quickstart.mdx +++ b/docs/android-core/quickstart.mdx @@ -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) @@ -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( diff --git a/docs/android/quickstart.mdx b/docs/android/quickstart.mdx index e5bee65af8..886423fe75 100644 --- a/docs/android/quickstart.mdx +++ b/docs/android/quickstart.mdx @@ -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) @@ -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,
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( diff --git a/docs/flutter-core/quickstart.mdx b/docs/flutter-core/quickstart.mdx index 026f2baa60..057828c254 100644 --- a/docs/flutter-core/quickstart.mdx +++ b/docs/flutter-core/quickstart.mdx @@ -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 @@ -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,
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`. | ```dart final meetingInfo = DyteMeetingInfoV2( diff --git a/docs/flutter/quickstart.mdx b/docs/flutter/quickstart.mdx index 41f867161e..e681fba950 100644 --- a/docs/flutter/quickstart.mdx +++ b/docs/flutter/quickstart.mdx @@ -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 @@ -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: @@ -102,7 +102,6 @@ final meetingInfo = DyteMeetingInfoV2(authToken: ''); 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, @@ -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 diff --git a/docs/guides/capabilities/ai/meeting-transcription.mdx b/docs/guides/capabilities/ai/meeting-transcription.mdx index 376e3f981f..c551f6ae38 100644 --- a/docs/guides/capabilities/ai/meeting-transcription.mdx +++ b/docs/guides/capabilities/ai/meeting-transcription.mdx @@ -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). @@ -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). @@ -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. @@ -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. - diff --git a/docs/guides/capabilities/audio/transcriptions.mdx b/docs/guides/capabilities/audio/transcriptions.mdx index c4a300c491..33082a69b7 100644 --- a/docs/guides/capabilities/audio/transcriptions.mdx +++ b/docs/guides/capabilities/audio/transcriptions.mdx @@ -22,15 +22,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). @@ -57,7 +54,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). @@ -73,10 +70,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. @@ -85,8 +83,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. - diff --git a/docs/guides/capabilities/misc/embed.mdx b/docs/guides/capabilities/misc/embed.mdx index e99fe9b743..0cf591d5ce 100644 --- a/docs/guides/capabilities/misc/embed.mdx +++ b/docs/guides/capabilities/misc/embed.mdx @@ -15,8 +15,8 @@ You simply need to add a small piece of HTML code to your website or application - 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 ## Embed using an iFrame @@ -32,11 +32,11 @@ Pass your options with meeting ID auth token in the URL query. Here's an example ### Query Parameters -| Name | Required | Description | -| :--------------- | :--------- | :------------------------------------------------------------------------------------------------------------------------ | --- | -| `authToken` | `required` | The `token` string you receive when you [add a Participant](/api/#/operations/add_participant) to a meeting. | -| `meetingID` | `required` | The ID of the meeting you receive when you [create a meeting](https://docs.dyte.io/api/?v=v2#/operations/create_meeting). | -| `endRedirectURL` | `optional` | The URL to which the meeting would be redirected on end of the meeting. | | +| Name | Required | Description | +| :--------------- | :--------- | :----------------------------------------------------------------------------------------------------------- | --- | +| `authToken` | `required` | The `token` string you receive when you [add a Participant](/api/#/operations/add_participant) to a meeting. | +| `meetingID` | `required` | The ID of the meeting you receive when you [create a meeting](/api/?v=v2#/operations/create_meeting). | +| `endRedirectURL` | `optional` | The URL to which the meeting would be redirected on end of the meeting. | | ## Events diff --git a/docs/guides/capabilities/recording/add-watermark.mdx b/docs/guides/capabilities/recording/add-watermark.mdx index ebbb842190..3f2a59f6c7 100644 --- a/docs/guides/capabilities/recording/add-watermark.mdx +++ b/docs/guides/capabilities/recording/add-watermark.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 # Add Watermark to Your Recording -Dyte's watermark feature enables you to include an image as a watermark in your recording. To add watermark, configure the following parameters to video_config in the [Start recording API](https://docs.dyte.io/api#/operations/start_recording). +Dyte's watermark feature enables you to include an image as a watermark in your recording. To add watermark, configure the following parameters to video_config in the [Start recording API](/api#/operations/start_recording). | **Parameter** | **Description** | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | diff --git a/docs/guides/capabilities/recording/custom-cloud-storage.mdx b/docs/guides/capabilities/recording/custom-cloud-storage.mdx index b01fe4437b..1a4009096c 100644 --- a/docs/guides/capabilities/recording/custom-cloud-storage.mdx +++ b/docs/guides/capabilities/recording/custom-cloud-storage.mdx @@ -144,4 +144,4 @@ You can change the name of the recording file using the `file_name_prefix` field It's important to note that you can only add a prefix to the default format; you can't change the entire file name. For example, if you teach an online physics class at 9 a.m. using Dyte, you could add `Physics_9am` to the file name. `Physics_9am_roomname_timestamp` would be the new file name. -For more information, see [start recording a meeting](https://docs.dyte.io/api#/operations/start_recording). +For more information, see [start recording a meeting](/api#/operations/start_recording). diff --git a/docs/guides/capabilities/recording/start-recording.mdx b/docs/guides/capabilities/recording/start-recording.mdx index 23a34d4b64..312c6e249b 100644 --- a/docs/guides/capabilities/recording/start-recording.mdx +++ b/docs/guides/capabilities/recording/start-recording.mdx @@ -14,7 +14,7 @@ There are two ways to start recording a Dyte meeting: [creating a meeting](/api/?v=v2#/operations/create_meeting) - Using the [Start Recording API](/api/?v=v2#/operations/start_recording) -Dyte stores recordings for a period of 7 days, after which they will expire and no longer be accessible. It is important to either download a copy of your recording or [set up storage](https://docs.dyte.io/guides/recording/custom-cloud-storage#set-storage-configuration) before the link expires. +Dyte stores recordings for a period of 7 days, after which they will expire and no longer be accessible. It is important to either download a copy of your recording or [set up storage](/guides/recording/custom-cloud-storage#set-storage-configuration) before the link expires. :::info note diff --git a/docs/guides/capabilities/video/add-virtual-background.mdx b/docs/guides/capabilities/video/add-virtual-background.mdx index fcd64331e9..6e8a49c944 100644 --- a/docs/guides/capabilities/video/add-virtual-background.mdx +++ b/docs/guides/capabilities/video/add-virtual-background.mdx @@ -36,8 +36,8 @@ Make sure you've read the Getting Started with Dyte topic and completed the foll - 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) +- Create a [Dyte Meeting](/api/?v=v2#/operations/create_meeting) +- [Add Participant](/api/?v=v2#/operations/add_participant) to the meeting Once you’ve integrated Dyte into your website or application successfully, perform the following steps to incorporate a virtual background feature into your Dyte meetings. diff --git a/docs/guides/livestream/advanced/configuring-permissions.mdx b/docs/guides/livestream/advanced/configuring-permissions.mdx index 54d276b20e..c1cbc6cd14 100644 --- a/docs/guides/livestream/advanced/configuring-permissions.mdx +++ b/docs/guides/livestream/advanced/configuring-permissions.mdx @@ -57,7 +57,7 @@ You can manage permissions for your livestreams in Media, such as who can start | View Only | Participants can only view the livestream. | media-ls (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` | Token from [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`. | ```swift let meetingInfo = DyteMeetingInfoV2(authToken: authToken, @@ -147,22 +147,22 @@ with the Dyte meeting server. ```swift meeting.doInit(dyteMeetingInfo_: meetingInfo) ``` + Note: This is the asynchronous method, You will have to attached observer (meeting.addMeetingRoomEventsListener(meetingRoomEventsListener: self) ) to know its completion state, success or failure, Listen to below callbacks of 'DyteMeetingRoomEventsListener'. - ```swift func onMeetingInitCompleted() { } - + func onMeetingInitFailed(exception: KotlinException) { } -``` +``` -OR +OR -To initialize the connection request, call the `doInit(dyteMeetingInfo: DyteMeetingInfoV2, onInitCompleted: () -> Void, onInitFailed_: () -> Void)` method -which is asynchronous and callback based. +To initialize the connection request, call the `doInit(dyteMeetingInfo: DyteMeetingInfoV2, onInitCompleted: () -> Void, onInitFailed_: () -> Void)` method +which is asynchronous and callback based. ## Step 5: Connect to the meeting @@ -180,7 +180,7 @@ func onMeetingInitCompleted() { } ``` -Or +Or ```swift meeting.doInit(dyteMeetingInfo: meetingInfo) { diff --git a/docs/partials/_android-quickstart.mdx b/docs/partials/_android-quickstart.mdx index 02552fe003..7e71fc9ff8 100644 --- a/docs/partials/_android-quickstart.mdx +++ b/docs/partials/_android-quickstart.mdx @@ -61,9 +61,9 @@ Release builds (or any other Proguard builds) require an additional setup step, 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( diff --git a/docs/partials/_flutter-quickstart.mdx b/docs/partials/_flutter-quickstart.mdx index dc431af690..ab9fe8a708 100644 --- a/docs/partials/_flutter-quickstart.mdx +++ b/docs/partials/_flutter-quickstart.mdx @@ -81,11 +81,11 @@ flutter pub add dyte_uikit ## 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). -| 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`. | After getting the `authToken`, you need to create the `DyteMeetingInfoV2` object as follows: diff --git a/docs/partials/_ios-quickstart.mdx b/docs/partials/_ios-quickstart.mdx index b9ce3e5dd1..3777673c9a 100644 --- a/docs/partials/_ios-quickstart.mdx +++ b/docs/partials/_ios-quickstart.mdx @@ -68,9 +68,9 @@ To set the initialization properties in the `DyteUiKitEngine` class, simply init Try this in `viewDidAppear()` -| 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`. | ```swift import DyteUiKit diff --git a/docs/plugin-sdk/setup/create.mdx b/docs/plugin-sdk/setup/create.mdx index 035739fca3..4b29f7f8c4 100644 --- a/docs/plugin-sdk/setup/create.mdx +++ b/docs/plugin-sdk/setup/create.mdx @@ -7,7 +7,7 @@ sidebar_position: 1 - Ensure that Dyte CLI is installed on your machine. Run the command `dyte help` to verify. For more information on how to install Dyte CLI, see - [Setup Dyte CLI](https://docs.dyte.io/cli). + [Setup Dyte CLI](/cli). - Create an account on the [Dyte Developer Portal](https://dev.dyte.io) if you haven't already. diff --git a/docs/plugin-sdk/setup/customize.mdx b/docs/plugin-sdk/setup/customize.mdx index f58d4a8c4a..40e8d164ee 100644 --- a/docs/plugin-sdk/setup/customize.mdx +++ b/docs/plugin-sdk/setup/customize.mdx @@ -11,7 +11,7 @@ icon, tags, and so on. When you create a plugin with the Dyte CLI, :::danger important It is important to generate `dyte-config.json` using the -[Dyte CLI](https://docs.dyte.io/cli/plugins). Each config files comes with a +[Dyte CLI](/cli/plugins). Each config files comes with a unique plugin ID generated by Dyte. This ID cannot be modified. ::: @@ -20,7 +20,7 @@ unique plugin ID generated by Dyte. This ID cannot be modified. Here is a list of all properties the config object can have: -| **Property** | **Description**n | **Type** | **Required** | +| **Property** | **Description**n | **Type** | **Required** | | --------------- | ------------------------------------------------------------------------ | ---------- | ------------ | | **name** | Name of the plugin. | `string` | true | | **version** | Version of the plugin. | `string` | true | @@ -33,9 +33,7 @@ Here is a list of all properties the config object can have: | **author** | Name of the creator. | `string` | false | | **repository** | URL for the Github/Gitlab repository. | `string` | false | -[//]: - # - '| contentScript | Relative path to the file that uses MediaStreams API. | string | false |' +[//]: # '| contentScript | Relative path to the file that uses MediaStreams API. | string | false |' This is what a basic config object looks like: diff --git a/docs/plugin-sdk/setup/publish.mdx b/docs/plugin-sdk/setup/publish.mdx index 0030a52d7b..d3e7d40c0c 100644 --- a/docs/plugin-sdk/setup/publish.mdx +++ b/docs/plugin-sdk/setup/publish.mdx @@ -44,7 +44,7 @@ dyte plugins publish -l :::info Read more about how you can manage plugins with Dyte CLI -[here](https://docs.dyte.io/cli/plugins#publishing-a-plugin). +[here](/cli/plugins#publishing-a-plugin). ::: diff --git a/docs/react-web-core/introduction.mdx b/docs/react-web-core/introduction.mdx index cbcec72ea5..473cda711a 100644 --- a/docs/react-web-core/introduction.mdx +++ b/docs/react-web-core/introduction.mdx @@ -24,7 +24,7 @@ The Core SDK was developed with a user-friendly approach to eliminate the comple - useDyteMeeting() - useDyteSelector() - See [Hooks](https://docs.dyte.io/react-ui-kit/using-hooks) for more information. + See [Hooks](/react-ui-kit/using-hooks) for more information. ## Utility Modules diff --git a/docs/react-web-core/stage.mdx b/docs/react-web-core/stage.mdx index a4257adef6..b34b17d747 100644 --- a/docs/react-web-core/stage.mdx +++ b/docs/react-web-core/stage.mdx @@ -12,7 +12,7 @@ Using Dyte's stage management APIs a user can do actions such as leave and join ## Access the stage APIs -The stage module can be accessed under [`meeting.stage`](https://docs.dyte.io/react-web-core/reference/DyteStage) namespace. +The stage module can be accessed under [`meeting.stage`](/react-web-core/reference/DyteStage) namespace. ## Properties diff --git a/docs/rn-core/stage.mdx b/docs/rn-core/stage.mdx index a4257adef6..b34b17d747 100644 --- a/docs/rn-core/stage.mdx +++ b/docs/rn-core/stage.mdx @@ -12,7 +12,7 @@ Using Dyte's stage management APIs a user can do actions such as leave and join ## Access the stage APIs -The stage module can be accessed under [`meeting.stage`](https://docs.dyte.io/react-web-core/reference/DyteStage) namespace. +The stage module can be accessed under [`meeting.stage`](/react-web-core/reference/DyteStage) namespace. ## Properties diff --git a/docs/web-core/stage.mdx b/docs/web-core/stage.mdx index a4257adef6..b34b17d747 100644 --- a/docs/web-core/stage.mdx +++ b/docs/web-core/stage.mdx @@ -12,7 +12,7 @@ Using Dyte's stage management APIs a user can do actions such as leave and join ## Access the stage APIs -The stage module can be accessed under [`meeting.stage`](https://docs.dyte.io/react-web-core/reference/DyteStage) namespace. +The stage module can be accessed under [`meeting.stage`](/react-web-core/reference/DyteStage) namespace. ## Properties diff --git a/docusaurus.config.js b/docusaurus.config.js index 58c046d382..0c6186ccb2 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -228,10 +228,6 @@ const plugins = [ return ['/capabilities/export-chat-dump']; } - if (path.startsWith('/guides/capabilities/audio/transcriptions')) { - return ['/guides/capabilities/ai/meeting-transcription']; - } - if (path.startsWith('/guides/capabilities/misc/embed')) { return ['/guides/capabilities/embed']; } @@ -444,7 +440,7 @@ const config = { trailingSlash: false, themes: ['@docusaurus/theme-live-codeblock'], clientModules: [require.resolve('./src/client/define-ui-kit.js')], - scripts: [{ src: 'https://cdn.statuspage.io/se-v2.js' }], + scripts: [{ src: 'https://cdn.statuspage.io/se-v2.js', async: true }], presets: [ [ @@ -465,7 +461,7 @@ const config = { ], }, sitemap: { - ignorePatterns: ['/tags/**'], + ignorePatterns: ['**/tags/**'], }, googleTagManager: { containerId: 'GTM-5FDFFSS', diff --git a/src/components/homepage/HomeFooter.jsx b/src/components/homepage/HomeFooter.jsx index a69bc6bcfc..ec495ed281 100644 --- a/src/components/homepage/HomeFooter.jsx +++ b/src/components/homepage/HomeFooter.jsx @@ -87,12 +87,13 @@ function Safety({ className }) { )} >
- Your Security,
+ Your Security, +
Our Priority.
- - + SOC Compliant + Compliant
); diff --git a/src/faq.yaml b/src/faq.yaml index df3cd7edf0..b9edaeb8e4 100644 --- a/src/faq.yaml +++ b/src/faq.yaml @@ -69,7 +69,7 @@ - question: What is the UI Kit? tags: ['General'] answer: |- - Dyte's React UI Kit is a prebuilt design library of UI components that makes it easy to integrate video and voice calls into any app or website within minutes. See [Dyte docs](https://docs.dyte.io/react-ui-kit). + Dyte's React UI Kit is a prebuilt design library of UI components that makes it easy to integrate video and voice calls into any app or website within minutes. See [Dyte docs](/react-ui-kit). - question: What is the Plugin SDK? tags: ['General'] @@ -180,7 +180,7 @@ answer: |- The meeting recordings are saved in your cloud storage that you set up. The supported cloud providers are AWS S3 bucket, DigitalOcean Spaces, Azure Blob storage, and Google Cloud Storage (GCS) buckets. - For more information on how to configure storage configs for Dyte Recordings, see [Set storage configuration](https://docs.dyte.io/guides/recording/custom-cloud-storage#set-storage-configuration). + For more information on how to configure storage configs for Dyte Recordings, see [Set storage configuration](/guides/recording/custom-cloud-storage#set-storage-configuration). If you haven't set up your storage configurations, Dyte will keep your recordings for 7 days, after which they will expire and become inaccessible.