@gibme/tablo.tv 20.0.0

package/dist/live_transcoder.js

@@ -0,0 +1,289 @@
+"use strict";
+// Copyright (c) 2025, Brandon Lehmann <brandonlehmann@gmail.com>
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiveTranscoder = void 0;
+const events_1 = require("events");
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const ffmpeg_static_1 = __importDefault(require("ffmpeg-static"));
+const which_1 = __importDefault(require("which"));
+const crypto_1 = require("crypto");
+const timer_1 = __importDefault(require("@gibme/timer"));
+class LiveTranscoder extends events_1.EventEmitter {
+    /**
+     * Creates a new live transcoder instance.
+     *
+     * The `output_path` must be a valid path to a directory on the local filesystem.
+     *
+     * The `channel_id` must be a valid channel ID for the specified `device`.
+     *
+     * The `device` must be a valid `Device` instance.
+     * @param id
+     * @param device
+     * @param channel_id
+     * @param output_path
+     * @param filename
+     * @param auto_restart
+     */
+    constructor(id, device, channel_id, output_path, filename = 'stream.m3u8', auto_restart = true) {
+        super();
+        this.id = id;
+        this.device = device;
+        this.channel_id = channel_id;
+        this.output_path = output_path;
+        this.filename = filename;
+        this.auto_restart = auto_restart;
+        this.ffmpeg_path = ffmpeg_static_1.default !== null && ffmpeg_static_1.default !== void 0 ? ffmpeg_static_1.default : which_1.default.sync('ffmpeg');
+        this.emitter = new events_1.EventEmitter();
+        this._use_count = 0;
+        this._active = false;
+        this._full_path = '';
+        this.emitter.on('abort', () => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            if (this.process) {
+                (_a = this.process.stdin) === null || _a === void 0 ? void 0 : _a.write('q', error => {
+                    if (error) {
+                        this.emit('error', error);
+                    }
+                });
+                try {
+                    if (!this.process.killed) {
+                        this.process.kill();
+                    }
+                }
+                catch (_c) {
+                }
+                delete this.process;
+                (_b = this.timer) === null || _b === void 0 ? void 0 : _b.destroy();
+                delete this.timer;
+                if (this.session) {
+                    yield this.device.deleteSession(this.session);
+                }
+                this.active = false;
+                this.emitter.emit('stopped');
+            }
+        }));
+        this.emitter.on('stopped', () => {
+            try {
+                const current_path = (0, path_1.resolve)(output_path, `./${this.id}`);
+                if ((0, fs_1.existsSync)(current_path)) {
+                    (0, fs_1.rmSync)(current_path, { recursive: true, force: true });
+                }
+            }
+            catch (_a) {
+            }
+            this.emit('stopped');
+        });
+        this.full_path = (0, path_1.resolve)(output_path, `./${this.id}`);
+        if ((0, fs_1.existsSync)(this.full_path)) {
+            (0, fs_1.rmSync)(this.full_path, { recursive: true, force: true });
+        }
+        (0, fs_1.mkdirSync)(this.full_path, { recursive: true });
+        this.full_path = (0, path_1.resolve)(this.full_path, `./${this.filename}`);
+    }
+    get use_count() {
+        return this._use_count;
+    }
+    get active() {
+        return this._active;
+    }
+    set active(active) {
+        this._active = active;
+    }
+    get full_path() {
+        return this._full_path;
+    }
+    set full_path(path) {
+        this._full_path = path;
+    }
+    get session() {
+        return this._session;
+    }
+    set session(session) {
+        this._session = session;
+    }
+    get channel() {
+        var _a;
+        return (_a = this.session) === null || _a === void 0 ? void 0 : _a.channel;
+    }
+    get relative_path() {
+        if (this.id) {
+            return `${this.output_path}/${this.id}/${this.filename}`
+                .replace('//', '/');
+        }
+        else {
+            return '';
+        }
+    }
+    /**
+     * Retrieves an existing instance of a live transcoder or creates a new instance if one does not exist.
+     *
+     * The `device` must be a valid `Device` instance.
+     *
+     * The `channel_id` must be a valid channel ID for the specified `device`.
+     *
+     * The `output_path` must be a valid path to a directory on the local filesystem.
+     *
+     * The `filename` is the name of the output file.
+     *
+     * @param device
+     * @param channel_id
+     * @param output_path
+     * @param filename
+     * @param auto_restart
+     */
+    static instance(device_1, channel_id_1, output_path_1) {
+        return __awaiter(this, arguments, void 0, function* (device, channel_id, output_path, filename = 'stream.m3u8', auto_restart = true) {
+            const info = yield device.info();
+            if (!info) {
+                throw new Error('Failed to retrieve device information');
+            }
+            const id = (0, crypto_1.createHash)('sha256')
+                .update(JSON.stringify({ server_id: info.server_id, channel_id }))
+                .digest('hex');
+            let instance = this.instances.get(id);
+            if (!instance) {
+                instance = new LiveTranscoder(id, device, channel_id, output_path, filename, auto_restart);
+                this.instances.set(id, instance);
+            }
+            return instance;
+        });
+    }
+    on(event, listener) {
+        return super.on(event, listener);
+    }
+    once(event, listener) {
+        return super.once(event, listener);
+    }
+    off(event, listener) {
+        return super.off(event, listener);
+    }
+    /**
+     * Starts the live transcoder.
+     *
+     * The live transcoder will attempt to start a new session for the specified `channel_id` on the specified `device`.
+     *
+     * If a session is successfully started, the live transcoder will attempt to start a new transcoding process.
+     */
+    start() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.active) {
+                this._use_count++;
+                this.emit('ready');
+                return true;
+            }
+            this.session = yield this.device.watchChannel(this.channel_id);
+            if (!this.session) {
+                this.emit('error', new Error('Failed to start session'));
+                return false;
+            }
+            this.timer = new timer_1.default((this.session.keepalive - 30) * 1000);
+            this.timer.on('tick', () => __awaiter(this, void 0, void 0, function* () {
+                if (this.session) {
+                    yield this.device.keepaliveSession(this.session);
+                }
+            }));
+            this._use_count++;
+            const started = this.start_ffmpeg();
+            if (started) {
+                const check = () => setTimeout(() => {
+                    if ((0, fs_1.existsSync)(this.full_path)) {
+                        this.active = true;
+                        this.emit('ready');
+                    }
+                    else {
+                        check();
+                    }
+                }, 100);
+                check();
+            }
+            return started;
+        });
+    }
+    /**
+     * Stops the live transcoder.
+     */
+    stop() {
+        this._use_count--;
+        if (this.active && this.use_count <= 0) {
+            this.emitter.emit('abort');
+        }
+    }
+    /**
+     * Attempts to start the FFMpeg process
+     * @private
+     */
+    start_ffmpeg() {
+        if (!this.session) {
+            return false;
+        }
+        const args = ['-re', '-i', `${this.session.playlist_url}`,
+            '-c:v', 'libx264', '-preset', 'veryfast', '-tune',
+            'zerolatency', '-crf', '23', '-g', '48',
+            '-keyint_min', '48', '-sc_threshold', '0', '-ac',
+            '2', '-c:a', 'aac', '-b:a', '128k',
+            '-f', 'hls', '-hls_time', '4', '-hls_list_size',
+            '6', '-hls_flags', 'delete_segments+program_date_time+append_list',
+            this.full_path];
+        this.process = (0, child_process_1.spawn)(this.ffmpeg_path, args, {
+            detached: false,
+            shell: false,
+            windowsHide: false,
+            stdio: ['pipe', 'ignore', 'ignore']
+        });
+        this.process.on('error', error => {
+            this.emit('error', error);
+            if (!this.auto_restart) {
+                this.emitter.emit('abort');
+            }
+            else {
+                this.start_ffmpeg();
+            }
+        });
+        this.process.on('exit', code => {
+            this.emit('exit', code);
+            if (!this.auto_restart) {
+                this.emitter.emit('abort');
+            }
+            else {
+                this.start_ffmpeg();
+            }
+        });
+        return true;
+    }
+}
+exports.LiveTranscoder = LiveTranscoder;
+LiveTranscoder.instances = new Map();
+exports.default = LiveTranscoder;
+//# sourceMappingURL=live_transcoder.js.map

