eufy-mega / model/capabilities / PtzActions

Type Alias: PtzActions

type PtzActions = object;

Bound pan/tilt/zoom (PTZ) controls — the object returned by dev.ptz(). Movement is command-driven (the camera has no "go to angle X" write; it steps in a direction). Preset operations are grouped under PtzPresetActions via preset() (e.g. dev.ptz().preset().goto(3)).

Properties

panAngle?

readonly optional panAngle?: number;

Current pan angle (property panAngle), when the camera reports it.

---

rotationSpeed?

readonly optional rotationSpeed?: number;

Rotation speed (property rotationSpeed).

---

tiltAngle?

readonly optional tiltAngle?: number;

Current tilt angle (property tiltAngle), when the camera reports it.

Methods

down()

down(): Promise<void>;

Tilt one step down.

Returns

Promise<void>

---

left()

left(): Promise<void>;

Rotate one step left.

Returns

Promise<void>

---

preset()

preset(): PtzPresetActions;

Preset operations (goto/preview/save/setDefault/delete + list/image when live-bound).

Returns

PtzPresetActions

---

right()

right(): Promise<void>;

Rotate one step right.

Returns

Promise<void>

---

rotate()

rotate(direction, zoom?): Promise<void>;

Rotate one step in direction. zoom is the optical/digital zoom factor (default 1.0).

Parameters

direction

PtzDirection

zoom?

number

Returns

Promise<void>

---

up()

up(): Promise<void>;

Tilt one step up.

Returns

Promise<void>

---

zoom()?

optional zoom(dstZoom, region?): Promise<void>;

Set the digital zoom to dstZoom. Pass a ZoomRegion to crop to a window (default centred). Zoom is a dual-lens feature — this method is present only on cameras that have a second (telephoto) lens; it is undefined on single-lens PT cams, so call it with ?..

Parameters

dstZoom

number

region?

ZoomRegion

Returns

Promise<void>