bigbluebutton-html-plugin-sdk 0.0.60 → 0.0.61

package/README.md

@@ -249,6 +249,10 @@ One other thing is that the type of the return is precisely the same type requir
 - presentation-area:
   - open: this function will open the presentation area content automatically;
   - close: this function will close the presentation area content automatically;
+- conference:
+  - setSpeakerLevel: this function will set the speaker volume level(audio output) of the conference to a certain number between 0 and 1;
+- user-status:
+  - setAwayStatus: this function will set the away status of the user to a certain status;
 
 See usage ahead:
 

package/dist/cjs/ui-commands/commands.d.ts

@@ -18,4 +18,10 @@ export declare const uiCommands: {
         open: () => void;
         close: () => void;
     };
+    userStatus: {
+        setAwayStatus: (setAwayStatusCommandArguments: import("./user-status/types").SetAwayStatusCommandArguments) => void;
+    };
+    conference: {
+        setSpeakerLevel: (setSpeakerLevelCommandArguments: import("./conference/types").SetSpeakerLevelCommandArguments) => void;
+    };
 };

package/dist/cjs/ui-commands/commands.js

@@ -5,10 +5,14 @@ var commands_1 = require("./chat/commands");
 var commands_2 = require("./external-video/commands");
 var commands_3 = require("./sidekick-options-container/commands");
 var commands_4 = require("./presentation-area/commands");
+var commands_5 = require("./user-status/commands");
+var commands_6 = require("./conference/commands");
 exports.uiCommands = {
     chat: commands_1.chat,
     externalVideo: commands_2.externalVideo,
     sidekickOptionsContainer: commands_3.sidekickOptionsContainer,
     presentationArea: commands_4.presentationArea,
+    userStatus: commands_5.userStatus,
+    conference: commands_6.conference,
 };
 //# sourceMappingURL=commands.js.map

package/dist/cjs/ui-commands/commands.js.map

