Skip to content

Commit 0ce3d7a

Browse files
Add error code table to readme
Document error codes with a new table in the readme
1 parent 445a42e commit 0ce3d7a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,20 @@ LiveKit is a dynamic realtime environment and calls can fail for various reasons
356356

357357
You may throw errors of the type `RpcError` with a string `message` in an RPC method handler and they will be received on the caller's side with the message intact. Other errors will not be transmitted and will instead arrive to the caller as `1500` ("Application Error"). Other built-in errors are detailed in `RpcError`.
358358

359+
## Error Codes
360+
361+
| Code | Name | Reason |
362+
| ----- | --------------------------- | ------------------ |
363+
| 1 | `ConnectionError` | 0: `NotAllowed`<br>1: `ServerUnreachable`<br>2: `InternalError`<br>3: `Cancelled`<br>4:`LeaveRequest` |
364+
| 10 | `UnsupportedServer` | |
365+
| 12 | `UnexpectedConnectionState` | |
366+
| 13 | `NegotiationError` | |
367+
| 14 | `PublishDataError` | |
368+
| 15 | `SignalRequestError` | |
369+
| 20 | `TrackInvalidError` | |
370+
| 21 | `DeviceUnsupportedError` | |
371+
| 40 | `CryptorError` | |
372+
359373
## Examples
360374

361375
### Demo App

0 commit comments

Comments
 (0)