|
When a user wants to join a room, the following information must be supplied:
| • | Room name – The name of the room |
| • | Zone name – The name of the zone that holds that room |
| • | Password (optional) – If the room is password protected, the user joining that room must supply the correct password |
| • | Receive zone list updates (boolean) – If true, the user will receive updates for this zone when something notable changes. A zone update is a minimal update sent when one of the following events happen in the zone: |
| • | An existing room is removed |
| • | A room’s externally viewable details have changed (name, description, capacity, password status, user count, description) |
| • | Receive user list updates (boolean) – If true, the user will receive user list updates for the room. A user list update is fired when one of the following events happen: |
| • | A new user joins the room |
| • | The user starts or stops sending a live audio or video stream to the server. Receiving this event is configurable - see next property |
| • | Receive streaming events (boolean) – If true, the joining user will receive a user list update event when someone in the room starts or stops streaming a live video to the server |
| • | Receive user variable updates (boolean) – If true, the joining user will receive user variable update events when user variables are updated. See also User Variables. |
| • | Receive room variable updates (boolean) – If true, the joining user will receive room variable updates when room variables are updated. See also Room Variables. |
|