RealtimeStore class

A key-value store shared by everyone in the room, kept in sync in realtime.

Every method needs a joined room: called before Room.join completes or after the room is left, it throws a VideoSDKError (3035).

Example

// Set a value
await room.realtimeStore.setValue("key", "value");

// Get a value
var value = await room.realtimeStore.getValue("key");

// Observe a key
room.realtimeStore.observe("key", (value, updatedBy) {
  print("Value changed: $value");
});

Properties

runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getValue(String key) → Future<String?>
The getValue() method retrieves the current value associated with a given key.
observe(String key, void listener(String? value, Participant? updatedBy)) → Future<void>
The observe() method subscribes listener to real-time updates for a given key. When the key’s value changes, listener runs for every participant observing it.
setValue(String key, String? value) → Future<void>
The setValue() method is used to store or update data in the RealtimeStore. If a key already exists, it will be overwritten with the new value. Passing null as the value deletes the key.
stopObserving(String key, void listener(String? value, Participant? updatedBy)) → Future<void>
Stops listener observing key.