Skip to main content

struct RoomParams

(Niantic.Lightship.SharedAR.Rooms.RoomParams)

Overview

The RoomParams struct contains properties of the room

struct RoomParams {
// properties

string RoomID;
RoomVisibility Visibility;
int Capacity;
string Name;
string Description;
string Passcode;

// methods

RoomParams(
int capacity,
string name = "",
string description = "",
string passcode = "",
RoomVisibility visibility = RoomVisibility.Public
);

RoomParams(string id, RoomVisibility visibility = RoomVisibility.Public);
};

Detailed Documentation

The RoomParams struct contains properties of the room

Properties

RoomID

string RoomID

Room ID of the room. This is only set by RoomManagementService.

Visibility

RoomVisibility Visibility

Visibility of the room

Capacity

int Capacity

Capacity of the room. Value should be between 2 to 32 peers.

Name

string Name

Name of the room. Name does not need to be unique between rooms

Description

string Description

Description of the room

Passcode

string Passcode

Passcode to access the room. Required when visibility is set to private.

Methods

RoomParams

RoomParams(
int capacity,
string name = "",
string description = "",
string passcode = "",
RoomVisibility visibility = RoomVisibility.Public
)

Constructor

    Parameters:

    capacity - Capacity of the room. Value should be between 2 to 32 peers.

    name - Name of the room

    description - Description of the room

    passcode - Passcode of the room

    visibility - Visibility of the room

RoomParams

RoomParams(string id, RoomVisibility visibility = RoomVisibility.Public)

Constructor for construction through ID. Typically used in conjunction with Room.GetOrCreateRoomAsync which returns the necessary string ID.

    Parameters:

    id - The specific RoomID GUID from the backend

    visibility - Visibility of the room