eufy-mega / model/capabilities / AudioActions

Type Alias: AudioActions

type AudioActions = object;

Bound audio controls — the object returned by dev.audio(). Which methods are present depends on the device family (call with ?.): a camera/doorbell gets setMicrophone/setSpeaker/ setVolume (+ setRingtoneVolume on a doorbell); a HomeBase/station gets setAlarmVolume (+ setPromptVolume). One capability, all audio/volume controls, family-gated.

Properties

alarmTone?

readonly optional alarmTone?: number;

HomeBase alarm tone index (property hubAlarmTone).

---

audioRecording?

readonly optional audioRecording?: boolean;

Whether audio is recorded with video (property audioRecording).

---

microphone?

readonly optional microphone?: boolean;

Whether the microphone is enabled (property microphone).

---

setAlarmTone?

optional setAlarmTone?: (tone) => Promise<void>;

Set the HomeBase alarm tone (which siren sound plays) — an enum index matching the app's tone picker, see HubAlarmTone. HomeBase family only.

Parameters

tone

number

Returns

Promise<void>

---

setAlarmVolume?

optional setAlarmVolume?: (n) => Promise<void>;

Set the HomeBase alarm/speaker volume, 0–100. HomeBase family only (not NVRs).

Parameters

n

number

Returns

Promise<void>

---

setAudioRecording?

optional setAudioRecording?: (on) => Promise<void>;

Enable/disable recording audio with video. Camera/doorbell.

Parameters

on

boolean

Returns

Promise<void>

---

setMicrophone?

optional setMicrophone?: (on) => Promise<void>;

Enable/disable the microphone (device → app audio). Camera/doorbell.

Parameters

on

boolean

Returns

Promise<void>

---

setPromptVolume?

optional setPromptVolume?: (n) => Promise<void>;

Set the HomeBase voice-prompt volume, 0–100. HomeBase family only (not NVRs).

Parameters

n

number

Returns

Promise<void>

---

setRingtoneVolume?

optional setRingtoneVolume?: (n) => Promise<void>;

Set the doorbell ring/chime volume, 0–100. Doorbell only.

Parameters

n

number

Returns

Promise<void>

---

setSpeaker?

optional setSpeaker?: (on) => Promise<void>;

Enable/disable the speaker (app → device audio). Camera/doorbell.

Parameters

on

boolean

Returns

Promise<void>

---

setVolume?

optional setVolume?: (n) => Promise<void>;

Set speaker volume, 0–100. Camera/doorbell.

Parameters

n

number

Returns

Promise<void>

---

speaker?

readonly optional speaker?: boolean;

Whether the speaker is enabled (property speaker).

---

volume?

readonly optional volume?: number;

Speaker volume 0-100 (property speakerVolume).