@huddly/sdk-interfaces/lib/abstract_classes/DiagnosticsMessage.js

Module for describing the Huddly SDK using interfaces

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.DiagnosticsLevel = void 0;
var DiagnosticsLevel;
(function (DiagnosticsLevel) {
    DiagnosticsLevel["INFO"] = "INFO";
    DiagnosticsLevel["WARN"] = "WARN";
    DiagnosticsLevel["ERROR"] = "ERROR";
})(DiagnosticsLevel = exports.DiagnosticsLevel || (exports.DiagnosticsLevel = {}));
/**
 * Provides diagnostic information from the camera.
 * @export
 * @class DiagnosticsMessage
 */
class DiagnosticsMessage {
    constructor(type) {
        this._level = DiagnosticsLevel.INFO;
        this._message = '';
        this._tip = 'No tip available';
        this._type = type;
    }
    /**
     * Human readable message in english if type is ok, or not
     * @type {string}
     * @memberof DiagnosticsMessage
     */
    get message() {
        return this._message;
    }
    /**
     * Type that indentifies what type of diagnostics message it is e.g USBMODE
     * @type {string}
     * @memberof DiagnosticsMessage
     */
    get type() {
        return this._type;
    }
    /**
     * What type of level is the message, INFO, WARN, ERROR
     * @type {DiagnosticsLevel}
     * @memberof DiagnosticsMessage
     */
    get level() {
        return this._level;
    }
    /**
     * Human readable message how you can mitigate a problem
     * @type {string}
     * @memberof DiagnosticsMessage
     */
    get tip() {
        return this._tip;
    }
    /**
     * Data object can contain more detailed information about the diagnostics information
     * @type {any}
     * @memberof DiagnosticsMessage
     */
    get data() {
        return undefined;
    }
}
exports.default = DiagnosticsMessage;
//# sourceMappingURL=DiagnosticsMessage.js.map