bigbluebutton-html-plugin-sdk
Version:
This repository contains the SDK for developing BigBlueButton plugins. Plugins are React components that can be loaded from external sources by the BigBlueButton HTML5 client to extend its functionalities.
47 lines • 2.41 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.UserCameraHelperButton = void 0;
var enums_1 = require("./enums");
// UserCameraHelper Extensible Area
var UserCameraHelperButton = /** @class */ (function () {
/**
* Returns object to be used in the setter for the UserCamera Helper. In this case,
* a button.
*
* @param label - label to be displayed in userCamera helper button (Not mandatory).
* @param tooltip - label to be displayed when hovering the userCamera helper button.
* @param icon - icon to be used in the userCamera helper button. It goes in the left side of it.
* @param onClick - function to be called when clicking the button.
* @param displayFunction - function to tell BBB core which cameras will receive this extensible
* area.
* @param position - position to place the userCamera helper button.
* See {@link UserCameraHelperItemPosition}
* @param disabled - if true, the userCamera helper button will not be clickable
* @param dataTest - string attribute to be used for testing
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
*/
function UserCameraHelperButton(_a) {
var id = _a.id, _b = _a.label, label = _b === void 0 ? '' : _b, _c = _a.icon, icon = _c === void 0 ? '' : _c, _d = _a.tooltip, tooltip = _d === void 0 ? '' : _d, _e = _a.disabled, disabled = _e === void 0 ? true : _e, _f = _a.dataTest, dataTest = _f === void 0 ? '' : _f, _g = _a.onClick, onClick = _g === void 0 ? function () { } : _g, _h = _a.position, position = _h === void 0 ? enums_1.UserCameraHelperItemPosition.TOP_RIGHT : _h, displayFunction = _a.displayFunction;
var _this = this;
this.id = '';
this.setItemId = function (id) {
_this.id = "UserCameraHelperButton_".concat(id);
};
if (id) {
this.id = id;
}
this.label = label;
this.icon = icon;
this.tooltip = tooltip;
this.disabled = disabled;
this.dataTest = dataTest;
this.onClick = onClick;
this.displayFunction = displayFunction;
this.type = enums_1.UserCameraHelperItemType.BUTTON;
this.position = position;
}
return UserCameraHelperButton;
}());
exports.UserCameraHelperButton = UserCameraHelperButton;
//# sourceMappingURL=component.js.map