ring-client-api 9.22.1 → 9.25.0-beta.1

package/CHANGELOG.md

@@ -2,6 +2,49 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [9.25.0-beta.1](https://github.com/dgreif/ring/compare/v9.25.0-beta.0...v9.25.0-beta.1) (2022-02-14)
+
+
+### Features
+
+* use new WebRTC endpoint for live calls ([6e7779f](https://github.com/dgreif/ring/commit/6e7779feef9789583921fc44bab32c099f3026d2))
+
+## [9.25.0-beta.0](https://github.com/dgreif/ring/compare/v9.24.0...v9.25.0-beta.0) (2022-01-29)
+
+
+### Features
+
+* **api:** decouple ffmpeg prep from execution ([#859](https://github.com/dgreif/ring/issues/859)) ([e3cc9d1](https://github.com/dgreif/ring/commit/e3cc9d15584377bf2be94a9d457efc3dfcb4bd8b))
+* handle new camera types with no battery ([11ae286](https://github.com/dgreif/ring/commit/11ae28697d8cb0e2da71e880c82e1883f04047b9))
+* slightly faster snapshots via new endpoint ([b840471](https://github.com/dgreif/ring/commit/b840471bc6b7b66e5873370251bd57c1a35b267a))
+
+## [9.24.0](https://github.com/dgreif/ring/compare/v9.23.0...v9.24.0) (2022-01-22)
+
+
+### Features
+
+* support glassbreak sensor ([98271f9](https://github.com/dgreif/ring/commit/98271f91f13aaae051fccaab7165cd17f2a2377c))
+
+
+### Bug Fixes
+
+* allow process to exit when RingApi.disconnect() is called ([#851](https://github.com/dgreif/ring/issues/851)) ([8ef25ac](https://github.com/dgreif/ring/commit/8ef25acca66c533873b7fd43c7c899e34b4a7617))
+* avoid error when ring terminates video stream ([7717d5e](https://github.com/dgreif/ring/commit/7717d5eaa40afed3d34f0e8e6eea1402e21afef7)), closes [#853](https://github.com/dgreif/ring/issues/853)
+* update dependencies ([c80d052](https://github.com/dgreif/ring/commit/c80d052f9eaf4c0a50a495166177daa40299ffa7))
+
+## [9.23.0](https://github.com/dgreif/ring/compare/v9.22.1...v9.23.0) (2021-10-17)
+
+
+### Features
+
+* **homebridge:** config option to hide camera lights ([58be17c](https://github.com/dgreif/ring/commit/58be17cfee524bfb158566e59d60438e9b6f0f5d)), closes [#802](https://github.com/dgreif/ring/issues/802)
+* **homebridge:** option to treat "knock" as a ding ([7ece8b2](https://github.com/dgreif/ring/commit/7ece8b25314ef403a6c2bab6a28476a3b7229507)), closes [#514](https://github.com/dgreif/ring/issues/514)
+
+
+### Bug Fixes
+
+* update dependencies ([b685e27](https://github.com/dgreif/ring/commit/b685e27e952a94635a277848821ebfa640d50ee2))
+
 ### [9.22.1](https://github.com/dgreif/ring/compare/v9.22.0...v9.22.1) (2021-10-13)
 
 

package/README.md

@@ -45,6 +45,7 @@ Option | Default | Explanation
 `ffmpegPath` | Uses `ffmpeg-for-homebridge` | A custom path to the `ffmpeg` executable.  By default, the static binaries built in [ffmpeg-for-homebridge](https://github.com/oznu/ffmpeg-for-homebridg) will be used.  If you prefer to use your own version of ffmpeg, you can pass a complete path, or simply `"ffmpeg"` to use ffmpeg from your `PATH`.
 `controlCenterDisplayName` | 'ring-client-api' | This allows you to change the displayed name for the Authorized Device within Control Center in the Ring app
 `avoidSnapshotBatteryDrain` | false | Causes snapshots for battery cameras to be fetched at a minimum 10 minute interval to avoid draining the battery.
+`treatKnockAsDing` | false | Will cause "knock" (`door_activity`) dings to be emitted from `onDoorbellPressed`
 
 ## Locations
 ```typescript
@@ -108,7 +109,7 @@ Camera also includes the following observables:
 * `onDoorbellPressed`: emits a ding every time the doorbell is pressed
 * `onMotionDetected`: `true` or `false` based on `onActiveDings` containing a motion ding
 
-Some other useful propeties
+Some other useful properties
 * `id`
 * `name`: same as `description` from `data`
 * `hasLight`: does this camera have a light

package/lib/api/api.d.ts

@@ -9,6 +9,7 @@ export interface RingApiOptions extends SessionOptions {
     cameraDingsPollingSeconds?: number;
     locationModePollingSeconds?: number;
     avoidSnapshotBatteryDrain?: boolean;
+    treatKnockAsDing?: boolean;
     debug?: boolean;
     ffmpegPath?: string;
     externalPorts?: {

package/lib/api/api.js

@@ -24,7 +24,8 @@ class RingApi extends subscribed_1.Subscribed {
         super();
         this.options = options;
         this.restClient = new rest_client_1.RingRestClient(this.options);
-        this.onRefreshTokenUpdated = this.restClient.onRefreshTokenUpdated.asObservable();
+        this.onRefreshTokenUpdated =
+            this.restClient.onRefreshTokenUpdated.asObservable();
         if (options.debug) {
             (0, util_1.enableDebug)();
         }
@@ -128,7 +129,7 @@ class RingApi extends subscribed_1.Subscribed {
         return __awaiter(this, void 0, void 0, function* () {
             const rawLocations = yield this.fetchRawLocations(), { authorizedDoorbots, chimes, doorbots, allCameras, baseStations, beamBridges, } = yield this.fetchRingDevices(), locationIdsWithHubs = [...baseStations, ...beamBridges].map((x) => x.location_id), cameras = allCameras.map((data) => new ring_camera_1.RingCamera(data, doorbots.includes(data) ||
                 authorizedDoorbots.includes(data) ||
-                data.kind.startsWith('doorbell'), this.restClient, this.options.avoidSnapshotBatteryDrain || false)), ringChimes = chimes.map((data) => new ring_chime_1.RingChime(data, this.restClient)), locations = rawLocations
+                data.kind.startsWith('doorbell'), this.restClient, this.options.avoidSnapshotBatteryDrain || false, this.options.treatKnockAsDing || false)), ringChimes = chimes.map((data) => new ring_chime_1.RingChime(data, this.restClient)), locations = rawLocations
                 .filter((location) => {
                 return (!Array.isArray(this.options.locationIds) ||
                     this.options.locationIds.includes(location.location_id));
@@ -169,6 +170,7 @@ class RingApi extends subscribed_1.Subscribed {
             .catch((e) => {
             (0, util_1.logError)(e);
         });
+        this.restClient.clearTimeouts();
     }
 }
 exports.RingApi = RingApi;

package/lib/api/live-call.d.ts

@@ -0,0 +1,41 @@
+import { ReplaySubject } from 'rxjs';
+import { RingCamera } from './ring-camera';
+import { Subscribed } from './subscribed';
+import { RtpPacket } from '@koush/werift';
+declare type SpawnInput = string | number;
+export interface FfmpegOptions {
+    input?: SpawnInput[];
+    video?: SpawnInput[] | false;
+    audio?: SpawnInput[];
+    output: SpawnInput[];
+}
+export declare class LiveCall extends Subscribed {
+    private sessionId;
+    private camera;
+    private readonly ws;
+    private readonly onWsOpen;
+    private readonly onMessage;
+    private readonly pc;
+    readonly onCallAnswered: ReplaySubject<void>;
+    readonly onCallEnded: ReplaySubject<void>;
+    private readonly audioSplitter;
+    private readonly videoSplitter;
+    readonly onVideoRtp: import("rxjs").Subject<RtpPacket>;
+    readonly onAudioRtp: import("rxjs").Subject<RtpPacket>;
+    constructor(sessionId: string, camera: RingCamera);
+    private handleMessage;
+    reservePort(bufferPorts?: number): Promise<number>;
+    prepareTranscoder(transcodeVideoStream: boolean, ffmpegInputOptions: SpawnInput[] | undefined, audioPort: number, videoPort: number, sdpInput: string): {
+        ffmpegInputArguments: SpawnInput[];
+        inputSdpLines: string[];
+    };
+    startTranscoding(ffmpegOptions: FfmpegOptions): Promise<void>;
+    activated: boolean;
+    activate(): Promise<void>;
+    activateCameraSpeaker(): Promise<void>;
+    private sendMessage;
+    private callEnded;
+    stop(): void;
+    sendAudioPacket(rtp: RtpPacket): void;
+}
+export {};

package/lib/api/live-call.js

@@ -0,0 +1,201 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiveCall = void 0;
+const rtp_utils_1 = require("./rtp-utils");
+const ws_1 = require("ws");
+const rxjs_1 = require("rxjs");
+const peer_connection_1 = require("./peer-connection");
+const util_1 = require("./util");
+const operators_1 = require("rxjs/operators");
+const subscribed_1 = require("./subscribed");
+const camera_utils_1 = require("@homebridge/camera-utils");
+const ffmpeg_1 = require("./ffmpeg");
+class LiveCall extends subscribed_1.Subscribed {
+    constructor(sessionId, camera) {
+        super();
+        this.sessionId = sessionId;
+        this.camera = camera;
+        this.onCallAnswered = new rxjs_1.ReplaySubject(1);
+        this.onCallEnded = new rxjs_1.ReplaySubject(1);
+        this.audioSplitter = new camera_utils_1.RtpSplitter();
+        this.videoSplitter = new camera_utils_1.RtpSplitter();
+        this.activated = false;
+        const liveCallSession = (0, rtp_utils_1.parseLiveCallSession)(sessionId);
+        this.pc = new peer_connection_1.PeerConnection();
+        this.ws = new ws_1.WebSocket(`wss://${liveCallSession.rms_fqdn}:${liveCallSession.webrtc_port}/`, {
+            headers: {
+                API_VERSION: '3.1',
+                API_TOKEN: sessionId,
+                CLIENT_INFO: 'Ring/3.48.0;Platform/Android;OS/7.0;Density/2.0;Device/samsung-SM-T710;Locale/en-US;TimeZone/GMT-07:00',
+            },
+        });
+        this.onAudioRtp = this.pc.onAudioRtp;
+        this.onVideoRtp = this.pc.onVideoRtp;
+        this.onMessage = (0, rxjs_1.fromEvent)(this.ws, 'message');
+        this.onWsOpen = (0, rxjs_1.fromEvent)(this.ws, 'open');
+        const onError = (0, rxjs_1.fromEvent)(this.ws, 'error'), onClose = (0, rxjs_1.fromEvent)(this.ws, 'close');
+        this.addSubscriptions(this.onMessage
+            .pipe((0, operators_1.concatMap)((message) => {
+            return this.handleMessage(JSON.parse(message.data));
+        }))
+            .subscribe(), this.onWsOpen.subscribe(() => {
+            (0, util_1.logDebug)(`WebSocket connected for ${this.camera.name}`);
+        }), onError.subscribe((e) => {
+            (0, util_1.logError)(e);
+            this.callEnded();
+        }), onClose.subscribe(() => {
+            this.callEnded();
+        }));
+    }
+    handleMessage(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            switch (message.method) {
+                case 'sdp':
+                    const answer = yield this.pc.createAnswer(message);
+                    this.sendMessage(Object.assign({ method: 'sdp' }, answer));
+                    this.onCallAnswered.next();
+                    return;
+                case 'ice':
+                    yield this.pc.addIceCandidate({
+                        candidate: message.ice,
+                        sdpMLineIndex: message.mlineindex,
+                    });
+                    return;
+            }
+        });
+    }
+    reservePort(bufferPorts = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const ports = yield (0, camera_utils_1.reservePorts)({ count: bufferPorts + 1 });
+            return ports[0];
+        });
+    }
+    prepareTranscoder(transcodeVideoStream, ffmpegInputOptions, audioPort, videoPort, sdpInput) {
+        const ffmpegInputArguments = [
+            '-hide_banner',
+            '-protocol_whitelist',
+            'pipe,udp,rtp,file,crypto',
+            '-acodec',
+            'libopus',
+            '-f',
+            'sdp',
+            ...(ffmpegInputOptions || []),
+            '-i',
+            sdpInput,
+        ], inputSdpLines = [
+            'v=0',
+            'o=105202070 3747 461 IN IP4 127.0.0.1',
+            's=Talk',
+            'c=IN IP4 127.0.0.1',
+            'b=AS:380',
+            't=0 0',
+            'a=rtcp-xr:rcvr-rtt=all:10000 stat-summary=loss,dup,jitt,TTL voip-metrics',
+            `m=audio ${audioPort} RTP/SAVP 101`,
+            'a=rtpmap:101 OPUS/48000/2',
+            'a=rtcp-fb:101 nack pli',
+            'a=fmtp:101 useinbandfec=1;sprop-stereo=0',
+            'a=rtcp-mux',
+        ];
+        if (transcodeVideoStream) {
+            inputSdpLines.push(`m=video ${videoPort} RTP/SAVP 96`, 'a=rtpmap:96 H264/90000', 'a=rtcp-fb:96 nack', 'a=rtcp-fb:96 nack pli', 'a=fmtp:96 packetization-mode=1;profile-level-id=640029;level-asymmetry-allowed=1', 'a=rtcp-mux');
+            this.addSubscriptions(this.onVideoRtp
+                .pipe((0, operators_1.concatMap)((rtp) => {
+                return this.videoSplitter.send(rtp.serialize(), {
+                    port: videoPort,
+                });
+            }))
+                .subscribe());
+        }
+        this.addSubscriptions(this.onAudioRtp
+            .pipe((0, operators_1.concatMap)((rtp) => {
+            return this.audioSplitter.send(rtp.serialize(), {
+                port: audioPort,
+            });
+        }))
+            .subscribe());
+        return {
+            ffmpegInputArguments,
+            inputSdpLines,
+        };
+    }
+    startTranscoding(ffmpegOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const videoPort = yield this.reservePort(1), audioPort = yield this.reservePort(1), transcodeVideoStream = ffmpegOptions.video !== false, { ffmpegInputArguments, inputSdpLines } = this.prepareTranscoder(transcodeVideoStream, ffmpegOptions.input, audioPort, videoPort, 'pipe:'), ff = new camera_utils_1.FfmpegProcess({
+                ffmpegArgs: ffmpegInputArguments.concat(...(ffmpegOptions.audio || ['-acodec', 'aac']), ...(transcodeVideoStream
+                    ? ffmpegOptions.video || ['-vcodec', 'copy']
+                    : []), ...(ffmpegOptions.output || [])),
+                ffmpegPath: (0, ffmpeg_1.getFfmpegPath)(),
+                exitCallback: () => this.callEnded(),
+                logLabel: `From Ring (${this.camera.name})`,
+                logger: {
+                    error: util_1.logError,
+                    info: util_1.logDebug,
+                },
+            });
+            this.onCallEnded.subscribe(() => ff.stop());
+            ff.writeStdin(inputSdpLines.filter((x) => Boolean(x)).join('\n'));
+            // Activate the stream now that ffmpeg is ready to receive
+            yield this.activate();
+        });
+    }
+    activate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.activated) {
+                return;
+            }
+            this.activated = true;
+            yield (0, rxjs_1.firstValueFrom)(this.onCallAnswered);
+            this.sendMessage({ method: 'activate_session' });
+            this.sendMessage({
+                video_enabled: true,
+                audio_enabled: true,
+                method: 'stream_options',
+            });
+        });
+    }
+    activateCameraSpeaker() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, rxjs_1.firstValueFrom)(this.onCallAnswered);
+            this.sendMessage({
+                stealth_mode: false,
+                method: 'camera_options',
+            });
+        });
+    }
+    sendMessage(message) {
+        this.ws.send(JSON.stringify(message));
+    }
+    callEnded() {
+        try {
+            this.sendMessage({
+                reason: { code: 0, text: '' },
+                method: 'close',
+            });
+            this.ws.close();
+        }
+        catch (_) {
+            // ignore any errors since we are stopping the call
+        }
+        this.unsubscribe();
+        this.onCallEnded.next();
+        this.pc.close();
+        this.audioSplitter.close();
+        this.videoSplitter.close();
+    }
+    stop() {
+        this.callEnded();
+    }
+    sendAudioPacket(rtp) {
+        this.pc.returnAudioTrack.writeRtp(rtp);
+    }
+}
+exports.LiveCall = LiveCall;

package/lib/api/peer-connection.d.ts

@@ -0,0 +1,17 @@
+import { MediaStreamTrack, RTCIceCandidate, RTCPeerConnection, RtcpPacket, RtpPacket } from '@koush/werift';
+import { Subject } from 'rxjs';
+export declare class PeerConnection {
+    pc: RTCPeerConnection;
+    onAudioRtp: Subject<RtpPacket>;
+    onAudioRtcp: Subject<RtcpPacket>;
+    onVideoRtp: Subject<RtpPacket>;
+    onVideoRtcp: Subject<RtcpPacket>;
+    returnAudioTrack: MediaStreamTrack;
+    constructor();
+    createAnswer(offer: {
+        type: 'offer';
+        sdp: string;
+    }): Promise<import("@koush/werift").RTCSessionDescription>;
+    addIceCandidate(candidate: RTCIceCandidate): Promise<void>;
+    close(): void;
+}

package/lib/api/peer-connection.js

@@ -0,0 +1,96 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PeerConnection = void 0;
+const werift_1 = require("@koush/werift");
+const rxjs_1 = require("rxjs");
+const util_1 = require("./util");
+const debug = false;
+class PeerConnection {
+    constructor() {
+        this.onAudioRtp = new rxjs_1.Subject();
+        this.onAudioRtcp = new rxjs_1.Subject();
+        this.onVideoRtp = new rxjs_1.Subject();
+        this.onVideoRtcp = new rxjs_1.Subject();
+        this.returnAudioTrack = new werift_1.MediaStreamTrack({ kind: 'audio' });
+        const pc = (this.pc = new werift_1.RTCPeerConnection({
+            codecs: {
+                audio: [
+                    new werift_1.RTCRtpCodecParameters({
+                        mimeType: 'audio/opus',
+                        clockRate: 48000,
+                        channels: 2,
+                    }),
+                ],
+                video: [
+                    new werift_1.RTCRtpCodecParameters({
+                        mimeType: 'video/H264',
+                        clockRate: 90000,
+                        rtcpFeedback: [
+                            { type: 'transport-cc' },
+                            { type: 'ccm', parameter: 'fir' },
+                            { type: 'nack' },
+                            { type: 'nack', parameter: 'pli' },
+                            { type: 'goog-remb' },
+                        ],
+                        parameters: 'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=42e01f',
+                    }),
+                ],
+            },
+        })), audioTransceiver = pc.addTransceiver(this.returnAudioTrack, {
+            direction: 'sendrecv',
+        }), videoTransceiver = pc.addTransceiver('video', {
+            direction: 'recvonly',
+        });
+        audioTransceiver.onTrack.subscribe((track) => {
+            track.onReceiveRtp.subscribe((rtp) => {
+                this.onAudioRtp.next(rtp);
+            });
+            track.onReceiveRtcp.subscribe((rtcp) => {
+                this.onAudioRtcp.next(rtcp);
+            });
+            if (debug) {
+                track.onReceiveRtp.once(() => {
+                    (0, util_1.logInfo)('received first audio packet');
+                });
+            }
+        });
+        videoTransceiver.onTrack.subscribe((track) => {
+            track.onReceiveRtp.subscribe((rtp) => {
+                this.onVideoRtp.next(rtp);
+            });
+            track.onReceiveRtcp.subscribe((rtcp) => {
+                this.onVideoRtcp.next(rtcp);
+            });
+            track.onReceiveRtp.once(() => {
+                if (debug) {
+                    (0, util_1.logInfo)('received first video packet');
+                }
+                setInterval(() => videoTransceiver.receiver.sendRtcpPLI(track.ssrc), 2000);
+            });
+        });
+    }
+    createAnswer(offer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.pc.setRemoteDescription(offer);
+            const answer = yield this.pc.createAnswer();
+            yield this.pc.setLocalDescription(answer);
+            return answer;
+        });
+    }
+    addIceCandidate(candidate) {
+        return this.pc.addIceCandidate(candidate);
+    }
+    close() {
+        this.pc.close().catch(util_1.logError);
+    }
+}
+exports.PeerConnection = PeerConnection;

package/lib/api/rest-client.d.ts

@@ -6,6 +6,7 @@ export declare function deviceApi(path: string): string;
 export declare function appApi(path: string): string;
 export interface ExtendedResponse {
     responseTimestamp: number;
+    timeMillis: number;
 }
 export interface EmailAuth {
     email: string;
@@ -24,6 +25,7 @@ export declare class RingRestClient {
     refreshToken: string | undefined;
     private hardwareIdPromise;
     private _authPromise;
+    private timeouts;
     private clearPreviousAuth;
     private get authPromise();
     private sessionPromise?;
@@ -44,4 +46,5 @@ export declare class RingRestClient {
         url: string;
     }): Promise<T & ExtendedResponse>;
     getCurrentAuth(): Promise<AuthTokenResponse>;
+    clearTimeouts(): void;
 }

package/lib/api/rest-client.js

@@ -44,8 +44,13 @@ function requestWithRetry(requestOptions) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const options = Object.assign(Object.assign({}, defaultRequestOptions), requestOptions), { headers, body } = (yield (0, got_1.default)(options)), data = body;
-            if (data !== null && typeof data === 'object' && headers.date) {
-                data.responseTimestamp = new Date(headers.date).getTime();
+            if (data !== null && typeof data === 'object') {
+                if (headers.date) {
+                    data.responseTimestamp = new Date(headers.date).getTime();
+                }
+                if (headers['x-time-millis']) {
+                    data.timeMillis = Number(headers['x-time-millis']);
+                }
             }
             return data;
         }
@@ -66,12 +71,15 @@ function requestWithRetry(requestOptions) {
 class RingRestClient {
     constructor(authOptions) {
         this.authOptions = authOptions;
-        // prettier-ignore
-        this.refreshToken = ('refreshToken' in this.authOptions ? this.authOptions.refreshToken : undefined);
-        this.hardwareIdPromise = (0, util_1.getHardwareId)(this.authOptions.systemId);
+        this.timeouts = [];
         this.sessionPromise = undefined;
         this.using2fa = false;
         this.onRefreshTokenUpdated = new rxjs_1.ReplaySubject(1);
+        this.refreshToken =
+            'refreshToken' in this.authOptions
+                ? this.authOptions.refreshToken
+                : undefined;
+        this.hardwareIdPromise = (0, util_1.getHardwareId)(this.authOptions.systemId);
     }
     clearPreviousAuth() {
         this._authPromise = undefined;
@@ -83,11 +91,12 @@ class RingRestClient {
             authPromise
                 .then(({ expires_in }) => {
                 // clear the existing auth promise 1 minute before it expires
-                setTimeout(() => {
+                const timeout = setTimeout(() => {
                     if (this._authPromise === authPromise) {
                         this.clearPreviousAuth();
                     }
                 }, ((expires_in || 3600) - 60) * 1000);
+                this.timeouts.push(timeout);
             })
                 .catch(() => {
                 // ignore these errors here, they should be handled by the function making a rest request
@@ -288,5 +297,8 @@ class RingRestClient {
     getCurrentAuth() {
         return this.authPromise;
     }
+    clearTimeouts() {
+        this.timeouts.forEach(clearTimeout);
+    }
 }
 exports.RingRestClient = RingRestClient;

package/lib/api/ring-camera.d.ts

@@ -7,6 +7,7 @@ import { DeepPartial } from './util';
 import { FfmpegOptions, SipSession } from './sip-session';
 import { SipOptions } from './sip-call';
 import { Subscribed } from './subscribed';
+import { LiveCall } from './live-call';
 export declare function getBatteryLevel(data: Pick<CameraData, 'battery_life' | 'battery_life_2'>): number | null;
 export declare function getSearchQueryString(options: CameraEventOptions | (HistoryOptions & {
     accountId: string;
@@ -16,13 +17,13 @@ export declare class RingCamera extends Subscribed {
     isDoorbot: boolean;
     private restClient;
     private avoidSnapshotBatteryDrain;
+    private treatKnockAsDing;
     id: number;
     deviceType: import("./ring-types").RingCameraKind;
     model: string;
     onData: BehaviorSubject<CameraData>;
     hasLight: boolean;
     hasSiren: boolean;
-    hasBattery: boolean;
     onRequestUpdate: Subject<unknown>;
     onRequestActiveDings: Subject<unknown>;
     onNewDing: Subject<ActiveDing>;
@@ -32,13 +33,14 @@ export declare class RingCamera extends Subscribed {
     onMotionStarted: import("rxjs").Observable<null>;
     onBatteryLevel: import("rxjs").Observable<number | null>;
     onInHomeDoorbellStatus: import("rxjs").Observable<boolean>;
-    constructor(initialData: CameraData, isDoorbot: boolean, restClient: RingRestClient, avoidSnapshotBatteryDrain: boolean);
+    constructor(initialData: CameraData, isDoorbot: boolean, restClient: RingRestClient, avoidSnapshotBatteryDrain: boolean, treatKnockAsDing: boolean);
     updateData(update: CameraData): void;
     requestUpdate(): void;
     get data(): CameraData;
     get name(): string;
     get activeDings(): ActiveDing[];
     get batteryLevel(): number | null;
+    get hasBattery(): boolean;
     get hasLowBattery(): boolean;
     get isCharging(): boolean;
     get operatingOnBattery(): boolean;
@@ -53,6 +55,7 @@ export declare class RingCamera extends Subscribed {
     getDeviceSettings(): Promise<CameraDeviceSettingsData & import("./rest-client").ExtendedResponse>;
     setInHomeDoorbell(enable: boolean): Promise<boolean>;
     getHealth(): Promise<CameraHealth>;
+    startLiveCall(): Promise<LiveCall>;
     startVideoOnDemand(): Promise<("" | ActiveDing) & import("./rest-client").ExtendedResponse>;
     private pollForActiveDing;
     private expiredDingIds;
@@ -74,18 +77,21 @@ export declare class RingCamera extends Subscribed {
     }): Promise<string>;
     private isTimestampInLifeTime;
     get snapshotsAreBlocked(): boolean;
-    private getSnapshotTimestamp;
-    private refreshSnapshotInProgress?;
     get snapshotLifeTime(): number;
+    private lastSnapshotTimestamp;
     private lastSnapshotTimestampLocal;
     private lastSnapshotPromise?;
     get currentTimestampAge(): number;
-    get currentTimestampExpiresIn(): number;
     get hasSnapshotWithinLifetime(): boolean;
     private checkIfSnapshotsAreBlocked;
-    private requestSnapshotUpdate;
-    private refreshSnapshot;
-    getSnapshot(): Promise<Buffer | undefined>;
+    private shouldUseExistingSnapshotPromise;
+    private fetchingSnapshot;
+    getSnapshot(): Promise<Buffer>;
+    getNextSnapshot({ afterMs, maxWaitMs, force, }: {
+        afterMs?: number;
+        maxWaitMs?: number;
+        force?: boolean;
+    }): Promise<Buffer & import("./rest-client").ExtendedResponse>;
     getSipOptions(): Promise<SipOptions>;
     getUpdatedSipOptions(expiredDingId: string): Promise<SipOptions>;
     createSipSession(options?: {