VideoRoomSessionMethods

updateMeta

View as Markdown

updateMeta

  • updateMeta(meta): Promise<void>

Updates the RoomSession metadata by only setting the specified fields. This is different from setMeta, which replaces the whole metadata object.

Parameters

meta
Record<string, unknown>

The update to the metadata.

Returns

Promise<void>

Permissions

  • room.set_meta

You need to specify the permissions when creating the Video Room Token on the server side.

Example

1roomSession.on("room.updated", (e) => {
2  // We can set an event listener to log changes to the metadata.
3  console.log(e.room.meta);
4});
5
6await roomSession.setMeta({ foo: "bar", baz: true });
7// The logger will now print `{ foo: "bar", baz: true }`
8
9await roomSession.updateMeta({ baz: false, t: 10 });
10// The logger will now print `{ foo: "bar", baz: false, t: 10 }`