rooms.create

Import and client

import { RelayServer } from '@relayrtc/node'
 
const relay = new RelayServer({
  apiUrl: process.env.RELAYRTC_API_URL!,
  apiKey: process.env.RELAYRTC_SECRET_KEY!,
})

Requirements

A secret key with rooms:create. The requested resource must belong to that key's project environment.

Parameters

Every method accepts RequestOptions as its final argument.

Example

const result = await relay.rooms.create({ name: 'Team call', maxParticipants: 10 })

Returns

Promise<Room>. Returns a room object.

Behavior

Creating a room does not join it or open media devices. Issue participant tokens next.

REST equivalent

POST /v1/rooms. Failures throw RelayApiError.