api

Documentation

Index

• type AudioFormatEnum
  • func (e AudioFormatEnum) String() string
• type Check
• type Input
• type Result
• type TTSRequestConfig
• type TextFormatEnum
  • func (e TextFormatEnum) String() string
• type ValidateFailure

Types

type AudioFormatEnum

type AudioFormatEnum int

AudioFormatEnum represent possible audio outputs

const (
	//AudioNone value
	AudioNone AudioFormatEnum = iota
	//AudioDefault value
	AudioDefault
	//AudioMP3 value
	AudioMP3
	//AudioM4A value`
	AudioM4A
)

func (AudioFormatEnum) String

func (e AudioFormatEnum) String() string

type Check

type Check struct {
	ID    string `json:"id,omitempty"`
	Value int    `json:"value,omitempty"`
}

Check is validation check

type Input

type Input struct {
	Text string `json:"text,omitempty"`
	//Possible values are m4a, mp3
	OutputFormat     string `json:"outputFormat,omitempty"`
	OutputTextFormat string `json:"outputTextFormat,omitempty"`
	AllowCollectData *bool  `json:"saveRequest,omitempty"`
}

Input is sythesis input data

type Result

type Result struct {
	AudioAsString      string            `json:"audioAsString,omitempty"`
	Error              string            `json:"error,omitempty"`
	ValidationFailures []ValidateFailure `json:"validationFailItems,omitempty"`
	Text               string            `json:"text,omitempty"`
	RequestID          string            `json:"requestID,omitempty"`
}

Result is synthesis result

type TTSRequestConfig

type TTSRequestConfig struct {
	Text             string
	RequestID        string
	OutputFormat     AudioFormatEnum
	OutputTextFormat TextFormatEnum
	OutputMetadata   []string
	AllowCollectData bool
	SaveTags         []string
}

TTSRequestConfig config for request`

type TextFormatEnum

type TextFormatEnum int

TextFormatEnum represent possible output text types

const (
	//TextNone do not output text
	TextNone TextFormatEnum = iota
	//TextNormalized output normalized text
	TextNormalized
	//TextAccented output normalized accented text
	TextAccented
)

func (TextFormatEnum) String

func (e TextFormatEnum) String() string

type ValidateFailure

type ValidateFailure struct {
	FailingText     string `json:"failingText,omitempty"`
	FailingPosition int    `json:"failingPosition,omitempty"`
	Check           Check  `json:"check"`
}

ValidateFailure indicate validation failure position