Class AssetCameraSdkFacade

Facade for controlled, external interaction with the AssetCameraRenderPlugin.

Hierarchy (View Summary)

EventEmitter<AssetCameraSdkFacadeEvents>
- AssetCameraSdkFacade

Index

Properties

Methods

addEventListener animateToAngle getCurrentCameraState

Properties

`Protected` `Readonly`emitter

emitter: Emitter<AssetCameraSdkFacadeEvents> = ...

An event emitter for handling custom events.

Methods

addEventListener

addEventListener<K extends "onCameraMove">(
event: K,
listener: (eventData: AssetCameraSdkFacadeEvents[K]) => void,
): { remove: () => void }
Adds an event listener for a specific event.
Type Parameters
- K extends "onCameraMove"
  The type of the event key.
Parameters
- event: K
  The event to listen to.
- listener: (eventData: AssetCameraSdkFacadeEvents[K]) => void
  The callback function to be invoked when the event is emitted.
Returns { remove: () => void }
An object with a remove method to unsubscribe the listener.
Inherited from EventEmitter.addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:20

animateToAngle

animateToAngle(
angleOptions: Pick<LookAt, "pitch" | "roll" | "yaw">,
animationDurationMs?: number,
): Promise<void>
Animates the camera to a specific angle.
Parameters
- angleOptions: Pick<LookAt, "pitch" | "roll" | "yaw">
- animationDurationMs: number = 0
  The duration of the animation in milliseconds. Defaults to 0 for an instant change.
Returns Promise<void>
A promise that resolves when the animation is complete.

Remarks
Part of required API for Multivista. Only needs to change the angle, not the position.
- Defined in asset/camera/src/lib/external-facade/AssetCameraSdkFacade.ts:54

getCurrentCameraState

getCurrentCameraState(): CameraState
Returns CameraState
The current camera state.
- Defined in asset/camera/src/lib/external-facade/AssetCameraSdkFacade.ts:65