prerecorded

Documentation

Overview

*********** WARNING *********** This package provides the prerecorded client implementation for the Deepgram API

Deprecated: This package is deprecated. Use the listen package instead. This will be removed in a future release.

This package is frozen and no new functionality will be added. *********** WARNING ***********

*********** WARNING *********** This package provides the prerecorded client implementation for the Deepgram API

Deprecated: This package is deprecated. Use the listen package instead. This will be removed in a future release.

This package is frozen and no new functionality will be added. *********** WARNING ***********

Index

• Constants
• func Init(init InitLib)
• func InitWithDefault()
• type Client
  • func New(apiKey string, options *interfaces.ClientOptions) *Client
  • func NewWithDefaults() *Client
• type InitLib

Constants

const (
	LogLevelDefault   = common.LogLevelDefault
	LogLevelErrorOnly = common.LogLevelErrorOnly
	LogLevelStandard  = common.LogLevelStandard
	LogLevelElevated  = common.LogLevelElevated
	LogLevelFull      = common.LogLevelFull
	LogLevelDebug     = common.LogLevelDebug
	LogLevelTrace     = common.LogLevelTrace
	LogLevelVerbose   = common.LogLevelVerbose
)

please see pkg/common/init.go for more information

const (
	PackageVersion = listenv1rest.PackageVersion
)

********************************* PreRecordedClient *********************************

Functions

func Init

func Init(init InitLib)

The SDK Init function for this library. Allows you to set the logging level and use of a log file. Default is output to the stdout.

func InitWithDefault

func InitWithDefault()

InitWithDefault is the SDK Init function for this library using default values.

Types

type Client

type Client = listenv1rest.Client

func New

func New(apiKey string, options *interfaces.ClientOptions) *Client

New creates a new prerecorded client with the specified options

Input parameters: - apiKey: string containing the Deepgram API key - options: ClientOptions which allows overriding things like hostname, version of the API, etc.

Deprecated: This package is deprecated. Use the listen package instead. This will be removed in a future release.

func NewWithDefaults

func NewWithDefaults() *Client

NewWithDefaults creates a new analyze/read client with all default options

Notes:

• The Deepgram API KEY is read from the environment variable DEEPGRAM_API_KEY

Deprecated: This package is deprecated. Use the listen package instead. This will be removed in a future release.

type InitLib

type InitLib struct {
	LogLevel      common.LogLevel
	DebugFilePath string
}

Initialization options for this SDK.