restv1

Documentation

Overview

This package defines the Speak REST API for Deepgram

Index

• Constants
• Variables
• type Client
  • func New(client *speak.Client) *Client
  • func (c *Client) ToFile(ctx context.Context, text string, options *interfaces.SpeakOptions, ...) (*api.SpeakResponse, error)
  • func (c *Client) ToSave(ctx context.Context, filename, text string, options *interfaces.SpeakOptions) (*api.SpeakResponse, error)
  • func (c *Client) ToStream(ctx context.Context, text string, options *interfaces.SpeakOptions, ...) (*api.SpeakResponse, error)

Constants

const (
	PackageVersion string = "v1.0"
)

Variables

var (
	// ErrInvalidInput required input was not found
	ErrInvalidInput = errors.New("required input was not found")
)

errors

Types

type Client

type Client struct {
	*speak.Client
}

func New

func New(client *speak.Client) *Client

func (*Client) ToFile

func (c *Client) ToFile(ctx context.Context, text string, options *interfaces.SpeakOptions, w io.Writer) (*api.SpeakResponse, error)

ToFile TTS saved to a file

func (*Client) ToSave

func (c *Client) ToSave(ctx context.Context, filename, text string, options *interfaces.SpeakOptions) (*api.SpeakResponse, error)

ToSave TTS saved to a file

func (*Client) ToStream

func (c *Client) ToStream(ctx context.Context, text string, options *interfaces.SpeakOptions, buf *interfaces.RawResponse) (*api.SpeakResponse, error)

ToStream TTS streamed to a buffer