bigbluebutton-html-plugin-sdk 0.1.5 → 0.1.6

package/README.md

@@ -374,6 +374,8 @@ One other thing is that the type of the return is precisely the same type requir
   - send: This function will send a notification for the client to render, keep in mind that it's only client-side. Should you want it to be rendered in multiple clients, use this with a data-channel;
 - user-status:
   - setAwayStatus: this function will set the away status of the user to a certain status;
+- captions:
+  - setDisplayAudioCaptions: This function will set the track of transcripted audio to be displayed or disable it;
 
 See usage ahead:
 

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

@@ -0,0 +1,13 @@
+import { SetDisplayAudioCaptionsCommandArguments } from './types';
+export declare const captions: {
+    /**
+     * Sets the automatically generated audio captions to be displayed/or not in the client.
+     *
+     * @param setDisplayAudioCaptionsCommandArguments: object with a
+     * {@link CaptionsLanguageEnum} that tells the language to which the core will set the
+     * display of the audio captions. If the value is `CaptionsLanguageEnum.NONE`, it will hide the
+     * audio captions.
+     * Refer to {@link SetDisplayAudioCaptionsCommandArguments} to understand the argument structure.
+     */
+    setDisplayAudioCaptions: (setDisplayAudioCaptions: SetDisplayAudioCaptionsCommandArguments) => void;
+};

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.captions = void 0;
+var enums_1 = require("./enums");
+exports.captions = {
+    /**
+     * Sets the automatically generated audio captions to be displayed/or not in the client.
+     *
+     * @param setDisplayAudioCaptionsCommandArguments: object with a
+     * {@link CaptionsLanguageEnum} that tells the language to which the core will set the
+     * display of the audio captions. If the value is `CaptionsLanguageEnum.NONE`, it will hide the
+     * audio captions.
+     * Refer to {@link SetDisplayAudioCaptionsCommandArguments} to understand the argument structure.
+     */
+    setDisplayAudioCaptions: function (setDisplayAudioCaptions) {
+        var displayAudioCaptions = setDisplayAudioCaptions.displayAudioCaptions;
+        window.dispatchEvent(new CustomEvent(enums_1.CaptionsEnum.SET_DISPLAY_AUDIO_CAPTIONS, {
+            detail: {
+                displayAudioCaptions: displayAudioCaptions,
+            },
+        }));
+    },
+};
+//# sourceMappingURL=commands.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/ui-commands/captions/commands.ts"],"names":[],"mappings":";;;AAAA,iCAAuC;AAG1B,QAAA,QAAQ,GAAG;IACtB;;;;;;;;OAQG;IACH,uBAAuB,EAAE,UACvB,uBAAgE;QAG9D,IAAA,oBAAoB,GAClB,uBAAuB,qBADL,CACM;QAC5B,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAEb,oBAAY,CAAC,0BAA0B,EAAE;YACzC,MAAM,EAAE;gBACN,oBAAoB,sBAAA;aACrB;SACF,CAAC,CACH,CAAC;IACJ,CAAC;CAEF,CAAC"}

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

