Skip to content

Managing rooms

從後端伺服器建立、列出和刪除房間。

Initialize RoomServiceClient

房間管理由 RoomServiceClient 完成，建立如下：

pip install livekit-api

from livekit.api import LiveKitAPI

# Will read LIVEKIT_URL, LIVEKIT_API_KEY, and LIVEKIT_API_SECRET from environment variables
async with api.LiveKitAPI() as lkapi:
# ... use your client with `lkapi.room` ...

import { Room, RoomServiceClient } from 'livekit-server-sdk';

const livekitHost = 'https://my.livekit.host';
const roomService = new RoomServiceClient(livekitHost, 'api-key', 'secret-key');

import (
    lksdk "github.com/livekit/server-sdk-go"
    livekit "github.com/livekit/protocol/livekit"
)

// ...

host := "https://my.livekit.host"
roomClient := lksdk.NewRoomServiceClient(host, "api-key", "secret-key")

Create a room

from livekit.api import CreateRoomRequest

room = await lkapi.room.create_room(CreateRoomRequest(
    name="myroom",
    empty_timeout=10 * 60,
    max_participants=20,
))

const opts = {
    name: 'myroom',
    emptyTimeout: 10 * 60, // 10 minutes
    maxParticipants: 20,
};
roomService.createRoom(opts).then((room: Room) => {
    console.log('room created', room);
});

room, _ := roomClient.CreateRoom(context.Background(), &livekit.CreateRoomRequest{
    Name:            "myroom",
    EmptyTimeout:    10 * 60, // 10 minutes
    MaxParticipants: 20,
})

lk room create --empty-timeout 600 myroom

List rooms

from livekit.api import ListRoomsRequest

rooms = await lkapi.room.list_rooms(ListRoomsRequest())

roomService.listRooms().then((rooms: Room[]) => {
    console.log('existing rooms', rooms);
});

rooms, _ := roomClient.ListRooms(context.Background(), &livekit.ListRoomsRequest{})

lk room list

Delete a room

刪除房間會導致所有參與者斷開連接。

from livekit.api import DeleteRoomRequest

await lkapi.room.delete_room(DeleteRoomRequest(
    room="myroom",
))

// Delete a room
roomService.deleteRoom('myroom').then(() => {
    console.log('room deleted');
});

_, _ = roomClient.DeleteRoom(context.Background(), &livekit.DeleteRoomRequest{
    Room: "myroom",
})

lk room delete myroom