adds speak-stream API

examples/speak/stream/hello-world/main.go → examples/speak/rest/stream/hello-world/main.go

@@ -29,7 +29,7 @@ func main() {
 	// Go context
 	ctx := context.Background()
 
-	// set the Transcription options
+	// set the TTS options
 	options := &interfaces.SpeakOptions{
 		Model: "aura-asteria-en",
 	}

examples/speak/stream/interactive/main.go

@@ -0,0 +1,178 @@
+// Copyright 2024 Deepgram SDK contributors. All Rights Reserved.
+// Use of this source code is governed by a MIT license that can be found in the LICENSE file.
+// SPDX-License-Identifier: MIT
+package main
+
+import (
+	"bufio"
+	"context"
+	"fmt"
+	"os"
+	"strings"
+
+	msginterfaces "github.com/deepgram/deepgram-go-sdk/pkg/api/speak-stream/v1/interfaces" // Add this import
+	"github.com/deepgram/deepgram-go-sdk/pkg/client/interfaces"
+	"github.com/deepgram/deepgram-go-sdk/pkg/client/speak"
+)
+
+const (
+	API_KEY    = ""
+	TTS_TEXT   = "Hello, this is a text to speech example using Deepgram."
+	AUDIO_DIR  = "tts_outputs"
+	AUDIO_FILE = "output.mp3"
+)
+
+// Implement your own callback
+type MyCallback struct{}
+
+func (c MyCallback) Metadata(md *msginterfaces.MetadataResponse) error {
+	fmt.Printf("\n[Metadata] Received\n")
+	fmt.Printf("Metadata.RequestID: %s\n", strings.TrimSpace(md.RequestID))
+	return nil
+}
+
+func (c MyCallback) SpeakStream(ss *msginterfaces.SpeakStreamResponse) error {
+	fmt.Printf("\n[SpeakStream] Received\n")
+	fmt.Printf("SpeakStream.ContentType: %s\n", strings.TrimSpace(ss.ContentType))
+	fmt.Printf("SpeakStream.Date: %s\n", strings.TrimSpace(ss.Date))
+	fmt.Printf("SpeakStream.ModelName: %s\n", strings.TrimSpace(ss.ModelName))
+	fmt.Printf("SpeakStream.ModelUUID: %s\n", strings.TrimSpace(ss.ModelUUID))
+	fmt.Printf("SpeakStream.RequestID: %s\n", strings.TrimSpace(ss.RequestID))
+	return nil
+}
+
+func (c MyCallback) Binary(byMsg []byte) error {
+	if _, err := os.Stat(AUDIO_DIR); os.IsNotExist(err) {
+		err := os.Mkdir(AUDIO_DIR, 0755)
+		if err != nil {
+			fmt.Printf("Error creating directory %s: %v\n", AUDIO_DIR, err)
+			return err
+		}
+	}
+
+	filePath := fmt.Sprintf("%s/%s", AUDIO_DIR, AUDIO_FILE)
+	file, err := os.Create(filePath)
+	if err != nil {
+		fmt.Printf("Error creating file %s: %v\n", filePath, err)
+		return err
+	}
+	defer file.Close()
+
+	_, err = file.Write(byMsg)
+	if err != nil {
+		fmt.Printf("Error writing audio data to file: %v\n", err)
+		return err
+	}
+
+	fmt.Printf("Audio data saved to %s\n", filePath)
+	return nil
+}
+
+func (c MyCallback) Flush(fl *msginterfaces.FlushedResponse) error {
+	fmt.Printf("\n[Flushed] Received\n")
+	return nil
+}
+
+func (c MyCallback) Error(er *msginterfaces.ErrorResponse) error {
+	fmt.Printf("\n[Error] Received\n")
+	fmt.Printf("Error.Type: %s\n", er.Type)
+	fmt.Printf("Error.Description: %s\n\n", er.Description)
+	return nil
+}
+
+func (c MyCallback) Close(cr *msginterfaces.CloseResponse) error {
+	fmt.Printf("\n[Close] Received\n")
+	return nil
+}
+
+func (c MyCallback) Open(or *msginterfaces.OpenResponse) error {
+	fmt.Printf("\n[Open] Received\n")
+	return nil
+}
+
+func main() {
+	// init library
+	speak.InitWithDefault()
+
+	// Go context
+	ctx := context.Background()
+
+	// print instructions
+	fmt.Print("\n\nPress ENTER to exit!\n\n")
+
+	// set the TTS options
+	ttsOptions := &interfaces.SpeakOptions{
+		Model: "aura-asteria-en",
+	}
+
+	// set the Client options
+	cOptions := &interfaces.ClientOptions{}
+
+	// create the callback
+	callback := MyCallback{}
+
+	// create a new stream using the NewStream function
+	dgClient, err := speak.NewStream(ctx, "", cOptions, ttsOptions, callback)
+	if err != nil {
+		fmt.Println("ERROR creating TTS connection:", err)
+		return
+	}
+
+	// connect the websocket to Deepgram
+	bConnected := dgClient.Connect()
+	if !bConnected {
+		fmt.Println("Client.Connect failed")
+		os.Exit(1)
+	}
+
+	// Send the text input
+	err = dgClient.WriteJSON(map[string]interface{}{
+		"type": "Speak",
+		"text": TTS_TEXT,
+	})
+	if err != nil {
+		fmt.Printf("Error sending text input: %v\n", err)
+		return
+	}
+
+	// Simulate user input to reset the buffer, flush, send new text, or just exit
+	fmt.Print("\n\nPress 'r' and ENTER to reset the buffer, 'f' and ENTER to flush, enter new text to send it, or just ENTER to exit...\n\n")
+	input := bufio.NewScanner(os.Stdin)
+	for input.Scan() {
+		switch input.Text() {
+		case "r":
+			err = dgClient.Reset()
+			if err != nil {
+				fmt.Printf("Error resetting buffer: %v\n", err)
+			} else {
+				fmt.Println("Buffer reset successfully.")
+			}
+		case "f":
+			err = dgClient.Flush()
+			if err != nil {
+				fmt.Printf("Error flushing buffer: %v\n", err)
+			} else {
+				fmt.Println("Buffer flushed successfully.")
+			}
+		case "":
+			goto EXIT
+		default:
+			err = dgClient.WriteJSON(map[string]interface{}{
+				"type": "Speak",
+				"text": input.Text(),
+			})
+			if err != nil {
+				fmt.Printf("Error sending text input: %v\n", err)
+			} else {
+				fmt.Println("Text sent successfully.")
+			}
+		}
+	}
+
+EXIT:
+
+	// close the connection
+	dgClient.Stop()
+
+	fmt.Printf("Program exiting...\n")
+}

pkg/api/speak-stream/v1/constants.go

@@ -0,0 +1,21 @@
+// Copyright 2024 Deepgram SDK contributors. All Rights Reserved.
+// Use of this source code is governed by a MIT license that can be found in the LICENSE file.
+// SPDX-License-Identifier: MIT
+
+package speak
+
+import (
+	"errors"
+)
+
+// errors
+var (
+	// ErrInvalidInput required input was not found
+	ErrInvalidInput = errors.New("required input was not found")
+
+	// ErrInvalidMessageType invalid message type
+	ErrInvalidMessageType = errors.New("invalid message type")
+
+	// ErrUserCallbackNotDefined user callback object not defined
+	ErrUserCallbackNotDefined = errors.New("user callback object not defined")
+)