@@ -1 +1 @@
-{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAEnD,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,gBAAgB,6BAAA;CACjB,CAAC"}
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../src/ui-commands/commands.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,sDAA0D;AAC1D,kEAAiF;AACjF,yDAAgE;AAChE,mDAAoD;AACpD,kDAAmD;AAEtC,QAAA,UAAU,GAAG;IACxB,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;CACX,CAAC"}

package/dist/cjs/ui-commands/conference/commands.d.ts

@@ -0,0 +1,12 @@
+import { SetSpeakerLevelCommandArguments } from './types';
+export declare const conference: {
+    /**
+     * Sets the volume of the speakers in the conference to a certain level.
+     * Needs to be a value between 0 and 1.
+     *
+     * @param setSpeakerLevelCommandArgumentsthe volume to which the core will set the speaker
+     * level.
+     * Refer to {@link SetSpeakerLevelCommandArguments} to understand the argument structure.
+     */
+    setSpeakerLevel: (setSpeakerLevelCommandArguments: SetSpeakerLevelCommandArguments) => void;
+};

package/dist/cjs/ui-commands/conference/commands.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.conference = void 0;
+var enums_1 = require("./enums");
+exports.conference = {
+    /**
+     * Sets the volume of the speakers in the conference to a certain level.
+     * Needs to be a value between 0 and 1.
+     *
+     * @param setSpeakerLevelCommandArgumentsthe volume to which the core will set the speaker
+     * level.
+     * Refer to {@link SetSpeakerLevelCommandArguments} to understand the argument structure.
+     */
+    setSpeakerLevel: function (setSpeakerLevelCommandArguments) {
+        var level = setSpeakerLevelCommandArguments.level;
+        if (level <= 1 && level >= 0) {
+            window.dispatchEvent(new CustomEvent(enums_1.ConferenceEnum.SET_SPEAKER_LEVEL, {
+                detail: {
+                    level: level,
+                },
+            }));
+        }
+        else {
+            throw new Error('Not possible to set the speaker volume less than zero or higher than one');
+        }
+    },
+};
+//# sourceMappingURL=commands.js.map

package/dist/cjs/ui-commands/conference/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/conference/commands.ts"],"names":[],"mappings":";;;AAAA,iCAAyC;AAG5B,QAAA,UAAU,GAAG;IACxB;;;;;;;OAOG;IACH,eAAe,EAAE,UAAC,+BAAgE;QACxE,IAAA,KAAK,GAAK,+BAA+B,MAApC,CAAqC;QAClD,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;YAC5B,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,sBAAc,CAAC,iBAAiB,EAAE;gBAClC,MAAM,EAAE;oBACN,KAAK,OAAA;iBACN;aACF,CAAC,CACH,CAAC;SACH;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;SAC7F;IACH,CAAC;CACF,CAAC"}

package/dist/cjs/ui-commands/conference/enums.d.ts

@@ -0,0 +1,3 @@
+export declare enum ConferenceEnum {
+    SET_SPEAKER_LEVEL = "SET_SPEAKER_LEVEL_COMMAND"
+}

package/dist/cjs/ui-commands/conference/enums.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConferenceEnum = void 0;
+var ConferenceEnum;
+(function (ConferenceEnum) {
+    ConferenceEnum["SET_SPEAKER_LEVEL"] = "SET_SPEAKER_LEVEL_COMMAND";
+})(ConferenceEnum || (exports.ConferenceEnum = ConferenceEnum = {}));
+//# sourceMappingURL=enums.js.map

package/dist/cjs/ui-commands/conference/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/conference/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,iEAA+C,CAAA;AACjD,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB"}

package/dist/cjs/ui-commands/conference/types.d.ts

@@ -0,0 +1,6 @@
+export interface SetSpeakerLevelCommandArguments {
+    level: number;
+}
+export interface UiCommandsConferenceObject {
+    setSpeakerLevel: (setSpeakerlevelCommandArguments: SetSpeakerLevelCommandArguments) => void;
+}

package/dist/cjs/ui-commands/conference/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/ui-commands/conference/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ui-commands/conference/types.ts"],"names":[],"mappings":""}

package/dist/cjs/ui-commands/types.d.ts

@@ -2,9 +2,13 @@ import { UiCommandsChatObject } from './chat/types';
 import { UiCommandsExternalVideoObject } from './external-video/types';
 import { UiCommandsSidekickOptionsContainerObject } from './sidekick-options-container/types';
 import { UiCommandsPresentationAreaObject } from './presentation-area/types';
+import { UiCommandsUserStatusObject } from './user-status/types';
+import { UiCommandsConferenceObject } from './conference/types';
 export interface UiCommands {
     chat: UiCommandsChatObject;
     externalVideo: UiCommandsExternalVideoObject;
     sidekickOptionsContainer: UiCommandsSidekickOptionsContainerObject;
     presentationArea: UiCommandsPresentationAreaObject;
+    userStatus: UiCommandsUserStatusObject;
+    conference: UiCommandsConferenceObject;
 }

package/dist/cjs/ui-commands/user-status/commands.d.ts

@@ -0,0 +1,11 @@
+import { SetAwayStatusCommandArguments } from './types';
+export declare const userStatus: {
+    /**
+     * Sets the away status of the user to a certain status.
+     *
+     * @param setAwayStatusCommandArguments the status to which the core will set the user
+     * status.
+     * Refer to {@link SetAwayStatusCommandArguments} to understand the argument structure.
+     */
+    setAwayStatus: (setAwayStatusCommandArguments: SetAwayStatusCommandArguments) => void;
+};

package/dist/cjs/ui-commands/user-status/commands.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userStatus = void 0;
+var enums_1 = require("./enums");
+exports.userStatus = {
+    /**
+     * Sets the away status of the user to a certain status.
+     *
+     * @param setAwayStatusCommandArguments the status to which the core will set the user
+     * status.
+     * Refer to {@link SetAwayStatusCommandArguments} to understand the argument structure.
+     */
+    setAwayStatus: function (setAwayStatusCommandArguments) {
+        var away = setAwayStatusCommandArguments.away;
+        window.dispatchEvent(new CustomEvent(enums_1.UserStatusEnum.SET_AWAY_STATUS, {
+            detail: {
+                away: away,
+            },
+        }));
+    },
+};
+//# sourceMappingURL=commands.js.map

package/dist/cjs/ui-commands/user-status/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/user-status/commands.ts"],"names":[],"mappings":";;;AAAA,iCAAyC;AAG5B,QAAA,UAAU,GAAG;IACxB;;;;;;OAMG;IACH,aAAa,EAAE,UAAC,6BAA4D;QAClE,IAAA,IAAI,GAAK,6BAA6B,KAAlC,CAAmC;QAC/C,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,sBAAc,CAAC,eAAe,EAAE;YAChC,MAAM,EAAE;gBACN,IAAI,MAAA;aACL;SACF,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/cjs/ui-commands/user-status/enums.d.ts

@@ -0,0 +1,3 @@
+export declare enum UserStatusEnum {
+    SET_AWAY_STATUS = "SET_AWAY_USER_STATUS_COMMAND"
+}

package/dist/cjs/ui-commands/user-status/enums.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserStatusEnum = void 0;
+var UserStatusEnum;
+(function (UserStatusEnum) {
+    UserStatusEnum["SET_AWAY_STATUS"] = "SET_AWAY_USER_STATUS_COMMAND";
+})(UserStatusEnum || (exports.UserStatusEnum = UserStatusEnum = {}));
+//# sourceMappingURL=enums.js.map

package/dist/cjs/ui-commands/user-status/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/user-status/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,kEAAgD,CAAA;AAClD,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB"}

package/dist/cjs/ui-commands/user-status/types.d.ts

@@ -0,0 +1,6 @@
+export interface SetAwayStatusCommandArguments {
+    away: boolean;
+}
+export interface UiCommandsUserStatusObject {
+    setAwayStatus: (setAwayStatusCommandArguments: SetAwayStatusCommandArguments) => void;
+}

package/dist/cjs/ui-commands/user-status/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/ui-commands/user-status/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/ui-commands/user-status/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigbluebutton-html-plugin-sdk",
-  "version": "0.0.60",
+  "version": "0.0.61",
   "homepage": "https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",