Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions docs/partials/error-codes/_web_core_debug_system_error_codes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
:::info Note

This information is intended for developers debugging or troubleshooting Dyte's web core system errors.

:::

Error codes are a standardized method for developers to convey application errors and issues to users or other developers in a structured manner. Error codes typically consist of a numerical or alphanumeric code and a description that provides more information about the error.

This document lists Dyte's web core error codes that you may encounter in various scenarios. System error codes can arise in different parts of the system, and their descriptions may not always provide exact details. To address these codes effectively, you must first understand the programmatic and runtime contexts in which these errors occurred.

## Error codes and format

Error codes consist of four-digit numbers that are categorized by the type of error. The first two digits denote the module in which the error occurred, and the remaining digits specify the type of error.

## Error codes prefixes

Here is a list of error code prefixes corresponding to each Dyte modules:

| **Module** | **Error Code Prefix** |
| ------------------------------ | --------------------- |
| DyteClient | 00xx |
| Controller | 01xx |
| RoomNodeClient | 02xx |
| HiveNodeClient | 03xx |
| SocketService | 04xx |
| Chat | 05xx |
| Plugins | 06xx |
| Polls | 07xx |
| Meta | 08xx |
| Permissions/Presets | 09xx |
| Recording | 10xx |
| Self (or local media handling) | 11xx |
| Participant | 12xx |
| Spotlight | 13xx |
| Remote Request | 14xx |
| Webinar | 15xx |
| Device | 16xx |
| End-End Encryption | 17xx |
| AI (transcripts, summary) | 18xx |
| Livestream | 19xx |
| Stage | 20xx |
----------------------------------------------------------
479 changes: 479 additions & 0 deletions docs/partials/error-codes/_web_core_error_codes_details.mdx

Large diffs are not rendered by default.

78 changes: 5 additions & 73 deletions docs/react-web-core/error-codes/error-code-zero-ten.mdx
Original file line number Diff line number Diff line change
@@ -1,82 +1,14 @@
---
title: System Error Codes (0-16)
title: System Error Codes (0-20)
sidebar_position: 2
---

This topic describes web core system error codes 0-16.
This topic describes react web core system error codes 0-20.

## Error code: 0001
import ErrorCodesDetails from '@site/docs/partials/error-codes/_web_core_error_codes_details.mdx';

