Interface: ModuleApi
@faeyumbrea/lib-camera-api-types
@faeyumbrea/lib-camera-api-types / ModuleApi
Defined in: api.d.ts:7
Properties
Section titled “Properties”apiMajor
Section titled “apiMajor”
readonlyapiMajor:1
Defined in: api.d.ts:9
followUser
Section titled “followUser”followUser: (
consumerId,userId,options?,mode?) => {follow:CameraFollow;ok:true; } | {ok:false;reason:RejectionReason|"unavailable"; }
Defined in: api.d.ts:13
Follow the latest responding session of a user on this scene; all sessions remain addressable together.
Parameters
Section titled “Parameters”consumerId
Section titled “consumerId”string
userId
Section titled “userId”string
options?
Section titled “options?”Pick<MoveOptions, "duration" | "easing" | "bounds" | "lockInput">
Returns
Section titled “Returns”{ follow: CameraFollow; ok: true; } | { ok: false; reason: RejectionReason | "unavailable"; }
frame: (
bounds,options?) =>CameraPosition|undefined
Defined in: api.d.ts:15
Compute views without taking ownership or moving the camera.
Parameters
Section titled “Parameters”bounds
Section titled “bounds”readonly CameraBounds[]
options?
Section titled “options?”Returns
Section titled “Returns”CameraPosition | undefined
frameTokens
Section titled “frameTokens”frameTokens: (
tokenIds,options?) =>CameraPosition|undefined
Defined in: api.d.ts:16
Parameters
Section titled “Parameters”tokenIds
Section titled “tokenIds”readonly string[]
options?
Section titled “options?”Returns
Section titled “Returns”CameraPosition | undefined
gridPosition
Section titled “gridPosition”gridPosition: (
row,column) =>Readonly<{x:number;y:number; }> |undefined
Defined in: api.d.ts:27
Parameters
Section titled “Parameters”number
column
Section titled “column”number
Returns
Section titled “Returns”Readonly<{ x: number; y: number; }> | undefined
readonlyid:"lib-camera"
Defined in: api.d.ts:8
moveRemote
Section titled “moveRemote”moveRemote: (
consumer,targets,options,remote?) =>Promise<RemoteUserResult[]>
Defined in: api.d.ts:10
Parameters
Section titled “Parameters”consumer
Section titled “consumer”string
targets
Section titled “targets”string | readonly string[]
options
Section titled “options”remote?
Section titled “remote?”Returns
Section titled “Returns”Promise<RemoteUserResult[]>
observeUser
Section titled “observeUser”observeUser: (
userId,callback,mode?) =>ViewportSubscription
Defined in: api.d.ts:12
Parameters
Section titled “Parameters”userId
Section titled “userId”string
callback
Section titled “callback”(sample) => void
Returns
Section titled “Returns”openControls
Section titled “openControls”openControls: () =>
void
Defined in: api.d.ts:33
Returns
Section titled “Returns”void
panic: () =>
Promise<void>
Defined in: api.d.ts:32
Stop this client immediately and persist its opt-out.
Returns
Section titled “Returns”Promise<void>
read: () =>
Readonly<CameraPosition> |undefined
Defined in: api.d.ts:20
Returns
Section titled “Returns”Readonly<CameraPosition> | undefined
read3D
Section titled “read3D”read3D: () =>
Readonly<CameraView3D> |undefined
Defined in: api.d.ts:22
Native 3D position and look-at target; absent unless 3D Canvas is active and ready.
Returns
Section titled “Returns”Readonly<CameraView3D> | undefined
register
Section titled “register”register: (
options) =>LocalConsumer
Defined in: api.d.ts:19
Registration is available at init; movement requires a ready canvas.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”sceneBounds
Section titled “sceneBounds”sceneBounds: () =>
CameraBounds|undefined
Defined in: api.d.ts:17
Returns
Section titled “Returns”CameraBounds | undefined
set3DRemote
Section titled “set3DRemote”set3DRemote: (
consumer,targets,view,remote?) =>Promise<RemoteUserResult[]>
Defined in: api.d.ts:11
Parameters
Section titled “Parameters”consumer
Section titled “consumer”string
targets
Section titled “targets”string | readonly string[]
remote?
Section titled “remote?”Returns
Section titled “Returns”Promise<RemoteUserResult[]>
tokenPosition
Section titled “tokenPosition”tokenPosition: (
tokenId) =>Readonly<{x:number;y:number; }> |undefined
Defined in: api.d.ts:23
Parameters
Section titled “Parameters”tokenId
Section titled “tokenId”string
Returns
Section titled “Returns”Readonly<{ x: number; y: number; }> | undefined