Class AssetCameraSdkFacade

Facade for controlled, external interaction with the AssetCameraRenderPlugin.

Hierarchy (View Summary)

EventEmitterBase<CameraAPI.Events>
- AssetCameraSdkFacade

Implements

CameraAPI.Facade

Index

Constructors

Properties

Methods

addEventListener animateToAngle getCurrentCameraState

Constructors

constructor

new AssetCameraSdkFacade(plugin: AssetCameraRenderPlugin): AssetCameraSdkFacade
Parameters
- plugin: AssetCameraRenderPlugin
Returns AssetCameraSdkFacade
Overrides EventEmitterBase.constructor
- Defined in asset/camera/src/lib/external-facade/AssetCameraSdkFacade.ts:30

Properties

`Protected` `Readonly`emitter

emitter: Emitter<CameraAPI.Events> = ...

An event emitter for handling custom events.

Methods

addEventListener

addEventListener<K extends "onCameraMove">(
event: K,
listener: (eventData: CameraAPI.Events[K]) => void,
): EventHandle
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: CameraAPI.Events[K]) => void
  The callback function to be invoked when the event is emitted.
Returns EventHandle
An EventHandle with a remove method to unsubscribe the listener.
Implementation of Facade.addEventListener
Inherited from EventEmitterBase.addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:76

animateToAngle

animateToAngle(
angleOptions: CameraRotation,
animationDurationMs?: number,
): Promise<void>
Animates the camera to a specific angle.
Parameters
- angleOptions: CameraRotation
- animationDurationMs: number = 0
Returns Promise<void>
A promise that resolves when the animation is complete.
Implementation of Facade.animateToAngle
- Defined in asset/camera/src/lib/external-facade/AssetCameraSdkFacade.ts:59

getCurrentCameraState

getCurrentCameraState(): CameraAPI.CameraState
Returns CameraAPI.CameraState
The current camera state.
Implementation of Facade.getCurrentCameraState
- Defined in asset/camera/src/lib/external-facade/AssetCameraSdkFacade.ts:70