Interface: LocalConsumer
@faeyumbrea/lib-camera-api-types
@faeyumbrea/lib-camera-api-types / LocalConsumer
Defined in: controller.d.ts:21
Properties
Section titled “Properties”acquire
Section titled “acquire”acquire: () =>
SessionResult
Defined in: controller.d.ts:32
Returns
Section titled “Returns”follow
Section titled “follow”follow: (
source,interval?) => {follow:CameraFollow;ok:true; } | {ok:false;reason:RejectionReason|"unavailable"; }
Defined in: controller.d.ts:23
Parameters
Section titled “Parameters”source
Section titled “source”() => MoveOptions | undefined
interval?
Section titled “interval?”number
Returns
Section titled “Returns”{ follow: CameraFollow; ok: true; } | { ok: false; reason: RejectionReason | "unavailable"; }
readonlyid:string
Defined in: controller.d.ts:22
move: (
options,signal?) =>Promise<MovementResult| {reason:RejectionReason;status:"rejected"; }>
Defined in: controller.d.ts:34
Acquire, move, and release, including when movement fails.
Parameters
Section titled “Parameters”options
Section titled “options”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<MovementResult | { reason: RejectionReason; status: "rejected"; }>
set3D: (
view) =>CameraResult3D
Defined in: controller.d.ts:31
Acquire, set the 3D view immediately, and release.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”unregister
Section titled “unregister”unregister: () =>
void
Defined in: controller.d.ts:38
Returns
Section titled “Returns”void