package/dist/live_transcoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"live_transcoder.js","sourceRoot":"","sources":["../src/live_transcoder.ts"],"names":[],"mappings":";AAAA,iEAAiE;AACjE,EAAE;AACF,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,4EAA4E;AAC5E,wEAAwE;AACxE,2DAA2D;AAC3D,EAAE;AACF,iFAAiF;AACjF,kDAAkD;AAClD,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,8EAA8E;AAC9E,yEAAyE;AACzE,gFAAgF;AAChF,gFAAgF;AAChF,YAAY;;;;;;;;;;;;;;;AAEZ,mCAAsC;AACtC,iDAAoD;AACpD,2BAAmD;AACnD,+BAA+B;AAC/B,kEAAmC;AACnC,kDAA0B;AAE1B,mCAAoC;AACpC,yDAAiC;AAEjC,MAAqB,cAAe,SAAQ,qBAAY;IAOpD;;;;;;;;;;;;;;OAcG;IACH,YACoB,EAAU,EACT,MAAa,EACb,UAAkB,EACnB,WAAmB,EACnB,WAAW,aAAa,EACxB,eAAe,IAAI;QAEnC,KAAK,EAAE,CAAC;QAPQ,OAAE,GAAF,EAAE,CAAQ;QACT,WAAM,GAAN,MAAM,CAAO;QACb,eAAU,GAAV,UAAU,CAAQ;QACnB,gBAAW,GAAX,WAAW,CAAQ;QACnB,aAAQ,GAAR,QAAQ,CAAgB;QACxB,iBAAY,GAAZ,YAAY,CAAO;QA1BtB,gBAAW,GAAG,uBAAM,aAAN,uBAAM,cAAN,uBAAM,GAAI,eAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAGtD,YAAO,GAAG,IAAI,qBAAY,EAAE,CAAC;QAkF7B,eAAU,GAAG,CAAC,CAAC;QAMf,YAAO,GAAG,KAAK,CAAC;QAUhB,eAAU,GAAW,EAAE,CAAC;QAvE5B,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAS,EAAE;;YAChC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,MAAA,IAAI,CAAC,OAAO,CAAC,KAAK,0CAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE;oBACnC,IAAI,KAAK,EAAE,CAAC;wBACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;oBAC9B,CAAC;gBACL,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC;oBACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;wBACvB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;oBACxB,CAAC;gBACL,CAAC;gBAAC,WAAM,CAAC;gBACT,CAAC;gBAED,OAAO,IAAI,CAAC,OAAO,CAAC;gBAEpB,MAAA,IAAI,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC;gBAEtB,OAAO,IAAI,CAAC,KAAK,CAAC;gBAElB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBACf,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAClD,CAAC;gBAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;gBAEpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACjC,CAAC;QACL,CAAC,CAAA,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAC5B,IAAI,CAAC;gBACD,MAAM,YAAY,GAAG,IAAA,cAAO,EAAC,WAAW,EAAE,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;gBAE1D,IAAI,IAAA,eAAU,EAAC,YAAY,CAAC,EAAE,CAAC;oBAC3B,IAAA,WAAM,EAAC,YAAY,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC3D,CAAC;YACL,CAAC;YAAC,WAAM,CAAC;YACT,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,GAAG,IAAA,cAAO,EAAC,WAAW,EAAE,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAEtD,IAAI,IAAA,eAAU,EAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,IAAA,WAAM,EAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,CAAC;QAED,IAAA,cAAS,EAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/C,IAAI,CAAC,SAAS,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnE,CAAC;IAID,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAID,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,IAAY,MAAM,CAAE,MAAe;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAID,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,IAAY,SAAS,CAAE,IAAY;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IAC3B,CAAC;IAID,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED,IAAY,OAAO,CAAE,OAAwC;QACzD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC5B,CAAC;IAED,IAAW,OAAO;;QACd,OAAO,MAAA,IAAI,CAAC,OAAO,0CAAE,OAAO,CAAC;IACjC,CAAC;IAED,IAAW,aAAa;QACpB,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACV,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE;iBACnD,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACJ,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,MAAM,CAAO,QAAQ;6DACxB,MAAa,EACb,UAAkB,EAClB,WAAmB,EACnB,QAAQ,GAAG,aAAa,EACxB,YAAY,GAAG,IAAI;YAEnB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YAEjC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACR,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;YAC7D,CAAC;YAED,MAAM,EAAE,GAAG,IAAA,mBAAU,EAAC,QAAQ,CAAC;iBAC1B,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;iBACjE,MAAM,CAAC,KAAK,CAAC,CAAC;YAEnB,IAAI,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAEtC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,QAAQ,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;gBAE3F,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YACrC,CAAC;YAED,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAUM,EAAE,CAAE,KAAU,EAAE,QAAkC;QACrD,OAAO,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;IAUM,IAAI,CAAE,KAAU,EAAE,QAAkC;QACvD,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAUM,GAAG,CAAE,KAAU,EAAE,QAAkC;QACtD,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACU,KAAK;;YACd,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACd,IAAI,CAAC,UAAU,EAAE,CAAC;gBAElB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEnB,OAAO,IAAI,CAAC;YAChB,CAAC;YAED,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAE/D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC;gBAEzD,OAAO,KAAK,CAAC;YACjB,CAAC;YAED,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;YAE7D,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,GAAS,EAAE;gBAC7B,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBACf,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrD,CAAC;YACL,CAAC,CAAA,CAAC,CAAC;YAEH,IAAI,CAAC,UAAU,EAAE,CAAC;YAElB,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAEpC,IAAI,OAAO,EAAE,CAAC;gBACV,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE;oBAChC,IAAI,IAAA,eAAU,EAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;wBAEnB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACvB,CAAC;yBAAM,CAAC;wBACJ,KAAK,EAAE,CAAC;oBACZ,CAAC;gBACL,CAAC,EAAE,GAAG,CAAC,CAAC;gBAER,KAAK,EAAE,CAAC;YACZ,CAAC;YAED,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;IAED;;OAEG;IACI,IAAI;QACP,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,YAAY;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;YACrD,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO;YACjD,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;YACvC,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,EAAE,KAAK;YAChD,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM;YAClC,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,gBAAgB;YAC/C,GAAG,EAAE,YAAY,EAAE,+CAA+C;YAClE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEpB,IAAI,CAAC,OAAO,GAAG,IAAA,qBAAK,EAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE;YACzC,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;SACtC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;YAC7B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAE1B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,YAAY,EAAE,CAAC;YACxB,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAExB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,YAAY,EAAE,CAAC;YACxB,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;;AAGI,wCAAc;AAzUK,wBAAS,GAAG,IAAI,GAAG,EAA0B,AAApC,CAAqC;kBADrD,cAAc"}