@@ -0,0 +1,12 @@
+export declare enum CaptionsEnum {
+    SET_DISPLAY_AUDIO_CAPTIONS = "SET_SHOW_AUDIO_CAPTIONS_COMMAND"
+}
+export declare enum CaptionsLanguageEnum {
+    NONE = "",
+    ENGLISH = "en-US",
+    SPANISH = "es-ES",
+    PORTUGUESE = "pt-PT",
+    PORTUGUESE_BR = "pt-BR",
+    FRENCH = "fr-FR",
+    GERMAN = "de-DE"
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaptionsLanguageEnum = exports.CaptionsEnum = void 0;
+var CaptionsEnum;
+(function (CaptionsEnum) {
+    CaptionsEnum["SET_DISPLAY_AUDIO_CAPTIONS"] = "SET_SHOW_AUDIO_CAPTIONS_COMMAND";
+})(CaptionsEnum || (exports.CaptionsEnum = CaptionsEnum = {}));
+var CaptionsLanguageEnum;
+(function (CaptionsLanguageEnum) {
+    CaptionsLanguageEnum["NONE"] = "";
+    CaptionsLanguageEnum["ENGLISH"] = "en-US";
+    CaptionsLanguageEnum["SPANISH"] = "es-ES";
+    CaptionsLanguageEnum["PORTUGUESE"] = "pt-PT";
+    CaptionsLanguageEnum["PORTUGUESE_BR"] = "pt-BR";
+    CaptionsLanguageEnum["FRENCH"] = "fr-FR";
+    CaptionsLanguageEnum["GERMAN"] = "de-DE";
+})(CaptionsLanguageEnum || (exports.CaptionsLanguageEnum = CaptionsLanguageEnum = {}));
+//# sourceMappingURL=enums.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../../src/ui-commands/captions/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAEX;AAFD,WAAY,YAAY;IACtB,8EAA8D,CAAA;AAChE,CAAC,EAFW,YAAY,4BAAZ,YAAY,QAEvB;AAED,IAAY,oBAQX;AARD,WAAY,oBAAoB;IAC9B,iCAAS,CAAA;IACT,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,4CAAoB,CAAA;IACpB,+CAAuB,CAAA;IACvB,wCAAgB,CAAA;IAChB,wCAAgB,CAAA;AAClB,CAAC,EARW,oBAAoB,oCAApB,oBAAoB,QAQ/B"}

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

@@ -0,0 +1,7 @@
+import { CaptionsLanguageEnum } from './enums';
+export interface SetDisplayAudioCaptionsCommandArguments {
+    displayAudioCaptions: CaptionsLanguageEnum;
+}
+export interface UiCommandsCaptionsObject {
+    setDisplayAudioCaptions: (setDisplayAudioCaptionsCommandArguments: SetDisplayAudioCaptionsCommandArguments) => void;
+}

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

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

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

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

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

@@ -6,6 +6,9 @@ export declare const uiCommands: {
         setSelfViewDisableAllDevices: (setSelfViewDisableAllDevicesCommandArguments: import("./camera/types").SetSelfViewDisableAllDevicesCommandArguments) => void;
         setSelfViewDisable: (setSelfViewDisableCommandArguments: import("./camera/types").SetSelfViewDisableCommandArguments) => void;
     };
+    captions: {
+        setDisplayAudioCaptions: (setDisplayAudioCaptions: import("./captions/types").SetDisplayAudioCaptionsCommandArguments) => void;
+    };
     chat: {
         form: {
             open: () => void;

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

@@ -9,20 +9,22 @@ var commands_5 = require("./user-status/commands");
 var commands_6 = require("./conference/commands");
 var commands_7 = require("./notification/commands");
 var commands_8 = require("./camera/commands");
-var commands_9 = require("./actions-bar/commands");
-var commands_10 = require("./layout/commands");
-var commands_11 = require("./nav-bar/commands");
+var commands_9 = require("./captions/commands");
+var commands_10 = require("./actions-bar/commands");
+var commands_11 = require("./layout/commands");
+var commands_12 = require("./nav-bar/commands");
 exports.uiCommands = {
-    actionsBar: commands_9.actionsBar,
+    actionsBar: commands_10.actionsBar,
     camera: commands_8.camera,
+    captions: commands_9.captions,
     chat: commands_1.chat,
     externalVideo: commands_2.externalVideo,
     sidekickOptionsContainer: commands_3.sidekickOptionsContainer,
-    navBar: commands_11.navBar,
+    navBar: commands_12.navBar,
     presentationArea: commands_4.presentationArea,
     userStatus: commands_5.userStatus,
     conference: commands_6.conference,
     notification: commands_7.notification,
-    layout: commands_10.layout,
+    layout: commands_11.layout,
 };
 //# 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;AAChE,mDAAoD;AACpD,kDAAmD;AACnD,oDAAuD;AACvD,8CAA2C;AAC3C,mDAAoD;AACpD,+CAA2C;AAC3C,gDAA4C;AAE/B,QAAA,UAAU,GAAG;IACxB,UAAU,uBAAA;IACV,MAAM,mBAAA;IACN,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,MAAM,oBAAA;IACN,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;IACV,YAAY,yBAAA;IACZ,MAAM,oBAAA;CACP,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;AACnD,oDAAuD;AACvD,8CAA2C;AAC3C,gDAA+C;AAC/C,oDAAoD;AACpD,+CAA2C;AAC3C,gDAA4C;AAE/B,QAAA,UAAU,GAAG;IACxB,UAAU,wBAAA;IACV,MAAM,mBAAA;IACN,QAAQ,qBAAA;IACR,IAAI,iBAAA;IACJ,aAAa,0BAAA;IACb,wBAAwB,qCAAA;IACxB,MAAM,oBAAA;IACN,gBAAgB,6BAAA;IAChB,UAAU,uBAAA;IACV,UAAU,uBAAA;IACV,YAAY,yBAAA;IACZ,MAAM,oBAAA;CACP,CAAC"}

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

@@ -1,2 +1,3 @@
 export { NotificationTypeUiCommand } from './notification/enums';
 export { ChangeEnforcedLayoutTypeEnum } from './layout/enums';
+export { CaptionsLanguageEnum } from './captions/enums';

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

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChangeEnforcedLayoutTypeEnum = exports.NotificationTypeUiCommand = void 0;
+exports.CaptionsLanguageEnum = exports.ChangeEnforcedLayoutTypeEnum = exports.NotificationTypeUiCommand = void 0;
 var enums_1 = require("./notification/enums");
 Object.defineProperty(exports, "NotificationTypeUiCommand", { enumerable: true, get: function () { return enums_1.NotificationTypeUiCommand; } });
 var enums_2 = require("./layout/enums");
 Object.defineProperty(exports, "ChangeEnforcedLayoutTypeEnum", { enumerable: true, get: function () { return enums_2.ChangeEnforcedLayoutTypeEnum; } });
+var enums_3 = require("./captions/enums");
+Object.defineProperty(exports, "CaptionsLanguageEnum", { enumerable: true, get: function () { return enums_3.CaptionsLanguageEnum; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ui-commands/index.ts"],"names":[],"mappings":";;;AAAA,8CAAiE;AAAxD,kHAAA,yBAAyB,OAAA;AAClC,wCAA8D;AAArD,qHAAA,4BAA4B,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ui-commands/index.ts"],"names":[],"mappings":";;;AAAA,8CAAiE;AAAxD,kHAAA,yBAAyB,OAAA;AAClC,wCAA8D;AAArD,qHAAA,4BAA4B,OAAA;AACrC,0CAAwD;AAA/C,6GAAA,oBAAoB,OAAA"}

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

@@ -9,11 +9,13 @@ import { UiCommandsActionsBarObject } from './actions-bar/types';
 import { UiCommandsLayoutObject } from './layout/types';
 import { UiCommandsNavBarObject } from './nav-bar/types';
 import { UiCommandsCameraObject } from './camera/types';
+import { UiCommandsCaptionsObject } from './captions/types';
 export interface UiCommands {
     layout: UiCommandsLayoutObject;
     actionsBar: UiCommandsActionsBarObject;
     camera: UiCommandsCameraObject;
     chat: UiCommandsChatObject;
+    captions: UiCommandsCaptionsObject;
     externalVideo: UiCommandsExternalVideoObject;
     sidekickOptionsContainer: UiCommandsSidekickOptionsContainerObject;
     navBar: UiCommandsNavBarObject;

package/package.json

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