Class: Client
Defined in: livelink.clients/livelink.base/sources/session/Client.ts:25
A client in a session.
A client represents an instance of a 3dverse user viewing the session.
A user can have multiple clients in the same session.
Clients must not be instantiated but can be accessed through the Session object.
A client seen from here has identity only. Everything a client shows — the camera entities it
views the scene through, the entity under its mouse pointer — is carried by the client metadata
piggybacked on the video frames, which only a streaming client receives. Those members therefore
live on the browser SDK's Client subclass; a livelink.agent client never receives frames
and would only ever see them empty.
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
session_id | readonly | UUID | The unique identifier of the session the client is associated with. |
Accessors
id
Get Signature
get id(): UUID;
Defined in: livelink.clients/livelink.base/sources/session/Client.ts:44
The unique identifier of the client.
Returns
user_id
Get Signature
get user_id(): UUID;
Defined in: livelink.clients/livelink.base/sources/session/Client.ts:52
The id of the user that the client is associated with. Note that the same user can have multiple clients in the same session.
Returns
username
Get Signature
get username(): string;
Defined in: livelink.clients/livelink.base/sources/session/Client.ts:59
The username of the user that the client is associated with.
Returns
string
client_type
Get Signature
get client_type(): "user" | "guest" | "api" | "unknown";
Defined in: livelink.clients/livelink.base/sources/session/Client.ts:66
The type of the client.
Returns
"user" | "guest" | "api" | "unknown"
is_external
Get Signature
get is_external(): boolean;
Defined in: livelink.clients/livelink.base/sources/session/Client.ts:73
Indicates if the client is external to the current session.
Returns
boolean