- **Error message**: Failed to initialize
- **Possible reason**: `DyteClient` is not getting initialized.
- **Possible solution**: Verify if you initialized the `DyteClient` correctly `await DyteClient.init({ ... })`. See [DyteClient](/web-core/reference/DyteClient). If you continue to experience issue, please [reach out](https://dyte.io/contact) to us for the help.

## Error code: 0002

- **Error message**: Failed to join room
- **Possible reason**: Indicates a problem with the `DyteClient`.
- **Possible solution**: The `joinRoom()` method is used to join a meeting room in Dyte. Try calling this method on the `DyteClient`:

```bash
await meeting.joinRoom();
```

Once the join room process completes, you'll see the `roomJoined` event is emitted on the `meeting.self` namespace.

## Error code: 0003

- **Error message**: Failed to leave room
- **Possible reason**: Indicates a problem with the `DyteClient`.
- **Possible solution**: The `leaveRoom()` method is used to leave a meeting room in Dyte. Try calling this method on the `DyteClient`:

```bash
await meeting.leaveRoom();
```

## Error code: 0501

- **Error message**: Permission denied
- **Possible reason**: Indicates a problem with chat.
- **Possible solution**: Please check if you've added the required permissions to your organization for your [preset](https://dev.dyte.io/).

<img
src="/static/errorcodes/chat-perms.png"
width="300"
height="100"
alt="error-chat-preset"
className="errorcode-chat-perms-preset"
/>

## Error code: 0502

- **Error message**: Invalid message body
- **Possible reason**: Indicates a problem with chat.
- **Possible solution**: The type `Message` is not defined correctly. See [Chat](/web-core/chat/introduction).

## Error code: 1601

- **Error message**: Failed to get audio track
- **Possible reason**: Indicates a problem with the audio track of the device.
- **Possible solution**: Verify if you've subscribed to the [Audio update event](/web-core/local-user/events#audio-update). Check your audio track status. If the problem persists, please [contact us](https://dyte.io/contact) for the help.

## Error code: 1602

- **Error message**: Failed to get video track
- **Possible reason**: Indicates a problem with the video track of the device.
- **Possible solution**: Verify if you've subscribed to the [Video update event](/web-core/local-user/events#video-update). Check your video track status. If the problem persists, please [contact us](https://dyte.io/contact) for the help.

## Error code: 1603

- **Error message**: Incorrect device
- **Possible reason**: Indicates a problem with the device.
- **Possible solution**: Verify if you're connected to the correct device. See [Device update](/web-core/local-user/events#device-update). If the problem persists, please [contact us](https://dyte.io/contact) for the help.

## Error code: 1604

- **Error message**: Failed to change device
- **Possible reason**: Indicates a problem with the device.
- **Possible solution**: Please [contact us](https://dyte.io/contact) for the help.
<ErrorCodesDetails />

<head>
<title>React Web Core System Error Codes (0-16)</title>
<title>React Web Core System Error Codes (0-20)</title>
</head>
38 changes: 2 additions & 36 deletions docs/react-web-core/error-codes/error-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,9 @@ title: Debug System Error Codes
sidebar_position: 1
---

:::info Note
import ErrorCodeDebugSystem from '@site/docs/partials/error-codes/_web_core_debug_system_error_codes.mdx';

This information is intended for developers debugging or troubleshooting Dyte's web core system errors.

:::

Error codes are a standardized method for developers to convey application errors and issues to users or other developers in a structured manner. Error codes typically consist of a numerical or alphanumeric code and a description that provides more information about the error.

This document lists Dyte's web core error codes that you may encounter in various scenarios. System error codes can arise in different parts of the system, and their descriptions may not always provide exact details. To address these codes effectively, you must first understand the programmatic and runtime contexts in which these errors occurred.

## Error codes and format

Error codes consist of four-digit numbers that are categorized by the type of error. The first two digits denote the module in which the error occurred, and the remaining digits specify the type of error.

## Error codes prefixes

Here is a list of error code prefixes corresponding to each Dyte modules:

| **Module** | **Error Code Prefix** |
| ------------------------------ | --------------------- |
| DyteClient | 00xx |
| Controller | 01xx |
| RoomNodeClient | 02xx |
| HiveNodeClient | 03xx |
| SocketService | 04xx |
| Chat | 05xx |
| Plugins | 06xx |
| Polls | 07xx |
| Meta | 08xx |
| Permissions/Presets | 09xx |
| Recording | 10xx |
| Self (or local media handling) | 11xx |
| Participant | 12xx |
| Spotlight | 13xx |
| Remote Request | 14xx |
| Webinar | 15xx |
| Device | 16xx |
<ErrorCodeDebugSystem />

<head>
<title>React Web Core Debug System Error Codes</title>
Expand Down
3 changes: 2 additions & 1 deletion docs/react-web-core/reference/DyteClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ actions on the meeting.
| --- | --- |
| options | The options object. |
| options.authToken | The authorization token received using the API. |
| options.apiBase | The base URL of the API. |
| options.baseURI | The base URL of the API. |
| options.defaults | The default audio and video settings. |
| options.onError | optional error callback, To listen for Dyte SDK errors |

<a name="module_DyteClient+participants"></a>

Expand Down
78 changes: 5 additions & 73 deletions docs/web-core/error-codes/error-code-zero-ten.mdx
Original file line number Diff line number Diff line change
@@ -1,82 +1,14 @@
---
title: System Error Codes (0-16)
title: System Error Codes (0-20)
sidebar_position: 2
---

This topic describes web core system error codes 0-16.
This topic describes web core system error codes 0-20.

## Error code: 0001
import ErrorCodesDetails from '@site/docs/partials/error-codes/_web_core_error_codes_details.mdx';

- **Error message**: Failed to initialize
- **Possible reason**: `DyteClient` is not getting initialized.
- **Possible solution**: Verify if you initialized the `DyteClient` correctly `await DyteClient.init({ ... })`. See [DyteClient](/web-core/reference/DyteClient). If you continue to experience issue, please [reach out](https://dyte.io/contact) to us for the help.

## Error code: 0002

- **Error message**: Failed to join room
- **Possible reason**: Indicates a problem with the `DyteClient`.
- **Possible solution**: The `joinRoom()` method is used to join a meeting room in Dyte. Try calling this method on the `DyteClient`:

```bash
await meeting.joinRoom();
```

Once the join room process completes, you'll see the `roomJoined` event is emitted on the `meeting.self` namespace.

## Error code: 0003

- **Error message**: Failed to leave room
- **Possible reason**: Indicates a problem with the `DyteClient`.
- **Possible solution**: The `leaveRoom()` method is used to leave a meeting room in Dyte. Try calling this method on the `DyteClient`:

```bash
meeting.leaveRoom();
```

## Error code: 0501

- **Error message**: Permission denied
- **Possible reason**: Indicates a problem with chat.
- **Possible solution**: Please check if you've added the required permissions to your organization for your [preset](https://dev.dyte.io/).

<img
src="/static/errorcodes/chat-perms.png"
width="300"
height="100"
alt="error-chat-preset"
className="errorcode-chat-perms-preset"
/>

## Error code: 0502

- **Error message**: Invalid message body
- **Possible reason**: Indicates a problem with chat.
- **Possible solution**: The type `Message` is not defined correctly. See [Chat](/web-core/chat/introduction).

## Error code: 1601

- **Error message**: Failed to get audio track
- **Possible reason**: Indicates a problem with the audio track of the device.
- **Possible solution**: Verify if you've subscribed to the [Audio update event](/web-core/local-user/events#audio-update). Check your audio track status. If the problem persists, please [contact us](https://dyte.io/contact) for the help.

## Error code: 1602

- **Error message**: Failed to get video track
- **Possible reason**: Indicates a problem with the video track of the device.
- **Possible solution**: Verify if you've subscribed to the [Video update event](/web-core/local-user/events#video-update). Check your video track status. If the problem persists, please [contact us](https://dyte.io/contact) for the help.

## Error code: 1603

- **Error message**: Incorrect device
- **Possible reason**: Indicates a problem with the device.
- **Possible solution**: Verify if you're connected to the correct device. See [Device update](/web-core/local-user/events#device-update). If the problem persists, please [contact us](https://dyte.io/contact) for the help.

## Error code: 1604

- **Error message**: Failed to change device
- **Possible reason**: Indicates a problem with the device.
- **Possible solution**: Please [contact us](https://dyte.io/contact) for the help.
<ErrorCodesDetails />

<head>
<title>Web Core System Error Codes (0-16)</title>
<title>Web Core System Error Codes (0-20)</title>
</head>
38 changes: 2 additions & 36 deletions docs/web-core/error-codes/error-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,9 @@ title: Debug System Error Codes
sidebar_position: 1
---

:::info Note
import ErrorCodeDebugSystem from '@site/docs/partials/error-codes/_web_core_debug_system_error_codes.mdx';

This information is intended for developers debugging or troubleshooting Dyte's web core system errors.

:::

Error codes are a standardized method for developers to convey application errors and issues to users or other developers in a structured manner. Error codes typically consist of a numerical or alphanumeric code and a description that provides more information about the error.

This document lists Dyte's web core error codes that you may encounter in various scenarios. System error codes can arise in different parts of the system, and their descriptions may not always provide exact details. To address these codes effectively, you must first understand the programmatic and runtime contexts in which these errors occurred.

## Error codes and format

Error codes consist of four-digit numbers that are categorized by the type of error. The first two digits denote the module in which the error occurred, and the remaining digits specify the type of error.

## Error codes prefixes

Here is a list of error code prefixes corresponding to each Dyte modules:

| **Module** | **Error Code Prefix** |
| ------------------------------ | --------------------- |
| DyteClient | 00xx |
| Controller | 01xx |
| RoomNodeClient | 02xx |
| HiveNodeClient | 03xx |
| SocketService | 04xx |
| Chat | 05xx |
| Plugins | 06xx |
| Polls | 07xx |
| Meta | 08xx |
| Permissions/Presets | 09xx |
| Recording | 10xx |
| Self (or local media handling) | 11xx |
| Participant | 12xx |
| Spotlight | 13xx |
| Remote Request | 14xx |
| Webinar | 15xx |
| Device | 16xx |
<ErrorCodeDebugSystem />

<head>
<title>Web Core Debug System Error Codes</title>
Expand Down
Loading