Fix OpenTTS getWavData, format and add doc comments (#761)

hlxid · web-flow · commit 10e12816f0cf · 2022-09-04T21:19:32.000+02:00
diff --git a/samples/opentts/extension/index.ts b/samples/opentts/extension/index.ts
@@ -13,7 +13,7 @@ async function playTTSInGraphic(client: OpenTTSClient, nodecg: NodeCG) {
     if (voiceName === undefined) throw new Error("no voice available");
 
     const helloWorldUrl = client.generateWavUrl("Hello World", voiceName);
-    await nodecg.sendMessage("setSrc", helloWorldUrl);
+    nodecg.sendMessage("setSrc", helloWorldUrl);
 }
 
 module.exports = function (nodecg: NodeCG) {
@@ -23,9 +23,10 @@ module.exports = function (nodecg: NodeCG) {
 
     nodecg.listenFor("ready", () => {
         const client = opentts?.getClient();
-        if (client !== undefined){
-            playTTSInGraphic(client, nodecg)
-                .catch(err => nodecg.log.error(`Error while trying to play tts message: ${err.messages}`));
+        if (client !== undefined) {
+            playTTSInGraphic(client, nodecg).catch((err) =>
+                nodecg.log.error(`Error while trying to play tts message: ${err.messages}`),
+            );
         }
     });
 
diff --git a/samples/opentts/graphics/index.html b/samples/opentts/graphics/index.html
@@ -1,10 +1,10 @@
 <!DOCTYPE html>
 <html lang="en">
-<head>
-    <title>OpenTTS Sample</title>
-</head>
-<body>
-<audio controls id="opentts-audio"></audio>
-<script src="index.js"></script>
-</body>
-</html>
+    <head>
+        <title>OpenTTS Sample</title>
+    </head>
+    <body>
+        <audio controls id="opentts-audio"></audio>
+        <script src="index.js"></script>
+    </body>
+</html>
diff --git a/services/nodecg-io-opentts/extension/index.ts b/services/nodecg-io-opentts/extension/index.ts
@@ -25,8 +25,7 @@ class OpenTTSService extends ServiceBundle<OpenTTSConfig, OpenTTSClient> {
         return success(client);
     }
 
-    stopClient(_: OpenTTSClient, logger: Logger): void {
+    stopClient(_: OpenTTSClient, _logger: Logger): void {
         // Client is stateless, no need to stop anything
     }
 }
-
diff --git a/services/nodecg-io-opentts/extension/openTtsClient.ts b/services/nodecg-io-opentts/extension/openTtsClient.ts
@@ -29,7 +29,7 @@ export class OpenTTSClient {
     private async executeRequest(path: string): Promise<Response> {
         const response = await fetch(this.buildBaseURL() + path);
         if (!response.ok) {
-            throw new Error("Failed to execute opentts request: " + (await response.text()));
+            throw new Error(`Failed to execute opentts request: ${await response.text()}`);
         }
 
         return response;
@@ -57,6 +57,9 @@ export class OpenTTSClient {
         return await response.json();
     }
 
+    /**
+     * Generates a URL to a .wav file with the spoken text that is generated using OpenTTS:
+     */
     generateWavUrl(
         text: string,
         voice: string,
@@ -65,15 +68,24 @@ export class OpenTTSClient {
         cache?: boolean,
     ): string {
         const params = new URLSearchParams({ text, voice });
-        if(vocoder) params.set("vocoder", vocoder);
-        if(denoiserStrength) params.set("denoiserStrength", denoiserStrength.toString());
-        if(cache !== undefined) params.set("cache", cache.toString());
+        if (vocoder) params.set("vocoder", vocoder);
+        if (denoiserStrength) params.set("denoiserStrength", denoiserStrength.toString());
+        if (cache !== undefined) params.set("cache", cache.toString());
 
         return `${this.buildBaseURL()}/api/tts?${params}`;
     }
 
+    /**
+     * Downloads the .wav file from the given URL and returns it as a Buffer.
+     * @param url the url generated by {@link generateWavUrl}
+     * @returns the wav file
+     */
     async getWavData(url: string): Promise<ArrayBuffer> {
-        const response = await this.executeRequest(url);
+        const response = await fetch(url);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch wav audio data: ${await response.text()}`);
+        }
+
         return await response.arrayBuffer();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,7 @@ class OpenTTSService extends ServiceBundle<OpenTTSConfig, OpenTTSClient> {`
`25`	`25`	`return success(client);`
`26`	`26`	`}`
`27`	`27`
`28`		`- stopClient(_: OpenTTSClient, logger: Logger): void {`
	`28`	`+ stopClient(_: OpenTTSClient, _logger: Logger): void {`
`29`	`29`	`// Client is stateless, no need to stop anything`
`30`	`30`	`}`
`31`	`31`	`}`
`32`		`-`