Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 3.27 KB

README.md

File metadata and controls

86 lines (61 loc) · 3.27 KB
Raw

Room Joining function

Function to join room in Livekit.

🧰 Usage

POST /

Receives IDs of the room and user, and sends back the necessary access to the user.

Parameters

Name Description Location Type Sample Value
roomName Name of the room Body String jcbd...kdsn
uid User ID Body String dfge...ythr

Response

Sample 200 Response:

{
    "msg": "Success",
    "livekit_socket_url": "livekitSocketUrl",
    "access_token": "accessToken",
}

Sample 400 Response:

{
    "msg": "Missing required parameter: roomName"
}

Sample 500 Response:

{
    "msg": "Error joining room"
}

⚙️ Configuration

Setting Value
Runtime Node (18.0)
Entrypoint src/main.js
Build Commands npm install && npm run start
Permissions Users
Timeout (Seconds) 15

🔒 Environment Variables

LIVEKIT_API_KEY

API Key to use Livekit Server SDK.

Question Answer
Required Yes
Sample Value AP......9X
Documentation Livekit

LIVEKIT_API_SECRET

API Secret to use Livekit Server SDK.

Question Answer
Required Yes
Sample Value HC1Itf...........dAAKF5o
Documentation Livekit

LIVEKIT_SOCKET_URL

Socket URL of Livekit instance.

Question Answer
Required Yes
Sample Value wss://******.livekit.cloud
Documentation Livekit