Skip to main content

Class: Client

Defined in: livelink.clients/livelink.js/sources/session/Client.ts:42

The browser SDK ships its own Client subclass, adding everything that comes from the client metadata: the camera entities the client views the scene through and the 3d data under its mouse pointer. That metadata is piggybacked on the video frames, so it exists only in a streaming SDK — see Session._updateClients, fed by the frame handler.

It also resolves entities as the proxied browser Entity rather than the shared headless one.

Extends​

  • Client

Properties​

PropertyModifierTypeDescriptionInherited from
session_idreadonlyUUIDThe unique identifier of the session the client is associated with.ClientBase.session_id

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​

UUID

Inherited from​

ClientBase.id;

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​

UUID

Inherited from​

ClientBase.user_id;

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

Inherited from​

ClientBase.username;

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"

Inherited from​

ClientBase.client_type;

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

Inherited from​

ClientBase.is_external;

Methods​

getCameraEntities()​

getCameraEntities(): Promise<Entity[]>;

Defined in: livelink.clients/livelink.js/sources/session/Client.ts:107

Returns the camera entities that the client is using.

Returns​

Promise<Entity[]>

getHoveredEntity()​

getHoveredEntity(): Promise<Entity | null>;

Defined in: livelink.clients/livelink.js/sources/session/Client.ts:128

Returns the entity that the client's mouse pointer is currently hovering over.

Returns​

Promise<Entity | null>