Room metadata

Use room metadata to share application-specific state with all participants.

On this page

Overview

Similar to Participant metadata, Rooms also feature a metadata field for application-specific data which is visible to all participants.

Room metadata can only be set using the server APIs, but can be accessed by all participants in the room using the LiveKit SDKs.

To set room metadata, use the CreateRoom and UpdateRoomMetadata APIs.

To subscribe to updates, you must handle the RoomMetadataChanged event.