package/dist/tablo.d.ts

@@ -0,0 +1,362 @@
+import TabloAPI from './tablo_api';
+import Lighthouse from './lighthouse';
+import type { Logo } from './types';
+/**
+ * See https://jessedp.github.io/tablo-api-docs/#tablo-api-introduction
+ * for an extensive list of device endpoints
+ *
+ * Note: this implementation is currently incomplete and is unlikely to have all endpoints implemented.
+ */
+export declare class Tablo extends TabloAPI {
+    private readonly cache;
+    private readonly session_channels;
+    /**
+     * Attempts to discover the Tablo devices on the network from which this API is made.
+     * @param timeout
+     */
+    static discover(timeout?: number): Promise<Lighthouse.Device[]>;
+    /**
+     * Returns the currently available airings
+     *
+     * Note: This method contains a loop that results in the method taking a bit of time to complete,
+     * you may specify a progress callback to help report the progress to the caller.
+     *
+     * Repeated calls to this method are cached for approximately 10 minutes.
+     *
+     * @param all if true, will return all airings, otherwise will only return airings that are currently playing.
+     * @param timeout
+     * @param force_refresh if set to true, will force a refresh of the cache.
+     * @param progress_callback
+     */
+    airings(all?: boolean, timeout?: number, force_refresh?: boolean, progress_callback?: (total: number, received: number) => void): Promise<Tablo.Airing[]>;
+    /**
+     * Retrieves account subscription information from the device
+     * @param timeout
+     */
+    accountSubscription(timeout?: number): Promise<Tablo.AccountSubscription | undefined>;
+    /**
+     * Retrieves the capabilities of the device.
+     * @param timeout
+     */
+    capabilities(timeout?: number): Promise<string[]>;
+    channel(channel_id: string, timeout?: number): Promise<Tablo.Channel | undefined>;
+    /**
+     * Returns a list of the available channels on the device.
+     * @param timeout
+     */
+    channels(timeout?: number): Promise<Tablo.Channel[]>;
+    /**
+     * Retrieves information regarding the latest (or a specified) channel scan.
+     *
+     * @param scan_idx if not specified, will pull the latest channel scan information
+     * @param timeout
+     */
+    channelScanInfo(scan_idx?: number | string, timeout?: number): Promise<Tablo.ChannelScan | undefined>;
+    /**
+     * Deletes/stops an existing watch (streaming) session
+     * @param tokenOrPlayerSession
+     * @param timeout
+     */
+    deleteSession(tokenOrPlayerSession: string | Tablo.PlayerSession, timeout?: number): Promise<boolean>;
+    /**
+     * Retrieves device subscription information.
+     * @param timeout
+     */
+    deviceSubscription(timeout?: number): Promise<Tablo.DeviceSubscription | undefined>;
+    /**
+     * Retrieves the guide status from the device
+     * @param timeout
+     */
+    guideStatus(timeout?: number): Promise<Tablo.GuideStatus | undefined>;
+    /**
+     * Retrieves a list of the hard drives connected to the device.
+     * @param timeout
+     */
+    hardDrives(timeout?: number): Promise<Tablo.HardDrive[]>;
+    /**
+     * Retrieves device information
+     * @param timeout
+     */
+    info(timeout?: number): Promise<Tablo.Info | undefined>;
+    /**
+     * Sends a watch (streaming) session keepalive request so that the session does not time out and stop
+     * @param tokenOrPlayerSession
+     * @param timeout
+     */
+    keepaliveSession(tokenOrPlayerSession: string | Tablo.PlayerSession, timeout?: number): Promise<Tablo.PlayerSession | undefined>;
+    /**
+     * Retrieves device location information
+     * @param timeout
+     */
+    location(timeout?: number): Promise<Tablo.Location | undefined>;
+    /**
+     * Attempts to retrieve an existing watch (streaming) session
+     * @param tokenOrPlayerSession
+     * @param timeout
+     */
+    session(tokenOrPlayerSession: string | Tablo.PlayerSession, timeout?: number): Promise<Tablo.PlayerSession | undefined>;
+    /**
+     * Retrieves the settings of the device.
+     * @param timeout
+     */
+    settings(timeout?: number): Promise<Tablo.Settings | undefined>;
+    /**
+     * Retrieves the list of supported storage types.
+     * @param timeout
+     */
+    storage(timeout?: number): Promise<string[]>;
+    /**
+     * Retrieves tuner information of the device.
+     * @param timeout
+     */
+    tuners(timeout?: number): Promise<Tablo.Tuner[]>;
+    /**
+     * Retrieves device update information.
+     * @param timeout
+     */
+    updateInfo(timeout?: number): Promise<Tablo.UpdateInfo | undefined>;
+    /**
+     * Retrieves device update progress information.
+     * @param timeout
+     */
+    updateProgress(timeout?: number): Promise<unknown | undefined>;
+    /**
+     * Initiates a channel watch (streaming) session on the device which must be managed via
+     * `keepaliveSession` and `deleteSession`
+     * @param channel_id
+     * @param device_info
+     * @param timeout
+     */
+    watchChannel(channel_id: string, device_info?: Partial<Tablo.Client.Device>, timeout?: number): Promise<Tablo.PlayerSession | undefined>;
+}
+export declare namespace Tablo {
+    export namespace Client {
+        type DeviceExtra = {
+            deviceOS: string;
+            deviceId: string;
+            width: number;
+            deviceModel: string;
+            lang: string;
+            height: number;
+            deviceOSVersion: string;
+            limitedAdTracking: number;
+            deviceMake: string;
+        };
+        export type Device = {
+            device_id: string;
+            extra: Partial<DeviceExtra>;
+            platform: string;
+            bandwidth: unknown;
+        };
+        export {};
+    }
+    export type Info = {
+        server_id: string;
+        name: string;
+        timezone: string;
+        deprecated: string;
+        version: string;
+        local_address: string;
+        setup_completed: boolean;
+        build_number: number;
+        model: {
+            wifi: boolean;
+            tuners: number;
+            type: string;
+            name: string;
+        };
+        availability: string;
+        cache_key: string;
+        product: string;
+    };
+    export type Location = {
+        state: string;
+        location: {
+            postal_code: string;
+            name: string;
+            locality: string;
+            area: string;
+            state: string;
+            latitude: number;
+            longitude: number;
+        };
+        timezone: {
+            name: string;
+            raw_offset: number;
+            dst_offset: number;
+            does_dst: boolean;
+        };
+    };
+    export type Tuner = {
+        in_use: boolean;
+        channel: string | null;
+        recording: string | null;
+        channel_identifier: string | null;
+    };
+    export type Settings = {
+        led: string;
+        extended_live_recordings: boolean;
+        auto_delete_recordings: boolean;
+        exclude_duplicates: boolean;
+        preferred_audio_track: string;
+        data_collection: boolean;
+        enable_amplifier: boolean;
+    };
+    export type Channel = {
+        call_sign: string;
+        name: string;
+        call_sign_src: string;
+        major: number;
+        minor: number;
+        network: string;
+        flags: string[];
+        resolution: string;
+        favourite: boolean;
+        tms_station_id: string;
+        tms_affiliate_id: string;
+        channel_identifier: string;
+        source: string;
+        logos: Logo[];
+    };
+    export type PlayerSession<DateType = Date> = {
+        token: string;
+        expires: DateType;
+        keepalive: number;
+        playlist_url: string;
+        video_details: {
+            container_format: string;
+            flags: string[];
+        };
+        channel: Channel;
+    };
+    export type HardDrive = {
+        error: unknown | null;
+        connected: boolean;
+        format_state: string;
+        name: string;
+        busy_state: string;
+        kind: string;
+        size: number;
+        size_mib: number;
+        usage: number;
+        usage_mib: number;
+        free: number;
+        free_mib: number;
+        limit: number;
+        limit_mib: number;
+    };
+    export type GuideStatus<DateType = Date> = {
+        guide_seeded: boolean;
+        last_update: DateType;
+        limit: DateType;
+        download_progress: number | null;
+    };
+    export type DeviceSubscription<DateType = Date> = {
+        state: string;
+        expires: DateType | null;
+        url: string;
+        identifier: string;
+    };
+    type Subscription<DateType = Date> = {
+        kind: string;
+        state: string;
+        name: string;
+        title: string;
+        deprecated: string;
+        expires: DateType | null;
+        registration_url: string;
+        registration_identifier: string;
+        subtitle: string;
+        description: string;
+        actions: any[];
+        warnings: any[];
+    };
+    export type AccountSubscription<DateType = Date> = {
+        services: {
+            guide_data: {
+                selected: boolean;
+                active: boolean;
+            };
+            cloud_dvr: unknown | null;
+            deprecated: string;
+        };
+        state: string;
+        trial: unknown | null;
+        offered_option: unknown | null;
+        registration: {
+            url: string;
+            identifier: string;
+        };
+        subscriptions: Subscription<DateType>[];
+    };
+    export type UpdateInfo<DateType = Date> = {
+        details: unknown | null;
+        available_update: unknown | null;
+        last_checked: DateType;
+        last_update: DateType | null;
+        sequence: string[];
+        current_step: unknown | null;
+        state: string;
+        error: unknown | null;
+    };
+    export type ChannelScan<DateType = Date> = {
+        object_id: string;
+        path: string;
+        postal_code: string;
+        datetime: DateType;
+        completed: boolean;
+        progress: number;
+        preferred_audio_track: string;
+    };
+    export type Episode<DateType = Date> = {
+        title: string;
+        description: string;
+        number: number;
+        season_number: number;
+        orig_air_date: DateType;
+        tms_id: string;
+    };
+    export type Airing<DateType = Date> = {
+        show_title: string;
+        start_time: DateType;
+        end_time: DateType;
+        duration: number;
+        episode: Episode<DateType>;
+        channel: Channel;
+    };
+    export namespace Batched {
+        type Root = {
+            object_id: number;
+            path: string;
+        };
+        type Channel = {
+            channel: Tablo.Channel;
+        };
+        type Airing = {
+            series_path: string;
+            season_path: string;
+            episode: Episode<string>;
+            airing_details: {
+                show_title: string;
+                datetime: string;
+                duration: number;
+                channel_path: string;
+                channel: Root & Channel;
+            };
+            qualifiers: string[];
+            schedule: {
+                state: string;
+                qualifier: string;
+                skip_reason: string;
+                skip_detail: unknown | null;
+                offsets: {
+                    start: number;
+                    end: number;
+                    source: string;
+                };
+            };
+        };
+    }
+    export {};
+}
+export default Tablo;