Class YandexSpeechKit

Класс отвечающий за преобразование текста в аудио файл. Преобразование осуществляется через сервис Yandex SpeechKit.

Hierarchy

Constructors

constructor

Properties

_error _oauth _request emotion folderId format lang sampleRateHertz speed text voice E_EVIL E_GOOD E_NEUTRAL F_LPCM F_OGGOPUS L_EN L_RU L_TR TTS_API_URL V_ALENA V_ALYSS V_ERKANYAVAS V_ERMIL V_FILIPP V_JANE V_NICK V_OKSANA V_OMAZH V_SILAERKAN V_ZAHAR

Methods

_initPost _log call getTts setOAuth

Constructors

constructor

Properties

Protected _error

_error: null | string

Текст с ошибкой

Protected _oauth

_oauth: undefined | null | string

Авторизационный токен. О том как получить авторизационный токен сказано тут:

See

(https://yandex.ru/dev/dialogs/alice/doc/resource-upload-docpage/#http-images-load__auth) Смотри тут

Protected _request

_request: Request

Отправка запроса.

See

Request Смотри тут

emotion

emotion: string

Эмоциональная окраска голоса. Поддерживается только при выборе русского языка (ru-RU) и голосов jane или omazh. Допустимые значения: good — доброжелательный; evil — злой; neutral (по умолчанию) — нейтральный.

Default Value

neutral

folderId

folderId: null | number

Идентификатор каталога, к которому у вас есть доступ. Требуется для авторизации с пользовательским аккаунтом (см. ресурс UserAccount ). Не используйте это поле, если вы делаете запрос от имени сервисного аккаунта. Максимальная длина строки в символах — 50.

format

format: string

Формат синтезируемого аудио. Допустимые значения: lpcm — аудиофайл синтезируется в формате LPCM без WAV-заголовка. Характеристики аудио: Дискретизация — 8, 16 или 48 кГц в зависимости от значения параметра sampleRateHertz. Разрядность квантования — 16 бит. Порядок байтов — обратный (little-endian). Аудиоданные хранятся как знаковые числа (signed integer). oggopus (по умолчанию) — данные в аудиофайле кодируются с помощью аудиокодека OPUS и упаковываются в контейнер OGG (OggOpus).

Default Value

oggopus

lang

lang: string

Язык. Допустимые значения: ru-RU (по умолчанию) — русский язык; en-US — английский язык; tr-TR — турецкий язык.

Default Value

ru-RU

sampleRateHertz

sampleRateHertz: undefined | number

Частота дискретизации синтезируемого аудио. Применяется, если значение format равно lpcm. Допустимые значения: 48000 (по умолчанию) — частота дискретизации 48 кГц; 16000 — частота дискретизации 16 кГц; 8000 — частота дискретизации 8 кГц.

Default Value

48000

speed

speed: number

Скорость (темп) синтезированной речи. Для премиум-голосов временно не поддерживается. Скорость речи задается дробным числом в диапазоне от 0.1 до 3.0. Где: 3.0 — самый быстрый темп; 1.0 (по умолчанию) — средняя скорость человеческой речи; 0.1 — самый медленный темп.

Default Value

1.0

text

text: undefined | string

Текст, который нужно озвучить, в кодировке UTF-8. Можно использовать только одно из полей text и ssml. Для передачи слов-омографов используйте + перед ударной гласной. Например, гот+ов или def+ect. Чтобы отметить паузу между словами, используйте -. Ограничение на длину строки: 5000 символов.

voice

voice: string

Желаемый голос для синтеза речи из списка. Значение параметра по умолчанию: oksana.

Default Value

oksana

Static Readonly E_EVIL

E_EVIL: "evil" = 'evil'

Static Readonly E_GOOD

E_GOOD: "good" = 'good'

Static Readonly E_NEUTRAL

E_NEUTRAL: "neutral" = 'neutral'

Static Readonly F_LPCM

F_LPCM: "lpcm" = 'lpcm'

Static Readonly F_OGGOPUS

F_OGGOPUS: "oggopus" = 'oggopus'

Static Readonly L_EN

L_EN: "en_EN" = 'en_EN'

Static Readonly L_RU

L_RU: "ru-RU" = 'ru-RU'

Static Readonly L_TR

L_TR: "tr-TR" = 'tr-TR'

Static Readonly TTS_API_URL

TTS_API_URL: "https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize" = 'https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize'

Const

string Адрес, на который будет отправляться запрос

Static Readonly V_ALENA

V_ALENA: "alena" = 'alena'

Static Readonly V_ALYSS

V_ALYSS: "alyss" = 'alyss'

Static Readonly V_ERKANYAVAS

V_ERKANYAVAS: "erkanyavas" = 'erkanyavas'

Static Readonly V_ERMIL

V_ERMIL: "ermil" = 'ermil'

Static Readonly V_FILIPP

V_FILIPP: "filipp" = 'filipp'

Static Readonly V_JANE

V_JANE: "jane" = 'jane'

Static Readonly V_NICK

V_NICK: "nick" = 'nick'

Static Readonly V_OKSANA

V_OKSANA: "oksana" = 'oksana'

Static Readonly V_OMAZH

V_OMAZH: "omazh" = 'omazh'

Static Readonly V_SILAERKAN

V_SILAERKAN: "silaerkan" = 'silaerkan'

Static Readonly V_ZAHAR

V_ZAHAR: "zahar" = 'zahar'

Methods

Protected _initPost

  • _initPost(): void

  • Инициализация параметров для отправки запроса.

    Returns void

Protected _log

call

  • Отправка запроса для обработки данных.

    Returns

    Promise

    Api

    Type Parameters

    Parameters

    • url: null | string = null

      Адрес запроса.

    Returns Promise<null | T>

getTts

  • Получение голосового текста. Если синтез прошел успешно, в ответе будет бинарное содержимое аудиофайла. Формат выходных данных зависит от значения параметра format.

    Returns

    Promise

    See

    (https://cloud.yandex.ru/docs/speechkit/tts/request) Смотри тут

    Api

    Parameters

    • text: null | string = null

      Текст для преобразования

    Returns Promise<any>

setOAuth

  • Установка и инициализация токена.

    Api

    Parameters

    • oauth: null | string

      Авторизационный токен для загрузки данных.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc