Livekit.RoomServiceClient (Livekit v0.1.4)

View Source

Client for the Livekit Room Service API.

Summary

Functions

Deletes a room.

Gets a participant from a room.

Lists participants in a room.

Mutes or unmutes a participant's track.

Creates a new RoomServiceClient instance.

Removes a participant from a room.

Sends data to specific participants in a room.

Updates a participant's metadata, permissions, or name.

Updates track subscriptions for a participant.

Functions

create_room(client, name, opts \\ [])

Creates a new room.

delete_room(client, room)

Deletes a room.

get_participant(client, room, identity)

Gets a participant from a room.

list_participants(client, room)

Lists participants in a room.

list_rooms(client, names \\ nil)

Lists all rooms.

mute_published_track(client, room, identity, track_sid, muted)

Mutes or unmutes a participant's track.

new(base_url, api_key, api_secret)

Creates a new RoomServiceClient instance.

remove_participant(client, room, identity)

Removes a participant from a room.

send_data(client, room, data, kind, opts \\ [])

Sends data to specific participants in a room.

update_participant(client, room, identity, opts \\ [])

Updates a participant's metadata, permissions, or name.

update_room_metadata(client, room, metadata)

Updates room metadata.

update_subscriptions(client, room, identity, track_sids, subscribe)

Updates track subscriptions for a participant.